Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
- 
+
servers:
- url: https://wwwcie.ups.com/api
@@ -46,9 +46,9 @@ paths:
schema:
type: string
minimum: 1
- description: "Valid values: True or False. If True, either the region element
+ description: "Valid values: True or False. If True, either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
- and the PostcodeExtendedLow fields will be recognized for validation
+ and the PostcodeExtendedLow fields will be recognized for validation
in addition to the urbanization element. If False or no indicator, street
level address validation is provided"
required: false
@@ -96,7 +96,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/XAVRequestWrapper"
+ $ref: "#/components/schemas/XAVRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -122,31 +122,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/XAVResponseWrapper"
+ $ref: "#/components/schemas/XAVResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/addressvalidation/{deprecatedVersion}/{requestoption}":
post:
deprecated: true
@@ -165,9 +165,9 @@ paths:
schema:
type: string
minimum: 1
- description: "Valid values: True or False. If True, either the region element
+ description: "Valid values: True or False. If True, either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
- and the PostcodeExtendedLow fields will be recognized for validation
+ and the PostcodeExtendedLow fields will be recognized for validation
in addition to the urbanization element. If False or no indicator, street
level address validation is provided"
required: false
@@ -216,7 +216,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/XAVRequestWrapper"
+ $ref: "#/components/schemas/XAVRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -242,31 +242,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/XAVResponseWrapper"
+ $ref: "#/components/schemas/XAVResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -294,7 +294,7 @@ components:
- XAVRequest
properties:
XAVRequest:
- "$ref": "#/components/schemas/XAVRequest"
+ $ref: "#/components/schemas/XAVRequest"
XAVResponseWrapper:
xml:
name: XAVResponse
@@ -305,7 +305,7 @@ components:
- XAVResponse
properties:
XAVResponse:
- "$ref": "#/components/schemas/XAVResponse"
+ $ref: "#/components/schemas/XAVResponse"
XAVRequest:
type: object
required:
@@ -313,15 +313,15 @@ components:
- Request
properties:
Request:
- "$ref": "#/components/schemas/XAVRequest_Request"
+ $ref: "#/components/schemas/XAVRequest_Request"
RegionalRequestIndicator:
- description: >
+ description: >-
If this indicator is present then either the region element
or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow
and the PostcodeExtendedLow fields will be recognized for validation in
- addition to the urbanization element. If this tag is present, US and
+ addition to the urbanization element. If this tag is present, US and
PR street level address validation will not occur. The default is to
- provide street level address validation. Not valid with the address
+ provide street level address validation. Not valid with the address
classification request option.
maximum: 1
type: string
@@ -336,7 +336,7 @@ components:
minLength: 1
maxLength: 2
AddressKeyFormat:
- "$ref": "#/components/schemas/XAVRequest_AddressKeyFormat"
+ $ref: "#/components/schemas/XAVRequest_AddressKeyFormat"
xml:
name: XAVRequest
maximum: 1
@@ -367,7 +367,7 @@ components:
minLength: 1
maxLength: 1
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
required:
@@ -420,7 +420,7 @@ components:
- PostcodePrimaryLow
- PostcodeExtendedLow
- Valid only for US or PR origins only. Using this tag for non US/PR origins may cause address format errors.
+ Valid only for US or PR origins only. Using this tag for non US/PR origins may cause address format errors.
maximum: 1
type: string
minLength: 1
@@ -467,14 +467,14 @@ components:
- CountryCode
description: |-
AddressKeyFormat container.
- The Key format is based on addressing standards jointly developed by the Postal Service and mailing industry. The information provided in the Address Key container will be returned in the same format.
+ The Key format is based on addressing standards jointly developed by the Postal Service and mailing industry. The information provided in the Address Key container will be returned in the same format.
XAVResponse:
type: object
required:
- Response
properties:
Response:
- "$ref": "#/components/schemas/XAVResponse_Response"
+ $ref: "#/components/schemas/XAVResponse_Response"
ValidAddressIndicator:
description: Indicates query found a valid match.
maximum: 1
@@ -489,7 +489,7 @@ components:
maximum: 1
type: string
AddressClassification:
- "$ref": "#/components/schemas/XAVResponse_AddressClassification"
+ $ref: "#/components/schemas/XAVResponse_AddressClassification"
Candidate:
description: |
Candidate Container.
@@ -497,7 +497,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/XAVResponse_Candidate"
+ $ref: "#/components/schemas/XAVResponse_Candidate"
xml:
name: XAVResponse
maximum: 1
@@ -508,17 +508,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and description.
+ Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -540,7 +540,7 @@ components:
minLength: 1
maxLength: 1
Description:
- description: Describes Response Status Code. Returns text of 'Success'
+ description: Describes Response Status Code. Returns text of 'Success'
or 'Failure'.
maximum: 1
type: string
@@ -617,9 +617,9 @@ components:
type: object
properties:
AddressClassification:
- "$ref": "#/components/schemas/Candidate_AddressClassification"
+ $ref: "#/components/schemas/Candidate_AddressClassification"
AddressKeyFormat:
- "$ref": "#/components/schemas/Candidate_AddressKeyFormat"
+ $ref: "#/components/schemas/Candidate_AddressKeyFormat"
xml:
name: Candidate
required:
@@ -673,7 +673,7 @@ components:
description: "Address line (street number, street name and street type,
and political division 1, political division 2 and postal code) used for
street level information. Additional secondary information (apartment,
- suite, floor, etc.) Applicable to US and PR only. Not returned if user
+ suite, floor, etc.) Applicable to US and PR only. Not returned if user
selects the RegionalRequestIndicator."
type: array
maximum: 3
@@ -695,10 +695,10 @@ components:
minLength: 1
maxLength: 30
PoliticalDivision1:
- description: "State/Province. Returned if the location is within a State/Province/Territory.
- For International: returned if user enters valid Country or Territory
- Code, and City/postal code and it has a match. For Domestic addresses,
- the value must be a valid 2-character value (per US Mail standards). For
+ description: "State/Province. Returned if the location is within a State/Province/Territory.
+ For International: returned if user enters valid Country or Territory
+ Code, and City/postal code and it has a match. For Domestic addresses,
+ the value must be a valid 2-character value (per US Mail standards). For
International the full State or Province name will be returned."
maximum: 1
type: string
@@ -713,7 +713,7 @@ components:
maxLength: 10
PostcodeExtendedLow:
description: "Low-end extended postal code in a range. Example in quotes:
- Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric"
+ Postal Code 30076-'1234'. Only returned in candidate list. May be alphanumeric"
maximum: 1
type: string
minLength: 1
@@ -739,7 +739,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -748,7 +748,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/DangerousGoods.yaml b/DangerousGoods.yaml
index d88a54a..29d3c8b 100644
--- a/DangerousGoods.yaml
+++ b/DangerousGoods.yaml
@@ -4,19 +4,19 @@ info:
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
-
+
The Dangerous Goods API provides the ability to determine if certain materials, such as dangerous goods or hazardous materials, can be shipped with UPS. The API's two endpoints - Chemical Reference Data and Acceptance Audit Precheck, help perform pre-checks before shipping any dangerous goods.
# Reference
- Business Rules
- Appendix
- Errors
- FAQ
-
+
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -69,7 +69,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -84,31 +84,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/dangerousgoods/{version}/acceptanceauditprecheck":
post:
description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code.
@@ -153,7 +153,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper"
examples:
json:
summary: A sample JSON request
@@ -218,31 +218,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/dangerousgoods/{deprecatedVersion}/chemicalreferencedata":
post:
deprecated: true
@@ -290,7 +290,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -305,31 +305,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck":
post:
deprecated: true
@@ -375,7 +375,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper"
examples:
json:
summary: A sample JSON request
@@ -440,31 +440,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper"
+ $ref: "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -492,7 +492,7 @@ components:
- ChemicalReferenceDataRequest
properties:
ChemicalReferenceDataRequest:
- "$ref": "#/components/schemas/ChemicalReferenceDataRequest"
+ $ref: "#/components/schemas/ChemicalReferenceDataRequest"
DANGEROUSGOODSUTILITYResponseWrapper:
xml:
name: ChemicalReferenceDataResponse
@@ -503,7 +503,7 @@ components:
- ChemicalReferenceDataResponse
properties:
ChemicalReferenceDataResponse:
- "$ref": "#/components/schemas/ChemicalReferenceDataResponse"
+ $ref: "#/components/schemas/ChemicalReferenceDataResponse"
ChemicalReferenceDataRequest:
type: object
required:
@@ -511,11 +511,11 @@ components:
- ShipperNumber
properties:
Request:
- "$ref": "#/components/schemas/ChemicalReferenceDataRequest_Request"
+ $ref: "#/components/schemas/ChemicalReferenceDataRequest_Request"
IDNumber:
description: This is the ID number (UN/NA/ID) for the specified commodity.
UN/NA/ID Identification Number assigned to the specified regulated good.
- (Include the UN/NA/ID as part of the entry). At least one of the information
+ (Include the UN/NA/ID as part of the entry). At least one of the information
- IDNumber or ProperShippingName should be provided to retrieve Chemical
Reference Data.
maximum: 1
@@ -523,7 +523,7 @@ components:
minLength: 1
maxLength: 6
ProperShippingName:
- description: The Proper Shipping Name assigned by ADR, CFR or IATA. At
+ description: The Proper Shipping Name assigned by ADR, CFR or IATA. At
least one of the information - IDNumber or ProperShippingName should be
provided to retrieve Chemical Reference Data.
maximum: 1
@@ -531,7 +531,7 @@ components:
minLength: 1
maxLength: 250
ShipperNumber:
- description: Shipper's six digit account number. Your UPS Account Number
+ description: Shipper's six digit account number. Your UPS Account Number
must have correct Dangerous goods contract to successfully use this Webservice.
maximum: 1
type: string
@@ -565,7 +565,7 @@ components:
type: string
maximum: 1
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
@@ -590,7 +590,7 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/ChemicalReferenceDataResponse_Response"
+ $ref: "#/components/schemas/ChemicalReferenceDataResponse_Response"
ChemicalData:
description: |
Container to hold Chemical Data information.
@@ -598,7 +598,7 @@ components:
**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/ChemicalReferenceDataResponse_ChemicalData"
+ $ref: "#/components/schemas/ChemicalReferenceDataResponse_ChemicalData"
xml:
name: ChemicalReferenceDataResponse
description: Dangerous Goods Utility Response container for Chemical Reference
@@ -610,17 +610,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Contains Dangerous Goods Utility Chemical Reference Data response
@@ -634,7 +634,7 @@ components:
- Code
properties:
Code:
- description: 'Identifies the success or failure of the transaction. Valid
+ description: 'Identifies the success or failure of the transaction. Valid
values: 0 = Failed and 1 = Successful.'
maximum: 1
type: string
@@ -690,17 +690,17 @@ components:
type: object
properties:
ChemicalDetail:
- "$ref": "#/components/schemas/ChemicalData_ChemicalDetail"
+ $ref: "#/components/schemas/ChemicalData_ChemicalDetail"
ProperShippingNameDetail:
- "$ref": "#/components/schemas/ChemicalData_ProperShippingNameDetail"
+ $ref: "#/components/schemas/ChemicalData_ProperShippingNameDetail"
PackageQuantityLimitDetail:
description: |
- Container to hold Package Quantity Limit Detail information. It will be returned if applies for a given chemical record.
+ Container to hold Package Quantity Limit Detail information. It will be returned if applies for a given chemical record.
**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/ChemicalData_PackageQuantityLimitDetail"
+ $ref: "#/components/schemas/ChemicalData_PackageQuantityLimitDetail"
xml:
name: ChemicalData
ChemicalData_ChemicalDetail:
@@ -712,7 +712,7 @@ components:
\ Possible values are ADR, 49CFR, IATA. It will be returned if applies
for a given chemical record.\n\nADR = Europe to Europe Ground Movement\n49CFR
= HazMat regulated by US Dept. of Transportation within the U.S. or ground
- shipments to Canada, \nIATA= Worldwide Air movement."
+ shipments to Canada,\nIATA= Worldwide Air movement."
maximum: 1
type: string
minLength: 3
@@ -720,7 +720,7 @@ components:
IDNumber:
description: This is the ID number (UN/NA/ID) for the specified commodity.
UN/NA/ID Identification Number assigned to the specified regulated good.
- (Include the UN/NA/ID as part of the entry). It will be returned if applies
+ (Include the UN/NA/ID as part of the entry). It will be returned if applies
for a given chemical record.
maximum: 1
type: string
@@ -728,21 +728,21 @@ components:
maxLength: 6
HazardousMaterialsDescription:
description: Free form text containing the full name that are used to describe
- a regulated chemical record. It will be returned if applies for a given
+ a regulated chemical record. It will be returned if applies for a given
chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 250
ClassDivisionNumber:
- description: This is the hazard class associated to the specified commodity. It
+ description: This is the hazard class associated to the specified commodity. It
will be returned if applies for a given chemical record.
maximum: 1
type: string
minLength: 1
maxLength: 10
SubRiskClass:
- description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). It will be returned if applies for a given chemical record.
+ description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). It will be returned if applies for a given chemical record.
maximum: 1
type: string
minLength: 1
@@ -750,7 +750,7 @@ components:
PackagingGroupType:
description: This is the packing group category associated to the specified
commodity. This code represents the potential degree of danger represented
- by a regulated commodity being transported. It will be returned if applies
+ by a regulated commodity being transported. It will be returned if applies
for a given chemical record.
maximum: 1
type: string
@@ -758,15 +758,15 @@ components:
maxLength: 10
SpecialPermit:
description: "Indicates whether or not related entity requires special permit
- in order to transport the chemical. It will be returned if applies for
- a given chemical record.\n\nValid values: \nAIR\nGND\nBOTH"
+ in order to transport the chemical. It will be returned if applies for
+ a given chemical record.\n\nValid values:\nAIR\nGND\nBOTH"
maximum: 1
type: string
minLength: 1
maxLength: 4
TechnicalNameRequiredIndicator:
description: |-
- Indicates whether TechnicalName is required or not. It will be returned if applies for a given chemical record.
+ Indicates whether TechnicalName is required or not. It will be returned if applies for a given chemical record.
Y = TechnicalName is required.
N = TechnicalName is not required.
@@ -776,8 +776,8 @@ components:
maxLength: 1
AdditionalShippingInformationRequiredIndicator:
description: "Indicates whether or not additional text is required for the
- shipping papers for the related entity. It will be returned if applies
- for a given chemical record.\n\nValid values: \nN = No, additional information
+ shipping papers for the related entity. It will be returned if applies
+ for a given chemical record.\n\nValid values:\nN = No, additional information
for the shipping papers are not required.\nY = Yes, additional information
for the shipping papers are required."
maximum: 1
@@ -786,7 +786,7 @@ components:
maxLength: 1
TunnelRestrictionCode:
description: |-
- Defines what is restricted to pass through a tunnel. EXAMPLES OF VALUES:
+ Defines what is restricted to pass through a tunnel. EXAMPLES OF VALUES:
(B),(D),(E),(B/D),(B/E),(C,D),(C/E),(D/E),Blank
maximum: 1
type: string
@@ -806,7 +806,7 @@ components:
maxLength: 1
TransportMultiplierQuantity:
description: |-
- The quantity that represents a multiplication factor used to calculate a value to determine the placarding to be place on the vehicle or container that holds the related regulated commodity. This factor is associated with a code value represented by Regulated Commodity Transport Category Code. EXAMPLES OF VALUES:
+ The quantity that represents a multiplication factor used to calculate a value to determine the placarding to be place on the vehicle or container that holds the related regulated commodity. This factor is associated with a code value represented by Regulated Commodity Transport Category Code. EXAMPLES OF VALUES:
0 = No multiplier - must use placarding
1 = Use a multiplier of 50
2 = Use a multiplier of 3
@@ -861,7 +861,7 @@ components:
maxLength: 250
xml:
name: ProperShippingNameDetail
- description: Container to hold Proper Shipping Name Detail information. It
+ description: Container to hold Proper Shipping Name Detail information. It
will be returned if applies for a given chemical record.
maximum: 1
ChemicalData_PackageQuantityLimitDetail:
@@ -870,7 +870,7 @@ components:
properties:
PackageQuantityLimitTypeCode:
description: |-
- The type of package quantity limit. It will be returned if applies for a given chemical record.
+ The type of package quantity limit. It will be returned if applies for a given chemical record.
Valid values:
CAO - Cargo Aircraft Only
@@ -885,7 +885,7 @@ components:
minLength: 1
maxLength: 10
Quantity:
- description: The numerical value of the mass capacity of the regulated good. It
+ description: The numerical value of the mass capacity of the regulated good. It
will be returned if applies for a given chemical record.
maximum: 1
type: string
@@ -900,7 +900,7 @@ components:
minLength: 1
maxLength: 10
PackagingInstructionCode:
- description: The packing instructions related to the chemical record. It
+ description: The packing instructions related to the chemical record. It
will be returned if applies for a given chemical record.
maximum: 1
type: string
@@ -918,7 +918,7 @@ components:
- AcceptanceAuditPreCheckRequest
properties:
AcceptanceAuditPreCheckRequest:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckRequest"
DANGEROUSGOODSUTILITYAPCResponseWrapper:
xml:
name: AcceptanceAuditPreCheckResponse
@@ -929,7 +929,7 @@ components:
- AcceptanceAuditPreCheckResponse
properties:
AcceptanceAuditPreCheckResponse:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckResponse"
AcceptanceAuditPreCheckRequest:
type: object
required:
@@ -937,14 +937,14 @@ components:
- Shipment
properties:
Request:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Request"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckRequest_Request"
OriginRecordTransactionTimestamp:
description: "The time that the request was made from the originating system.
- UTC time down to milliseconds. \nExample: 2016-07-14T12:01:33.999"
+ UTC time down to milliseconds.\nExample: 2016-07-14T12:01:33.999"
type: string
maximum: 1
Shipment:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment"
xml:
name: AcceptanceAuditPreCheckRequest
maximum: 1
@@ -954,14 +954,14 @@ components:
type: object
properties:
RequestOption:
- description: "Enables the user to specify optional processing. \n\nCurrently,
+ description: "Enables the user to specify optional processing.\n\nCurrently,
there is no optional process in Dangerous Goods Utility WS."
type: string
SubVersion:
description: Not Used.
type: string
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
@@ -978,24 +978,24 @@ components:
- Package
properties:
ShipperNumber:
- description: Shipper's six digit account number. Your UPS Account Number
+ description: Shipper's six digit account number. Your UPS Account Number
must have correct Dangerous goods contract to successfully use this Webservice.
maximum: 1
type: string
minLength: 6
maxLength: 6
ShipFromAddress:
- "$ref": "#/components/schemas/Shipment_ShipFromAddress"
+ $ref: "#/components/schemas/Shipment_ShipFromAddress"
ShipToAddress:
- "$ref": "#/components/schemas/Shipment_ShipToAddress"
+ $ref: "#/components/schemas/Shipment_ShipToAddress"
Service:
- "$ref": "#/components/schemas/Shipment_Service"
+ $ref: "#/components/schemas/Shipment_Service"
RegulationSet:
description: "The Regulatory set associated with every regulated shipment.
It must be same across the shipment. Not required when the CommodityRegulatedLevelCode
- is EQ. Valid values: ADR, 49CFR, IATA.\n\nADR = Europe to Europe Ground
+ is EQ. Valid values: ADR, 49CFR, IATA.\n\nADR = Europe to Europe Ground
Movement\n49CFR = HazMat regulated by US Dept. of Transportation within
- the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement."
+ the U.S. or ground shipments to Canada\nIATA= Worldwide Air movement."
maximum: 1
type: string
minLength: 3
@@ -1004,7 +1004,7 @@ components:
type: array
maximum: 1000
items:
- "$ref": "#/components/schemas/Shipment_Package"
+ $ref: "#/components/schemas/Shipment_Package"
xml:
name: Shipment
description: Contains shipment information.
@@ -1123,10 +1123,10 @@ components:
minLength: 1
maxLength: 5
PackageWeight:
- "$ref": "#/components/schemas/Package_PackageWeight"
+ $ref: "#/components/schemas/Package_PackageWeight"
QValue:
description: 'This is required when a HazMat shipment specifies AllPackedInOneIndicator
- and the regulation set for that shipment is IATA. Valid values: 0.1;
+ and the regulation set for that shipment is IATA. Valid 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
@@ -1139,8 +1139,8 @@ components:
maximum: 1
TransportationMode:
description: "The method of transport by which a shipment is approved to
- move and the regulations associated with that method. \n\nOnly required
- when the CommodityRegulatedLevelCode is FR or LQ. Valid entries include:
+ move and the regulations associated with that method.\n\nOnly required
+ when the CommodityRegulatedLevelCode is FR or LQ. Valid entries include:
GND, CAO, and PAX."
maximum: 1
type: string
@@ -1152,7 +1152,7 @@ components:
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 Emergency Phone Number can only include the following allowable characters
+ 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 Emergency Phone Number can only include the following allowable characters
“period “.”, dash “-“, plus sign “+” and conventional parentheses “(“ and “)”, “EXT or OPT”
Required when (TDG regulation set and CommodityRegulatedLevelCode = FR)
@@ -1173,7 +1173,7 @@ components:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/Package_ChemicalRecord"
+ $ref: "#/components/schemas/Package_ChemicalRecord"
xml:
name: Package
description: Package Information container.
@@ -1191,7 +1191,7 @@ components:
minLength: 15
maxLength: 15
UnitOfMeasurement:
- "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/PackageWeight_UnitOfMeasurement"
xml:
name: PackageWeight
description: Container to hold package weight information.
@@ -1203,7 +1203,7 @@ components:
properties:
Code:
description: |-
- Package weight unit of measurement code. Valid values:
+ Package weight unit of measurement code. Valid values:
LBS = Pounds
KGS = Kilograms
maximum: 1
@@ -1261,7 +1261,7 @@ components:
IDNumber:
description: "This is the ID number (UN/NA/ID) for the specified commodity.
\n\nRequired if CommodityRegulatedLevelCode = LR, LQ or FR and if the
- field applies to the material by regulation. \n\nUN/NA/ID Identification
+ field applies to the material by regulation.\n\nUN/NA/ID Identification
Number assigned to the specified regulated good. (Include the UN/NA/ID
as part of the entry)."
maximum: 1
@@ -1270,9 +1270,9 @@ components:
maxLength: 6
PackagingGroupType:
description: "This is the packing group category associated to the specified
- commodity. \nRequired if CommodityRegulatedLevelCode = LQ or FR and if
+ commodity.\nRequired if CommodityRegulatedLevelCode = LQ or FR and if
the field applies to the material by regulation. Must be shown in Roman
- Numerals. Valid values are: \nI\nII\nIII \nblank"
+ Numerals. Valid values are:\nI\nII\nIII\nblank"
maximum: 1
type: string
minLength: 1
@@ -1287,7 +1287,7 @@ components:
UOM:
description: |-
Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good.
- Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.
+ Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.
maximum: 1
type: string
minLength: 1
@@ -1301,7 +1301,7 @@ components:
minLength: 1
maxLength: 353
ProperShippingName:
- description: "The Proper Shipping Name assigned by ADR, CFR or IATA. \n\nRequired
+ description: "The Proper Shipping Name assigned by ADR, CFR or IATA.\n\nRequired
if CommodityRegulatedLevelCode = LR, LQ or FR."
maximum: 1
type: string
@@ -1326,7 +1326,7 @@ components:
maxLength: 75
PackagingType:
description: "The package type code identifying the type of packaging used
- for the commodity. (Ex: Fiberboard Box). \nRequired if CommodityRegulatedLevelCode
+ for the commodity. (Ex: Fiberboard Box).\nRequired if CommodityRegulatedLevelCode
= LQ or FR."
maximum: 1
type: string
@@ -1334,22 +1334,22 @@ components:
maxLength: 255
HazardLabelRequired:
description: "Defines the type of label that is required on the package
- for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode =
+ for the commodity.\n\nNot applicable if CommodityRegulatedLevelCode =
LR or EQ."
maximum: 1
type: string
minLength: 1
maxLength: 50
PackagingTypeQuantity:
- description: "The number of pieces of the specific commodity. \n\nRequired
- if CommodityRegulatedLevelCode = LQ or FR. Valid values: 1 to 999"
+ description: "The number of pieces of the specific commodity.\n\nRequired
+ if CommodityRegulatedLevelCode = LQ or FR. Valid values: 1 to 999"
maximum: 1
type: string
minLength: 1
maxLength: 3
CommodityRegulatedLevelCode:
description: |-
- Indicates the type of commodity. Valid values: LR, FR, LQ, EQ
+ Indicates the type of commodity. Valid values: LR, FR, LQ, EQ
FR = Fully Regulated
LQ = Limited Quantity
@@ -1360,7 +1360,7 @@ components:
minLength: 2
maxLength: 2
TransportCategory:
- description: 'Transport Category. Valid values: 0 to 4'
+ description: 'Transport Category. Valid values: 0 to 4'
maximum: 1
type: string
minLength: 1
@@ -1384,7 +1384,7 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_Response"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckResponse_Response"
ShipperNumber:
description: Shipper's six digit account number. This is same account number
present in the request that is played back in response.
@@ -1393,10 +1393,10 @@ components:
minLength: 6
maxLength: 6
Service:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_Service"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckResponse_Service"
RegulationSet:
description: |-
- The Regulatory set associated with every regulated shipment. This is same Regulation set present in the request that is played back in response. Valid values:
+ The Regulatory set associated with every regulated shipment. This is same Regulation set present in the request that is played back in response. Valid values:
ADR
49CFR
IATA
@@ -1413,7 +1413,7 @@ components:
type: array
maximum: 20
items:
- "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_PackageResults"
+ $ref: "#/components/schemas/AcceptanceAuditPreCheckResponse_PackageResults"
xml:
name: AcceptanceAuditPreCheckResponse
maximum: 1
@@ -1425,15 +1425,15 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and description.
+ Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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"
+ $ref: "#/components/schemas/Response_Alert"
AlertDetail:
description: |
Alert Detail Container.
@@ -1441,10 +1441,10 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/Response_AlertDetail"
+ $ref: "#/components/schemas/Response_AlertDetail"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Contains Dangerous Goods Utility Acceptance Audit Pre-check response
@@ -1470,7 +1470,7 @@ components:
minLength: 1
maxLength: 150
ElementLevelInformation:
- "$ref": "#/components/schemas/AlertDetail_ElementLevelInformation"
+ $ref: "#/components/schemas/AlertDetail_ElementLevelInformation"
xml:
name: AlertDetail
AlertDetail_ElementLevelInformation:
@@ -1480,7 +1480,7 @@ components:
- Level
properties:
Level:
- description: "Define type of element in request. Possible values: \nH
+ description: "Define type of element in request. Possible values:\nH
for the header details level\nS for the shipment level\nP for the package
level\nC for the commodity level"
maximum: 1
@@ -1488,9 +1488,9 @@ components:
minLength: 1
maxLength: 1
ElementIdentifier:
- type: array
- items:
- "$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier"
+ type: array
+ items:
+ $ref: "#/components/schemas/ElementLevelInformation_ElementIdentifier"
xml:
name: ElementLevelInformation
description: Provides more information about the element that represents the
@@ -1516,7 +1516,7 @@ components:
maxLength: 5
xml:
name: ElementIdentifier
- description: "Contains more information about the type of element. \nReturned
+ description: "Contains more information about the type of element.\nReturned
if Level is P or C."
AcceptanceAuditPreCheckResponse_Service:
type: object
@@ -1545,7 +1545,7 @@ components:
maxLength: 5
AccessibleIndicator:
description: |-
- Indicates if a package is crew accessible or not. Y = Package is crew accessible.
+ Indicates if a package is crew accessible or not. Y = Package is crew accessible.
N = Package is not crew accessible.
maximum: 1
type: string
@@ -1553,7 +1553,7 @@ components:
maxLength: 1
EuropeBUIndicator:
description: "Indicates if origin country or territory is in the Europe
- Business Unit. \n Y = Origin country or territory is in the Europe Business
+ Business Unit.\nY = Origin country or territory is in the Europe Business
Unit.\nN = Origin country or territory is not in the Europe Business Unit."
maximum: 1
type: string
@@ -1567,7 +1567,7 @@ components:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/PackageResults_ChemicalRecordResults"
+ $ref: "#/components/schemas/PackageResults_ChemicalRecordResults"
xml:
name: PackageResults
PackageResults_ChemicalRecordResults:
@@ -1589,7 +1589,7 @@ components:
minLength: 1
maxLength: 4
TransportCategory:
- description: 'Transport Category. Valid values: 0 to 4'
+ description: 'Transport Category. Valid values: 0 to 4'
maximum: 1
type: string
minLength: 1
@@ -1614,7 +1614,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -1623,7 +1623,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/DeliveryDefense.yaml b/DeliveryDefense.yaml
index 01e665e..4163fb8 100644
--- a/DeliveryDefense.yaml
+++ b/DeliveryDefense.yaml
@@ -2,20 +2,20 @@ openapi: 3.1.0
info:
title: DeliveryDefense API
description: |
- Address Confidence
-
+ Address Confidence
+
For more information on the Delivery Defense API, please visit the Product Info page.
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
-
+
# Purpose
-
+
The API is designed to enable customers to obtain an Address Confidence score based on analysis of historical data.
version: "1.0"
tags:
@@ -32,10 +32,9 @@ paths:
- Delivery Defense
operationId: "score"
summary: Get Verified Address Score
- description: |
- This API cleans and verifies inputted addresses to enhance the accuracy of generating an Address Confidence score. The returned data includes the cleaned address, the Address Confidence score, and an indication of whether the address is commercial or residential.
+ description: This API cleans and verifies inputted addresses to enhance the accuracy of generating an Address Confidence score. The returned data includes the cleaned address, the Address Confidence score, and an indication of whether the address is commercial or residential.
security:
- - OAuth2: []
+ - OAuth2: []
requestBody:
content:
application/json:
@@ -130,7 +129,7 @@ paths:
**Example Scenario**:
- **Request**: A client submits an address for scoring.
- **Response**: The server returns a `204 No Content` status.
-
+
'400':
description: Bad Request
@@ -146,7 +145,7 @@ paths:
status: 400
traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00
errors:
- State:
+ State:
- The State field is required.
StreetFieldMissing:
value:
@@ -178,35 +177,35 @@ paths:
'401':
description: Unauthorized
- content:
- application/json:
- schema:
+ content:
+ application/json:
+ schema:
$ref: '#/components/schemas/Error'
examples:
InvalidToken:
- value:
+ value:
errorCode: "401"
- errorMessage: Invalid Authentication Information.
-
+ errorMessage: Invalid Authentication Information.
+
'500':
description: Internal Server Error
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"
+ 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:
AddressRequestBody:
type: object
@@ -240,8 +239,7 @@ components:
description: An error code representing the type of error.
errorMessage:
type: string
- description: |
- * Invalid Authentication Information.
+ description: '* Invalid Authentication Information.'
required:
- errorCode
- errorMessage
@@ -258,8 +256,7 @@ components:
description: One or more validation errors occurred
status:
type: integer
- description: |
- * 400
+ description:'* 400'
traceId:
type: string
description: auto generated Id
@@ -302,11 +299,11 @@ components:
type: string
description: Zipcode in address
country:
- type: string
- description: Country code in address
+ type: string
+ description: Country code in address
score:
type: integer
- description: >
+ description: |-
* If range is between 900-1000 then there is a low likelihood of
loss.
@@ -325,4 +322,4 @@ components:
type: string
description: >-
Indicates if the address used for lookup is residential or
- commercial
\ No newline at end of file
+ commercial
diff --git a/DeliveryIntercept.yaml b/DeliveryIntercept.yaml
index 1b5c992..539763f 100644
--- a/DeliveryIntercept.yaml
+++ b/DeliveryIntercept.yaml
@@ -13,13 +13,13 @@ info:
Product Info
-
+
# CIE Behavior
The Delivery Intercept API will return a stubbed success response if the correct data is used for a given endpoint. The static data that is valid for each of the endpoints is in the table below:
-
+
| Endpoint | transId | trackingNumber |
|------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| /charges | SIICharges | 1Z4096YY0316914058
@@ -47,7 +47,7 @@ servers:
default: v2
enum:
- v2
-security:
+security:
- OAuth2: []
paths:
/charges/{trackingNumber}:
@@ -55,7 +55,7 @@ paths:
summary: charges by inquiry type
description: Obtains intercept charges specified by the inquiry type.
operationId: getCharges
- tags:
+ tags:
- Delivery Intercept
servers:
- url: https://wwwcie.ups.com/api/deliverychange/{version}
@@ -157,7 +157,7 @@ paths:
statusCode: "0006"
errors:
- code: "605"
- message: Package address token does not match any tokens in the user's profile.
+ message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
@@ -173,7 +173,7 @@ paths:
summary: redirect a package to a Customer center for pickup.
description: Request your package to be held at or returned to a UPS facility where the receiver may claim the same-day.
operationId: submitWillCall
- tags:
+ tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
@@ -317,7 +317,7 @@ paths:
statusCode: "0006"
errors:
- code: "605"
- message: Package address token does not match any tokens in the user's profile.
+ message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
@@ -333,7 +333,7 @@ paths:
summary: redirect the package back to the sender
description: Return the package to the original shipper prior to delivery.
operationId: submitReturnToSender
- tags:
+ tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
@@ -428,7 +428,7 @@ paths:
statusCode: "0006"
errors:
- code: "605"
- message: Package address token does not match any tokens in the user's profile.
+ message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
@@ -444,7 +444,7 @@ paths:
summary: change to a new delivery date in the future.
description: Have the package delivered to the original address but on a different day in the future.
operationId: submitRescheduleDelivery
- tags:
+ tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
@@ -540,7 +540,7 @@ paths:
statusCode: "0006"
errors:
- code: "605"
- message: Package address token does not match any tokens in the user's profile.
+ message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
@@ -553,10 +553,10 @@ paths:
$ref: '#/components/schemas/ErrorResponse'
/redirect/address/{trackingNumber}:
post:
- summary: Submission to request a new delivery address.
+ summary: Submission to request a new delivery address.
description: Deliver to a different address than on the label originally created for the shipment.
operationId: submitDeliverToAnotherAddressRequest
- tags:
+ tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
@@ -644,7 +644,7 @@ paths:
statusCode: "0006"
errors:
- code: "605"
- message: Package address token does not match any tokens in the user's profile.
+ message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
@@ -660,7 +660,7 @@ paths:
summary: cancel an existing Delivery Intercept request
description: Cancel a previously applied intercept on the package.
operationId: cancelExistingRequest
- tags:
+ tags:
- Delivery Intercept
parameters:
- $ref: "#/components/parameters/transId"
@@ -743,7 +743,7 @@ paths:
statusCode: "0006"
errors:
- code: "605"
- message: Package address token does not match any tokens in the user's profile.
+ message: Package address token does not match any tokens in the user's profile.
'500':
description: System error occurred
headers:
@@ -758,13 +758,13 @@ 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"
+ 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
@@ -773,8 +773,7 @@ components:
parameters:
transactionSrc:
name: transactionSrc
- description: >-
- Identifies the client/source application that is calling the API.
+ description: Identifies the client/source application that is calling the API.
in: header
required: true
style: simple
@@ -818,7 +817,7 @@ components:
example: application/json
TrackingNumber:
name: trackingNumber
- description: The number being tracked. Each method defines if required.
+ description: The number being tracked. Each method defines if required.
in: path
required: true
style: simple
@@ -893,7 +892,7 @@ components:
type: string
example: Ste 8
addressLine3:
- description: Line 3 of the street
+ description: Line 3 of the street
maxLength: 35
type: string
city:
@@ -932,7 +931,7 @@ components:
example: OAK
type: string
fullName:
- description: Full person name
+ description: Full person name
example: HUNTLY OAK
type: string
phoneNumber:
@@ -978,14 +977,13 @@ components:
streetNumber:
maxLength: 11
type: string
- example: "512"
+ example: "512"
ChargesInfo:
type: object
required: [chargeCurrency]
properties:
accessorialCharge:
- description: |
- Includes sum of all accessorial charges (i.e. including addition handling, intercept).
+ description: Includes sum of all accessorial charges (i.e. including addition handling, intercept).
type: string
maxLength: 20
example: "5.00"
@@ -1090,7 +1088,7 @@ components:
| CODE | DESCRIPTION |
| TRUE | the charges were paid by a third-party shipper. |
- | FALSE | the charges were paid by the original shipper. |
+ | FALSE | the charges were paid by the original shipper. |
type: boolean
default: false
taxes:
@@ -1106,7 +1104,7 @@ components:
description: Identifies the tax amount for a particular tax type
type: string
totalTax:
- description: Taxes for EU/Mexico/Canada country movement . sum of tax amounts present in the taxes field.
+ description: Taxes for EU/Mexico/Canada country movement . sum of tax amounts present in the taxes field.
type: string
maxLength: 4
example: "0.00"
@@ -1120,8 +1118,8 @@ components:
| VALUE | DESCRIPTION |
| :--: | :-- |
- | NTC | NO Tax calculation |
- | NTA | NO Tax applicable |
+ | NTC | NO Tax calculation |
+ | NTA | NO Tax applicable |
| TA | Taxes applicable |
| TE | Taxes exempt |
| TU | Taxes Undermined |
@@ -1133,8 +1131,8 @@ components:
type: object
required: [name,telephone]
properties:
- name:
- description: Contact Name
+ name:
+ description: Contact Name
maxLength: 30
minLength: 1
example: The UPS Store
@@ -1254,7 +1252,7 @@ components:
type: string
requestType:
description: |
- The request type of the intercept being performed. Each method defines if required.
+ The request type of the intercept being performed. Each method defines if required.
| VALUE | DESCRIPTION |
| :--: | :-- |
| WC | WILL_CALL |
@@ -1334,8 +1332,7 @@ components:
maxLength: 254
example: Watch for dog
originalPublicLocationId:
- description: |
- The original UAP public location ID where the package is currently located or in-transit to. Format- UXXXXXXXX ('U' followed by 8 numbers)
+ description: The original UAP public location ID where the package is currently located or in-transit to. Format- UXXXXXXXX ('U' followed by 8 numbers)
type: string
maxLength: 9
minLength: 9
@@ -1349,8 +1346,8 @@ components:
$ref: '#/components/schemas/ContactInfo'
iobb:
description: |
- iOvations Black Box data. Used for fraud checking/scoring.
-
+ iOvations Black Box data. Used for fraud checking/scoring.
+
| S.NO. | DESCRIPTION |
| :--: | :-- |
| 1 | iobb value is labeled “EMPTY” |
@@ -1378,28 +1375,27 @@ components:
example: 1Z1144YY0125887968
multiTrackingNumbers:
type: array
- description: |
- This unbounded array is required only for the API version v3. It is used to process multiple tracking numbers with the same request.
+ description: This unbounded array is required only for the API version v3. It is used to process multiple tracking numbers with the same request.
items:
$ref: '#/components/schemas/MultiTrackingNumbers'
MyChoiceInterceptCommonResponse:
type: object
properties:
addrToken:
- description: The token associated with the tracking number and one of the user's active enrollments.
+ description: The token associated with the tracking number and one of the user's active enrollments.
type: string
maxLength: 32
example: f01882cf6aad4833a2a25144bd04714e
myChoiceCountry:
description: |
Will only be returned if notificationRequestType is DBD email or DBD phone. Indicates if My Choice is supported in the
- package's ship to country.
-
+ package's ship to country.
+
| CODE | DESCRIPTION |
| :--: | :-- |
- | | No My Choice support check was done. |
- | 0 | Area does not support My Choice functionality. |
- | 1 | Area supports My Choice functionality. |
+ | | No My Choice support check was done. |
+ | 0 | Area does not support My Choice functionality. |
+ | 1 | Area supports My Choice functionality. |
type: string
maxLength: 1
minLength: 1
@@ -1471,7 +1467,7 @@ components:
required: [ratingRequest]
properties:
ratingRequest:
- description: |
+ description: |
List of rating request data. If you want to find out the accessory and transportation charges of a "redirect" request
for a specified Tracking number then this array list must contain one rating request. This array is unbounded.
type: array
@@ -1703,7 +1699,7 @@ components:
- type: object
required: [deliveryDate]
properties:
- deliveryDate:
+ deliveryDate:
description: Format- YYYYMMDD
maxLength: 8
minLength: 8
@@ -1712,7 +1708,7 @@ components:
example: "20190223"
required: [transactionId]
MyChoiceRescheduleDeliveryResponse:
- allOf:
+ allOf:
- $ref: '#/components/schemas/MyChoiceCommonResponse'
- $ref: '#/components/schemas/MyChoiceInterceptCommonResponse'
MyChoiceReturnToSenderRequest:
@@ -1725,7 +1721,7 @@ components:
reasonForReturn:
description: |
Reason for return code.
-
+
| CODE | DESCRIPTION |
| :--: | :-- |
| AM | RECEIVER REFUSED, CANCELLED ORDER |
@@ -1750,7 +1746,7 @@ components:
properties:
addrToken:
description: |
- Will only be returned when the addressToken is present on the request or can be retrieved from AMS for MyChoice functionality.
+ Will only be returned when the addressToken is present on the request or can be retrieved from AMS for MyChoice functionality.
The token associated with the tracking number and one of the user's active enrollments.
maxLength: 32
type: string
@@ -1839,7 +1835,7 @@ components:
minLength: 3
example: "001"
name:
- description: |
+ description: |
If this field is not present, MCCL will call SCL Component to obtain all location information.
This field must be supplied by trusted end clients only.
type: string
@@ -1901,9 +1897,9 @@ components:
unavailableReasonDescription:
description: |
Will be returned when unavailable is true.
-
+
| CODE | DESCRIPTION |
- | :--: | :-- |
+ | :--: | :-- |
| 01 | Temporarily unavailable |
| 02 | Location Full |
| 03 | Unavialable |
@@ -1911,7 +1907,7 @@ components:
type: string
example: "01"
serviceOfferingCode:
- type: string
+ type: string
description: |
The code for the service being offered.
@@ -1944,11 +1940,11 @@ components:
code:
description: |
The business classification type code.
-
+
| CODE | DESCRIPTION |
| :--: | :-- |
| 001 | BAKERY |
- | 002 | BOOKSTORE |
+ | 002 | BOOKSTORE |
| 003 | CHEMISTS |
| 004 | CLOTHes_SHOES |
| 005 | CONVIENIENCE_SHOP |
@@ -2015,7 +2011,7 @@ components:
paymentType:
description: |
Conditional on the charges. Required if the charges are greater than zero.
-
+
| CODE | DESCRIPTION |
| :--: | :-- |
| C | Credit Card |
@@ -2042,14 +2038,14 @@ components:
platformType:
description: |
Platform type associated with the source application.
-
+
| VALUE | DESCRIPTION |
| :-- | :-- |
| AU | M.UPS.COM |
| GG | UPSXMLONLINETOOLS |
| 72 | WEB-INTERNETBASEDAPPLICATION |
| XK | UPSMOBILEFORANDROID |
- | XL | UPSMOBILEFORIOS |
+ | XL | UPSMOBILEFORIOS |
| XM | UPSSOCIALFACEBOOKCLIENT=XM |
maxLength: 2
minLength: 2
@@ -2064,7 +2060,7 @@ components:
iobb:
description: |
Used on request only for non-authorized payment. Used for fraud checking/scoring.
-
+
| S.NO. | DESCRIPTION |
| :--: | :-- |
| 1 | iobb value is labeled “EMPTY” |
@@ -2098,8 +2094,7 @@ components:
type: string
example: "TPSJWGKFWNMG4020"
cardType:
- description: |
- The card type is required for non-authorized cards and new cards.
+ description: The card type is required for non-authorized cards and new cards.
maxLength: 2
minLength: 2
example: "01"
@@ -2138,39 +2133,32 @@ components:
type: object
properties:
cardTypeID:
- description: |
- The card type ID
+ description: The card type ID
example: "04"
type: string
cardTypeName:
- description: |
- The card type name
+ description: The card type name
example: "04"
type: string
cardTypePCSName:
- description: |
- the card type PCS name
+ description: the card type PCS name
example: "MASTERCARD"
type: string
cardTypeLength:
- description: |
- the card type length
+ description: the card type length
type: string
cardTypeMaxLength:
- description: |
- the max length for card type
+ description: the max length for card type
example: 16
type: integer
format: int32
cardTypeMinLength:
- description: |
- the min length for card type
+ description: the min length for card type
example: 16
type: integer
format: int32
cardTypePaymentType:
- description: |
- the card type payment type
+ description: the card type payment type
example: "CC"
type: string
lastFourChars:
@@ -2213,7 +2201,7 @@ components:
maxLength: 10
example: "TESTO"
accountCountry:
- description: Country code associated with the account.
+ description: Country code associated with the account.
type: string
maxLength: 2
minLength: 2
@@ -2227,15 +2215,14 @@ components:
description: Displayable account number.
type: string
zipCode:
- description: |
- Request required when saveAccountInfo is TRUE. Postal code associated with the account used when saving a new account to the user's profile.
+ description: Request required when saveAccountInfo is TRUE. Postal code associated with the account used when saving a new account to the user's profile.
type: string
example: "21009"
accountType:
type: string
description: UPS account type.
defaultAccount:
- description: |
+ description: |
when saveAccountInfo is TRUE. If this is the default account in the user's profile.
TRUE - account is the default / will be saved as the default account.
FALSE - account is not the default payment.
@@ -2267,8 +2254,8 @@ components:
example: "USD"
iobb:
description: |
- Used on request only for non-authorized payment. Used for fraud checking/scoring
-
+ Used on request only for non-authorized payment. Used for fraud checking/scoring
+
| S.NO. | DESCRIPTION |
| :--: | :-- |
| 1 | iobb value is labeled “EMPTY” |
@@ -2296,8 +2283,7 @@ components:
description: The account name associated with this payment.
type: string
guidCode:
- description: |
- Request required for pre-authorized payment. The guid generated after the transaction payment authorization, acts as the authorization code.
+ description: Request required for pre-authorized payment. The guid generated after the transaction payment authorization, acts as the authorization code.
type: string
example : "EB154DF85A3F4309A774EB500E4EBDAD"
payPalBillingAgreementId:
@@ -2321,7 +2307,7 @@ components:
description: The backend transaction id.
example: SC_AUTH0_SCP_V4_TEST
transId:
- type: string
+ type: string
description: An identifier unique to the request.
example: 0a1b9c2d8e3f7g4h6i5
transactionSrc:
@@ -2362,49 +2348,43 @@ components:
response:
type: object
required: [transactionId, statusCode, errors]
- properties:
+ properties:
transactionId:
- description: |-
- A unique value that will be used to identify the transaction for logging and troubleshooting purposes.
+ description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes.
maxLength: 14
minLength: 1
example: ASR1212
type: string
statusCode:
- description: |-
- API response status code, Internal code regarding the success or failure of the operation
+ description: API response status code, Internal code regarding the success or failure of the operation
maxLength: 4
minLength: 1
example: "0006"
type: string
subStatusCode:
- description: |-
- A new status code for adding granularity to the existing status code structure
+ description: A new status code for adding granularity to the existing status code structure
type: string
success:
description: Indicates if the transaction is considered successful.
default: false
- type: boolean
+ type: boolean
errors:
type: array
description: |
Will only be returned if the HTTP statusCode isn't '200'(success). A list of one or more validation errors. On the API version
v3 the first element of the errors array contains the statusCode and scoring statusMessage field. This array is unbounded.
- items:
+ items:
type: object
- properties:
+ properties:
code:
- description: |-
- the code of the error
+ description: the code of the error
maxLength: 4
minLength: 1
example: "0006"
type: string
message:
- description: |-
- the message of the error
+ description: the message of the error
maxLength: 120
minLength: 1
example: "Failure to check eligibility through Tracking component"
type: string
-
\ No newline at end of file
diff --git a/GlobalCheckout.yaml b/GlobalCheckout.yaml
index 9a78b4b..fbdcf34 100644
--- a/GlobalCheckout.yaml
+++ b/GlobalCheckout.yaml
@@ -9,15 +9,15 @@ info:
## Key Business Values
- Simplifies the International Cross Border shipping process.
-
+
For more information on the Global Checkout API, please visit the Product Info page.
-
+
Appendix
Explore API documentation and sample applications through GitHub.
-
+
-servers:
+servers:
- url: https://wwwcie.ups.com/api/brokerage/{version}
description: UPS Customer Integration Environment
variables:
@@ -32,10 +32,10 @@ servers:
default: v1
enum:
- v1
-tags:
+tags:
- name: Global Checkout
description: Operations related to guaranteed rate quotes
-security:
+security:
- OAuth2: []
paths:
/content/glc/request-quote:
@@ -44,10 +44,10 @@ paths:
summary: returns a guaranteed landed cost quote
description: This endpoint requests guaranteed quotes for landed cost duties and taxes.
security:
- - OAuth2: []
- tags:
+ - OAuth2: []
+ tags:
- Global Checkout
- parameters:
+ parameters:
- $ref: "#/components/parameters/transId"
- $ref: "#/components/parameters/transactionSrc"
- $ref: "#/components/parameters/Accept"
@@ -99,7 +99,7 @@ paths:
quantity:
value: 12
unitOfMeasure: pallets
- grossWeight:
+ grossWeight:
value: 1250
unitOfMeasure: kg
unitPrice:
@@ -200,17 +200,17 @@ paths:
field: partNumber
message: PART_NUMBER is not valid
value: ''
-components:
+components:
securitySchemes:
OAuth2:
type: oauth2
- description: |
- "Find your Client ID and Secret on your app info page. Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
version: "1.0"
servers:
@@ -48,7 +48,7 @@ paths:
summary: Initiates an interactive description session for a product.
description: Initiates an interactive description session for a product.
security:
- - OAuth2: []
+ - OAuth2: []
operationId: start_interactive_post
parameters:
- name: transId
@@ -82,13 +82,13 @@ paths:
responses:
"200":
description: Successful Response
- headers:
+ headers:
x-api-success-count:
- description: |-
- UPS monetization header indicating the full completion of the API service.
+ description: |-
+ UPS monetization header indicating the full completion of the API service.
A value of 1 would indicate a completed transaction, while a value of 0 would be the default for uncomplete.
A value of 1 should be present whenever the "noMoreQuestions" field is set to true.
- schema:
+ schema:
type: integer
example: 1
content:
@@ -112,7 +112,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4000:
value:
response:
@@ -172,7 +172,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
UJ0001:
value:
response:
@@ -196,7 +196,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4015:
value:
response:
@@ -220,7 +220,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4022:
value:
response:
@@ -244,7 +244,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E5000:
value:
response:
@@ -257,11 +257,11 @@ paths:
- Interactive Description
summary: Continues refinement of product description and HTS code via questions and answers.
description: |
- This endpoint facilitates the ongoing interactive process for refining a product description and determining its corresponding Harmonized Tariff Schedule (HTS) code.
-
+ This endpoint facilitates the ongoing interactive process for refining a product description and determining its corresponding Harmonized Tariff Schedule (HTS) code.
+
After initiating a session with the initial product description using the /interactive endpoint, users can continue their interaction via this endpoint by providing answers to the questions returned from the previous interaction. Each interaction refines the product description further, helping the system to accurately identify the correct HTS code. The {sessionId} parameter uniquely identifies the user's session and ensures that the interaction is continued seamlessly.
security:
- - OAuth2: []
+ - OAuth2: []
operationId: iterate_interactive__sessionId__post
parameters:
- name: sessionId
@@ -299,13 +299,13 @@ paths:
responses:
"200":
description: Successful Response
- headers:
+ headers:
x-api-success-count:
- description: |-
- UPS monetization header indicating the full completion of the API service.
+ description: |-
+ UPS monetization header indicating the full completion of the API service.
A value of 1 would indicate a completed transaction, while a value of 0 would be the default for uncomplete.
A value of 1 should be present whenever the "noMoreQuestions" field is set to true.
- schema:
+ schema:
type: integer
example: 1
content:
@@ -329,7 +329,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4000:
value:
response:
@@ -371,7 +371,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
UJ0001:
value:
response:
@@ -395,7 +395,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4015:
value:
response:
@@ -419,7 +419,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4022:
value:
response:
@@ -443,7 +443,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E5000:
value:
response:
@@ -459,7 +459,7 @@ paths:
description: Allows the user to provide feedback on a specific question of the
overall session.
security:
- - OAuth2: []
+ - OAuth2: []
operationId: submit_feedback_interactive_feedback__sessionId__post
parameters:
- name: sessionId
@@ -502,7 +502,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4000:
value:
response:
@@ -538,7 +538,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
UJ0001:
value:
response:
@@ -562,7 +562,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4015:
value:
response:
@@ -586,7 +586,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E4022:
value:
response:
@@ -610,7 +610,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/CustomErrorResponse"
- examples:
+ examples:
E5000:
value:
response:
@@ -624,13 +624,13 @@ components:
properties:
id:
type: string
- description: |-
+ description: |-
The "id" field in the response structure represents the unique identifier of the question that was answered.
This identifier helps track which specific question the user's response corresponds to, ensuring the accuracy and continuity of the interactive session. It is used to maintain the sequence of interactions and to provide context for subsequent questions and answers.
selected:
type: integer
description: |-
- The "selected" field represents the index of the chosen option from the multiple-choice answers provided for a specific question.
+ The "selected" field represents the index of the chosen option from the multiple-choice answers provided for a specific question.
This is a 0-based index, meaning the first option is represented by 0, the second by 1, and so on.
This field ensures that the system accurately records the user's choice and continues the interactive session based on the selected answer.
required:
@@ -698,13 +698,13 @@ components:
properties:
id:
type: string
- description: |-
+ description: |-
The "id" field in the response structure represents the unique identifier of the question that was answered.
This identifier helps track which specific question the user's response corresponds to, ensuring the accuracy and continuity of the interactive session. It is used to maintain the sequence of interactions and to provide context for subsequent questions and answers.
selected:
type: integer
description: |-
- The "selected" field represents the index of the chosen option from the multiple-choice answers provided for a specific question.
+ The "selected" field represents the index of the chosen option from the multiple-choice answers provided for a specific question.
This is a 0-based index, meaning the first option is represented by 0, the second by 1, and so on.
This field ensures that the system accurately records the user's choice and continues the interactive session based on the selected answer.
assumed:
@@ -787,8 +787,8 @@ components:
example: ["For decorative purposes", "For storing or drinking water"]
other:
type: array
- description: |-
- An extended list of "options". When a large list of potential options are generated by the API, uncommon options will be categorized into the "other" field.
+ description: |-
+ An extended list of "options". When a large list of potential options are generated by the API, uncommon options will be categorized into the "other" field.
For all intensive purposes, selecting an option from the other list should be treated as an indexable list as a continuation of options. For example, if "options" is a list of 5 items, selecting the first value from "other" would be index 5.
items:
type: string
@@ -796,7 +796,7 @@ components:
selected:
type: integer
description: |-
- The "selected" field represents the index of the chosen option from the multiple-choice answers provided for a specific question.
+ The "selected" field represents the index of the chosen option from the multiple-choice answers provided for a specific question.
This is a 0-based index, meaning the first option is represented by 0, the second by 1, and so on.
This field ensures that the system accurately records the user's choice and continues the interactive session based on the selected answer.
assumed:
@@ -880,15 +880,15 @@ 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"
+ 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: {}
\ No newline at end of file
+ scopes: {}
diff --git a/LandedCost.yaml b/LandedCost.yaml
index 80d3f94..91392f6 100644
--- a/LandedCost.yaml
+++ b/LandedCost.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.3
info:
title: Landed Cost Quote API
description: |
-
+
The Landed Cost Quote API allows you to estimate the all-inclusive cost of international shipments - including applicable duties, VAT, taxes, brokerage fees, and other fees. Required parameters include the currency and shipment details, such as the commodity ID, price, quantity, and country code of origin.
Key Business Values:
@@ -15,13 +15,13 @@ info:
- Business Rules
- Appendix
- Errors
-
+
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
version: ''
servers:
@@ -79,7 +79,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LandedCostRequest"
+ $ref: "#/components/schemas/LandedCostRequest"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -124,7 +124,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LandedCostResponse"
+ $ref: "#/components/schemas/LandedCostResponse"
examples:
json:
summary: A sample JSON response
@@ -175,25 +175,25 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -246,7 +246,7 @@ components:
This must match the major number of the corresponding ICD version.
example: 1, 2, 3
shipment:
- "$ref": "#/components/schemas/LandedCostRequest_Shipment"
+ $ref: "#/components/schemas/LandedCostRequest_Shipment"
xml:
name: LandedCostRequest
maximum: 1
@@ -340,7 +340,7 @@ components:
type: array
maximum: 99
items:
- "$ref": "#/components/schemas/Request_ShipmentItems"
+ $ref: "#/components/schemas/Request_ShipmentItems"
description: Array of shipment item objects (commodities), that are in a
shipment.
Request_ShipmentItems:
@@ -469,7 +469,7 @@ components:
type: array
maximum: 1
items:
- "$ref": "#/components/schemas/brokerageFeeItems"
+ $ref: "#/components/schemas/brokerageFeeItems"
description: An array of Brokerage fees.
totalBrokerageFees:
type: number
@@ -504,7 +504,7 @@ components:
shipmentItems:
type: array
items:
- "$ref": "#/components/schemas/Response_ShipmentItems"
+ $ref: "#/components/schemas/Response_ShipmentItems"
maximum: 99
description: An array of Landed Cost for all valid commodities.
transID:
@@ -542,7 +542,7 @@ components:
description: Version number of the instance that processed this request.
Default is 1.
errors:
- "$ref": "#/components/schemas/Errors"
+ $ref: "#/components/schemas/Errors"
xml:
name: LandedCostResponse
maximum: 1
@@ -641,7 +641,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -650,7 +650,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/Locator.yaml b/Locator.yaml
index 0180166..4ef88bb 100644
--- a/Locator.yaml
+++ b/Locator.yaml
@@ -3,7 +3,7 @@ info:
title: Locator
version: ''
description: |
-
+
The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
# Reference
- Business Rules
@@ -11,11 +11,11 @@ info:
- Errors
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -66,9 +66,9 @@ paths:
Locations and Will call locations)\n8-All available Additional Services\n16-All
available Program Types\n24-All available Additional Services and Program
types\n32-All available Retail Locations\n40-All available Retail Locations
- and Additional Services \n48-All available Retail Locations and Program
- Types \n56-All available Retail Locations, Additional Services and Program
- Types \n64-Search for UPS Access Point Locations. "
+ and Additional Services\n48-All available Retail Locations and Program
+ Types\n56-All available Retail Locations, Additional Services and Program
+ Types\n64-Search for UPS Access Point Locations."
required: true
- in: query
name: Locale
@@ -85,7 +85,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LOCATORRequestWrapper"
+ $ref: "#/components/schemas/LOCATORRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -138,31 +138,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LOCATORResponseWrapper"
+ $ref: "#/components/schemas/LOCATORResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/locations/{deprecatedVersion}/search/availabilities/{reqOption}":
post:
deprecated: true
@@ -207,9 +207,9 @@ paths:
Locations and Will call locations)\n8-All available Additional Services\n16-All
available Program Types\n24-All available Additional Services and Program
types\n32-All available Retail Locations\n40-All available Retail Locations
- and Additional Services \n48-All available Retail Locations and Program
- Types \n56-All available Retail Locations, Additional Services and Program
- Types \n64-Search for UPS Access Point Locations. "
+ and Additional Services\n48-All available Retail Locations and Program
+ Types\n56-All available Retail Locations, Additional Services and Program
+ Types\n64-Search for UPS Access Point Locations. "
required: true
- in: query
name: Locale
@@ -226,7 +226,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LOCATORRequestWrapper"
+ $ref: "#/components/schemas/LOCATORRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -279,31 +279,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LOCATORResponseWrapper"
+ $ref: "#/components/schemas/LOCATORResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -331,7 +331,7 @@ components:
- LocatorRequest
properties:
LocatorRequest:
- "$ref": "#/components/schemas/LocatorRequest"
+ $ref: "#/components/schemas/LocatorRequest"
LOCATORResponseWrapper:
xml:
name: LocatorResponse
@@ -342,7 +342,7 @@ components:
- LocatorResponse
properties:
LocatorResponse:
- "$ref": "#/components/schemas/LocatorResponse"
+ $ref: "#/components/schemas/LocatorResponse"
LocatorRequest:
type: object
required:
@@ -351,13 +351,13 @@ components:
- Translate
properties:
Request:
- "$ref": "#/components/schemas/LocatorRequest_Request"
+ $ref: "#/components/schemas/LocatorRequest_Request"
OriginAddress:
- "$ref": "#/components/schemas/LocatorRequest_OriginAddress"
+ $ref: "#/components/schemas/LocatorRequest_OriginAddress"
Translate:
- "$ref": "#/components/schemas/LocatorRequest_Translate"
+ $ref: "#/components/schemas/LocatorRequest_Translate"
UnitOfMeasurement:
- "$ref": "#/components/schemas/LocatorRequest_UnitOfMeasurement"
+ $ref: "#/components/schemas/LocatorRequest_UnitOfMeasurement"
LocationID:
description: Location ID is the identification number of the UPS affiliated
location.
@@ -367,23 +367,23 @@ components:
minLength: 1
maxLength: 10
LocationSearchCriteria:
- "$ref": "#/components/schemas/LocatorRequest_LocationSearchCriteria"
+ $ref: "#/components/schemas/LocatorRequest_LocationSearchCriteria"
SortCriteria:
- "$ref": "#/components/schemas/LocatorRequest_SortCriteria"
+ $ref: "#/components/schemas/LocatorRequest_SortCriteria"
AllowAllConfidenceLevels:
description: Indicator to allow confidence level in search.
type: string
maximum: 1
SearchOptionCode:
- description: "Valid values: \n01-Proximity Search Details\n02-Address Search
+ description: "Valid values:\n01-Proximity Search Details\n02-Address Search
Details\n03-Proximity Search Summary\n04-Address Search Summary\n05-Freight
- Will Call Search. \nEither OptionType 03 or 04 is required."
+ Will Call Search.\nEither OptionType 03 or 04 is required."
maximum: 1
type: string
minLength: 2
maxLength: 2
ServiceGeoUnit:
- "$ref": "#/components/schemas/LocatorRequest_ServiceGeoUnit"
+ $ref: "#/components/schemas/LocatorRequest_ServiceGeoUnit"
FreightIndicator:
description: FreightIndicator. Required for Freight Location Search.
type: string
@@ -396,9 +396,9 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
RequestAction:
- description: "Indicates the action to be taken by the XML service. \nThe
+ description: "Indicates the action to be taken by the XML service.\nThe
only valid value is 'Locator'."
maximum: 1
type: string
@@ -429,13 +429,13 @@ components:
type: object
properties:
Geocode:
- "$ref": "#/components/schemas/OriginAddress_Geocode"
+ $ref: "#/components/schemas/OriginAddress_Geocode"
AddressKeyFormat:
- "$ref": "#/components/schemas/OriginAddress_AddressKeyFormat"
+ $ref: "#/components/schemas/OriginAddress_AddressKeyFormat"
MaximumListSize:
description: "If present, indicates the maximum number of locations the
client wishes to receive in an address candidate response where the provided
- origin information is insufficient to accurately establish location. \n\nValid
+ origin information is insufficient to accurately establish location.\n\nValid
values: 1-50, default 10"
maximum: 1
type: string
@@ -554,7 +554,7 @@ components:
- CountryCode
description: "Contains all of the basic information about the origin such as:
Address Lines, City, State/Province, Postal Code and Country or Territory
- Code. \nThe element CountryCode is required."
+ Code.\nThe element CountryCode is required."
LocatorRequest_Translate:
type: object
maximum: 1
@@ -563,7 +563,7 @@ components:
description: "Locale is the 5 digit combination of 2 character language
code and 2 character country or territory code separated by an underscore
('_') character. Will be used to determine what language the response
- will be sent in. \nDefault value is: en_US. \nExamples are: fr_CA, es_MX."
+ will be sent in.\nDefault value is: en_US.\nExamples are: fr_CA, es_MX."
maximum: 1
type: string
minLength: 5
@@ -594,7 +594,7 @@ components:
SearchOption:
type: array
items:
- "$ref": "#/components/schemas/LocationSearchCriteria_SearchOption"
+ $ref: "#/components/schemas/LocationSearchCriteria_SearchOption"
MaximumListSize:
description: If present, indicates the maximum number of locations the client
wishes to receive in response; ranges from 1 to 50 with a default value
@@ -606,20 +606,20 @@ components:
SearchRadius:
description: "Defines the maximum radius the user wishes to search for a
UPS location. If the user does not specify, the default value is 100 miles.
- Whole numbers only. \n\nValid values are:\n5-100 for UnitOfMeasure MI\n5-150
+ Whole numbers only.\n\nValid values are:\n5-100 for UnitOfMeasure MI\n5-150
for UnitOfMesaure KM"
maximum: 1
type: string
minLength: 1
maxLength: 3
ServiceSearch:
- "$ref": "#/components/schemas/LocationSearchCriteria_ServiceSearch"
+ $ref: "#/components/schemas/LocationSearchCriteria_ServiceSearch"
FreightWillCallSearch:
- "$ref": "#/components/schemas/LocationSearchCriteria_FreightWillCallSearch"
+ $ref: "#/components/schemas/LocationSearchCriteria_FreightWillCallSearch"
AccessPointSearch:
- "$ref": "#/components/schemas/LocationSearchCriteria_AccessPointSearch"
+ $ref: "#/components/schemas/LocationSearchCriteria_AccessPointSearch"
OpenTimeCriteria:
- "$ref": "#/components/schemas/LocationSearchCriteria_OpenTimeCriteria"
+ $ref: "#/components/schemas/LocationSearchCriteria_OpenTimeCriteria"
BrexitFilter:
description: Brexit Filter. Applicable for country code GB; Pass the PostalCode
for the address in the location search if Brexit functionality is desired.
@@ -634,7 +634,7 @@ components:
name: LocationSearchCriteria
maximum: 1
description: "The Location search criteria container allows the user to further
- define the basis to which they wish to receive the UPS locations. \nOnly relevant
+ define the basis to which they wish to receive the UPS locations.\nOnly relevant
when the user requests a Location search (request option 1)."
LocationSearchCriteria_SearchOption:
type: object
@@ -643,13 +643,13 @@ components:
- OptionType
properties:
OptionType:
- "$ref": "#/components/schemas/SearchOption_OptionType"
+ $ref: "#/components/schemas/SearchOption_OptionType"
OptionCode:
type: array
items:
- "$ref": "#/components/schemas/SearchOption_OptionCode"
+ $ref: "#/components/schemas/SearchOption_OptionCode"
Relation:
- "$ref": "#/components/schemas/SearchOption_Relation"
+ $ref: "#/components/schemas/SearchOption_Relation"
xml:
name: SearchOption
description: |
@@ -682,7 +682,7 @@ components:
name: OptionType
description: "OptionType is a container that indicates the type of search for
locations. There are 5 types of search. They are search by: Location, Retail
- Location, Additional Services, Program Type, and a Service Level Option. \nIf
+ Location, Additional Services, Program Type, and a Service Level Option.\nIf
search criteria by Location or Retail Location is not provided the default
search of The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping
Outlet location types will be performed."
@@ -705,7 +705,7 @@ components:
name: OptionCode
description: "Option code contains the information of a particular Location,
Retail Location, Additional Service, Program Type or End Point Service Offering
- depending on the option type. \nThe SearchOptions can contain one or more
+ depending on the option type.\nThe SearchOptions can contain one or more
OptionCodes which forms the criteria for the location search."
SearchOption_Relation:
type: object
@@ -728,7 +728,7 @@ components:
xml:
name: Relation
description: "The relation container will contain the relation parameter (And/Or)
- that has to be used among multiple option codes in the location search. \n\nThis
+ that has to be used among multiple option codes in the location search.\n\nThis
is only applicable to option type Additional Services and Program Types. If
this container is not present for Additional Services and Program Types, the
default relation of And is used."
@@ -745,11 +745,11 @@ components:
ServiceCode:
type: array
items:
- "$ref": "#/components/schemas/ServiceSearch_ServiceCode"
+ $ref: "#/components/schemas/ServiceSearch_ServiceCode"
ServiceOptionCode:
type: array
items:
- "$ref": "#/components/schemas/ServiceSearch_ServiceOptionCode"
+ $ref: "#/components/schemas/ServiceSearch_ServiceOptionCode"
xml:
name: ServiceSearch
description: Allows for users to further define the search criteria. Refer to
@@ -809,7 +809,7 @@ components:
- FacilityAddress
properties:
FreightWillCallRequestType:
- description: "Valid values are: \n1 - Postal Code\n2 - Delivery SLIC\n3
+ description: "Valid values are:\n1 - Postal Code\n2 - Delivery SLIC\n3
- Delivery City/State.\n1: Freight Will Call Search based on Postal Code,
this search is valid for Postal code countries. 2: Freight Will Call Search
based on SLIC. 3: Freight Will Call Search based on City and/or State.
@@ -821,7 +821,7 @@ components:
FacilityAddress:
type: array
items:
- "$ref": "#/components/schemas/FreightWillCallSearch_FacilityAddress"
+ $ref: "#/components/schemas/FreightWillCallSearch_FacilityAddress"
OriginOrDestination:
description: |-
OriginOrDestination is required for FreightWillCallRequestType 1 and type 3 . Valid values:
@@ -843,8 +843,8 @@ components:
minLength: 2
maxLength: 3
DayOfWeekCode:
- description: "Day Of week Code. Valid Values are 1 to 7. \n1-Sunday\n2-Monday
- \n3-Tuesday \n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
+ description: "Day Of week Code. Valid Values are 1 to 7.\n1-Sunday\n2-Monday
+ \n3-Tuesday\n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
maximum: 1
type: string
minLength: 1
@@ -923,7 +923,7 @@ components:
minLength: 1
maxLength: 15
AccessPointStatus:
- description: "Status of UPS Access Point. Valid values are: \n01-Active-available\n07-Active-unavailable."
+ description: "Status of UPS Access Point. Valid values are:\n01-Active-available\n07-Active-unavailable."
maximum: 1
type: string
minLength: 2
@@ -938,9 +938,9 @@ components:
minLength: 6
maxLength: 10
IncludeCriteria:
- "$ref": "#/components/schemas/AccessPointSearch_IncludeCriteria"
+ $ref: "#/components/schemas/AccessPointSearch_IncludeCriteria"
ExcludeFromResult:
- "$ref": "#/components/schemas/AccessPointSearch_ExcludeFromResult"
+ $ref: "#/components/schemas/AccessPointSearch_ExcludeFromResult"
ExactMatchIndicator:
description: Presence of this tag represents that "AccessPointSearchByAddress"
service is requested. The value of this tag is ignored.
@@ -960,11 +960,11 @@ components:
type: object
properties:
MerchantAccountNumberList:
- "$ref": "#/components/schemas/IncludeCriteria_MerchantAccountNumberList"
+ $ref: "#/components/schemas/IncludeCriteria_MerchantAccountNumberList"
SearchFilter:
- "$ref": "#/components/schemas/IncludeCriteria_SearchFilter"
+ $ref: "#/components/schemas/IncludeCriteria_SearchFilter"
ServiceOfferingList:
- "$ref": "#/components/schemas/IncludeCriteria_ServiceOfferingList"
+ $ref: "#/components/schemas/IncludeCriteria_ServiceOfferingList"
xml:
name: IncludeCriteria
description: This contains elements to refine (include) UPS Access point address
@@ -1030,7 +1030,7 @@ components:
ServiceOffering:
type: array
items:
- "$ref": "#/components/schemas/ServiceOfferingList_ServiceOffering"
+ $ref: "#/components/schemas/ServiceOfferingList_ServiceOffering"
xml:
name: ServiceOfferingList
description: Container to hold end point service offering List for UPS Access
@@ -1045,10 +1045,10 @@ components:
- Code
properties:
Code:
- description: "The valid values are: \n001-Direct To Retail\n002-Not In One
+ description: "The valid values are:\n001-Direct To Retail\n002-Not In One
ADL\n003-Click and Collect\n004-Retail to Retail\n005-Pickup\n006-Drop
Off\n007-PUDO\n008-Early Pickup Delivery Time\n009-Accept prepaid drop
- offs\n010-DCO DCR intercept accepted \n011-Accepts Payments \n012-Pay
+ offs\n010-DCO DCR intercept accepted\n011-Accepts Payments\n012-Pay
At Store\n013-Accepts Restricted Articles"
maximum: 1
type: string
@@ -1094,7 +1094,7 @@ components:
minLength: 1
maxLength: 3
PostalCodeList:
- "$ref": "#/components/schemas/ExcludeFromResult_PostalCodeList"
+ $ref: "#/components/schemas/ExcludeFromResult_PostalCodeList"
xml:
name: ExcludeFromResult
description: This contains elements to exclude from UPS Access Point address
@@ -1107,7 +1107,7 @@ components:
PostalCode:
type: array
items:
- "$ref": "#/components/schemas/PostalCodeList_PostalCode"
+ $ref: "#/components/schemas/PostalCodeList_PostalCode"
xml:
name: PostalCodeList
description: Container to hold a list of postal codes to exclude from the access
@@ -1221,11 +1221,11 @@ components:
- SearchResults
properties:
Response:
- "$ref": "#/components/schemas/LocatorResponse_Response"
+ $ref: "#/components/schemas/LocatorResponse_Response"
Geocode:
- "$ref": "#/components/schemas/LocatorResponse_Geocode"
+ $ref: "#/components/schemas/LocatorResponse_Geocode"
SearchResults:
- "$ref": "#/components/schemas/LocatorResponse_SearchResults"
+ $ref: "#/components/schemas/LocatorResponse_SearchResults"
AllowAllConfidenceLevels:
description: |-
Confidence level.
@@ -1242,9 +1242,9 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
ResponseStatusCode:
- description: "Identifies the success or failure of the interchange. \n1-Success\n0-Failure"
+ description: "Identifies the success or failure of the interchange.\n1-Success\n0-Failure"
maximum: 1
type: string
minLength: 1
@@ -1256,7 +1256,7 @@ components:
minLength: 1
maxLength: 15
Error:
- "$ref": "#/components/schemas/Response_Error"
+ $ref: "#/components/schemas/Response_Error"
xml:
name: Response
maximum: 1
@@ -1273,7 +1273,7 @@ components:
type: string
maxLength: 512
XpciVersion:
- description: "Identifies the version of the message. \nCurrent version is
+ description: "Identifies the version of the message.\nCurrent version is
1.0014"
maximum: 1
type: string
@@ -1290,7 +1290,7 @@ components:
- ErrorCode
properties:
ErrorSeverity:
- description: "Describes the severity of the error. \nFor additional information,
+ description: "Describes the severity of the error.\nFor additional information,
refer to Locator Error Codes in the Appendix."
maximum: 1
type: string
@@ -1298,7 +1298,7 @@ components:
maxLength: 15
ErrorCode:
description: "A numeric value that describes the error. Each tool defines
- a range of error codes. \nFor additional information, refer to Locator
+ a range of error codes.\nFor additional information, refer to Locator
Error Codes in the Appendix."
maximum: 1
type: string
@@ -1311,7 +1311,7 @@ components:
minLength: 1
maxLength: 50
MinimumRetrySeconds:
- description: "Number of seconds to wait until retry. \n\nThis field is populated
+ description: "Number of seconds to wait until retry.\n\nThis field is populated
on special conditions of the Transient Error only, as defined by the service.\n\nA
number between 1 and 86400 (24 hours)"
maximum: 1
@@ -1325,7 +1325,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/Error_ErrorLocation"
+ $ref: "#/components/schemas/Error_ErrorLocation"
ErrorDigest:
description: |
The contents of the element in error.
@@ -1388,13 +1388,13 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/SearchResults_GeocodeCandidate"
+ $ref: "#/components/schemas/SearchResults_GeocodeCandidate"
Disclaimer:
type: string
description: "Disclaimer. In the event the user requested Ground and Air
service types and the maximum UPS locations list size has not been met,
the list of locations will continue with locations that provide either
- ground or air within the search radius. \n\nThe disclaimer will note this
+ ground or air within the search radius.\n\nThe disclaimer will note this
deviation from the requested search criteria. The disclaimer is also the
location where the user will receive information regarding a one-time
pickup option if the first location is greater than 20 miles from the
@@ -1406,7 +1406,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SearchResults_DropLocation"
+ $ref: "#/components/schemas/SearchResults_DropLocation"
AvailableLocationAttributes:
description: |
This container contains the information about the currently existing Retail Locations or Additional Services or Program types.
@@ -1414,10 +1414,10 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SearchResults_AvailableLocationAttributes"
+ $ref: "#/components/schemas/SearchResults_AvailableLocationAttributes"
ActiveAvailableAccessPointIndicator:
description: "Indicates whether the country or territory has AccessPoints
- or not. \n\nThis tag is populated in the Response only if tag \"ExistIndicator\"
+ or not.\n\nThis tag is populated in the Response only if tag \"ExistIndicator\"
was present in the Locator request."
type: string
maximum: 1
@@ -1432,9 +1432,9 @@ components:
- AddressKeyFormat
properties:
AddressKeyFormat:
- "$ref": "#/components/schemas/GeocodeCandidate_AddressKeyFormat"
+ $ref: "#/components/schemas/GeocodeCandidate_AddressKeyFormat"
Geocode:
- "$ref": "#/components/schemas/GeocodeCandidate_Geocode"
+ $ref: "#/components/schemas/GeocodeCandidate_Geocode"
LandmarkName:
description: If a Landmark code was provided in the request, a candidate
list of Landmark Names will be returned along with the corresponding address
@@ -1521,18 +1521,18 @@ components:
maxLength: 10
OriginOrDestination:
description: "OriginOrDestination will returned for FreightWillCallRequestType
- 1 Postal based and 3 City and/or State based search. \n\nOriginOrDestination
+ 1 Postal based and 3 City and/or State based search.\n\nOriginOrDestination
will be 01 for origin facilities and 02 for Destination facilities"
maximum: 1
type: string
minLength: 2
maxLength: 2
IVR:
- "$ref": "#/components/schemas/DropLocation_IVR"
+ $ref: "#/components/schemas/DropLocation_IVR"
Geocode:
- "$ref": "#/components/schemas/DropLocation_Geocode"
+ $ref: "#/components/schemas/DropLocation_Geocode"
AddressKeyFormat:
- "$ref": "#/components/schemas/DropLocation_AddressKeyFormat"
+ $ref: "#/components/schemas/DropLocation_AddressKeyFormat"
PhoneNumber:
description: |
The UPS locations Phone number. A phone number of the location will be returned.
@@ -1549,7 +1549,7 @@ components:
maxLength: 15
FaxNumber:
description: "The UPS location's Fax number. A fax number of the location
- will be returned when available. \n10 digits allowed for US, otherwise
+ will be returned when available.\n10 digits allowed for US, otherwise
1..15 digits allowed.\nThe fax number will be returned as string."
maximum: 1
type: string
@@ -1572,9 +1572,9 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/DropLocation_LocationAttribute"
+ $ref: "#/components/schemas/DropLocation_LocationAttribute"
Distance:
- "$ref": "#/components/schemas/DropLocation_Distance"
+ $ref: "#/components/schemas/DropLocation_Distance"
SpecialInstructions:
description: |
Walking directions.
@@ -1582,7 +1582,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/DropLocation_SpecialInstructions"
+ $ref: "#/components/schemas/DropLocation_SpecialInstructions"
LatestGroundDropOffTime:
description: |
The latest ground time the users can Drop-off the package at the location to be picked up. The time information is based on the time at the UPS location.
@@ -1651,7 +1651,7 @@ components:
minLength: 1
maxLength: 255
AdditionalComments:
- "$ref": "#/components/schemas/DropLocation_AdditionalComments"
+ $ref: "#/components/schemas/DropLocation_AdditionalComments"
Disclaimer:
description: |
Textual disclaimer about the drop location.
@@ -1679,7 +1679,7 @@ components:
minLength: 3
maxLength: 3
OperatingHours:
- "$ref": "#/components/schemas/DropLocation_OperatingHours"
+ $ref: "#/components/schemas/DropLocation_OperatingHours"
LocalizedInstruction:
description: |
LocalizedInstruction container. Applicable for SearchOptionCode 01, 02, 03.
@@ -1687,7 +1687,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/DropLocation_LocalizedInstruction"
+ $ref: "#/components/schemas/DropLocation_LocalizedInstruction"
PromotionInformation:
description: |
Container to hold any promotion text for the location. Text will be displayed in English or the locale given in the request.
@@ -1695,14 +1695,14 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/DropLocation_PromotionInformation"
+ $ref: "#/components/schemas/DropLocation_PromotionInformation"
SortCode:
- "$ref": "#/components/schemas/DropLocation_SortCode"
+ $ref: "#/components/schemas/DropLocation_SortCode"
ServiceOfferingList:
- "$ref": "#/components/schemas/DropLocation_ServiceOfferingList"
+ $ref: "#/components/schemas/DropLocation_ServiceOfferingList"
DisplayPhoneNumberIndicator:
- description: "Valid Values: \n0-Do not display phone number\n1-Display phone
- number. \nThis indicator will be returned only for the contact type Telephone
+ description: "Valid Values:\n0-Do not display phone number\n1-Display phone
+ number.\nThis indicator will be returned only for the contact type Telephone
number. This indicator is used by the clients to determine whether to
display the telephone number to the end user."
maximum: 1
@@ -1710,9 +1710,9 @@ components:
minLength: 1
maxLength: 1
AccessPointInformation:
- "$ref": "#/components/schemas/DropLocation_AccessPointInformation"
+ $ref: "#/components/schemas/DropLocation_AccessPointInformation"
LocationImage:
- "$ref": "#/components/schemas/DropLocation_LocationImage"
+ $ref: "#/components/schemas/DropLocation_LocationImage"
LocationNewIndicator:
description: Indicator for new location.
type: string
@@ -1757,12 +1757,12 @@ components:
maxLength: 30
TextToSpeechIndicator:
description: "Indicates to the response recipient that the information has
- changed, and a new audio file should be produced. \nONLY FOR IVR."
+ changed, and a new audio file should be produced.\nONLY FOR IVR."
type: string
maximum: 1
xml:
name: IVR
- description: "Integrated Voice Response information. \nONLY FOR IVR."
+ description: "Integrated Voice Response information.\nONLY FOR IVR."
DropLocation_Geocode:
type: object
maximum: 1
@@ -1833,19 +1833,19 @@ components:
- OptionType
properties:
OptionType:
- "$ref": "#/components/schemas/LocationAttribute_OptionType"
+ $ref: "#/components/schemas/LocationAttribute_OptionType"
OptionCode:
- description: |
- Option code is a container that contains the information of a particular type of Location or retail location or additional service or program type that the drop location contains.
+ description: |-
+ Option code is a container that contains the information of a particular type of Location or retail location or additional service or program type that the drop location contains.
- If the OptionType is Location or Retail Location Type there will be one code since each location has only one location type or retail location type.
+ If the OptionType is Location or Retail Location Type there will be one code since each location has only one location type or retail location type.
- If the Option type is additional services or program types there can be one or more option codes.
+ If the Option type is additional services or program types there can be one or more option codes.
- **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/LocationAttribute_OptionCode"
+ **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/LocationAttribute_OptionCode"
xml:
name: LocationAttribute
description: LocationAttribute is a container that contains the information
@@ -1903,7 +1903,7 @@ components:
minLength: 1
maxLength: 50
TransportationPickUpSchedule:
- "$ref": "#/components/schemas/OptionCode_TransportationPickUpSchedule"
+ $ref: "#/components/schemas/OptionCode_TransportationPickUpSchedule"
xml:
name: OptionCode
maximum: 1
@@ -1922,7 +1922,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/TransportationPickUpSchedule_PickUp"
+ $ref: "#/components/schemas/TransportationPickUpSchedule_PickUp"
xml:
name: TransportationPickUpSchedule
description: TransportationPickUpSchedule container contains details of Latest Drop Off time/Pickup Time for the transportation services (Ground/Air/Standard/Express/International) of the location.
@@ -1947,7 +1947,7 @@ components:
minLength: 1
maxLength: 1
PickUpDetails:
- "$ref": "#/components/schemas/PickUp_PickUpDetails"
+ $ref: "#/components/schemas/PickUp_PickUpDetails"
xml:
name: PickUp
PickUp_PickUpDetails:
@@ -1982,7 +1982,7 @@ components:
minLength: 1
maxLength: 4
UnitOfMeasurement:
- "$ref": "#/components/schemas/Distance_UnitOfMeasurement"
+ $ref: "#/components/schemas/Distance_UnitOfMeasurement"
xml:
name: Distance
description: Container for the straight line distance from the origin to the
@@ -1995,7 +1995,7 @@ components:
properties:
Code:
description: "The distance unit of measurement code. The unit of measurement
- used in the search request is returned. \n\nValid values: MI-Miles or
+ used in the search request is returned.\n\nValid values: MI-Miles or
KM-Kilometers"
type: string
Description:
@@ -2016,7 +2016,7 @@ components:
- Segment
properties:
Segment:
- description: Walking directions, last 50 feet.
+ description: Walking directions, last 50 feet.
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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:
@@ -2035,7 +2035,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/AdditionalComments_CommentType"
+ $ref: "#/components/schemas/AdditionalComments_CommentType"
xml:
name: AdditionalComments
description: Container for Additional Comments about Location.Text will be displayed
@@ -2072,7 +2072,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/OperatingHours_StandardHours"
+ $ref: "#/components/schemas/OperatingHours_StandardHours"
xml:
name: OperatingHours
description: Operating Hours.
@@ -2085,9 +2085,9 @@ components:
- HoursType
properties:
HoursType:
- description: "Hours Type. \n\nValid values: \n10-Regular Operating Hours
+ description: "Hours Type.\n\nValid values:\n10-Regular Operating Hours
\n11-Will Call Hours\n12-Same Day Will Call Hours\n14-Customer PickUp\n50-Drop
- Off Hours \n51-Prep Hours"
+ Off Hours\n51-Prep Hours"
maximum: 1
type: string
minLength: 2
@@ -2099,7 +2099,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/StandardHours_DayOfWeek"
+ $ref: "#/components/schemas/StandardHours_DayOfWeek"
xml:
name: StandardHours
StandardHours_DayOfWeek:
@@ -2109,7 +2109,7 @@ components:
- Day
properties:
Day:
- description: "Day of week. \nValid values: \n1-Sunday\n2-Monday\n3-Tuesday\n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
+ description: "Day of week.\nValid values:\n1-Sunday\n2-Monday\n3-Tuesday\n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
maximum: 1
type: string
minLength: 1
@@ -2236,7 +2236,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/ServiceOfferingList_ServiceOffering"
+ $ref: "#/components/schemas/ServiceOfferingList_ServiceOffering"
xml:
name: ServiceOfferingList
description: Container to hold the list of service offerings at the end point.
@@ -2258,9 +2258,9 @@ components:
minLength: 1
maxLength: 255
BusinessClassificationList:
- "$ref": "#/components/schemas/AccessPointInformation_BusinessClassificationList"
+ $ref: "#/components/schemas/AccessPointInformation_BusinessClassificationList"
AccessPointStatus:
- "$ref": "#/components/schemas/AccessPointInformation_AccessPointStatus"
+ $ref: "#/components/schemas/AccessPointInformation_AccessPointStatus"
FacilitySLIC:
description: Holds the value of facility SLIC of Access Point Location.
Not implemented currently. For future use.
@@ -2269,9 +2269,9 @@ components:
minLength: 1
maxLength: 10
PrivateNetworkList:
- "$ref": "#/components/schemas/AccessPointInformation_PrivateNetworkList"
+ $ref: "#/components/schemas/AccessPointInformation_PrivateNetworkList"
Availability:
- "$ref": "#/components/schemas/AccessPointInformation_Availability"
+ $ref: "#/components/schemas/AccessPointInformation_Availability"
xml:
name: AccessPointInformation
description: Container for UPS Access Point specific parameters.
@@ -2287,7 +2287,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/BusinessClassificationList_BusinessClassification"
+ $ref: "#/components/schemas/BusinessClassificationList_BusinessClassification"
xml:
name: BusinessClassificationList
description: Container to hold list for business classification.
@@ -2321,7 +2321,7 @@ components:
- Code
properties:
Code:
- description: "Valid status values are: \n01-Active-available\n06-Suspended\n07-Active-unavailable\n08-Terminated"
+ description: "Valid status values are:\n01-Active-available\n06-Suspended\n07-Active-unavailable\n08-Terminated"
maximum: 1
type: string
minLength: 2
@@ -2347,7 +2347,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/PrivateNetworkList_PrivateNetwork"
+ $ref: "#/components/schemas/PrivateNetworkList_PrivateNetwork"
xml:
name: PrivateNetworkList
description: Container to hold the list of private networks.
@@ -2377,9 +2377,9 @@ components:
type: object
properties:
ShippingAvailability:
- "$ref": "#/components/schemas/Availability_ShippingAvailability"
+ $ref: "#/components/schemas/Availability_ShippingAvailability"
DCRAvailability:
- "$ref": "#/components/schemas/Availability_DCRAvailability"
+ $ref: "#/components/schemas/Availability_DCRAvailability"
xml:
name: Availability
description: Container to hold the status of shipping or DRC/DCO availability
@@ -2395,7 +2395,7 @@ components:
type: string
maximum: 1
UnavailableReason:
- "$ref": "#/components/schemas/ShippingAvailability_UnavailableReason"
+ $ref: "#/components/schemas/ShippingAvailability_UnavailableReason"
xml:
name: ShippingAvailability
description: Holds status of shipping availability.
@@ -2438,7 +2438,7 @@ components:
type: string
maximum: 1
UnavailableReason:
- "$ref": "#/components/schemas/DCRAvailability_UnavailableReason"
+ $ref: "#/components/schemas/DCRAvailability_UnavailableReason"
xml:
name: DCRAvailability
description: Holds status of DCR/DCO availability.
@@ -2450,8 +2450,8 @@ components:
- Code
properties:
Code:
- description: "Code for DCR/DCO unavailability. Valid values: \n01-Temporarily
- Unavailable \n02-Location Full\n03-Unavailable\n04-Weather"
+ description: "Code for DCR/DCO unavailability. Valid values:\n01-Temporarily
+ Unavailable\n02-Location Full\n03-Unavailable\n04-Weather"
type: string
Description:
description: Description for DCR/ DCO unavailability.
@@ -2481,9 +2481,9 @@ components:
- OptionType
properties:
OptionType:
- "$ref": "#/components/schemas/AvailableLocationAttributes_OptionType"
+ $ref: "#/components/schemas/AvailableLocationAttributes_OptionType"
OptionCode:
- "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCode"
+ $ref: "#/components/schemas/AvailableLocationAttributes_OptionCode"
xml:
name: AvailableLocationAttributes
AvailableLocationAttributes_OptionType:
@@ -2507,11 +2507,10 @@ components:
the list of all available retail locations will be returned in 1 or many corresponding
OptionCodes.
AvailableLocationAttributes_OptionCode:
- description: |
- **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
+ description: '**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/AvailableLocationAttributes_OptionCodeElement"
+ $ref: "#/components/schemas/AvailableLocationAttributes_OptionCodeElement"
AvailableLocationAttributes_OptionCodeElement:
type: object
maximum: 1
@@ -2540,7 +2539,7 @@ components:
description: N/A
type: string
TransportationPickUpSchedule:
- "$ref": "#/components/schemas/AvailableLocationAttributesOptionCode_TransportationPickUpSchedule"
+ $ref: "#/components/schemas/AvailableLocationAttributesOptionCode_TransportationPickUpSchedule"
xml:
name: OptionCode
description: Option code is a container that contains the information of a particular
@@ -2559,7 +2558,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/AvailableLocationAttributes_TransportationPickUpSchedule_PickUp"
+ $ref: "#/components/schemas/AvailableLocationAttributes_TransportationPickUpSchedule_PickUp"
xml:
name: TransportationPickUpSchedule
description: Container to hold information regarding pickup details for each day of the week.
@@ -2584,7 +2583,7 @@ components:
minLength: 1
maxLength: 1
PickUpDetails:
- "$ref": "#/components/schemas/AvailableLocationAttributes_PickUp_PickUpDetails"
+ $ref: "#/components/schemas/AvailableLocationAttributes_PickUp_PickUpDetails"
xml:
name: PickUp
AvailableLocationAttributes_PickUp_PickUpDetails:
@@ -2611,7 +2610,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -2620,7 +2619,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/OAuthAuthCode.yaml b/OAuthAuthCode.yaml
index 86e8e3c..73ba1e6 100644
--- a/OAuthAuthCode.yaml
+++ b/OAuthAuthCode.yaml
@@ -4,10 +4,10 @@ info:
description: |-
The UPS OAuth Authorization Code API helps integrate UPS services into your business application for providing the service your application grants your customers. For example, you can create UPS shipping labels with shipping rates for merchants from within your application.
Since your application will not have access to your customer's UPS login credentials, the OAuth authorization code flow is used to let your customer use their UPS credentials, within your application, in a simple and secure way.
-
- The PKCE-enhanced Authorization Code Flow introduces a secret created by the calling application that can be verified by the authorization server; this secret is called the Code Verifier. Additionally, the calling app creates a transform value of the Code Verifier called the Code Challenge
+
+ The PKCE-enhanced Authorization Code Flow introduces a secret created by the calling application that can be verified by the authorization server; this secret is called the Code Verifier. Additionally, the calling app creates a transform value of the Code Verifier called the Code Challenge
and sends this value over HTTPS to retrieve an Authorization Code. This way, a malicious attacker can only intercept the Authorization Code, and they cannot exchange it for a token without the Code Verifier.
-
+
Key Business Values:
- **Enhanced Transaction Security**: The OAuth Authorization Code flow is more secure and reliable since the access token and the refresh token are never exposed in the browser's URL, thus reducing the risk of leakage or theft.
- **Operational Efficiency**: With the ability to obtain a refresh token when the token expires, your application can maintain a long-term and uninterrupted access to the protected resources, without requiring the user to re-authenticate or re-login.
@@ -31,12 +31,12 @@ info:
- Setting-up OAuth Authorization Code flow
- Accelerate API Integration with UPS SDKs
-
+
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
version: '1.0'
paths:
@@ -50,8 +50,7 @@ paths:
tags:
- OAuth Auth Code
summary: Authorize Client
- description: |-
- The Authorize Client endpoint initiates the OAuth Authorization Code flow by redirecting the user to UPS for logging-in and authorize the client application. To begin the authorization flow, the application constructs a URL using the application's client Id, the redirect URI, the scope of permissions requested, and a random string used for subsequent verification. A successful response redirects back to the client with an authorization code that can be exchanged for an access token.
+ description: The Authorize Client endpoint initiates the OAuth Authorization Code flow by redirecting the user to UPS for logging-in and authorize the client application. To begin the authorization flow, the application constructs a URL using the application's client Id, the redirect URI, the scope of permissions requested, and a random string used for subsequent verification. A successful response redirects back to the client with an authorization code that can be exchanged for an access token.
operationId: AuthorizeClient
parameters:
- in: query
@@ -93,7 +92,7 @@ paths:
name: code_challenge
schema:
type: string
- description: Base64 URL-Encoded SHA256 value of Code Verifier that can be
+ description: Base64 URL-Encoded SHA256 value of Code Verifier that can be
used to verify the code_verifier in the /token step.
required: false
responses:
@@ -122,25 +121,25 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
"/v1/oauth/token":
post:
servers:
@@ -176,12 +175,10 @@ paths:
description: Callback URL for the requesting application.
code_verifier:
type: string
- description: |
- **Only required for PKCE flow**. A randomly generated secret created by the calling application that can be verified by the authorization server.
+ description: '**Only required for PKCE flow**. A randomly generated secret created by the calling application that can be verified by the authorization server.'
client_id:
type: string
- description: |
- **Only required for PKCE flow**. The public identifier for your application, obtained when you, the developer first registered the application.
+ description: '**Only required for PKCE flow**. The public identifier for your application, obtained when you, the developer first registered the application.'
required:
- grant_type
- code
@@ -192,31 +189,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/generateTokenSuccessResponse"
+ $ref: "#/components/schemas/generateTokenSuccessResponse"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
"/v1/oauth/refresh":
post:
servers:
@@ -258,55 +255,54 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/refreshTokenSuccessResponse"
+ $ref: "#/components/schemas/refreshTokenSuccessResponse"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
components:
securitySchemes:
BasicAuthGenerate:
type: http
scheme: basic
- description: |
- - **Flow 1: Plain Auth-Code**
-
- Find your Client ID and Secret on your app info page.
- 1. Select \"Try It\"
+ description: |-
+ - **Flow 1: Plain Auth-Code**
+ Find your Client ID and Secret on your app info page.
+ 1. Select "Try It"
2. In the Security section enter your Client ID as the Username and your Secret as the Password.
3. Enter any additional information in the Body and Parameters sections.
- 4. Select \"Send\" to execute your API request
+ 4. Select "Send" to execute your API request
- **Flow 2: Auth-Code with PKCE [no http Authorization header required]**
- 1. Select \"Try It\"
+ 1. Select "Try It"
2. Include the **client_id** and **code_verifier** parameters in the body of the request. Do not include an Authorization header.
3. Enter any additional information in the Body and Parameters sections.
- 4. Select \"Send\" to execute your API request
+ 4. Select "Send" to execute your API request
BasicAuthRefresh:
type: http
scheme: basic
description: |
- Find your Client ID and Secret on your app info page.
+ Find your Client ID and Secret on your app info page.
1. Select \"Try It\"
2. In the Security section enter your Client ID as the Username and your Secret as the Password.
3. Enter any additional information in the Body and Parameters sections.
@@ -395,14 +391,14 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/errorResponseWrapper"
+ $ref: "#/components/schemas/errorResponseWrapper"
errorResponseWrapper:
type: object
properties:
errors:
type: array
items:
- "$ref": "#/components/schemas/errors"
+ $ref: "#/components/schemas/errors"
errors:
type: object
properties:
@@ -411,4 +407,4 @@ components:
type: string
message:
description: Error message
- type: string
\ No newline at end of file
+ type: string
diff --git a/OAuthClientCredentials.yaml b/OAuthClientCredentials.yaml
index 416d81d..fbac509 100644
--- a/OAuthClientCredentials.yaml
+++ b/OAuthClientCredentials.yaml
@@ -10,9 +10,9 @@ info:
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
paths:
"/security/v1/oauth/token":
@@ -54,31 +54,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenSuccessResponse"
+ $ref: "#/components/schemas/tokenSuccessResponse"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
'429':
description: Quota Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/tokenErrorResponse"
+ $ref: "#/components/schemas/tokenErrorResponse"
components:
securitySchemes:
BasicAuth:
@@ -122,14 +122,14 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/errorResponseWrapper"
+ $ref: "#/components/schemas/errorResponseWrapper"
errorResponseWrapper:
type: object
properties:
errors:
type: array
items:
- "$ref": "#/components/schemas/errors"
+ $ref: "#/components/schemas/errors"
errors:
type: object
properties:
diff --git a/Paperless.yaml b/Paperless.yaml
index de09df9..8f61de0 100644
--- a/Paperless.yaml
+++ b/Paperless.yaml
@@ -3,7 +3,7 @@ info:
title: Paperless Document
version: ''
description: |
-
+
The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments. Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -73,7 +73,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper"
examples:
'1':
summary: Upload Request with document type 013
@@ -120,31 +120,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/paperlessdocuments/{version}/image":
post:
summary: Paperless Document Push Image
@@ -194,7 +194,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -215,31 +215,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/paperlessdocuments/{version}/DocumentId/ShipperNumber":
delete:
summary: Delete Paperless Document
@@ -291,31 +291,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/paperlessdocuments/{deprecatedVersion}/upload":
post:
deprecated: true
@@ -326,7 +326,7 @@ paths:
- OAuth2: []
description: 'The Paperless Document API web service allows the users to upload,delete
and push to image repository their own customized trade documents for customs
- clearance to Forms History. '
+ clearance to Forms History.'
operationId: Deprecated Upload
parameters:
- in: header
@@ -367,7 +367,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper"
examples:
'1':
summary: Upload Request with document type 013
@@ -414,31 +414,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/paperlessdocuments/{deprecatedVersion}/image":
post:
deprecated: true
@@ -489,7 +489,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -510,31 +510,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber":
delete:
deprecated: true
@@ -587,31 +587,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper"
+ $ref: "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -639,7 +639,7 @@ components:
- DeleteRequest
properties:
DeleteRequest:
- "$ref": "#/components/schemas/DeleteRequest"
+ $ref: "#/components/schemas/DeleteRequest"
PAPERLESSDOCUMENTDeleteResponseWrapper:
xml:
name: DeleteResponse
@@ -650,7 +650,7 @@ components:
- DeleteResponse
properties:
DeleteResponse:
- "$ref": "#/components/schemas/DeleteResponse"
+ $ref: "#/components/schemas/DeleteResponse"
DeleteRequest:
type: object
required:
@@ -659,16 +659,16 @@ components:
- ShipperNumber
properties:
Request:
- "$ref": "#/components/schemas/DeleteRequest_Request"
+ $ref: "#/components/schemas/DeleteRequest_Request"
ShipperNumber:
- description: The Shipper's UPS Account Number. Your UPS Account Number
+ description: The Shipper's UPS Account Number. Your UPS Account Number
must have 'Upload Forms Created Offline' enabled to use this webservice.
maximum: 1
type: string
minLength: 6
maxLength: 6
DocumentID:
- description: DocumentId representing uploaded document to Forms History. Only
+ description: DocumentId representing uploaded document to Forms History. Only
one DocumentID will be accepted for delete request.
maximum: 1
type: string
@@ -693,7 +693,7 @@ components:
maximum: 1
type: string
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
@@ -704,7 +704,7 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/DeleteResponse_Response"
+ $ref: "#/components/schemas/DeleteResponse_Response"
xml:
name: DeleteResponse
description: Paperless Document API response container for delete request.
@@ -715,17 +715,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and description.
+ Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response container.
@@ -745,7 +745,7 @@ components:
minLength: 1
maxLength: 1
Description:
- description: Describes Response Status Code. Returns text of "Success"
+ description: Describes Response Status Code. Returns text of "Success"
or "Failure".
maximum: 1
type: string
@@ -801,7 +801,7 @@ components:
- PushToImageRepositoryRequest
properties:
PushToImageRepositoryRequest:
- "$ref": "#/components/schemas/PushToImageRepositoryRequest"
+ $ref: "#/components/schemas/PushToImageRepositoryRequest"
PAPERLESSDOCUMENTResponseWrapper:
xml:
name: PushToImageRepositoryResponse
@@ -812,7 +812,7 @@ components:
- PushToImageRepositoryResponse
properties:
PushToImageRepositoryResponse:
- "$ref": "#/components/schemas/PushToImageRepositoryResponse"
+ $ref: "#/components/schemas/PushToImageRepositoryResponse"
PushToImageRepositoryRequest:
type: object
required:
@@ -823,16 +823,16 @@ components:
- FormsHistoryDocumentID
properties:
Request:
- "$ref": "#/components/schemas/PushToImageRepositoryRequest_Request"
+ $ref: "#/components/schemas/PushToImageRepositoryRequest_Request"
ShipperNumber:
- description: The Shipper's UPS Account Number. Your UPS Account Number
+ description: The Shipper's UPS Account Number. Your UPS Account Number
must have 'Upload Forms Created Offline' enabled to use this webservice.
maximum: 1
type: string
minLength: 6
maxLength: 6
FormsHistoryDocumentID:
- "$ref": "#/components/schemas/PushToImageRepositoryRequest_FormsHistoryDocumentID"
+ $ref: "#/components/schemas/PushToImageRepositoryRequest_FormsHistoryDocumentID"
FormsGroupID:
description: FormsGroupID would be required in Push Request if user needs
to update uploaded DocumentID(s) in Forms History.
@@ -890,7 +890,7 @@ components:
maximum: 1
type: string
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
@@ -932,7 +932,7 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/PushToImageRepositoryResponse_Response"
+ $ref: "#/components/schemas/PushToImageRepositoryResponse_Response"
FormsGroupID:
description: FormsGroupID is a consolidated ID representing one or multiple
DocumentID(s).
@@ -951,17 +951,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and description.
+ Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response container.
@@ -976,7 +976,7 @@ components:
- UploadRequest
properties:
UploadRequest:
- "$ref": "#/components/schemas/UploadRequest"
+ $ref: "#/components/schemas/UploadRequest"
PAPERLESSDOCUMENTUploadResponseWrapper:
xml:
name: UploadResponse
@@ -987,7 +987,7 @@ components:
- UploadResponse
properties:
UploadResponse:
- "$ref": "#/components/schemas/UploadResponse"
+ $ref: "#/components/schemas/UploadResponse"
UploadRequest:
type: object
required:
@@ -996,9 +996,9 @@ components:
- ShipperNumber
properties:
Request:
- "$ref": "#/components/schemas/UploadRequest_Request"
+ $ref: "#/components/schemas/UploadRequest_Request"
ShipperNumber:
- description: The Shipper's UPS Account Number. Your UPS Account Number
+ description: The Shipper's UPS Account Number. Your UPS Account Number
must have 'Upload Forms Created Offline' enabled to use this webservice.
maximum: 1
type: string
@@ -1008,7 +1008,7 @@ components:
type: array
maximum: 13
items:
- "$ref": "#/components/schemas/UploadRequest_UserCreatedForm"
+ $ref: "#/components/schemas/UploadRequest_UserCreatedForm"
xml:
name: UploadRequest
maximum: 1
@@ -1026,7 +1026,7 @@ components:
maximum: 1
type: string
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
@@ -1048,13 +1048,13 @@ components:
maxLength: 300
UserCreatedFormFile:
description: |
- The user created form file. The maximum allowable size of each file is restricted to 10 MB. Should be a base64 encoded string.
+ The user created form file. The maximum allowable size of each file is restricted to 10 MB. Should be a base64 encoded string.
Note: The maximum allowable size of each file is restriced to 1MB in CIE (Customer Integration Environment).
maximum: 1
type: string
UserCreatedFormFileFormat:
- description: The UserCreatedForm file format. The allowed file formats
+ description: The UserCreatedForm file format. The allowed file formats
are bmp, doc, gif, jpg, pdf, png, rtf, tif, txt and xls. The only exceptions
for having file format of length 4 character are docx and xlsx. All other
file formats needs to be of length 3.
@@ -1063,7 +1063,7 @@ components:
minLength: 3
maxLength: 4
UserCreatedFormDocumentType:
- description: The type of documents in UserCreatedForm file. The allowed
+ description: The type of documents in UserCreatedForm file. The allowed
document types are 001 - Authorization Form, 002 - Commercial Invoice,
003 - Certificate of Origin, 004 - Export Accompanying Document, 005 -
Export License, 006 - Import Permit, 007 - One Time NAFTA, 008 - Other
@@ -1084,9 +1084,9 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/UploadResponse_Response"
+ $ref: "#/components/schemas/UploadResponse_Response"
FormsHistoryDocumentID:
- "$ref": "#/components/schemas/UploadResponse_FormsHistoryDocumentID"
+ $ref: "#/components/schemas/UploadResponse_FormsHistoryDocumentID"
xml:
name: UploadResponse
description: Paperless Document API Response Container for upload request.
@@ -1097,17 +1097,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and description.
+ Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response container.
@@ -1135,7 +1135,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -1144,7 +1144,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/Pickup.yaml b/Pickup.yaml
index 5f591e0..7c26b01 100644
--- a/Pickup.yaml
+++ b/Pickup.yaml
@@ -3,7 +3,7 @@ info:
title: Pickup
version: ''
description: |
-
+
Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups.
# Reference
- Business Rules
@@ -13,9 +13,9 @@ info:
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -79,7 +79,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPRequestWrapper"
+ $ref: "#/components/schemas/PICKUPRequestWrapper"
examples:
json:
summary: A sample JSON request(Standard Example)
@@ -104,31 +104,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPResponseWrapper"
+ $ref: "#/components/schemas/PICKUPResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
get:
description: Using the GET operation of the pickuptype endpoint within the Pickup API, users can retrieve the status of shipments sent via UPS pickup service. The endpoint uses the account number as a required parameter and returns a status of received/dispatched/completed/incomplete/updated ETA, or cancelled.
summary: Pickup Pending Status
@@ -156,7 +156,7 @@ paths:
name: AccountNumber
schema:
type: string
- description: "The specific account number that belongs to the \nshipper.Length
+ description: "The specific account number that belongs to the\nshipper.Length
6 or 10"
required: true
- in: path
@@ -188,31 +188,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPPendingResponseWrapper"
+ $ref: "#/components/schemas/PICKUPPendingResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/shipments/{version}/pickup/{CancelBy}":
delete:
description: Using the CancelBy endpoint of the Pickup API, users can request cancellation of a UPS on-demand package pickup. When the PRN (pickup request number), transaction ID, and the transaction source are supplied as required parameters, the endpoint returns confirmation that the pickup has been cancelled.
@@ -241,7 +241,7 @@ paths:
name: Prn
schema:
type: string
- description: "The pickup equest number (PRN) generated by \nUPS pickup system.\nRequired
+ description: "The pickup equest number (PRN) generated by\nUPS pickup system.\nRequired
if CancelBy = prn.Length 26"
required: false
- in: path
@@ -268,31 +268,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPCancelResponseWrapper"
+ $ref: "#/components/schemas/PICKUPCancelResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/pickupcreation/{version}/pickup":
post:
description: Using the Pickup API, applications can schedule pickups, manage
@@ -339,7 +339,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPCreationRequestWrapper"
+ $ref: "#/components/schemas/PICKUPCreationRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -393,31 +393,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPCreationResponseWrapper"
+ $ref: "#/components/schemas/PICKUPCreationResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/pickup/{version}/countries/{countrycode}":
get:
description: The countrycode endpoint of the Pickup API helps retrieve a list of political divisions (states) in a specified country or territory.
@@ -459,7 +459,7 @@ paths:
schema:
type: string
minimum: 1
- description: "Country or terrirtory for which the list will \nrepresent.Length
+ description: "Country or terrirtory for which the list will\nrepresent.Length
2"
required: true
responses:
@@ -468,31 +468,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPPolDivResponseWrapper"
+ $ref: "#/components/schemas/PICKUPPolDivResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/pickup/{version}/servicecenterlocations":
post:
description: The servicecenterlocations endpoint of the Pickup API helps retrieve service center information in a specified area - including location address, phone number, SLIC (Standard Location Identification Code), and hours of operation for pick-up and drop-off requests
@@ -537,7 +537,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPServCenterRequestWrapper"
+ $ref: "#/components/schemas/PICKUPServCenterRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -559,31 +559,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPServCenterResponseWrapper"
+ $ref: "#/components/schemas/PICKUPServCenterResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/shipments/{deprecatedVersion}/pickup/{CancelBy}":
delete:
deprecated: true
@@ -613,7 +613,7 @@ paths:
name: Prn
schema:
type: string
- description: "The pickup equest number (PRN) generated by \nUPS pickup system.\nRequired
+ description: "The pickup equest number (PRN) generated by\nUPS pickup system.\nRequired
if CancelBy = prn.Length 26"
required: false
- in: path
@@ -640,31 +640,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPCancelResponseWrapper"
+ $ref: "#/components/schemas/PICKUPCancelResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/pickupcreation/{deprecatedVersion}/pickup":
post:
deprecated: true
@@ -714,7 +714,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPCreationRequestWrapper"
+ $ref: "#/components/schemas/PICKUPCreationRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -768,31 +768,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PICKUPCreationResponseWrapper"
+ $ref: "#/components/schemas/PICKUPCreationResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -820,7 +820,7 @@ components:
- PickupRateRequest
properties:
PickupRateRequest:
- "$ref": "#/components/schemas/PickupRateRequest"
+ $ref: "#/components/schemas/PickupRateRequest"
PICKUPResponseWrapper:
xml:
name: PickupRateResponse
@@ -831,7 +831,7 @@ components:
- PickupRateResponse
properties:
PickupRateResponse:
- "$ref": "#/components/schemas/PickupRateResponse"
+ $ref: "#/components/schemas/PickupRateResponse"
PickupRateRequest:
type: object
required:
@@ -841,14 +841,14 @@ components:
- AlternateAddressIndicator
properties:
Request:
- "$ref": "#/components/schemas/PickupRateRequest_Request"
+ $ref: "#/components/schemas/PickupRateRequest_Request"
ShipperAccount:
- "$ref": "#/components/schemas/PickupRateRequest_ShipperAccount"
+ $ref: "#/components/schemas/PickupRateRequest_ShipperAccount"
PickupAddress:
- "$ref": "#/components/schemas/PickupRateRequest_PickupAddress"
+ $ref: "#/components/schemas/PickupRateRequest_PickupAddress"
AlternateAddressIndicator:
description: "Indicates if the pickup address is different than the address
- specified in the customer's profile. \nValid values:\nY = Alternate address\nN
+ specified in the customer's profile.\nValid values:\nY = Alternate address\nN
= Original pickup address (default)"
maximum: 1
type: string
@@ -867,7 +867,7 @@ components:
minLength: 1
maxLength: 1
PickupDateInfo:
- "$ref": "#/components/schemas/PickupRateRequest_PickupDateInfo"
+ $ref: "#/components/schemas/PickupRateRequest_PickupDateInfo"
RateChartType:
description: |
Rate Type with which pickup is rated. Possible RateChart values for different regions will be:
@@ -877,7 +877,7 @@ components:
3 – Standard List Rates
4 – Retail Rates.
- Alaska/Hawaii origin:
+ Alaska/Hawaii origin:
1 – Daily Rates
3 – Standard List Rates
4 – Retail Rates.
@@ -904,7 +904,7 @@ components:
maxLength: 1
UserLevelDiscountIndicator:
description: "Indicates whether to return user level promo discount for
- the on-callpickups. \nValid values:\nY = Rate this pickup with user level
+ the on-callpickups.\nValid values:\nY = Rate this pickup with user level
promo discount\nN = Do not rate this pickup with user level promo discount(default)"
maximum: 1
type: string
@@ -929,14 +929,14 @@ components:
Subversion. The value of the subversion is explained in the Response element
Description. Supported values: 1607, 1707,2007\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.\nExample:
+ or equal to '1601'.\n\nFormat: YYMM = Year and month of the release.\nExample:
1601 = 2016 January"
maximum: 1
type: string
minLength: 4
maxLength: 4
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
@@ -963,7 +963,7 @@ components:
- AccountNumber
properties:
AccountNumber:
- description: UPS account number. Shipper's (requester of the pickup) UPS
+ description: UPS account number. Shipper's (requester of the pickup) UPS
account number
maximum: 1
type: string
@@ -985,7 +985,7 @@ components:
maximum: 1
properties:
AddressLine:
- description: "Detailed street address. \nFor Jan. 2010 release, only one
+ description: "Detailed street address.\nFor Jan. 2010 release, only one
AddressLine is allowed."
maximum: 1
type: string
@@ -1073,7 +1073,7 @@ components:
maxLength: 8
xml:
name: PickupDateInfo
- description: "Required if the ServiceDateOption is: \n03 A Specific-Day Pickup"
+ description: "Required if the ServiceDateOption is:\n03 A Specific-Day Pickup"
PickupRateResponse:
type: object
required:
@@ -1081,9 +1081,9 @@ components:
- RateResult
properties:
Response:
- "$ref": "#/components/schemas/PickupRateResponse_Response"
+ $ref: "#/components/schemas/PickupRateResponse_Response"
RateResult:
- "$ref": "#/components/schemas/PickupRateResponse_RateResult"
+ $ref: "#/components/schemas/PickupRateResponse_RateResult"
WeekendServiceTerritoryIndicator:
description: |-
Indicates if the pickup address qualifies for WST (Weekend Service Territory). Returned if the pickup date is Saturday and subversion greater or equal to 1607. Valid Values:
@@ -1094,7 +1094,7 @@ components:
minLength: 1
maxLength: 1
WeekendServiceTerritory:
- "$ref": "#/components/schemas/PickupRateResponse_WeekendServiceTerritory"
+ $ref: "#/components/schemas/PickupRateResponse_WeekendServiceTerritory"
xml:
name: PickupRateResponse
maximum: 1
@@ -1105,15 +1105,15 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
oneOf:
- items:
- "$ref": "#/components/schemas/Response_Alert"
+ $ref: "#/components/schemas/Response_Alert"
type: array
- - "$ref": "#/components/schemas/Response_Alert"
+ - $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -1184,7 +1184,7 @@ components:
type: object
properties:
Disclaimer:
- "$ref": "#/components/schemas/RateResult_Disclaimer"
+ $ref: "#/components/schemas/RateResult_Disclaimer"
RateType:
description: |-
Indicates the pickup is rated as same-day or future-day pickup.
@@ -1201,13 +1201,13 @@ components:
minLength: 3
maxLength: 3
ChargeDetail:
- type: array
- items:
- "$ref": "#/components/schemas/RateResult_ChargeDetail"
+ type: array
+ items:
+ $ref: "#/components/schemas/RateResult_ChargeDetail"
TaxCharges:
- type: array
- items:
- "$ref": "#/components/schemas/RateResult_TaxCharges"
+ type: array
+ items:
+ $ref: "#/components/schemas/RateResult_TaxCharges"
TotalTax:
description: The sum of all taxes.
maximum: 1
@@ -1313,7 +1313,7 @@ components:
- MonetaryValue
properties:
Type:
- description: "Type of Tax code. \nValid values: ALV, BTW, DDS, DDV, DPH,
+ description: "Type of Tax code.\nValid values: ALV, BTW, DDS, DDV, DPH,
FPA, GST, IVA, IVA1, IVA2, IVA3, KM, MOMS, MWST, PDV, PST, PVM, PVN, QST,
TVA, VAT, VSK."
maximum: 1
@@ -1368,7 +1368,7 @@ components:
- PickupCancelRequest
properties:
PickupCancelRequest:
- "$ref": "#/components/schemas/PickupCancelRequest"
+ $ref: "#/components/schemas/PickupCancelRequest"
PICKUPCancelResponseWrapper:
xml:
name: PickupCancelResponse
@@ -1379,7 +1379,7 @@ components:
- PickupCancelResponse
properties:
PickupCancelResponse:
- "$ref": "#/components/schemas/PickupCancelResponse"
+ $ref: "#/components/schemas/PickupCancelResponse"
PickupCancelRequest:
type: object
required:
@@ -1387,7 +1387,7 @@ components:
- Request
properties:
Request:
- "$ref": "#/components/schemas/PickupCancelRequest_Request"
+ $ref: "#/components/schemas/PickupCancelRequest_Request"
CancelBy:
description: |-
Cancel pickup by Pickup Request Number (PRN).
@@ -1413,7 +1413,7 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Request Container.
@@ -1425,7 +1425,7 @@ components:
- PickupType
properties:
Response:
- "$ref": "#/components/schemas/PickupCancelResponse_Response"
+ $ref: "#/components/schemas/PickupCancelResponse_Response"
PickupType:
description: |-
The type of pickup that has been cancelled.
@@ -1435,7 +1435,7 @@ components:
minLength: 2
maxLength: 2
GWNStatus:
- "$ref": "#/components/schemas/PickupCancelResponse_GWNStatus"
+ $ref: "#/components/schemas/PickupCancelResponse_GWNStatus"
xml:
name: PickupCancelResponse
maximum: 1
@@ -1446,13 +1446,13 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
- type: array
- items:
- "$ref": "#/components/schemas/Response_Alert"
+ type: array
+ items:
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container
@@ -1498,7 +1498,7 @@ components:
- PickupCreationRequest
properties:
PickupCreationRequest:
- "$ref": "#/components/schemas/PickupCreationRequest"
+ $ref: "#/components/schemas/PickupCreationRequest"
PICKUPCreationResponseWrapper:
xml:
name: PickupCreationResponse
@@ -1509,7 +1509,7 @@ components:
- PickupCreationResponse
properties:
PickupCreationResponse:
- "$ref": "#/components/schemas/PickupCreationResponse"
+ $ref: "#/components/schemas/PickupCreationResponse"
PickupCreationRequest:
type: object
required:
@@ -1522,9 +1522,9 @@ components:
- AlternateAddressIndicator
properties:
Request:
- "$ref": "#/components/schemas/PickupCreationRequest_Request"
+ $ref: "#/components/schemas/PickupCreationRequest_Request"
RatePickupIndicator:
- description: "Indicates whether to rate the on-callpickup or not. \nValid
+ description: "Indicates whether to rate the on-callpickup or not.\nValid
values:\nY = Rate this pickup\nN = Do not rate this pickup (default)"
type: string
maximum: 1
@@ -1539,7 +1539,7 @@ components:
- 3 – Standard List Rates
- 4 – Retail Rates.
- Alaska/Hawaii origin:
+ Alaska/Hawaii origin:
- 1 – Daily Rates
- 3 – Standard List Rates
- 4 – Retail Rates.
@@ -1564,21 +1564,21 @@ components:
maxLength: 1
UserLevelDiscountIndicator:
description: "Indicates whether to return user level promo discount for
- the on-callpickups. \nValid values:\nY = Rate this pickup with user level
+ the on-callpickups.\nValid values:\nY = Rate this pickup with user level
promo discount\nN = Do not rate this pickup with user level promo discount(default)"
maximum: 1
type: string
minLength: 1
maxLength: 1
Shipper:
- "$ref": "#/components/schemas/PickupCreationRequest_Shipper"
+ $ref: "#/components/schemas/PickupCreationRequest_Shipper"
PickupDateInfo:
- "$ref": "#/components/schemas/PickupCreationRequest_PickupDateInfo"
+ $ref: "#/components/schemas/PickupCreationRequest_PickupDateInfo"
PickupAddress:
- "$ref": "#/components/schemas/PickupCreationRequest_PickupAddress"
+ $ref: "#/components/schemas/PickupCreationRequest_PickupAddress"
AlternateAddressIndicator:
description: "Indicates if pickup address is a different address than that
- specified in a customer's profile. \nValid values:\nY = Alternate address\nN
+ specified in a customer's profile.\nValid values:\nY = Alternate address\nN
= Original pickup address (default)"
maximum: 1
type: string
@@ -1587,12 +1587,12 @@ components:
PickupPiece:
type: array
items:
- "$ref": "#/components/schemas/PickupCreationRequest_PickupPiece"
+ $ref: "#/components/schemas/PickupCreationRequest_PickupPiece"
TotalWeight:
- "$ref": "#/components/schemas/PickupCreationRequest_TotalWeight"
+ $ref: "#/components/schemas/PickupCreationRequest_TotalWeight"
OverweightIndicator:
description: "Indicates if at least any package is over 70 lbs or 32 kgs.
- \nValid values: \nY = Over weight \nN = Not over weight (default) Not
+ \nValid values:\nY = Over weight\nN = Not over weight (default) Not
required for WWEF service."
maximum: 1
type: string
@@ -1601,17 +1601,17 @@ components:
TrackingData:
type: array
items:
- "$ref": "#/components/schemas/PickupCreationRequest_TrackingData"
+ $ref: "#/components/schemas/PickupCreationRequest_TrackingData"
TrackingDataWithReferenceNumber:
- "$ref": "#/components/schemas/PickupCreationRequest_TrackingDataWithReferenceNumber"
+ $ref: "#/components/schemas/PickupCreationRequest_TrackingDataWithReferenceNumber"
PaymentMethod:
description: "The payment method to pay for this on call pickup.\n00 = No
payment needed\n01 = Pay by shipper account\n03 = Pay by charge card\n04
= Pay by 1Z tracking number\n05 = Pay by check or money order\n06 = Cash(applicable
only for these countries - BE,FR,DE,IT,MX,NL,PL,ES,GB,CZ,HU,FI,NO)\n07=Pay
by PayPal\nRefer to Appendix # for valid payment methods for CZ, HU, FI
- and NO\n For countries and (or) zip codes where pickup is free of charge,
- please submit 00, means no payment needed as payment method. \n- If 01
+ and NO\nFor countries and (or) zip codes where pickup is free of charge,
+ please submit 00, means no payment needed as payment method.\n- If 01
is the payment method, then ShipperAccountNumber and ShipperAccount CountryCode
must be provided.\n- If 03 is selected, then CreditCard information should
be provided.\n- If 04 is selected, then the shipper agreed to pay for
@@ -1634,10 +1634,10 @@ components:
minLength: 1
maxLength: 35
FreightOptions:
- "$ref": "#/components/schemas/PickupCreationRequest_FreightOptions"
+ $ref: "#/components/schemas/PickupCreationRequest_FreightOptions"
ServiceCategory:
description: "Service Category.\nApplicable to the following countries:\nBE,
- FR, DE, IT, MX, NL, PL, ES, GB \nValid values: \n01 - domestic (default)\n02
+ FR, DE, IT, MX, NL, PL, ES, GB\nValid values:\n01 - domestic (default)\n02
- international\n03 - transborder"
maximum: 1
type: string
@@ -1673,14 +1673,14 @@ components:
Subversion. The value of the subversion is explained in the Response element
Description. Supported values: 1607, 1707,2007\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.\nExample:
+ or equal to '1601'.\n\nFormat: YYMM = Year and month of the release.\nExample:
1601 = 2016 January"
maximum: 1
type: string
minLength: 4
maxLength: 4
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Common element for all services
@@ -1688,14 +1688,14 @@ components:
type: object
properties:
Account:
- "$ref": "#/components/schemas/Shipper_Account"
+ $ref: "#/components/schemas/Shipper_Account"
ChargeCard:
- "$ref": "#/components/schemas/Shipper_ChargeCard"
+ $ref: "#/components/schemas/Shipper_ChargeCard"
xml:
name: Shipper
- description: "On-call pickup shipper or requestor information. Must provide
+ description: "On-call pickup shipper or requestor information. Must provide
when choose to pay the pickup by shipper account number, BillThirdParty account
- number, or BillReceiver account number. \nIt is optional if the shipper chooses
+ number, or BillReceiver account number.\nIt is optional if the shipper chooses
any other payment method. However, it is highly recommended to provide if
available."
maximum: 1
@@ -1707,7 +1707,7 @@ components:
- AccountNumber
properties:
AccountNumber:
- description: UPS account number. Shipper's (requester of the pickup) UPS
+ description: UPS account number. Shipper's (requester of the pickup) UPS
account number
maximum: 1
type: string
@@ -1723,7 +1723,7 @@ components:
maxLength: 2
xml:
name: Account
- description: "Shipper account information. \nMust provide when choose to pay
+ description: "Shipper account information.\nMust provide when choose to pay
the pickup by shipper account number"
Shipper_ChargeCard:
type: object
@@ -1748,7 +1748,7 @@ components:
minLength: 2
maxLength: 2
CardNumber:
- description: Charge card number. For Privileged clients, this element must
+ description: Charge card number. For Privileged clients, this element must
be tokenized card number.
maximum: 1
type: string
@@ -1766,15 +1766,15 @@ components:
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. \nNumber of digits varies for
- different type of credit card. Valid values are 3 or 4 digits.\nSecurity
+ card number or on the back of credit card.\nNumber of digits varies for
+ different type of credit card. Valid values are 3 or 4 digits.\nSecurity
code is required if credit card information is provided."
maximum: 1
type: string
minLength: 3
maxLength: 4
CardAddress:
- "$ref": "#/components/schemas/ChargeCard_CardAddress"
+ $ref: "#/components/schemas/ChargeCard_CardAddress"
xml:
name: ChargeCard
required:
@@ -1790,7 +1790,7 @@ components:
maximum: 1
properties:
AddressLine:
- description: Address Lines of the credit card billing address. Max of three
+ description: Address Lines of the credit card billing address. Max of three
address lines can be provided.
type: array
items:
@@ -1811,7 +1811,7 @@ components:
minLength: 1
maxLength: 50
PostalCode:
- description: Charge card billing address postal code. This is a required
+ description: Charge card billing address postal code. This is a required
field for postal countries.
maximum: 1
type: string
@@ -1855,12 +1855,12 @@ components:
minLength: 4
maxLength: 4
ReadyTime:
- description: "Pickup location's local ready time. \nReadyTime means the
- time when your shipment(s) can be ready for UPS to pick up. \n- User provided
- ReadyTime must be earlier than CallByTime. \n- CallByTime is determined
+ description: "Pickup location's local ready time.\nReadyTime means the
+ time when your shipment(s) can be ready for UPS to pick up.\n- User provided
+ ReadyTime must be earlier than CallByTime.\n- CallByTime is determined
by UPS pickup operation system. CallByTime is the Latest time a Customer
can call UPS or self-serve on UPS.com and complete a Pickup Request and
- UPS can still make the Pickup service request. \n- If ReadyTime is earlier
+ UPS can still make the Pickup service request.\n- If ReadyTime is earlier
than current local time, UPS uses the current local time as the ReadyTime.
\ Format: HHmm\nHour: 0-23\nMinute: 0-59"
type: string
@@ -1972,7 +1972,7 @@ components:
minLength: 1
maxLength: 11
Phone:
- "$ref": "#/components/schemas/PickupAddress_Phone"
+ $ref: "#/components/schemas/PickupAddress_Phone"
xml:
name: PickupAddress
description: The container of pickup address.
@@ -2013,7 +2013,7 @@ components:
minLength: 3
maxLength: 3
Quantity:
- description: "Number of pieces to be picked up. \nMax per service: 999"
+ description: "Number of pieces to be picked up.\nMax per service: 999"
maximum: 1
type: string
minLength: 1
@@ -2041,7 +2041,7 @@ components:
xml:
name: PickupPiece
description: "The container providing the information about how many items should
- be picked up. \nThe total number of return and forwarding packages cannot
+ be picked up.\nThe total number of return and forwarding packages cannot
exceed 9,999."
PickupCreationRequest_TotalWeight:
type: object
@@ -2051,7 +2051,7 @@ components:
- Weight
properties:
Weight:
- description: "The weight of the package. \nOne decimal digit is allowed.
+ description: "The weight of the package.\nOne decimal digit is allowed.
Example: 10.9"
maximum: 1
type: string
@@ -2074,7 +2074,7 @@ components:
maximum: 1
properties:
TrackingNumber:
- description: Tracking number for return shipment or forward shipment packages. Tracking
+ description: Tracking number for return shipment or forward shipment packages. Tracking
number(s) that have been previously used to pay for on-call pickup cannot
be used again.
maximum: 1
@@ -2084,7 +2084,7 @@ components:
xml:
name: TrackingData
description: |-
- Container for Return Service and Forward Tracking Numbers. Accept no more than 30 TrackingData.
+ Container for Return Service and Forward Tracking Numbers. Accept no more than 30 TrackingData.
TrackingDataWithReferenceNumber and TrackingData container cannot be present at the same time.
PickupCreationRequest_TrackingDataWithReferenceNumber:
@@ -2109,15 +2109,15 @@ components:
maxLength: 35
xml:
name: TrackingDataWithReferenceNumber
- description: Container for Tracking Number with its associated reference numbers. This
+ description: Container for Tracking Number with its associated reference numbers. This
container should be populated to provide visibility into shipment tied to
- pickup being scheduled. TrackingDataWithReferenceNumber and TrackingData
+ pickup being scheduled. TrackingDataWithReferenceNumber and TrackingData
container cannot be present at the same time.
PickupCreationRequest_FreightOptions:
type: object
properties:
ShipmentServiceOptions:
- "$ref": "#/components/schemas/FreightOptions_ShipmentServiceOptions"
+ $ref: "#/components/schemas/FreightOptions_ShipmentServiceOptions"
OriginServiceCenterCode:
description: Origin SLIC. This will be obtained from submitting a pickup
service center request. See PickupGetFacilitiesServiceCenterRequest.
@@ -2133,9 +2133,9 @@ components:
minLength: 2
maxLength: 2
DestinationAddress:
- "$ref": "#/components/schemas/FreightOptions_DestinationAddress"
+ $ref: "#/components/schemas/FreightOptions_DestinationAddress"
ShipmentDetail:
- "$ref": "#/components/schemas/FreightOptions_ShipmentDetail"
+ $ref: "#/components/schemas/FreightOptions_ShipmentDetail"
xml:
name: FreightOptions
maximum: 1
@@ -2149,7 +2149,7 @@ components:
maximum: 1
properties:
OriginLiftGateIndicator:
- description: Presence indicates OriginLiftGateRequiredIndicator is present. Conditionally
+ description: Presence indicates OriginLiftGateRequiredIndicator is present. Conditionally
requirements. Must not be present if DropOffAtUPSFacilityIndicator is
true
maximum: 1
@@ -2172,7 +2172,7 @@ components:
maximum: 1
properties:
City:
- description: The city of pickup address if available. It is required for
+ description: The city of pickup address if available. It is required for
non-postal country Ireland (IE).
maximum: 1
type: string
@@ -2188,7 +2188,7 @@ components:
minLength: 1
maxLength: 50
PostalCode:
- description: Postal Code for postal countries. It does not apply to non-postal
+ description: Postal Code for postal countries. It does not apply to non-postal
countries such as IE and HK
maximum: 1
type: string
@@ -2216,7 +2216,7 @@ components:
maximum: 1
type: string
PalletInformation:
- "$ref": "#/components/schemas/ShipmentDetail_PalletInformation"
+ $ref: "#/components/schemas/ShipmentDetail_PalletInformation"
xml:
name: ShipmentDetail
description: Refers to the ShipmentDetail Container under Freight Options
@@ -2224,7 +2224,7 @@ components:
type: object
properties:
Dimensions:
- "$ref": "#/components/schemas/PalletInformation_Dimensions"
+ $ref: "#/components/schemas/PalletInformation_Dimensions"
xml:
name: PalletInformation
description: Pallet Details.
@@ -2238,7 +2238,7 @@ components:
- Width
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/Dimensions_UnitOfMeasurement"
+ $ref: "#/components/schemas/Dimensions_UnitOfMeasurement"
Length:
description: Dimension length of pallet.
maximum: 1
@@ -2286,7 +2286,7 @@ components:
- RateStatus
properties:
Response:
- "$ref": "#/components/schemas/PickupCreationResponse_Response"
+ $ref: "#/components/schemas/PickupCreationResponse_Response"
PRN:
description: Pickup Request Number generated by UPS pickup system when a
successful pickup is scheduled.Same PRN will be returned if a pickup request
@@ -2296,7 +2296,7 @@ components:
minLength: 11
maxLength: 11
WeekendServiceTerritory:
- "$ref": "#/components/schemas/PickupCreationResponse_WeekendServiceTerritory"
+ $ref: "#/components/schemas/PickupCreationResponse_WeekendServiceTerritory"
WeekendServiceTerritoryIndicator:
description: |-
Indicates if the pickup address qualifies for WST (Weekend Service Territory). Returned if the pickup date is Saturday and subversion greater or equal to 1607. Valid Values:
@@ -2307,9 +2307,9 @@ components:
minLength: 1
maxLength: 1
RateStatus:
- "$ref": "#/components/schemas/PickupCreationResponse_RateStatus"
+ $ref: "#/components/schemas/PickupCreationResponse_RateStatus"
RateResult:
- "$ref": "#/components/schemas/PickupCreationResponse_RateResult"
+ $ref: "#/components/schemas/PickupCreationResponse_RateResult"
xml:
name: PickupCreationResponse
maximum: 1
@@ -2320,13 +2320,13 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
- type: array
- items:
- "$ref": "#/components/schemas/Response_Alert"
+ type: array
+ items:
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -2394,7 +2394,7 @@ components:
type: object
properties:
Disclaimer:
- "$ref": "#/components/schemas/RateResult_Disclaimer"
+ $ref: "#/components/schemas/RateResult_Disclaimer"
RateType:
description: |-
Indicates this pickup is rated as same-day or future-day pickup.
@@ -2417,7 +2417,7 @@ components:
**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/RateResult_ChargeDetail"
+ $ref: "#/components/schemas/RateResult_ChargeDetail"
TaxCharges:
description: |
Container to hold taxes when, detailed taxes are request via RateTaxIndicator.
@@ -2425,7 +2425,7 @@ components:
**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/RateResult_TaxCharges"
+ $ref: "#/components/schemas/RateResult_TaxCharges"
TotalTax:
description: The sum of all taxes.
maximum: 1
@@ -2509,7 +2509,7 @@ components:
- PickupGetPoliticalDivision1ListRequest
properties:
PickupGetPoliticalDivision1ListRequest:
- "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListRequest"
+ $ref: "#/components/schemas/PickupGetPoliticalDivision1ListRequest"
PICKUPPolDivResponseWrapper:
xml:
name: PickupGetPoliticalDivision1ListResponse
@@ -2520,7 +2520,7 @@ components:
- PickupGetPoliticalDivision1ListResponse
properties:
PickupGetPoliticalDivision1ListResponse:
- "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListResponse"
+ $ref: "#/components/schemas/PickupGetPoliticalDivision1ListResponse"
PickupGetPoliticalDivision1ListRequest:
type: object
required:
@@ -2528,7 +2528,7 @@ components:
- CountryCode
properties:
Request:
- "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListRequest_Request"
+ $ref: "#/components/schemas/PickupGetPoliticalDivision1ListRequest_Request"
CountryCode:
description: Specifies the country for which the list of Political Division
1 will be returned if available.
@@ -2545,7 +2545,7 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Common element for all services
@@ -2556,7 +2556,7 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListResponse_Response"
+ $ref: "#/components/schemas/PickupGetPoliticalDivision1ListResponse_Response"
PoliticalDivision1:
description: The Political Division 1/State Field.
minLength: 1
@@ -2575,13 +2575,13 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
type: array
items:
- "$ref": "#/components/schemas/Response_Alert"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -2596,7 +2596,7 @@ components:
- PickupGetServiceCenterFacilitiesRequest
properties:
PickupGetServiceCenterFacilitiesRequest:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesRequest"
PICKUPServCenterResponseWrapper:
xml:
name: PickupGetServiceCenterFacilitiesResponse
@@ -2607,7 +2607,7 @@ components:
- PickupGetServiceCenterFacilitiesResponse
properties:
PickupGetServiceCenterFacilitiesResponse:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesResponse"
PickupGetServiceCenterFacilitiesRequest:
type: object
required:
@@ -2616,17 +2616,17 @@ components:
- PickupPiece
properties:
Request:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_Request"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_Request"
PickupPiece:
items:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_PickupPiece"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_PickupPiece"
OriginAddress:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_OriginAddress"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_OriginAddress"
DestinationAddress:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_DestinationAddress"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_DestinationAddress"
Locale:
- description: "Origin Country or Territory Locale. Locale should be Origin
- Country. Example: en_US. \nThe Last 50 instruction will be send based
+ description: "Origin Country or Territory Locale. Locale should be Origin
+ Country. Example: en_US.\nThe Last 50 instruction will be send based
on this locale. Locale is required if PoximityIndicator is present for
Drop Off facilities."
maximum: 1
@@ -2647,7 +2647,7 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Container for the Request.
@@ -2684,7 +2684,7 @@ components:
properties:
StreetAddress:
description: Indicates the address of the shipper to allow for the nearest
- Drop off facility Search. Conditionally required if proximitySearchIndicator
+ Drop off facility Search. Conditionally required if proximitySearchIndicator
is present.
maximum: 1
type: string
@@ -2700,7 +2700,7 @@ components:
maxLength: 50
StateProvince:
description: Indicates the address of the shipper to allow for the nearest
- Drop off facility Search. Conditionally required if proximitySearchIndicator
+ Drop off facility Search. Conditionally required if proximitySearchIndicator
is present and if country or territory is US/CA/IE/HK.
maximum: 1
type: string
@@ -2723,13 +2723,13 @@ components:
minLength: 2
maxLength: 2
OriginSearchCriteria:
- "$ref": "#/components/schemas/OriginAddress_OriginSearchCriteria"
+ $ref: "#/components/schemas/OriginAddress_OriginSearchCriteria"
xml:
name: OriginAddress
required:
- CountryCode
description: Indicates the address of the shipper to allow for the nearest Drop
- off facility Search. Conditionally required for drop off location search.
+ off facility Search. Conditionally required for drop off location search.
OriginAddress_OriginSearchCriteria:
type: object
maximum: 1
@@ -2773,7 +2773,7 @@ components:
properties:
City:
description: Indicates the address of the consignee to allow for the nearest
- Pickup facility Search. Required for non-postal country Ireland (IE).
+ Pickup facility Search. Required for non-postal country Ireland (IE).
maximum: 1
type: string
minLength: 1
@@ -2808,7 +2808,7 @@ components:
name: DestinationAddress
required:
- CountryCode
- description: DestinationAddress container. Conditionally required for pickup
+ description: DestinationAddress container. Conditionally required for pickup
location search.
PickupGetServiceCenterFacilitiesResponse:
type: object
@@ -2817,9 +2817,9 @@ components:
- ServiceCenterLocation
properties:
Response:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_Response"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_Response"
ServiceCenterLocation:
- "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_ServiceCenterLocation"
+ $ref: "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_ServiceCenterLocation"
xml:
name: PickupGetServiceCenterFacilitiesResponse
description: Returns service center location information for Origin UPS Facilities
@@ -2831,13 +2831,13 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
- type: array
- items:
- "$ref": "#/components/schemas/Response_Alert"
+ type: array
+ items:
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Container for response.
@@ -2848,11 +2848,11 @@ components:
DropOffFacilities:
oneOf:
- items:
- "$ref": "#/components/schemas/ServiceCenterLocation_DropOffFacilities"
+ $ref: "#/components/schemas/ServiceCenterLocation_DropOffFacilities"
type: array
- - "$ref": "#/components/schemas/ServiceCenterLocation_DropOffFacilities"
+ - $ref: "#/components/schemas/ServiceCenterLocation_DropOffFacilities"
PickupFacilities:
- "$ref": "#/components/schemas/ServiceCenterLocation_PickupFacilities"
+ $ref: "#/components/schemas/ServiceCenterLocation_PickupFacilities"
xml:
name: ServiceCenterLocation
description: Locations of the nearest Service Center for Dropoff and Pickup
@@ -2875,7 +2875,7 @@ components:
maximum: 1
type: string
Address:
- "$ref": "#/components/schemas/DropOffFacilities_Address"
+ $ref: "#/components/schemas/DropOffFacilities_Address"
SLIC:
description: SLIC code for the UPS Drop off facility.
maximum: 1
@@ -2911,7 +2911,7 @@ components:
minLength: 10
maxLength: 10
FacilityTime:
- "$ref": "#/components/schemas/DropOffFacilities_FacilityTime"
+ $ref: "#/components/schemas/DropOffFacilities_FacilityTime"
OriginOrDestination:
description: Type of Facility.
maximum: 1
@@ -2919,11 +2919,11 @@ components:
LocalizedInstruction:
oneOf:
- items:
- "$ref": "#/components/schemas/DropOffFacilities_LocalizedInstruction"
+ $ref: "#/components/schemas/DropOffFacilities_LocalizedInstruction"
type: array
- - "$ref": "#/components/schemas/DropOffFacilities_LocalizedInstruction"
+ - $ref: "#/components/schemas/DropOffFacilities_LocalizedInstruction"
Distance:
- "$ref": "#/components/schemas/DropOffFacilities_Distance"
+ $ref: "#/components/schemas/DropOffFacilities_Distance"
xml:
name: DropOffFacilities
description: Returns information for DropOff Facilities. This includes name
@@ -2974,7 +2974,7 @@ components:
maxLength: 3
ResidentialIndicator:
description: "Indicates if the pickup address is a residential place or
- not. \nValid Values:\nY = Residential address\nN = Non-residential (Commercial)
+ not.\nValid Values:\nY = Residential address\nN = Non-residential (Commercial)
address (default)"
maximum: 1
type: string
@@ -2991,7 +2991,7 @@ components:
DayOfWeek:
type: array
items:
- "$ref": "#/components/schemas/FacilityTime_DayOfWeek"
+ $ref: "#/components/schemas/FacilityTime_DayOfWeek"
xml:
name: FacilityTime
description: Facility Time Container
@@ -3075,7 +3075,7 @@ components:
maxLength: 750
xml:
name: LocalizedInstruction
- description: Localized Instruction Container. Localized Instructions will be
+ description: Localized Instruction Container. Localized Instructions will be
returned for drop off location search by proximity order.
DropOffFacilities_Distance:
type: object
@@ -3118,7 +3118,7 @@ components:
maximum: 1
type: string
Address:
- "$ref": "#/components/schemas/PickupFacilities_Address"
+ $ref: "#/components/schemas/PickupFacilities_Address"
SLIC:
description: SLIC code for the UPS Pickup facility
maximum: 1
@@ -3154,16 +3154,16 @@ components:
minLength: 10
maxLength: 10
FacilityTime:
- "$ref": "#/components/schemas/PickupFacilities_FacilityTime"
+ $ref: "#/components/schemas/PickupFacilities_FacilityTime"
AirportCode:
- description: "AirPort Code for destination/pickup facility. \nExample: ATL
+ description: "AirPort Code for destination/pickup facility.\nExample: ATL
(Atlanta)\nIf Airport code is not present \"---\" will be returned."
maximum: 1
type: string
minLength: 3
maxLength: 3
SortCode:
- description: "Sort Code for destination/pickup facility. \nExample: V1"
+ description: "Sort Code for destination/pickup facility.\nExample: V1"
maximum: 1
type: string
minLength: 2
@@ -3232,9 +3232,9 @@ components:
- DayOfWeek
properties:
DayOfWeek:
- type: array
- items:
- "$ref": "#/components/schemas/PickupFacilities_FacilityTime_DayOfWeek"
+ type: array
+ items:
+ $ref: "#/components/schemas/PickupFacilities_FacilityTime_DayOfWeek"
xml:
name: FacilityTime
description: Facility Time Container
@@ -3308,7 +3308,7 @@ components:
- PickupPendingStatusRequest
properties:
PickupPendingStatusRequest:
- "$ref": "#/components/schemas/PickupPendingStatusRequest"
+ $ref: "#/components/schemas/PickupPendingStatusRequest"
PICKUPPendingResponseWrapper:
xml:
name: PickupPendingStatusResponse
@@ -3319,7 +3319,7 @@ components:
- PickupPendingStatusResponse
properties:
PickupPendingStatusResponse:
- "$ref": "#/components/schemas/PickupPendingStatusResponse"
+ $ref: "#/components/schemas/PickupPendingStatusResponse"
PickupPendingStatusRequest:
type: object
required:
@@ -3328,7 +3328,7 @@ components:
- AccountNumber
properties:
Request:
- "$ref": "#/components/schemas/PickupPendingStatusRequest_Request"
+ $ref: "#/components/schemas/PickupPendingStatusRequest_Request"
PickupType:
description: |-
Specify the type of pending pickup.
@@ -3351,7 +3351,7 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Common element for all services.
@@ -3363,13 +3363,13 @@ components:
- PendingStatus
properties:
Response:
- "$ref": "#/components/schemas/PickupPendingStatusResponse_Response"
+ $ref: "#/components/schemas/PickupPendingStatusResponse_Response"
PendingStatus:
oneOf:
- items:
- "$ref": "#/components/schemas/PickupPendingStatusResponse_PendingStatus"
+ $ref: "#/components/schemas/PickupPendingStatusResponse_PendingStatus"
type: array
- - "$ref": "#/components/schemas/PickupPendingStatusResponse_PendingStatus"
+ - $ref: "#/components/schemas/PickupPendingStatusResponse_PendingStatus"
xml:
name: PickupPendingStatusResponse
description: The response of the pending status for on-callpickup.
@@ -3380,13 +3380,13 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
- type: array
- items:
- "$ref": "#/components/schemas/Response_Alert"
+ type: array
+ items:
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -3484,7 +3484,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -3493,7 +3493,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/PreNotification.yaml b/PreNotification.yaml
index a3e22cc..04ceccb 100644
--- a/PreNotification.yaml
+++ b/PreNotification.yaml
@@ -3,9 +3,9 @@ info:
title: PreNotification
version: ''
description: |
-
+
The Pre-Notification API allows customer applications to inform UPS operations of Dangerous Goods shipments as they are processed and will enter the UPS transportation network prior to an upload of manifest information at the end of the day.
-
+
# Reference
- Business Rules
- Errors
@@ -13,9 +13,9 @@ info:
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -70,7 +70,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper"
+ $ref: "#/components/schemas/PRENOTIFICATIONRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -140,31 +140,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper"
+ $ref: "#/components/schemas/PRENOTIFICATIONResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/dangerousgoods/{deprecatedVersion}/prenotification":
post:
deprecated: true
@@ -213,7 +213,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper"
+ $ref: "#/components/schemas/PRENOTIFICATIONRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -283,31 +283,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper"
+ $ref: "#/components/schemas/PRENOTIFICATIONResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -335,7 +335,7 @@ components:
- PreNotificationRequest
properties:
PreNotificationRequest:
- "$ref": "#/components/schemas/PreNotificationRequest"
+ $ref: "#/components/schemas/PreNotificationRequest"
PRENOTIFICATIONResponseWrapper:
xml:
name: PreNotificationResponse
@@ -346,7 +346,7 @@ components:
- PreNotificationResponse
properties:
PreNotificationResponse:
- "$ref": "#/components/schemas/PreNotificationResponse"
+ $ref: "#/components/schemas/PreNotificationResponse"
PreNotificationRequest:
type: object
required:
@@ -354,9 +354,9 @@ components:
- Shipment
properties:
Request:
- "$ref": "#/components/schemas/PreNotificationRequest_Request"
+ $ref: "#/components/schemas/PreNotificationRequest_Request"
Shipment:
- "$ref": "#/components/schemas/PreNotificationRequest_Shipment"
+ $ref: "#/components/schemas/PreNotificationRequest_Shipment"
xml:
name: PreNotificationRequest
description: Pre-Notification Request.
@@ -365,7 +365,7 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Request Container
@@ -411,9 +411,9 @@ components:
minLength: 18
maxLength: 18
ShipToAddress:
- "$ref": "#/components/schemas/Shipment_ShipToAddress"
+ $ref: "#/components/schemas/Shipment_ShipToAddress"
ShipFromAddress:
- "$ref": "#/components/schemas/Shipment_ShipFromAddress"
+ $ref: "#/components/schemas/Shipment_ShipFromAddress"
PickupDate:
description: Date of the On Call Air Pickup. Format is YYYYMMDD
maximum: 1
@@ -421,7 +421,7 @@ components:
minLength: 8
maxLength: 8
Service:
- "$ref": "#/components/schemas/Shipment_Service"
+ $ref: "#/components/schemas/Shipment_Service"
RegulationSet:
description: |
The Regulatory set associated with every regulated shipment. It must be same across the shipment. Valid values are:
@@ -436,7 +436,7 @@ components:
type: array
maximum: 1000
items:
- "$ref": "#/components/schemas/Shipment_Package"
+ $ref: "#/components/schemas/Shipment_Package"
xml:
name: Shipment
description: Shipment Container
@@ -563,11 +563,11 @@ components:
minLength: 18
maxLength: 18
PackageWeight:
- "$ref": "#/components/schemas/Package_PackageWeight"
+ $ref: "#/components/schemas/Package_PackageWeight"
TransportationMode:
description: 'Declares that a package was prepared according to ground,
passenger aircraft, or cargo aircraft only. Only required when the CommodityRegulatedLevelCode
- is FR or LQ. Valid entries include: GND, CAO, PAX.'
+ is FR or LQ. Valid entries include: GND, CAO, PAX.'
maximum: 1
type: string
minLength: 3
@@ -587,7 +587,7 @@ components:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/Package_ChemicalRecord"
+ $ref: "#/components/schemas/Package_ChemicalRecord"
xml:
name: Package
description: Package Information container.
@@ -598,7 +598,7 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/PackageWeight_UnitOfMeasurement"
Weight:
description: Packages weight.
maximum: 1
@@ -616,7 +616,7 @@ components:
- Code
properties:
Code:
- description: "Package weight unit of measurement code. \nCodes are: \nLBS
+ description: "Package weight unit of measurement code.\nCodes are:\nLBS
= Pounds\nKGS = Kilograms"
maximum: 1
type: string
@@ -636,7 +636,7 @@ components:
maximum: 1
properties:
ReportableQuantity:
- description: Indicates whether or not a material being transported meets the definition of a hazardous material and meets or exceeds a reportable quantity threshold. If reportable quantity is met, "RQ" should be entered. Any other value will be interpreted as "Non Reportable" quantity.
+ description: Indicates whether or not a material being transported meets the definition of a hazardous material and meets or exceeds a reportable quantity threshold. If reportable quantity is met, "RQ" should be entered. Any other value will be interpreted as "Non Reportable" quantity.
maximum: 1
type: string
minLength: 1
@@ -654,7 +654,7 @@ components:
minLength: 7
maxLength: 7
IDNumber:
- description: This is the ID number (UN/NA/ID) for the specified commodity. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).
+ description: This is the ID number (UN/NA/ID) for the specified commodity. UN/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
@@ -694,7 +694,7 @@ components:
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 the layout is country code, area code, number. The following are restricted in the phone number
+ For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries the layout is country code, area code, number. The following are restricted in the phone number
period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT" The following are restricted in the phone number
period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT"
maximum: 1
@@ -738,7 +738,7 @@ components:
minLength: 50
maxLength: 50
PackagingTypeQuantity:
- description: The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
+ 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
@@ -789,7 +789,7 @@ components:
- Response
properties:
Response:
- "$ref": "#/components/schemas/PreNotificationResponse_Response"
+ $ref: "#/components/schemas/PreNotificationResponse_Response"
xml:
name: PreNotificationResponse
description: Pre-Notification Response container.
@@ -800,17 +800,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and description.
+ Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Contains Pre-Notification response components.
@@ -879,7 +879,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -888,7 +888,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/QuantumView.yaml b/QuantumView.yaml
index 5c0f579..50343e1 100644
--- a/QuantumView.yaml
+++ b/QuantumView.yaml
@@ -3,7 +3,7 @@ info:
title: Quantum View
version: ''
description: |
-
+
UPS Quantum View is a suite of services that gives you and your customers details regarding UPS shipments.
# Reference
- Business Rules
@@ -14,9 +14,9 @@ info:
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -54,7 +54,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper"
+ $ref: "#/components/schemas/QUANTUMVIEWRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -75,31 +75,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper"
+ $ref: "#/components/schemas/QUANTUMVIEWResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/quantumview/{deprecatedVersion}/events":
post:
deprecated: true
@@ -131,7 +131,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper"
+ $ref: "#/components/schemas/QUANTUMVIEWRequestWrapper"
examples:
json:
summary: A sample JSON request (Standard Example)
@@ -152,31 +152,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper"
+ $ref: "#/components/schemas/QUANTUMVIEWResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -204,7 +204,7 @@ components:
- QuantumViewRequest
properties:
QuantumViewRequest:
- "$ref": "#/components/schemas/QuantumViewRequest"
+ $ref: "#/components/schemas/QuantumViewRequest"
QUANTUMVIEWResponseWrapper:
xml:
name: QuantumViewResponse
@@ -215,22 +215,22 @@ components:
- QuantumViewResponse
properties:
QuantumViewResponse:
- "$ref": "#/components/schemas/QuantumViewResponse"
+ $ref: "#/components/schemas/QuantumViewResponse"
QuantumViewRequest:
type: object
required:
- Request
properties:
Request:
- "$ref": "#/components/schemas/QuantumViewRequest_Request"
+ $ref: "#/components/schemas/QuantumViewRequest_Request"
SubscriptionRequest:
type: array
items:
- "$ref": "#/components/schemas/QuantumViewRequest_SubscriptionRequest"
+ $ref: "#/components/schemas/QuantumViewRequest_SubscriptionRequest"
Bookmark:
description: "Bookmarks the file for next retrieval. It is a base64Encoded
- String. \nIt contains the combination of SubscriberID + SubscriptionName
- + File Name if the request is for all data. \nIt contains SubscriberID
+ String.\nIt contains the combination of SubscriberID + SubscriptionName
+ + File Name if the request is for all data.\nIt contains SubscriberID
\ if the request is for unread data. When a response comes back with a
bookmark it indicates that there is more data. To fetch the remaining
data, the requester should come back with the bookmark added to the original
@@ -245,7 +245,7 @@ components:
type: object
properties:
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
RequestAction:
description: Indicates the action to be taken by the XML service. The only
valid value is 'QVEvents'
@@ -282,7 +282,7 @@ components:
type: string
maxLength: 21
DateTimeRange:
- "$ref": "#/components/schemas/SubscriptionRequest_DateTimeRange"
+ $ref: "#/components/schemas/SubscriptionRequest_DateTimeRange"
FileName:
description: 'File name of specific subscription requested by user. Format:
YYMMDD_HHmmssnnn. (nnn - sequence number: usually = 001)'
@@ -308,7 +308,7 @@ components:
maxLength: 14
EndDateTime:
description: 'Ending date time for the retrieval criteria of the subscriptions.
- Format: YYYYMMDDHHmmss. When a null or empty EndDateTime is passed in
+ Format: YYYYMMDDHHmmss. When a null or empty EndDateTime is passed in
the request, it is defaulted to 7 days from the given begin date.'
maximum: 1
type: string
@@ -326,9 +326,9 @@ components:
- QuantumViewEvents
properties:
Response:
- "$ref": "#/components/schemas/QuantumViewResponse_Response"
+ $ref: "#/components/schemas/QuantumViewResponse_Response"
QuantumViewEvents:
- "$ref": "#/components/schemas/QuantumViewResponse_QuantumViewEvents"
+ $ref: "#/components/schemas/QuantumViewResponse_QuantumViewEvents"
Bookmark:
description: Bookmarks the file for next retrieval, It is a base64Encoded
String. It contains the combination of SubscriberID + SubscriptionName
@@ -348,9 +348,9 @@ components:
- ResponseStatusCode
properties:
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
ResponseStatusCode:
- description: "Identifies the success or failure of the interchange. \n1
+ description: "Identifies the success or failure of the interchange.\n1
= Success, 0 = Failure"
maximum: 1
type: string
@@ -369,7 +369,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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_Error"
+ $ref: "#/components/schemas/Response_Error"
xml:
name: Response
maximum: 1
@@ -389,7 +389,7 @@ components:
minLength: 6
maxLength: 6
ToolVersion:
- description: "Current tool version. \nValid value: 1.0"
+ description: "Current tool version.\nValid value: 1.0"
maximum: 1
type: string
minLength: 3
@@ -432,7 +432,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/Error_ErrorLocation"
+ $ref: "#/components/schemas/Error_ErrorLocation"
ErrorDigest:
description: |
The contents of the element in error.
@@ -486,7 +486,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/QuantumViewEvents_SubscriptionEvents"
+ $ref: "#/components/schemas/QuantumViewEvents_SubscriptionEvents"
xml:
name: QuantumViewEvents
description: The event that a user receives echoing Subscriber ID and information
@@ -510,9 +510,9 @@ components:
minLength: 1
maxLength: 16
SubscriptionStatus:
- "$ref": "#/components/schemas/SubscriptionEvents_SubscriptionStatus"
+ $ref: "#/components/schemas/SubscriptionEvents_SubscriptionStatus"
DateRange:
- "$ref": "#/components/schemas/SubscriptionEvents_DateRange"
+ $ref: "#/components/schemas/SubscriptionEvents_DateRange"
SubscriptionFile:
description: |
Container holds all of the unread files associated with the subscription.
@@ -520,7 +520,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SubscriptionEvents_SubscriptionFile"
+ $ref: "#/components/schemas/SubscriptionEvents_SubscriptionFile"
xml:
name: SubscriptionEvents
required:
@@ -545,7 +545,7 @@ components:
minLength: 1
maxLength: 2
Description:
- description: "Description of a subscription. \nValid values: \n- Unknown
+ description: "Description of a subscription.\nValid values:\n- Unknown
(Unknown subscription status)\n- Activate (Ready for the user to activate
the subscription)\n- Pending (In the process of waiting for privilege
requests authorization)\n- Active (The subscription is in good standing
@@ -601,7 +601,7 @@ components:
minLength: 16
maxLength: 16
StatusType:
- "$ref": "#/components/schemas/SubscriptionFile_StatusType"
+ $ref: "#/components/schemas/SubscriptionFile_StatusType"
Manifest:
description: |
Container represents all data that is relevant for the shipment, such as origin, destination, shipper, payment method etc. It will be returned when available.
@@ -609,7 +609,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SubscriptionFile_Manifest"
+ $ref: "#/components/schemas/SubscriptionFile_Manifest"
Origin:
description: |
Information about shipment's origin.
@@ -617,7 +617,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SubscriptionFile_Origin"
+ $ref: "#/components/schemas/SubscriptionFile_Origin"
Exception:
description: |
Shipment exception data.
@@ -625,7 +625,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SubscriptionFile_Exception"
+ $ref: "#/components/schemas/SubscriptionFile_Exception"
Delivery:
description: |
Container for delivery information.
@@ -633,7 +633,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SubscriptionFile_Delivery"
+ $ref: "#/components/schemas/SubscriptionFile_Delivery"
Generic:
description: |
Container for generic record information.
@@ -641,7 +641,7 @@ components:
**NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, 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/SubscriptionFile_Generic"
+ $ref: "#/components/schemas/SubscriptionFile_Generic"
xml:
name: SubscriptionFile
SubscriptionFile_StatusType:
@@ -678,9 +678,9 @@ components:
- CollectBillIndicator
properties:
Shipper:
- "$ref": "#/components/schemas/Manifest_Shipper"
+ $ref: "#/components/schemas/Manifest_Shipper"
ShipTo:
- "$ref": "#/components/schemas/Manifest_ShipTo"
+ $ref: "#/components/schemas/Manifest_ShipTo"
ReferenceNumber:
description: |
Shipment-level reference numbers.
@@ -688,9 +688,9 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Manifest_ReferenceNumber"
+ $ref: "#/components/schemas/Manifest_ReferenceNumber"
Service:
- "$ref": "#/components/schemas/Manifest_Service"
+ $ref: "#/components/schemas/Manifest_Service"
PickupDate:
description: Should be set equal to the date on while the packages were
picked up (may be prior days date if the transmission occurs after midnight).
@@ -730,9 +730,9 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Manifest_Package"
+ $ref: "#/components/schemas/Manifest_Package"
ShipmentServiceOptions:
- "$ref": "#/components/schemas/Manifest_ShipmentServiceOptions"
+ $ref: "#/components/schemas/Manifest_ShipmentServiceOptions"
ManufactureCountry:
description: Country or Territory of Manufacture of the contents of the
package.
@@ -747,7 +747,7 @@ components:
minLength: 1
maxLength: 35
CustomsValue:
- "$ref": "#/components/schemas/Manifest_CustomsValue"
+ $ref: "#/components/schemas/Manifest_CustomsValue"
SpecialInstructions:
description: User-defined special instructions for delivery.
maximum: 1
@@ -772,7 +772,7 @@ components:
minLength: 3
maxLength: 3
BillToAccount:
- "$ref": "#/components/schemas/Manifest_BillToAccount"
+ $ref: "#/components/schemas/Manifest_BillToAccount"
ConsigneeBillIndicator:
description: Indicates if consignee will be billed the shipment.
maximum: 1
@@ -885,7 +885,7 @@ components:
minLength: 1
maxLength: 1
UAPAddress:
- "$ref": "#/components/schemas/Manifest_UAPAddress"
+ $ref: "#/components/schemas/Manifest_UAPAddress"
DeliverToAddresseeOnlyIndicator:
description: '"Y" Indicates Shipment is Deliver to Addressee.'
maximum: 1
@@ -1058,7 +1058,7 @@ components:
minLength: 1
maxLength: 50
Address:
- "$ref": "#/components/schemas/Shipper_Address"
+ $ref: "#/components/schemas/Shipper_Address"
xml:
name: Shipper
description: Shipper's record for a shipment.
@@ -1097,8 +1097,7 @@ components:
minLength: 1
maxLength: 5
PostalCode:
- description: |
- Shipper's postal code. If the address is US then 5 or 9 digits are required. CA addresses must provide a 6 character postal code that has the format of A#A#A#, where A is a alphabetic character and # is numeric digit. Otherwise, 1 to 9 alphanumeric characters are allowed.
+ description: "Shipper's postal code. If the address is US then 5 or 9 digits are required. CA addresses must provide a 6 character postal code that has the format of A#A#A#, where A is a alphabetic character and # is numeric digit. Otherwise, 1 to 9 alphanumeric characters are allowed."
maximum: 1
type: string
minLength: 1
@@ -1170,7 +1169,7 @@ components:
minLength: 1
maxLength: 50
Address:
- "$ref": "#/components/schemas/ShipTo_Address"
+ $ref: "#/components/schemas/ShipTo_Address"
LocationID:
description: Location name that the package is shipped to.
maximum: 1
@@ -1228,8 +1227,7 @@ components:
minLength: 1
maxLength: 5
PostalCode:
- description: |
- Consignee's postal code. If the address is US then 5 or 9 digits are required. CA addresses must provide a 6 character postal code that has the format of A#A#A#, where A is a alphabetic character and # is numeric digit. Otherwise, 1 to 9 alphanumeric characters are allowed.
+ description: Consignee's postal code. If the address is US then 5 or 9 digits are required. CA addresses must provide a 6 character postal code that has the format of A#A#A#, where A is a alphabetic character and # is numeric digit. Otherwise, 1 to 9 alphanumeric characters are allowed.
maximum: 1
type: string
minLength: 1
@@ -1302,7 +1300,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Package_Activity"
+ $ref: "#/components/schemas/Package_Activity"
Description:
description: Description of package merchandise.
maximum: 1
@@ -1310,11 +1308,11 @@ components:
minLength: 1
maxLength: 120
Dimensions:
- "$ref": "#/components/schemas/Package_Dimensions"
+ $ref: "#/components/schemas/Package_Dimensions"
DimensionalWeight:
- "$ref": "#/components/schemas/Package_DimensionalWeight"
+ $ref: "#/components/schemas/Package_DimensionalWeight"
PackageWeight:
- "$ref": "#/components/schemas/Package_PackageWeight"
+ $ref: "#/components/schemas/Package_PackageWeight"
LargePackage:
description: |
Values for LargePackage are:
@@ -1338,9 +1336,9 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Package_ReferenceNumber"
+ $ref: "#/components/schemas/Package_ReferenceNumber"
PackageServiceOptions:
- "$ref": "#/components/schemas/Package_PackageServiceOptions"
+ $ref: "#/components/schemas/Package_PackageServiceOptions"
UPSPremiumCareIndicator:
description: Presence of the tag indicates UPSPremiumCare applies to this
package
@@ -1377,7 +1375,7 @@ components:
- Width
properties:
Length:
- description: "Package length. \nValid values: 0 to 108 IN and 0 to 270 CM"
+ description: "Package length.\nValid values: 0 to 108 IN and 0 to 270 CM"
maximum: 1
type: string
minLength: 3
@@ -1396,7 +1394,7 @@ components:
maxLength: 9
xml:
name: Dimensions
- description: "Container tag for package dimension information. \nLength + 2
+ description: "Container tag for package dimension information.\nLength + 2
* (Width + Height) must be less than or equal to 130 IN or 330 CM."
Package_DimensionalWeight:
type: object
@@ -1405,7 +1403,7 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/DimensionalWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/DimensionalWeight_UnitOfMeasurement"
Weight:
description: The value of package dimensional weight. A value of zero should
be used for letters.
@@ -1486,7 +1484,7 @@ components:
type: string
Code:
description: "Reference number type code for entire shipment, two-character
- alphanumeric. \nThe code specifies the Reference name. \nValid if the
+ alphanumeric.\nThe code specifies the Reference name.\nValid if the
origin/destination pair is US/US or PR/PR.\nFor additional information,
refer to the Reference Codes table in the Appendix."
maximum: 1
@@ -1509,9 +1507,9 @@ components:
type: object
properties:
COD:
- "$ref": "#/components/schemas/PackageServiceOptions_COD"
+ $ref: "#/components/schemas/PackageServiceOptions_COD"
InsuredValue:
- "$ref": "#/components/schemas/PackageServiceOptions_InsuredValue"
+ $ref: "#/components/schemas/PackageServiceOptions_InsuredValue"
EarliestDeliveryTime:
description: Earliest delivery time. Time format is HHMMSS.
maximum: 1
@@ -1557,7 +1555,7 @@ components:
3 - Tagless COD
type: string
CODAmount:
- "$ref": "#/components/schemas/COD_CODAmount"
+ $ref: "#/components/schemas/COD_CODAmount"
xml:
name: COD
description: Container for cash on delivery (COD) information.
@@ -1636,7 +1634,7 @@ components:
maximum: 1
type: string
CallTagARS:
- "$ref": "#/components/schemas/ShipmentServiceOptions_CallTagARS"
+ $ref: "#/components/schemas/ShipmentServiceOptions_CallTagARS"
xml:
name: ShipmentServiceOptions
description: Container tag for optional UPS services related to a shipment.
@@ -1652,7 +1650,7 @@ components:
minLength: 12
maxLength: 12
Code:
- description: "The type of Call Tag service. \nValid values:\n00 - No return
+ description: "The type of Call Tag service.\nValid values:\n00 - No return
service\n01 - UPS Call Tag Service\n02 - UPS Print and Mail\n03 - 1 UPS
Pickup Attempt\n04 - UPS Print Return Label\n05 - Online Call Tag (3 UPS
Pickup Attempts)\n06 - UPS Electronic Return Label\n08 - UPS Returns on
@@ -1726,7 +1724,7 @@ components:
minLength: 1
maxLength: 35
Address:
- "$ref": "#/components/schemas/UAPAddress_Address"
+ $ref: "#/components/schemas/UAPAddress_Address"
PhoneNumber:
description: UPS Access Point's Phone Number. US Phone numbers must be 10
digits. No formatting is allowed. Required if origin and destination countries
@@ -1807,7 +1805,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Origin_PackageReferenceNumber"
+ $ref: "#/components/schemas/Origin_PackageReferenceNumber"
ShipmentReferenceNumber:
description: |
Container tag for shipment reference number.
@@ -1815,7 +1813,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Origin_ShipmentReferenceNumber"
+ $ref: "#/components/schemas/Origin_ShipmentReferenceNumber"
ShipperNumber:
description: Shipper's six digit alphanumeric account number.
maximum: 1
@@ -1843,9 +1841,9 @@ components:
minLength: 6
maxLength: 6
ActivityLocation:
- "$ref": "#/components/schemas/Origin_ActivityLocation"
+ $ref: "#/components/schemas/Origin_ActivityLocation"
BillToAccount:
- "$ref": "#/components/schemas/Origin_BillToAccount"
+ $ref: "#/components/schemas/Origin_BillToAccount"
ScheduledDeliveryDate:
description: Scheduled delivery date for destination address. Date format
is YYYYMMDD.
@@ -1942,7 +1940,7 @@ components:
- AddressArtifactFormat
properties:
AddressArtifactFormat:
- "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat"
+ $ref: "#/components/schemas/ActivityLocation_AddressArtifactFormat"
xml:
name: ActivityLocation
description: Geographic location where an activity occurred during a movement
@@ -2016,7 +2014,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Exception_PackageReferenceNumber"
+ $ref: "#/components/schemas/Exception_PackageReferenceNumber"
ShipmentReferenceNumber:
description: |
Container tag for shipment reference number.
@@ -2024,7 +2022,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Exception_ShipmentReferenceNumber"
+ $ref: "#/components/schemas/Exception_ShipmentReferenceNumber"
ShipperNumber:
description: Shipper's six digit alphanumeric account number.
maximum: 1
@@ -2050,7 +2048,7 @@ components:
minLength: 6
maxLength: 6
UpdatedAddress:
- "$ref": "#/components/schemas/Exception_UpdatedAddress"
+ $ref: "#/components/schemas/Exception_UpdatedAddress"
StatusCode:
description: Code for status of updating shipping address issue.
maximum: 1
@@ -2076,7 +2074,7 @@ components:
minLength: 1
maxLength: 40
Resolution:
- "$ref": "#/components/schemas/Exception_Resolution"
+ $ref: "#/components/schemas/Exception_Resolution"
RescheduledDeliveryDate:
description: Rescheduled delivery date for updated shipping address. Date
format is YYYYMMDD.
@@ -2092,9 +2090,9 @@ components:
minLength: 6
maxLength: 6
ActivityLocation:
- "$ref": "#/components/schemas/Exception_ActivityLocation"
+ $ref: "#/components/schemas/Exception_ActivityLocation"
BillToAccount:
- "$ref": "#/components/schemas/Exception_BillToAccount"
+ $ref: "#/components/schemas/Exception_BillToAccount"
AccessPointLocationID:
description: The UPS Access Point Location ID.
maximum: 1
@@ -2229,7 +2227,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/UpdatedAddress_AddressExtendedInformation"
+ $ref: "#/components/schemas/UpdatedAddress_AddressExtendedInformation"
PoliticalDivision3:
description: The neighborhood, town, barrio etc. It will be returned if
there is any update due to exception.
@@ -2319,7 +2317,7 @@ components:
- AddressArtifactFormat
properties:
AddressArtifactFormat:
- "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat"
+ $ref: "#/components/schemas/ActivityLocation_AddressArtifactFormat"
xml:
name: ActivityLocation
description: Geographic location where an activity occurred during a movement
@@ -2368,7 +2366,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Delivery_PackageReferenceNumber"
+ $ref: "#/components/schemas/Delivery_PackageReferenceNumber"
ShipmentReferenceNumber:
description: |
Container tag for shipment reference number.
@@ -2376,7 +2374,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Delivery_ShipmentReferenceNumber"
+ $ref: "#/components/schemas/Delivery_ShipmentReferenceNumber"
ShipperNumber:
description: Shipper's six digit alphanumeric account number.
maximum: 1
@@ -2408,13 +2406,13 @@ components:
minLength: 1
maxLength: 40
ActivityLocation:
- "$ref": "#/components/schemas/Delivery_ActivityLocation"
+ $ref: "#/components/schemas/Delivery_ActivityLocation"
DeliveryLocation:
- "$ref": "#/components/schemas/Delivery_DeliveryLocation"
+ $ref: "#/components/schemas/Delivery_DeliveryLocation"
COD:
- "$ref": "#/components/schemas/Delivery_COD"
+ $ref: "#/components/schemas/Delivery_COD"
BillToAccount:
- "$ref": "#/components/schemas/Delivery_BillToAccount"
+ $ref: "#/components/schemas/Delivery_BillToAccount"
LastPickupDate:
description: Last pickup by Date from the UPS Access Point Location.
maximum: 1
@@ -2507,7 +2505,7 @@ components:
- AddressArtifactFormat
properties:
AddressArtifactFormat:
- "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat"
+ $ref: "#/components/schemas/ActivityLocation_AddressArtifactFormat"
xml:
name: ActivityLocation
description: Geographic location where an activity occurred during a movement
@@ -2522,7 +2520,7 @@ components:
- AddressArtifactFormat
properties:
AddressArtifactFormat:
- "$ref": "#/components/schemas/DeliveryLocation_AddressArtifactFormat"
+ $ref: "#/components/schemas/DeliveryLocation_AddressArtifactFormat"
Code:
description: Location Code for delivered package.
maximum: 1
@@ -2598,7 +2596,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/AddressArtifactFormat_AddressExtendedInformation"
+ $ref: "#/components/schemas/AddressArtifactFormat_AddressExtendedInformation"
PoliticalDivision3:
description: The neighborhood, town, barrio etc.
maximum: 1
@@ -2672,7 +2670,7 @@ components:
type: object
properties:
CODAmount:
- "$ref": "#/components/schemas/COD_CODAmount"
+ $ref: "#/components/schemas/COD_CODAmount"
xml:
name: COD
description: Container for cash on delivery (COD) information.
@@ -2754,7 +2752,7 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Generic_ShipmentReferenceNumber"
+ $ref: "#/components/schemas/Generic_ShipmentReferenceNumber"
PackageReferenceNumber:
description: |
Package-level reference number.
@@ -2762,15 +2760,15 @@ components:
**NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, 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/Generic_PackageReferenceNumber"
+ $ref: "#/components/schemas/Generic_PackageReferenceNumber"
Service:
- "$ref": "#/components/schemas/Generic_Service"
+ $ref: "#/components/schemas/Generic_Service"
Activity:
- "$ref": "#/components/schemas/Generic_Activity"
+ $ref: "#/components/schemas/Generic_Activity"
BillToAccount:
- "$ref": "#/components/schemas/Generic_BillToAccount"
+ $ref: "#/components/schemas/Generic_BillToAccount"
ShipTo:
- "$ref": "#/components/schemas/Generic_ShipTo"
+ $ref: "#/components/schemas/Generic_ShipTo"
RescheduledDeliveryDate:
description: |
If Activity Type is "DS" or "UD", this element will contain Rescheduled Delivery Date. Format will be YYYYMMDD.
@@ -2783,7 +2781,7 @@ components:
minLength: 1
maxLength: 8
FailureNotification:
- "$ref": "#/components/schemas/Generic_FailureNotification"
+ $ref: "#/components/schemas/Generic_FailureNotification"
xml:
name: Generic
Generic_ShipmentReferenceNumber:
@@ -2896,8 +2894,8 @@ components:
properties:
Option:
description: "Indicates how shipping charges for the package were billed.
- \nValid Values: 01, 02, 03, 04, 99 \nValue Definitions: \n01 Shipper\n02
- Consignee Billing \n03 Third Party\n04 Freight Collect\n99 International
+ \nValid Values: 01, 02, 03, 04, 99\nValue Definitions:\n01 Shipper\n02
+ Consignee Billing\n03 Third Party\n04 Freight Collect\n99 International
Bill Option"
maximum: 1
type: string
@@ -2950,7 +2948,7 @@ components:
minLength: 1
maxLength: 50
FailureNotificationCode:
- "$ref": "#/components/schemas/FailureNotification_FailureNotificationCode"
+ $ref: "#/components/schemas/FailureNotification_FailureNotificationCode"
xml:
name: FailureNotification
description: Failure notification information containing email address and Notification
@@ -2981,7 +2979,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -2990,7 +2988,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/Rating.yaml b/Rating.yaml
index a2c30e4..0a8ed30 100644
--- a/Rating.yaml
+++ b/Rating.yaml
@@ -4,7 +4,7 @@ info:
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
-
+
The Rating API is used when rating or shopping a shipment.
# Reference
- Business Rules
@@ -16,9 +16,9 @@ info:
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -92,7 +92,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/RATERequestWrapper"
+ $ref: "#/components/schemas/RATERequestWrapper"
examples:
'1':
summary: Simple Rate Example (Standard Example)
@@ -772,31 +772,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/RATEResponseWrapper"
+ $ref: "#/components/schemas/RATEResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
"/rating/{deprecatedVersion}/{requestoption}":
post:
deprecated: true
@@ -870,7 +870,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/RATERequestWrapper"
+ $ref: "#/components/schemas/RATERequestWrapper"
examples:
'1':
summary: Simple Rate Example (Standard Example)
@@ -1550,31 +1550,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/RATEResponseWrapper"
+ $ref: "#/components/schemas/RATEResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -1602,7 +1602,7 @@ components:
- RateRequest
properties:
RateRequest:
- "$ref": "#/components/schemas/RateRequest"
+ $ref: "#/components/schemas/RateRequest"
RATEResponseWrapper:
xml:
name: RateResponse
@@ -1613,7 +1613,7 @@ components:
- RateResponse
properties:
RateResponse:
- "$ref": "#/components/schemas/RateResponse"
+ $ref: "#/components/schemas/RateResponse"
RateRequest:
type: object
required:
@@ -1621,13 +1621,13 @@ components:
- Shipment
properties:
Request:
- "$ref": "#/components/schemas/RateRequest_Request"
+ $ref: "#/components/schemas/RateRequest_Request"
PickupType:
- "$ref": "#/components/schemas/RateRequest_PickupType"
+ $ref: "#/components/schemas/RateRequest_PickupType"
CustomerClassification:
- "$ref": "#/components/schemas/RateRequest_CustomerClassification"
+ $ref: "#/components/schemas/RateRequest_CustomerClassification"
Shipment:
- "$ref": "#/components/schemas/RateRequest_Shipment"
+ $ref: "#/components/schemas/RateRequest_Shipment"
xml:
name: RateRequest
description: Rate Request container.
@@ -1659,11 +1659,11 @@ components:
minLength: 4
maxLength: 4
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
- description: Request container. N/A
+ description: Request container. N/A
Request_TransactionReference:
type: object
maximum: 1
@@ -1685,7 +1685,7 @@ components:
- Code
properties:
Code:
- description: 'Pickup Type Code. Valid values: 01 - Daily Pickup (Default
+ description: 'Pickup Type Code. Valid values: 01 - Daily Pickup (Default
- used when an invalid pickup type code is provided)03 - Customer Counter06
- One Time Pickup19 - Letter Center20 - Air Service CenterLength is not
validated. When negotiated rates are requested, 07 (onCallAir) will be
@@ -1696,7 +1696,7 @@ components:
minLength: 2
maxLength: 2
Description:
- description: Pickup Type Description. Ignored if provided in the Request.
+ description: Pickup Type Description. Ignored if provided in the Request.
maximum: 1
type: string
minLength: 1
@@ -1711,7 +1711,7 @@ components:
- Code
properties:
Code:
- description: Customer classification code. Valid values:00 - Rates Associated
+ description: Customer classification code. Valid values:00 - Rates Associated
with Shipper Number01 - Daily Rates04 - Retail Rates05 - Regional Rates06
- General List Rates53 - Standard List RatesLength is not validated.If
customer classification code is not a valid value please refer to Rate
@@ -1721,7 +1721,7 @@ components:
minLength: 2
maxLength: 2
Description:
- description: Customer classification description of the code above. Ignored
+ description: Customer classification description of the code above. Ignored
if provided in the Request. Length is not validated.
maximum: 1
type: string
@@ -1741,53 +1741,53 @@ components:
maximum: 1
type: string
Shipper:
- "$ref": "#/components/schemas/Shipment_Shipper"
+ $ref: "#/components/schemas/Shipment_Shipper"
ShipTo:
- "$ref": "#/components/schemas/Shipment_ShipTo"
+ $ref: "#/components/schemas/Shipment_ShipTo"
ShipFrom:
- "$ref": "#/components/schemas/Shipment_ShipFrom"
+ $ref: "#/components/schemas/Shipment_ShipFrom"
AlternateDeliveryAddress:
- "$ref": "#/components/schemas/Shipment_AlternateDeliveryAddress"
+ $ref: "#/components/schemas/Shipment_AlternateDeliveryAddress"
ShipmentIndicationType:
type: array
items:
- "$ref": "#/components/schemas/Shipment_ShipmentIndicationType"
+ $ref: "#/components/schemas/Shipment_ShipmentIndicationType"
PaymentDetails:
- "$ref": "#/components/schemas/Shipment_PaymentDetails"
+ $ref: "#/components/schemas/Shipment_PaymentDetails"
FRSPaymentInformation:
- "$ref": "#/components/schemas/Shipment_FRSPaymentInformation"
+ $ref: "#/components/schemas/Shipment_FRSPaymentInformation"
FreightShipmentInformation:
- "$ref": "#/components/schemas/Shipment_FreightShipmentInformation"
+ $ref: "#/components/schemas/Shipment_FreightShipmentInformation"
GoodsNotInFreeCirculationIndicator:
- description: Goods Not In Free Circulation indicator. This is an empty
+ description: Goods Not In Free Circulation indicator. This is an empty
tag, any value inside is ignored. This indicator is invalid for a package
type of UPS Letter and DocumentsOnly.
maximum: 1
type: string
Service:
- "$ref": "#/components/schemas/Shipment_Service"
+ $ref: "#/components/schemas/Shipment_Service"
NumOfPieces:
description: Total number of pieces in all pallets. Required for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
type: string
ShipmentTotalWeight:
- "$ref": "#/components/schemas/Shipment_ShipmentTotalWeight"
+ $ref: "#/components/schemas/Shipment_ShipmentTotalWeight"
DocumentsOnlyIndicator:
description: 'Valid values are Document and Non-document. If the indicator
is present then the value is Document else Non-Document. Note: Not applicable
- for FRS rating requests. Empty Tag.'
+ for FRS rating requests. Empty Tag.'
type: string
Package:
type: array
maximum: 200
items:
- "$ref": "#/components/schemas/Shipment_Package"
+ $ref: "#/components/schemas/Shipment_Package"
ShipmentServiceOptions:
- "$ref": "#/components/schemas/Shipment_ShipmentServiceOptions"
+ $ref: "#/components/schemas/Shipment_ShipmentServiceOptions"
ShipmentRatingOptions:
- "$ref": "#/components/schemas/Shipment_ShipmentRatingOptions"
+ $ref: "#/components/schemas/Shipment_ShipmentRatingOptions"
InvoiceLineTotal:
- "$ref": "#/components/schemas/Shipment_InvoiceLineTotal"
+ $ref: "#/components/schemas/Shipment_InvoiceLineTotal"
RatingMethodRequestedIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator
is an indicator. If present, Billable Weight Calculation method and Rating
@@ -1798,7 +1798,7 @@ components:
description: Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator
is an indicator. The Tax related information includes any type of Taxes,
corresponding Monetary Values, Total Charges with Taxes and disclaimers
- (if applicable) would be returned in response. If present, any taxes
+ (if applicable) would be returned in response. If present, any taxes
that may be applicable to a shipment would be returned in response. If
this indicator is requested with NegotiatedRatesIndicator, Tax related
information, if applicable, would be returned only for Negotiated Rates
@@ -1806,12 +1806,12 @@ components:
maximum: 1
type: string
PromotionalDiscountInformation:
- "$ref": "#/components/schemas/Shipment_PromotionalDiscountInformation"
+ $ref: "#/components/schemas/Shipment_PromotionalDiscountInformation"
DeliveryTimeInformation:
- "$ref": "#/components/schemas/Shipment_DeliveryTimeInformation"
+ $ref: "#/components/schemas/Shipment_DeliveryTimeInformation"
MasterCartonIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. MasterCartonIndicator
- is an indicator and presence implies that shipment is Master Carton type. If
+ is an indicator and presence implies that shipment is Master Carton type. If
present, the shipment will be rated as a Master Carton Type. If this indicator
is requested with NegotiatedRatesIndicator, rates would be returned only
for Negotiated Rates and not for Published Rates.
@@ -1836,19 +1836,19 @@ components:
maximum: 1
properties:
Name:
- description: Shipper's name or company name. Length is not validated.
+ description: Shipper's name or company name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
- description: Shipper's attention name. Length is not validated.
+ description: Shipper's attention name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
ShipperNumber:
- description: Shipper's UPS account number. A valid account number is required
+ description: Shipper's UPS account number. A valid account number is required
to receive negotiated rates. Optional otherwise. Cannot be present when
requesting UserLevelDiscount.
maximum: 1
@@ -1856,7 +1856,7 @@ components:
minLength: 6
maxLength: 6
Address:
- "$ref": "#/components/schemas/Shipper_Address"
+ $ref: "#/components/schemas/Shipper_Address"
xml:
name: Shipper
required:
@@ -1871,7 +1871,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: Shipper's street address including name and number (when applicable). Maximum Occurrence should be three. Length is not validated.
+ description: Shipper's street address including name and number (when applicable). Maximum Occurrence should be three. Length is not validated.
maximum: 3
type: array
items:
@@ -1879,19 +1879,19 @@ components:
minLength: 1
maxLength: 35
City:
- description: Shipper's city. Required if country or territory does not utilize postal codes. Length is not validated.
+ description: Shipper's city. Required if country or territory does not utilize postal codes. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
- description: Shipper's state code. Length is not validated.
+ description: Shipper's state code. Length is not validated.
maximum: 1
type: string
minLength: 2
maxLength: 2
PostalCode:
- description: Shipper's postal code. Length is not validated.
+ description: Shipper's postal code. Length is not validated.
maximum: 1
type: string
minLength: 1
@@ -1904,7 +1904,7 @@ components:
maxLength: 2
xml:
name: Address
- description: Address Container. If the ShipFrom container is not present then
+ description: Address Container. If the ShipFrom container is not present then
this address will be used as the ShipFrom. If this address is used as the
ShipFrom, the shipment will be rated from this origin address.
Shipment_ShipTo:
@@ -1912,20 +1912,20 @@ components:
maximum: 1
properties:
Name:
- description: Destination attention name or company name. Length is not
+ description: Destination attention name or company name. Length is not
validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
- description: Destination attention name. Length is not validated.
+ description: Destination attention name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
Address:
- "$ref": "#/components/schemas/ShipTo_Address"
+ $ref: "#/components/schemas/ShipTo_Address"
xml:
name: ShipTo
required:
@@ -1939,7 +1939,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: Destination street address including name and number (when applicable). Max Occurrence can be 3. Length is not validated.
+ description: Destination street address including name and number (when applicable). Max Occurrence can be 3. Length is not validated.
maximum: 3
type: array
items:
@@ -1947,7 +1947,7 @@ components:
minLength: 1
maxLength: 35
City:
- description: Destination city. Required if country or territory does not utilize postal codes. Length is not validated.
+ description: Destination city. Required if country or territory does not utilize postal codes. Length is not validated.
maximum: 1
type: string
minLength: 1
@@ -1959,7 +1959,7 @@ components:
minLength: 2
maxLength: 2
PostalCode:
- description: Destination postal code. Required if country or territory utilizes postal codes (i.e. US and PR).
+ description: Destination postal code. Required if country or territory utilizes postal codes (i.e. US and PR).
maximum: 1
type: string
minLength: 1
@@ -1985,19 +1985,19 @@ components:
maximum: 1
properties:
Name:
- description: Origin attention name or company name. Length is not validated.
+ description: Origin attention name or company name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
- description: Origin attention name. Length is not validated.
+ description: Origin attention name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
Address:
- "$ref": "#/components/schemas/ShipFrom_Address"
+ $ref: "#/components/schemas/ShipFrom_Address"
xml:
name: ShipFrom
required:
@@ -2011,7 +2011,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: The origin street address including name and number (when applicable). Length is not validated.
+ description: The origin street address including name and number (when applicable). Length is not validated.
maximum: 3
type: array
items:
@@ -2019,14 +2019,14 @@ components:
minLength: 1
maxLength: 35
City:
- description: Origin city. Required if country or territory does not utilize postal codes. Length is not validated.
+ description: Origin city. Required if country or territory does not utilize postal codes. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
- Origin state code. A StateProvinceCode and valid account number are required when requesting negotiated rates. Otherwise the StateProvinceCode is optional.
+ Origin state code. A StateProvinceCode and valid account number are required when requesting negotiated rates. Otherwise the StateProvinceCode is optional.
If the TaxInformationIndicator flag is present in the request, a StateProvinceCode must be entered for tax charges to be accurately calculated in the response.
maximum: 1
@@ -2034,20 +2034,20 @@ components:
minLength: 2
maxLength: 2
PostalCode:
- description: Origin postal code. Required if country or territory utilizes postal codes (e.g. US and PR).
+ description: Origin postal code. Required if country or territory utilizes postal codes (e.g. US and PR).
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
- description: Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix. Required, but defaults to US.
+ description: Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix. Required, but defaults to US.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
- description: Address container for Ship From. Address Container
+ description: Address container for Ship From. Address Container
Shipment_AlternateDeliveryAddress:
type: object
maximum: 1
@@ -2056,7 +2056,7 @@ components:
description: UPS Access Point location name.
type: string
Address:
- "$ref": "#/components/schemas/AlternateDeliveryAddress_Address"
+ $ref: "#/components/schemas/AlternateDeliveryAddress_Address"
xml:
name: AlternateDeliveryAddress
required:
@@ -2076,7 +2076,7 @@ components:
properties:
AddressLine:
description: The UPS Access Point's street address, including name and number
- (when applicable). Length is not validated.
+ (when applicable). Length is not validated.
maximum: 3
type: array
items:
@@ -2110,7 +2110,7 @@ components:
ResidentialAddressIndicator:
description: Presence/Absence Indicator. Any value inside is ignored.This
field is a flag to indicate if the Alternate Delivery location is a residential
- location. True if ResidentialAddressIndicator tag exists. For future
+ location. True if ResidentialAddressIndicator tag exists. For future
use.
maximum: 1
type: string
@@ -2120,7 +2120,7 @@ components:
This field is a flag to indicate if the Alternate Delivery location is a PO box location.
- True if POBoxIndicator tag exists; false otherwise. Not valid with Shipment Indication Types:
+ True if POBoxIndicator tag exists; false otherwise. Not valid with Shipment Indication Types:
- 01 - Hold for Pickup at UPS Access Point
- 02 - UPS Access Point™ Delivery
maximum: 1
@@ -2146,7 +2146,7 @@ components:
minLength: 2
maxLength: 2
Description:
- description: Description for Shipment Indication Type. Length is not Validated.
+ description: Description for Shipment Indication Type. Length is not Validated.
maximum: 1
type: string
minLength: 1
@@ -2163,12 +2163,12 @@ components:
type: array
maximum: 2
items:
- "$ref": "#/components/schemas/PaymentDetails_ShipmentCharge"
+ $ref: "#/components/schemas/PaymentDetails_ShipmentCharge"
SplitDutyVATIndicator:
description: Split Duty VAT Indicator. The presence indicates the payer
specified for Transportation Charges will pay transportation charges and
any duties that apply to the shipment. The payer specified for Duties
- and Taxes will pay the VAT (Value-Added Tax) only. Empty Tag. The payment
+ and Taxes will pay the VAT (Value-Added Tax) only. Empty Tag. The payment
method for Transportation charges must be UPS account. The UPS account
must be a daily pickup account or an occasional account.
maximum: 1
@@ -2178,7 +2178,7 @@ components:
maximum: 1
description: Payment details container for detailed shipment charges. The two
shipment charges that are available for specification are Transportation charges
- and Duties and Taxes. This container is used for Who Pays What functionality.
+ and Duties and Taxes. This container is used for Who Pays What functionality.
PaymentDetails_ShipmentCharge:
type: object
maximum: 1
@@ -2192,15 +2192,15 @@ components:
minLength: 2
maxLength: 2
BillShipper:
- "$ref": "#/components/schemas/ShipmentCharge_BillShipper"
+ $ref: "#/components/schemas/ShipmentCharge_BillShipper"
BillReceiver:
- "$ref": "#/components/schemas/ShipmentCharge_BillReceiver"
+ $ref: "#/components/schemas/ShipmentCharge_BillReceiver"
BillThirdParty:
- "$ref": "#/components/schemas/ShipmentCharge_BillThirdParty"
+ $ref: "#/components/schemas/ShipmentCharge_BillThirdParty"
ConsigneeBilledIndicator:
description: Consignee Billing payment option indicator. The presence indicates
consignee billing option is selected. The absence indicates one of the
- other payment options is selected. Empty Tag. This element or its sibling
+ other payment options is selected. Empty Tag. This element or its sibling
element, BillShipper, BillReceiver or BillThirdParty, must be present
but no more than one can be present. This billing option is valid for
a shipment charge type of Transportation only. Only applies to US/PR and
@@ -2209,7 +2209,7 @@ components:
type: string
xml:
name: ShipmentCharge
- description: Shipment charge container. If Duty and Tax charges are applicable
+ 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.
@@ -2228,7 +2228,7 @@ components:
maxLength: 6
xml:
name: BillShipper
- description: Container for the BillShipper billing option. This element or
+ description: Container for the BillShipper billing option. This element or
its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator,
must be present but no more than one can be present.
ShipmentCharge_BillReceiver:
@@ -2238,7 +2238,7 @@ components:
- AccountNumber
properties:
AccountNumber:
- description: The UPS account number. The account must be a valid UPS account
+ description: The UPS account number. The account must be a valid UPS account
number that is active. For US, PR and CA accounts, the account must be
a daily pickup account, an occasional account, a customer B.I.N account,
or a dropper shipper account. All other accounts must be either a daily
@@ -2249,10 +2249,10 @@ components:
minLength: 6
maxLength: 6
Address:
- "$ref": "#/components/schemas/BillReceiver_Address"
+ $ref: "#/components/schemas/BillReceiver_Address"
xml:
name: BillReceiver
- description: Container for the BillReceiver billing option. This element or
+ 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.
@@ -2279,7 +2279,7 @@ components:
- AccountNumber
properties:
AccountNumber:
- description: The UPS account number of the third party shipper. The account
+ description: The UPS account number of the third party shipper. The account
must be a valid UPS account number that is active. For US, PR and CA accounts,
the account must be either a daily pickup account, an occasional account,
or a customer B.I.N account, or a drop shipper account. All other accounts
@@ -2290,10 +2290,10 @@ components:
minLength: 6
maxLength: 6
Address:
- "$ref": "#/components/schemas/BillThirdParty_Address"
+ $ref: "#/components/schemas/BillThirdParty_Address"
xml:
name: BillThirdParty
- description: Container for the third party billing option. This element or
+ 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:
@@ -2353,7 +2353,7 @@ components:
- Type
properties:
Type:
- "$ref": "#/components/schemas/FRSPaymentInformation_Type"
+ $ref: "#/components/schemas/FRSPaymentInformation_Type"
AccountNumber:
description: UPS Account Number.
maximum: 1
@@ -2361,11 +2361,11 @@ components:
minLength: 6
maxLength: 6
Address:
- "$ref": "#/components/schemas/FRSPaymentInformation_Address"
+ $ref: "#/components/schemas/FRSPaymentInformation_Address"
xml:
name: FRSPaymentInformation
maximum: 1
- description: UPS Ground Freight Pricing (GFP) Payment Information container. Required
+ description: UPS Ground Freight Pricing (GFP) Payment Information container. Required
only for GFP and when the FRSIndicator is present.
FRSPaymentInformation_Type:
type: object
@@ -2388,20 +2388,20 @@ components:
maxLength: 35
xml:
name: Type
- description: GFP Payment Information Type container. GFP only.
+ description: GFP Payment Information Type container. GFP only.
FRSPaymentInformation_Address:
type: object
maximum: 1
properties:
PostalCode:
- description: Postal Code for UPS accounts billing address. Postal Code may
+ description: Postal Code for UPS accounts billing address. Postal Code may
be present when the FRS Payment Information type = 02 and type = 03.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
- description: Country or Territory code for the UPS accounts & billing address. Country
+ description: Country or Territory code for the UPS accounts & billing address. Country
or Territory Code is required when the FRS Payment Information type =
02 and type= 03.
maximum: 1
@@ -2412,14 +2412,14 @@ components:
name: Address
required:
- CountryCode
- description: Payer Address Container. Address container may be present for
+ description: Payer Address Container. Address container may be present for
FRS Payment Information type = 02 and required when the FRS Payment Information
type = 03.
Shipment_FreightShipmentInformation:
type: object
properties:
FreightDensityInfo:
- "$ref": "#/components/schemas/FreightShipmentInformation_FreightDensityInfo"
+ $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
@@ -2440,16 +2440,16 @@ components:
maximum: 1
type: string
AdjustedHeight:
- "$ref": "#/components/schemas/FreightDensityInfo_AdjustedHeight"
+ $ref: "#/components/schemas/FreightDensityInfo_AdjustedHeight"
HandlingUnits:
type: array
items:
- "$ref": "#/components/schemas/FreightDensityInfo_HandlingUnits"
+ $ref: "#/components/schemas/FreightDensityInfo_HandlingUnits"
xml:
name: FreightDensityInfo
required:
- HandlingUnits
- description: Freight Density Info container. Required if DensityEligibleIndicator
+ description: Freight Density Info container. Required if DensityEligibleIndicator
is present.
FreightDensityInfo_AdjustedHeight:
type: object
@@ -2465,10 +2465,10 @@ components:
minLength: 1
maxLength: 19
UnitOfMeasurement:
- "$ref": "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
- description: Container to hold Adjusted Height information. Required if AdjustedHeightIndicator
+ description: Container to hold Adjusted Height information. Required if AdjustedHeightIndicator
is present.
AdjustedHeight_UnitOfMeasurement:
type: object
@@ -2506,9 +2506,9 @@ components:
minLength: 8
maxLength: 8
Type:
- "$ref": "#/components/schemas/HandlingUnits_Type"
+ $ref: "#/components/schemas/HandlingUnits_Type"
Dimensions:
- "$ref": "#/components/schemas/HandlingUnits_Dimensions"
+ $ref: "#/components/schemas/HandlingUnits_Dimensions"
xml:
name: HandlingUnits
description: Handling Unit for Density based rating container.
@@ -2519,7 +2519,7 @@ components:
- Code
properties:
Code:
- description: 'The code associated with Handling Unit Type. Valid values:
+ description: 'The code associated with Handling Unit Type. Valid values:
SKD = Skid CBY = CarboyPLT = PalletTOT = TotesLOO = LooseOTH = Other'
maximum: 1
type: string
@@ -2543,7 +2543,7 @@ components:
- Width
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/HandlingUnits_UnitOfMeasurement"
+ $ref: "#/components/schemas/HandlingUnits_UnitOfMeasurement"
Length:
description: The length of the line item used to determine dimensional weight.
maximum: 1
@@ -2607,7 +2607,7 @@ components:
minLength: 1
maxLength: 2
Description:
- description: Text description of the code representing the UnitOfMeasurement associated with the package. This element is not validated.
+ description: Text description of the code representing the UnitOfMeasurement associated with the package. This element is not validated.
maximum: 1
type: string
minLength: 1
@@ -2652,14 +2652,14 @@ components:
minLength: 3
maxLength: 3
Description:
- description: A text description of the UPS Service associated with the shipment. Length is not validated.
+ description: A text description of the UPS Service associated with the shipment. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Service
- description: Service Container. Only valid with RequestOption = Rate for both
+ description: Service Container. Only valid with RequestOption = Rate for both
Small package and GFP Rating requests.
Shipment_NumOfPieces:
description: Total number of pieces in all pallets. Required for UPS Worldwide
@@ -2675,14 +2675,14 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/ShipmentTotalWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/ShipmentTotalWeight_UnitOfMeasurement"
Weight:
description: Non-zero total weight of all packages in the shipment.
type: string
xml:
name: ShipmentTotalWeight
description: Shipment Total Weight Container. This container is only applicable
- for "ratetimeintransit" and "shoptimeintransit" request options. Required
+ for "ratetimeintransit" and "shoptimeintransit" request options. Required
for all international shipments when retreiving time in transit information,
including letters and documents shipments.
maximum: 1
@@ -2716,54 +2716,54 @@ components:
Shipment_DocumentsOnlyIndicator:
description: 'Valid values are Document and Non-document. If the indicator is
present then the value is Document else Non-Document. Note: Not applicable
- for FRS rating requests. Empty Tag.'
+ for FRS rating requests. Empty Tag.'
maximum: 1
type: string
Shipment_Package:
type: object
properties:
PackagingType:
- "$ref": "#/components/schemas/Package_PackagingType"
+ $ref: "#/components/schemas/Package_PackagingType"
Dimensions:
- "$ref": "#/components/schemas/Package_Dimensions"
+ $ref: "#/components/schemas/Package_Dimensions"
DimWeight:
- "$ref": "#/components/schemas/Package_DimWeight"
+ $ref: "#/components/schemas/Package_DimWeight"
PackageWeight:
- "$ref": "#/components/schemas/Package_PackageWeight"
+ $ref: "#/components/schemas/Package_PackageWeight"
Commodity:
- "$ref": "#/components/schemas/Package_Commodity"
+ $ref: "#/components/schemas/Package_Commodity"
LargePackageIndicator:
description: This element does not require a value and if one is entered
- it will be ignored. If present, it indicates the shipment will be categorized
+ it will be ignored. If present, it indicates the shipment will be categorized
as a Large Package.
maximum: 1
type: string
PackageServiceOptions:
- "$ref": "#/components/schemas/Package_PackageServiceOptions"
+ $ref: "#/components/schemas/Package_PackageServiceOptions"
AdditionalHandlingIndicator:
- description: A flag indicating if the packages require additional handling. True if AdditionalHandlingIndicator tag exists; false otherwise. Additional Handling indicator indicates it's a non-corrugated package. Empty Tag.
+ description: A flag indicating if the packages require additional handling. True if AdditionalHandlingIndicator tag exists; false otherwise. Additional Handling indicator indicates it's a non-corrugated package. Empty Tag.
maximum: 1
type: string
SimpleRate:
- "$ref": "#/components/schemas/Package_SimpleRate"
+ $ref: "#/components/schemas/Package_SimpleRate"
UPSPremier:
- "$ref": "#/components/schemas/Package_UPSPremier"
+ $ref: "#/components/schemas/Package_UPSPremier"
OversizeIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. It
- indicates if packge is oversized. Applicable for UPS Worldwide Economy
+ indicates if packge is oversized. Applicable for UPS Worldwide Economy
DDU service
maximum: 1
type: string
MinimumBillableWeightIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. It
- indicates if packge is qualified for minimum billable weight. Applicable
+ indicates if packge is qualified for minimum billable weight. Applicable
for UPS Worldwide Economy DDU service
maximum: 1
type: string
xml:
name: Package
maximum: 1
- description: Package Container. Only one Package allowed for Simple Rate
+ description: Package Container. Only one Package allowed for Simple Rate
Package_PackagingType:
type: object
maximum: 1
@@ -2772,7 +2772,7 @@ components:
properties:
Code:
description: |
- The code for the UPS packaging type associated with the package. Valid values:
+ The code for the UPS packaging type associated with the package. Valid values:
- 00 - UNKNOWN
- 01 - UPS Letter
- 02 - Package
@@ -2793,7 +2793,7 @@ components:
maxLength: 2
Description:
description: A text description of the code for the UPS packaging type associated
- with the shipment. Length is not validated.
+ with the shipment. Length is not validated.
maximum: 1
type: string
minLength: 1
@@ -2810,10 +2810,10 @@ components:
- Width
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/Dimensions_UnitOfMeasurement"
+ $ref: "#/components/schemas/Dimensions_UnitOfMeasurement"
Length:
description: |
- Length of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
+ Length of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
6 digits in length with 2 digits of significance after the decimal point.
maximum: 1
@@ -2822,7 +2822,7 @@ components:
maxLength: 9
Width:
description: |
- Width of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
+ Width of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
6 digits in length with 2 digits of significance after the decimal point.
maximum: 1
@@ -2831,7 +2831,7 @@ components:
maxLength: 9
Height:
description: |
- Height of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
+ Height of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
6 digits in length with 2 digits of significance after the decimal point.
maximum: 1
@@ -2842,13 +2842,13 @@ components:
name: Dimensions
maximum: 1
description: Dimensions Container. This container is not applicable for GFP
- Rating request. Required for Heavy Goods service. Package Dimension will
+ Rating request. Required for Heavy Goods service. Package Dimension will
be ignored for Simple Rate
Package_DimWeight:
type: object
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/DimWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/DimWeight_UnitOfMeasurement"
Weight:
description: Dimensional weight of the package. Decimal values are not accepted,
however there is one implied decimal place for values in this field (i.e.
@@ -2862,7 +2862,7 @@ components:
maximum: 1
description: Package Dimensional Weight container. Values in this container
are ignored when package dimensions are provided. Please visit ups.com for
- instructions on calculating this value. Only used for non-US/CA/PR shipments.
+ instructions on calculating this value. Only used for non-US/CA/PR shipments.
DimWeight_UnitOfMeasurement:
type: object
maximum: 1
@@ -2882,7 +2882,7 @@ components:
maxLength: 3
maximum: 1
Description:
- description: Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
+ 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
@@ -2897,9 +2897,9 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/PackageWeight_UnitOfMeasurement"
Weight:
- description: Actual package weight. Weight accepted for letters/envelopes.
+ description: Actual package weight. Weight accepted for letters/envelopes.
maximum: 1
type: string
minLength: 1
@@ -2907,8 +2907,8 @@ components:
xml:
name: PackageWeight
maximum: 1
- description: Package Weight Container. Required for an GFP Rating request.
- Otherwise optional. Required for Heavy Goods service. Package Weight will
+ description: Package Weight Container. Required for an GFP Rating request.
+ Otherwise optional. Required for Heavy Goods service. Package Weight will
be ignored for Simple Rate
PackageWeight_UnitOfMeasurement:
type: object
@@ -2932,7 +2932,7 @@ components:
maxLength: 3
maximum: 1
Description:
- description: Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
+ 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
@@ -2948,17 +2948,17 @@ components:
properties:
FreightClass:
description: Freight Classification. Freight class partially determines
- the freight rate for the article. See Appendix of the Rating Ground Freight
+ the freight rate for the article. See Appendix of the Rating Ground Freight
Web Services Developers Guide for list of Freight classes. For GFP Only.
maximum: 1
type: string
minLength: 10
maxLength: 10
NMFC:
- "$ref": "#/components/schemas/Commodity_NMFC"
+ $ref: "#/components/schemas/Commodity_NMFC"
xml:
name: Commodity
- description: Commodity Container. Required only for GFP rating when FRSShipmentIndicator
+ description: Commodity Container. Required only for GFP rating when FRSShipmentIndicator
is requested.
Commodity_NMFC:
type: object
@@ -2968,7 +2968,7 @@ components:
properties:
PrimeCode:
description: Value of NMFC Prime. Contact your service representative if
- you need information concerning NMFC Codes. Required if NMFC Container
+ you need information concerning NMFC Codes. Required if NMFC Container
is present. For GFP Only.
maximum: 1
type: string
@@ -2976,7 +2976,7 @@ components:
maxLength: 6
SubCode:
description: Value of NMFC Sub. Contact your service representative if you
- need information concerning NMFC Codes. Needs to be provided when the
+ need information concerning NMFC Codes. Needs to be provided when the
SubCode associated with the PrimeCode is other than 00. API defaults the
sub value to 00 if not provided. If provided the Sub Code should be associated
with the PrimeCode of the NMFC.
@@ -2986,23 +2986,23 @@ components:
maxLength: 2
xml:
name: NMFC
- description: NMFC Commodity container. For GFP Only.
+ description: NMFC Commodity container. For GFP Only.
Package_PackageServiceOptions:
type: object
properties:
DeliveryConfirmation:
- "$ref": "#/components/schemas/PackageServiceOptions_DeliveryConfirmation"
+ $ref: "#/components/schemas/PackageServiceOptions_DeliveryConfirmation"
AccessPointCOD:
- "$ref": "#/components/schemas/PackageServiceOptions_AccessPointCOD"
+ $ref: "#/components/schemas/PackageServiceOptions_AccessPointCOD"
COD:
- "$ref": "#/components/schemas/PackageServiceOptions_COD"
+ $ref: "#/components/schemas/PackageServiceOptions_COD"
DeclaredValue:
- "$ref": "#/components/schemas/PackageServiceOptions_DeclaredValue"
+ $ref: "#/components/schemas/PackageServiceOptions_DeclaredValue"
ShipperDeclaredValue:
- "$ref": "#/components/schemas/PackageServiceOptions_ShipperDeclaredValue"
+ $ref: "#/components/schemas/PackageServiceOptions_ShipperDeclaredValue"
ShipperReleaseIndicator:
description: The presence indicates that the package may be released by
- driver without a signature from the consignee. Empty Tag. Only available
+ 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
@@ -3010,21 +3010,21 @@ components:
description: Any value associated with this element will be ignored. If
present, the package is rated for UPS Proactive Response and proactive
package tracking.Contractual accessorial for health care companies to
- allow package monitoring throughout the UPS system. Shippers account
+ allow package monitoring throughout the UPS system. Shippers account
needs to have valid contract for UPS Proactive Response.
maximum: 1
type: string
RefrigerationIndicator:
description: Presence/Absence Indicator. Any value is ignored. If present,
- indicates that the package contains an item that needs refrigeration. Shippers
+ indicates that the package contains an item that needs refrigeration. Shippers
account needs to have a valid contract for Refrigeration.
maximum: 1
type: string
Insurance:
- "$ref": "#/components/schemas/PackageServiceOptions_Insurance"
+ $ref: "#/components/schemas/PackageServiceOptions_Insurance"
UPSPremiumCareIndicator:
description: |
- The UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present.
+ The UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present.
Valid only for Canada to Canada movements.
@@ -3047,9 +3047,9 @@ components:
maximum: 1
type: string
HazMat:
- "$ref": "#/components/schemas/PackageServiceOptions_HazMat"
+ $ref: "#/components/schemas/PackageServiceOptions_HazMat"
DryIce:
- "$ref": "#/components/schemas/PackageServiceOptions_DryIce"
+ $ref: "#/components/schemas/PackageServiceOptions_DryIce"
xml:
name: PackageServiceOptions
maximum: 1
@@ -3061,7 +3061,7 @@ components:
- DCISType
properties:
DCISType:
- description: 'Type of delivery confirmation. Valid values: 1 - Unsupported
+ description: 'Type of delivery confirmation. Valid values: 1 - Unsupported
2 - Delivery Confirmation Signature Required 3 - Delivery Confirmation
Adult Signature Required'
maximum: 1
@@ -3071,7 +3071,7 @@ components:
xml:
name: DeliveryConfirmation
description: Delivery Confirmation Container. For a list of valid origin/destination
- countries or territories please refer to appendix. DeliveryConfirmation and
+ countries or territories please refer to appendix. DeliveryConfirmation and
COD are mutually exclusive.
PackageServiceOptions_AccessPointCOD:
type: object
@@ -3081,7 +3081,7 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: Access Point COD Currency Code. Required if Access Point COD
+ description: Access Point COD Currency Code. Required if Access Point COD
container is present. UPS does not support all international currency
codes. Refer to the appendix for a list of valid codes.
maximum: 1
@@ -3090,7 +3090,7 @@ components:
maxLength: 3
MonetaryValue:
description: |
- Access Point COD Monetary Value. Required if Access Point COD container is present.
+ Access Point COD Monetary Value. Required if Access Point COD container is present.
8 digits prior to the decimal place and 2 after.
maximum: 1
@@ -3099,7 +3099,7 @@ components:
maxLength: 11
xml:
name: AccessPointCOD
- description: 'Access Point COD indicates Package COD is requested for a shipment. Valid
+ description: 'Access Point COD indicates Package COD is requested for a shipment. Valid
only for : 01 - Hold For Pickup At UPS Access Point, Shipment Indication type.
Package Access Point COD is valid only for shipment without return service
from US/PR to US/PR and CA to CA. Not valid with (Package) COD.'
@@ -3111,16 +3111,16 @@ components:
- CODAmount
properties:
CODFundsCode:
- description: Indicates the type of funds that will be used for the C.O.D. payment. For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
+ description: Indicates the type of funds that will be used for the C.O.D. payment. For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
maximum: 1
type: string
minLength: 1
maxLength: 1
CODAmount:
- "$ref": "#/components/schemas/COD_CODAmount"
+ $ref: "#/components/schemas/COD_CODAmount"
xml:
name: COD
- description: 'COD Container. Indicates COD is requested. Valid for the following
+ description: 'COD Container. Indicates COD is requested. Valid for the following
country or territory combinations: US/PR to US/PRCA to CACA to USNot allowed
for CA to US for packages that are designated as Letters or Envelopes.'
COD_CODAmount:
@@ -3131,13 +3131,13 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: Currency Code. Required if a value for the COD amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
+ description: Currency Code. Required if a value for the COD amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
- description: The COD value for the package. Required if COD option is present. The maximum amount allowed is 50,000 USD.
+ description: The COD value for the package. Required if COD option is present. The maximum amount allowed is 50,000 USD.
maximum: 1
type: string
minLength: 8
@@ -3153,7 +3153,7 @@ components:
properties:
CurrencyCode:
description: The IATA currency code associated with the declared value amount
- for the package. Required if a value for the package declared value amount
+ for the package. Required if a value for the package declared value amount
exists in the MonetaryValue tag. Must match one of the IATA currency codes.
Length is not validated. UPS does not support all international currency
codes. Refer to Currency Codes in the Appendix for a list of valid codes.
@@ -3163,7 +3163,7 @@ components:
maxLength: 3
MonetaryValue:
description: The monetary value for the declared value amount associated
- with the package. Max value of 5,000 USD for Local and 50,000 USD for
+ with the package. Max value of 5,000 USD for Local and 50,000 USD for
Remote. Absolute maximum value is 21474836.47
maximum: 1
type: string
@@ -3180,7 +3180,7 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: The IATA currency code associated with the amount for the package. UPS
+ description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes.
maximum: 1
@@ -3195,18 +3195,18 @@ components:
maxLength: 19
xml:
name: ShipperDeclaredValue
- description: Shipper Paid Declared Value Charge at Package level. Valid for
+ description: Shipper Paid Declared Value Charge at Package level. Valid for
UPS World Wide Express Freight shipments.
PackageServiceOptions_Insurance:
type: object
maximum: 1
properties:
BasicFlexibleParcelIndicator:
- "$ref": "#/components/schemas/Insurance_BasicFlexibleParcelIndicator"
+ $ref: "#/components/schemas/Insurance_BasicFlexibleParcelIndicator"
ExtendedFlexibleParcelIndicator:
- "$ref": "#/components/schemas/Insurance_ExtendedFlexibleParcelIndicator"
+ $ref: "#/components/schemas/Insurance_ExtendedFlexibleParcelIndicator"
TimeInTransitFlexibleParcelIndicator:
- "$ref": "#/components/schemas/Insurance_TimeInTransitFlexibleParcelIndicator"
+ $ref: "#/components/schemas/Insurance_TimeInTransitFlexibleParcelIndicator"
description: Insurance Accesorial. Only one type of insurance can exist at a time on the shipment. Valid for UPS World Wide Express Freight shipments.
Insurance_BasicFlexibleParcelIndicator:
type: object
@@ -3216,7 +3216,7 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: The IATA currency code associated with the amount for the package. UPS
+ description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
maximum: 1
@@ -3224,7 +3224,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: The monetary value associated with the package. Valid for
+ description: The monetary value associated with the package. Valid for
UPS World Wide Express Freight shipments.
maximum: 1
type: string
@@ -3232,7 +3232,7 @@ components:
maxLength: 8
xml:
name: BasicFlexibleParcelIndicator
- description: Container to hold Basic Flexible Parcel Indicator information. Valid
+ description: Container to hold Basic Flexible Parcel Indicator information. Valid
for UPS World Wide Express Freight shipments.
Insurance_ExtendedFlexibleParcelIndicator:
type: object
@@ -3242,7 +3242,7 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: The IATA currency code associated with the amount for the package. UPS
+ description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
maximum: 1
@@ -3250,7 +3250,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: The monetary value associated with the package. Valid for
+ description: The monetary value associated with the package. Valid for
UPS World Wide Express Freight shipments.
maximum: 1
type: string
@@ -3268,7 +3268,7 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: The IATA currency code associated with the amount for the package. UPS
+ description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
maximum: 1
@@ -3276,7 +3276,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: The monetary value associated with the package. Valid for
+ description: The monetary value associated with the package. Valid for
UPS World Wide Express Freight shipments.
maximum: 1
type: string
@@ -3284,14 +3284,14 @@ components:
maxLength: 8
xml:
name: TimeInTransitFlexibleParcelIndicator
- description: Container to hold Time In Transit Flexible Parcel Indicator information. Valid
+ description: Container to hold Time In Transit Flexible Parcel Indicator information. Valid
for UPS World Wide Express Freight shipments.
PackageServiceOptions_HazMat:
type: object
maximum: 1
properties:
PackageIdentifier:
- description: Identifies the package containing Dangerous Goods. Required
+ description: Identifies the package containing Dangerous Goods. Required
if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
@@ -3299,7 +3299,7 @@ components:
maxLength: 5
QValue:
description: 'QValue is required when a HazMat shipment specifies AllPackedInOneIndicator
- and the regulation set for that shipment is IATA. Applies only if SubVersion
+ and the regulation set for that shipment is IATA. Applies only if SubVersion
is greater than or equal to 1701. Valid values are : 0.1; 0.2; 0.3; 0.4;
0.5; 0.6; 0.7; 0.8; 0.9; 1.0'
maximum: 1
@@ -3308,13 +3308,13 @@ components:
maxLength: 3
OverPackedIndicator:
description: Presence/Absence Indicator. Any value is ignored. Presence
- indicates that shipment is overpack. Applies only if SubVersion is greater
+ indicates that shipment is overpack. Applies only if SubVersion is greater
than or equal to 1701.
maximum: 1
type: string
AllPackedInOneIndicator:
description: Presence/Absence Indicator. Any value is ignored. Indicates
- the hazmat shipment/package is all packed in one. Applies only if SubVersion
+ the hazmat shipment/package is all packed in one. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
@@ -3322,25 +3322,25 @@ components:
maximum: 3
type: array
items:
- "$ref": "#/components/schemas/HazMat_HazMatChemicalRecord"
+ $ref: "#/components/schemas/HazMat_HazMatChemicalRecord"
xml:
name: HazMat
required:
- HazMatChemicalRecord
- description: Container to hold HazMat information. Applies only if SubVersion
+ description: Container to hold HazMat information. Applies only if SubVersion
is greater than or equal to 1701.
HazMat_HazMatChemicalRecord:
type: object
properties:
ChemicalRecordIdentifier:
- description: Identifies the Chemcial Record. Required if SubVersion is
+ description: Identifies the Chemcial Record. Required if SubVersion is
greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 3
ClassDivisionNumber:
- description: "This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' Applies only if SubVersion is greater than or equal to 1701."
+ description: This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR'. Applies only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
@@ -3350,7 +3350,7 @@ components:
Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field
applies to the material by regulation. UN/NA/ID Identification Number
assigned to the specified regulated good. (Include the UN/NA/ID as part
- of the entry). Applies only if SubVersion is greater than or equal to
+ of the entry). Applies only if SubVersion is greater than or equal to
1701.
maximum: 1
type: string
@@ -3358,7 +3358,7 @@ components:
maxLength: 6
TransportationMode:
description: 'The method of transport by which a shipment is approved to
- move and the regulations associated with that method. Only required when
+ move and the regulations associated with that method. Only required when
the CommodityRegulatedLevelCode is FR or LQ.Valid values: 01 - Highway02
- Ground03 - Passenger Aircraft04 - Cargo Aircraft Only Applies only
if SubVersion is greater than or equal to 1701. For multiple ChemicalRecords
@@ -3390,7 +3390,7 @@ components:
for this field are (0) through (9) with trailing blanks. For numbers within
the U.S., the layout is '1', area code, 7-digit number. For all other
countries or territories the layout is country or territory code, area
- code, number. Applies only if SubVersion is greater than or equal to
+ code, number. Applies only if SubVersion is greater than or equal to
1701.
maximum: 1
type: string
@@ -3401,7 +3401,7 @@ components:
required to be communicated when a call is placed to the EmergencyPhoneNumber.
The information is required if there is a value in the EmergencyPhoneNumber
field above and the shipment is with a US50 or PR origin and/or destination
- and the RegulationSet is IATA. Applies only if SubVersion is greater
+ and the RegulationSet is IATA. Applies only if SubVersion is greater
than or equal to 1701.
maximum: 1
type: string
@@ -3410,14 +3410,14 @@ components:
ReportableQuantity:
description: Required if CommodityRegulatedLevelCode = LQ or FR and if the
field applies to the material by regulation. If reportable quantity is
- met, 'RQ' should be entered. Applies only if SubVersion is greater than
+ met, 'RQ' should be entered. Applies only if SubVersion is greater than
or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 2
SubRiskClass:
- description: Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). Applies only if SubVersion is greater than or equal to 1701.
+ description: Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). Applies only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
@@ -3426,7 +3426,7 @@ components:
description: This is the packing group category associated to the specified
commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the
field applies to the material by regulation. Must be shown in Roman Numerals.Valid
- values are:I, II,III,blank. Applies only if SubVersion is greater than
+ values are:I, II,III,blank. Applies only if SubVersion is greater than
or equal to 1701.
maximum: 1
type: string
@@ -3434,7 +3434,7 @@ components:
maxLength: 10
Quantity:
description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical
- value of the mass capacity of the regulated good. Applies only if SubVersion
+ value of the mass capacity of the regulated good. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
@@ -3443,7 +3443,7 @@ components:
UOM:
description: 'Required if CommodityRegulatedLevelCode = LQ or FR. The unit
of measure used for the mass capacity of the regulated good. For Example:
- ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. Applies
+ ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. Applies
only if SubVersion is greater than or equal to 1701.'
maximum: 1
type: string
@@ -3452,7 +3452,7 @@ components:
PackagingInstructionCode:
description: The packing instructions related to the chemical record. Required
if CommodityRegulatedLevelCode = LQ or FR and if the field applies to
- the material by regulation. Applies only if SubVersion is greater than
+ the material by regulation. Applies only if SubVersion is greater than
or equal to 1701.
maximum: 1
type: string
@@ -3460,7 +3460,7 @@ components:
maxLength: 353
ProperShippingName:
description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required
- if CommodityRegulatedLevelCode = LR, LQ or FR. Applies only if SubVersion
+ if CommodityRegulatedLevelCode = LR, LQ or FR. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
@@ -3469,7 +3469,7 @@ components:
TechnicalName:
description: The technical name (when required) for the specified commodity.
Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies
- to the material by regulation. Applies only if SubVersion is greater
+ to the material by regulation. Applies only if SubVersion is greater
than or equal to 1701.
maximum: 1
type: string
@@ -3479,7 +3479,7 @@ components:
description: |
Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
- Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers. Applies only if SubVersion is greater than or equal to 1701.
+ Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers. Applies only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
@@ -3487,14 +3487,14 @@ components:
PackagingType:
description: 'The package type code identifying the type of packaging used
for the commodity. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode
- = LQ or FR. Applies only if SubVersion is greater than or equal to 1701.'
+ = LQ or FR. Applies only if SubVersion is greater than or equal to 1701.'
maximum: 1
type: string
minLength: 1
maxLength: 255
HazardLabelRequired:
description: Defines the type of label that is required on the package for
- the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ. Applies
+ the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ. Applies
only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
@@ -3502,7 +3502,7 @@ components:
maxLength: 50
PackagingTypeQuantity:
description: The number of pieces of the specific commodity. Required if
- CommodityRegulatedLevelCode = LQ or FR.Valid values are 1 to 999. Applies
+ CommodityRegulatedLevelCode = LQ or FR.Valid values are 1 to 999. Applies
only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
@@ -3511,21 +3511,21 @@ components:
CommodityRegulatedLevelCode:
description: Indicates the type of commodity - Fully Regulated (FR), Limited
Quantity (LQ), Excepted Quantity (EQ), Lightly Regulated (LR). Default
- value is FR.Valid values are LR, FR, LQ, EQ. Applies only if SubVersion
+ value is FR.Valid values are LR, FR, LQ, EQ. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
minLength: 2
maxLength: 2
TransportCategory:
- description: Transport Category.Valid values are 0 to 4. Applies only if
+ description: Transport Category.Valid values are 0 to 4. Applies only if
SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 1
TunnelRestrictionCode:
- description: Defines what is restricted to pass through a tunnel. Applies
+ description: Defines what is restricted to pass through a tunnel. Applies
only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
@@ -3547,14 +3547,14 @@ components:
RegulationSet:
description: 'Regulation set for DryIce Shipment. Valid values: CFR = For
HazMat regulated by US Dept of Transportation within the U.S. or ground
- shipments to Canada,IATA = For Worldwide Air movement. The following
+ shipments to Canada,IATA = For Worldwide Air movement. The following
values are valid: CFR and IATA.'
maximum: 1
type: string
minLength: 3
maxLength: 4
DryIceWeight:
- "$ref": "#/components/schemas/DryIce_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
@@ -3570,7 +3570,7 @@ components:
type: string
xml:
name: DryIce
- description: Container to hold Dry Ice information. Lane check will happen
+ description: Container to hold Dry Ice information. Lane check will happen
based on postal code/ city.
DryIce_DryIceWeight:
type: object
@@ -3579,7 +3579,7 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/DryIceWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/DryIceWeight_UnitOfMeasurement"
Weight:
description: Weight for Dry Ice. Cannot be more than package weight. Should
be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit
@@ -3668,7 +3668,7 @@ components:
SaturdayPickupIndicator:
description: A flag indicating if the shipment requires a Saturday pickup.
True if SaturdayPickupIndicator tag exists; false otherwise. Not available
- for GFP rating requests. Empty Tag.
+ for GFP rating requests. Empty Tag.
maximum: 1
type: string
SaturdayDeliveryIndicator:
@@ -3684,34 +3684,34 @@ components:
AvailableServicesOption:
description: If we need diferent available services in response, this option
is used for shop request option. SaturdayDeliveryIndicator/ SundayDeliveryIndicator
- will be ignored in that case. Valid Values:1- Weekday+Saturday services2-
+ will be ignored in that case. Valid Values:1- Weekday+Saturday services2-
Weekday+Sunday services3- Weekday+Sat services+Sun services
maximum: 1
type: string
minLength: 1
maxLength: 1
AccessPointCOD:
- "$ref": "#/components/schemas/ShipmentServiceOptions_AccessPointCOD"
+ $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".
+ Presence of indicator means shipper restriction will apply to the shipment. Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point".
maximum: 1
type: string
DirectDeliveryOnlyIndicator:
description: |
- Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the Ship To address on the shipping label. This accessorial is not valid with Shipment Indication Types:
+ Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the Ship To address on the shipping label. This accessorial is not valid with Shipment Indication Types:
- 01 - Hold For Pickup At UPS Access Point
- 02 - UPS Access Point™ Delivery
maximum: 1
type: string
COD:
- "$ref": "#/components/schemas/ShipmentServiceOptions_COD"
+ $ref: "#/components/schemas/ShipmentServiceOptions_COD"
DeliveryConfirmation:
- "$ref": "#/components/schemas/ShipmentServiceOptions_DeliveryConfirmation"
+ $ref: "#/components/schemas/ShipmentServiceOptions_DeliveryConfirmation"
ReturnOfDocumentIndicator:
description: Return of Documents Indicator - If the flag is present, the
shipper has requested the ReturnOfDocument accessorial be added to the
@@ -3725,18 +3725,18 @@ components:
type: string
CertificateOfOriginIndicator:
description: The empty tag in request indicates that customer would be using
- UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
+ UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
PickupOptions:
- "$ref": "#/components/schemas/ShipmentServiceOptions_PickupOptions"
+ $ref: "#/components/schemas/ShipmentServiceOptions_PickupOptions"
DeliveryOptions:
- "$ref": "#/components/schemas/ShipmentServiceOptions_DeliveryOptions"
+ $ref: "#/components/schemas/ShipmentServiceOptions_DeliveryOptions"
RestrictedArticles:
- "$ref": "#/components/schemas/ShipmentServiceOptions_RestrictedArticles"
+ $ref: "#/components/schemas/ShipmentServiceOptions_RestrictedArticles"
ShipperExportDeclarationIndicator:
description: The empty tag in request indicates that customer would be using
- UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
+ UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
CommercialInvoiceRemovalIndicator:
@@ -3747,13 +3747,13 @@ components:
maximum: 1
type: string
ImportControl:
- "$ref": "#/components/schemas/ShipmentServiceOptions_ImportControl"
+ $ref: "#/components/schemas/ShipmentServiceOptions_ImportControl"
ReturnService:
- "$ref": "#/components/schemas/ShipmentServiceOptions_ReturnService"
+ $ref: "#/components/schemas/ShipmentServiceOptions_ReturnService"
SDLShipmentIndicator:
description: Empty Tag means the indicator is present. This field is a flag
to indicate if the receiver needs SDL rates in response. True if SDLShipmentIndicator
- tag exists; false otherwise. If present, the State Department License
+ tag exists; false otherwise. If present, the State Department License
(SDL) rates will be returned in the response.This service requires that
the account number is enabled for SDL.
maximum: 1
@@ -3777,7 +3777,7 @@ components:
maxLength: 2
ItemDisposalIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. If
- present, indicates that the customer would like items disposed. Shippers
+ 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
@@ -3792,7 +3792,7 @@ components:
- MonetaryValue
properties:
CurrencyCode:
- description: Access Point COD Currency Code. Required if Access Point COD
+ description: Access Point COD Currency Code. Required if Access Point COD
container is present. UPS does not support all international currency
codes. Refer to the appendix for a list of valid codes.
maximum: 1
@@ -3801,7 +3801,7 @@ components:
maxLength: 3
MonetaryValue:
description: |
- Access Point COD Monetary Value. Required if Access Point COD container is present.
+ Access Point COD Monetary Value. Required if Access Point COD container is present.
8 digits prior to the decimal place and 2 after.
maximum: 1
@@ -3811,7 +3811,7 @@ components:
xml:
name: AccessPointCOD
description: |
- Access Point COD indicates Shipment level Access Point COD is requested for a shipment. Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type.
+ Access Point COD indicates Shipment level Access Point COD is requested for a shipment. Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type.
Shipment Access Point COD is valid only for countries or territories within E.U.
@@ -3832,10 +3832,10 @@ components:
minLength: 1
maxLength: 1
CODAmount:
- "$ref": "#/components/schemas/ShipmentServiceOptions_COD_CODAmount"
+ $ref: "#/components/schemas/ShipmentServiceOptions_COD_CODAmount"
xml:
name: COD
- description: If present, indicates C.O.D. is requested for the shipment. Shipment
+ description: If present, indicates C.O.D. is requested for the shipment. Shipment
level C.O.D. is only available for EU origin countries or territories.C.O.D.
shipments are only available for Shippers with Daily Pickup and Drop Shipping
accounts.
@@ -3860,7 +3860,7 @@ components:
maxLength: 8
xml:
name: CODAmount
- description: CODAmount Container. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
+ description: CODAmount Container. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
ShipmentServiceOptions_DeliveryConfirmation:
type: object
maximum: 1
@@ -3868,13 +3868,13 @@ components:
- DCISType
properties:
DCISType:
- description: 'Type of delivery confirmation. Valid values: 1 - Delivery
+ description: 'Type of delivery confirmation. Valid values: 1 - Delivery
Confirmation Signature Required 2 - Delivery Confirmation Adult Signature
Required'
type: string
xml:
name: DeliveryConfirmation
- description: Delivery Confirmation Container. DeliveryConfirmation and C.O.D.
+ description: Delivery Confirmation Container. DeliveryConfirmation and C.O.D.
are mutually exclusive. Refer to the Appendix for a list of valid origin-destination
country or territory pairs associated with each confirmation type.
ShipmentServiceOptions_PickupOptions:
@@ -3893,7 +3893,7 @@ components:
type: string
xml:
name: PickupOptions
- description: Shipment Service Pickup Options Container. Valid for UPS Worldwide
+ description: Shipment Service Pickup Options Container. Valid for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
ShipmentServiceOptions_DeliveryOptions:
type: object
@@ -3911,7 +3911,7 @@ components:
type: string
xml:
name: DeliveryOptions
- description: Shipment Service Delivery Options Container. Valid for UPS Worldwide
+ description: Shipment Service Delivery Options Container. Valid for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
ShipmentServiceOptions_RestrictedArticles:
type: object
@@ -3919,62 +3919,62 @@ components:
properties:
AlcoholicBeveragesIndicator:
description: This field is a flag to indicate if the package has Alcohol.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
DiagnosticSpecimensIndicator:
description: This field is a flag to indicate if the package has Biological
- substances. True if present; false otherwise. Valid for UPS World Wide
+ substances. True if present; false otherwise. Valid for UPS World Wide
Express Freight shipments. Lane check will happen based on postal code/
city.
maximum: 1
type: string
PerishablesIndicator:
description: This field is a flag to indicate if the package has Perishables.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
PlantsIndicator:
description: This field is a flag to indicate if the package has Plants.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
SeedsIndicator:
description: This field is a flag to indicate if the package has Seeds.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
SpecialExceptionsIndicator:
description: This field is a flag to indicate if the package has Special
- Exceptions Restricted Materials. True if present; false otherwise. Valid
+ Exceptions Restricted Materials. True if present; false otherwise. Valid
for UPS World Wide Express Freight shipments.
maximum: 1
type: string
TobaccoIndicator:
description: This field is a flag to indicate if the package has Tobacco.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
ECigarettesIndicator:
description: This field is a flag to indicate if the package has E-Cigarettes.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
HempCBDIndicator:
description: This field is a flag to indicate if the package has Hemp/CBD.
- True if present; false otherwise. Valid for UPS World Wide Express Freight
+ True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
xml:
name: RestrictedArticles
- description: Restricted Articles container. Valid for UPS World Wide Express
+ description: Restricted Articles container. Valid for UPS World Wide Express
Freight shipments.
ShipmentServiceOptions_ImportControl:
type: object
@@ -4053,7 +4053,7 @@ components:
type: string
FRSShipmentIndicator:
description: FRS Indicator. The indicator is required to obtain rates for
- UPS Ground Freight Pricing (GFP). The account number must be enabled
+ UPS Ground Freight Pricing (GFP). The account number must be enabled
for GFP.
maximum: 1
type: string
@@ -4064,7 +4064,7 @@ components:
type: string
UserLevelDiscountIndicator:
description: UserLevelDiscountIndicator - required to obtain rates for User
- Level Promotions. This is required to obtain User Level Discounts. There
+ Level Promotions. This is required to obtain User Level Discounts. There
must also be no ShipperNumber in the Shipper container.
maximum: 1
type: string
@@ -4089,7 +4089,7 @@ components:
CurrencyCode:
description: 'Invoice Line Total Currency type. The Currency code should
match the origin country''s or territory''s currency code, otherwise the
- currency code entered will be ignored. Note: UPS doesn''t support all
+ currency code entered will be ignored. Note: UPS doesn''t support all
international currency codes. Please check the developer guides for Supported
Currency codes.'
maximum: 1
@@ -4097,14 +4097,14 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Total amount of the invoice accompanying the shipment. Required when the InvoiceLineTotal container exists in the rate request. Valid values are from 1 to 99999999.
+ description: Total amount of the invoice accompanying the shipment. Required when the InvoiceLineTotal container exists in the rate request. Valid values are from 1 to 99999999.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: InvoiceLineTotal
- description: Container to hold InvoiceLineTotal Information. Required if the
+ description: Container to hold InvoiceLineTotal Information. Required if the
shipment is from US/PR Outbound to non US/PR destination with the PackagingType
of UPS PAK(04).Required for international shipments when using request option
"ratetimeintransit" or "shoptimeintransit".
@@ -4116,7 +4116,7 @@ components:
- PromoCode
properties:
PromoCode:
- description: Promotion Code. A discount that is applied to the user. Required
+ description: Promotion Code. A discount that is applied to the user. Required
if PromotionalDiscountInformation container is present.
maximum: 1
type: string
@@ -4154,15 +4154,15 @@ components:
minLength: 2
maxLength: 2
Pickup:
- "$ref": "#/components/schemas/DeliveryTimeInformation_Pickup"
+ $ref: "#/components/schemas/DeliveryTimeInformation_Pickup"
ReturnContractServices:
type: array
items:
- "$ref": "#/components/schemas/DeliveryTimeInformation_ReturnContractServices"
+ $ref: "#/components/schemas/DeliveryTimeInformation_ReturnContractServices"
xml:
name: DeliveryTimeInformation
description: Container for requesting Time In Transit Information. Required
- to view time in transit information. Required to view any time in transit
+ to view time in transit information. Required to view any time in transit
information.
DeliveryTimeInformation_Pickup:
type: object
@@ -4171,13 +4171,13 @@ components:
- Date
properties:
Date:
- description: "Shipment Date; The Pickup date is a Shipment Date and it is a required input field. The user is allowed to query up to 35 days into the past and 60 days into the future. Format: YYYYMMDD If a date is not provided, it will be defaulted to the current system date."
+ description: "Shipment Date; The Pickup date is a Shipment Date and it is a required input field. The user is allowed to query up to 35 days into the past and 60 days into the future. Format: YYYYMMDD If a date is not provided, it will be defaulted to the current system date."
maximum: 1
type: string
minLength: 8
maxLength: 8
Time:
- description: Reflects the time the package is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Military Time Format HHMMSS or HHMM. Invalid pickup time will not be validated.
+ description: Reflects the time the package is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Military Time Format HHMMSS or HHMM. Invalid pickup time will not be validated.
maximum: 1
type: string
minLength: 4
@@ -4214,7 +4214,7 @@ components:
- RatedShipment
properties:
Response:
- "$ref": "#/components/schemas/RateResponse_Response"
+ $ref: "#/components/schemas/RateResponse_Response"
RatedShipment:
description: |
RatedShipment Container.
@@ -4222,7 +4222,7 @@ components:
**NOTE:** For versions >= v2409, this element will always be returned as an array. For requests using versions < v2409, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RateResponse_RatedShipment"
+ $ref: "#/components/schemas/RateResponse_RatedShipment"
xml:
name: RateResponse
description: Rate Response Container.
@@ -4233,15 +4233,15 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and 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"
+ $ref: "#/components/schemas/Response_Alert"
AlertDetail:
description: |
Alert Detail Container. Currently applies to and returned only for request containing HazMat and SubVersion greater than or equal to 1701.
@@ -4249,9 +4249,9 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/Response_AlertDetail"
+ $ref: "#/components/schemas/Response_AlertDetail"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -4264,14 +4264,14 @@ components:
- Code
properties:
Code:
- description: Identifies the success or failure of the transaction. 1 =
+ 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"
+ description: Describes Response Status Code. Returns text of "Success"
for a valid request.
maximum: 1
type: string
@@ -4321,7 +4321,7 @@ components:
minLength: 1
maxLength: 150
ElementLevelInformation:
- "$ref": "#/components/schemas/AlertDetail_ElementLevelInformation"
+ $ref: "#/components/schemas/AlertDetail_ElementLevelInformation"
xml:
name: AlertDetail
AlertDetail_ElementLevelInformation:
@@ -4348,7 +4348,7 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier"
+ $ref: "#/components/schemas/ElementLevelInformation_ElementIdentifier"
xml:
name: ElementLevelInformation
description: Provides more information about the element that represents the
@@ -4398,9 +4398,9 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedShipment_Disclaimer"
+ $ref: "#/components/schemas/RatedShipment_Disclaimer"
Service:
- "$ref": "#/components/schemas/RatedShipment_Service"
+ $ref: "#/components/schemas/RatedShipment_Service"
RateChart:
description: |
Rate Type with which Shipment is rated. Possible RateChart values for different regions will be:
@@ -4431,11 +4431,11 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedShipment_RatedShipmentAlert"
+ $ref: "#/components/schemas/RatedShipment_RatedShipmentAlert"
BillableWeightCalculationMethod:
description: Indicates whether the billable weight calculation method is
- utilized at the package or shipment level. This information will be returned
- only if RatingMethodRequestedIndicator is present in the request. Possible
+ utilized at the package or shipment level. This information will be returned
+ only if RatingMethodRequestedIndicator is present in the request. Possible
values:01 = Shipment Billable Weight02 = Package Billable Weight
maximum: 1
type: string
@@ -4444,18 +4444,18 @@ components:
RatingMethod:
description: Indicates whether the Shipment was rated at the shipment-level
or the package-level. This information will be returned only if RatingMethodRequestedIndicator
- is present in the request. Possible values:01 = Shipment level02 = Package
+ is present in the request. Possible values:01 = Shipment level02 = Package
level
maximum: 1
type: string
minLength: 2
maxLength: 2
BillingWeight:
- "$ref": "#/components/schemas/RatedShipment_BillingWeight"
+ $ref: "#/components/schemas/RatedShipment_BillingWeight"
TransportationCharges:
- "$ref": "#/components/schemas/RatedShipment_TransportationCharges"
+ $ref: "#/components/schemas/RatedShipment_TransportationCharges"
BaseServiceCharge:
- "$ref": "#/components/schemas/RatedShipment_BaseServiceCharge"
+ $ref: "#/components/schemas/RatedShipment_BaseServiceCharge"
ItemizedCharges:
description: |
Itemized Charges are returned only when the subversion element is present and greater than or equal to '1601'. These charges would be returned only when subversion is greater than or equal to 1601.
@@ -4463,11 +4463,11 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedShipment_ItemizedCharges"
+ $ref: "#/components/schemas/RatedShipment_ItemizedCharges"
FRSShipmentData:
- "$ref": "#/components/schemas/RatedShipment_FRSShipmentData"
+ $ref: "#/components/schemas/RatedShipment_FRSShipmentData"
ServiceOptionsCharges:
- "$ref": "#/components/schemas/RatedShipment_ServiceOptionsCharges"
+ $ref: "#/components/schemas/RatedShipment_ServiceOptionsCharges"
TaxCharges:
description: |
TaxCharges container are returned only when TaxInformationIndicator is present in request and when Negotiated Rates are not applicable. TaxCharges container contains Tax information for a given shipment.
@@ -4475,13 +4475,13 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedShipment_TaxCharges"
+ $ref: "#/components/schemas/RatedShipment_TaxCharges"
TotalCharges:
- "$ref": "#/components/schemas/RatedShipment_TotalCharges"
+ $ref: "#/components/schemas/RatedShipment_TotalCharges"
TotalChargesWithTaxes:
- "$ref": "#/components/schemas/RatedShipment_TotalChargesWithTaxes"
+ $ref: "#/components/schemas/RatedShipment_TotalChargesWithTaxes"
NegotiatedRateCharges:
- "$ref": "#/components/schemas/RatedShipment_NegotiatedRateCharges"
+ $ref: "#/components/schemas/RatedShipment_NegotiatedRateCharges"
RatedPackage:
description: |
Rated Package Container.
@@ -4489,11 +4489,11 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedShipment_RatedPackage"
+ $ref: "#/components/schemas/RatedShipment_RatedPackage"
TimeInTransit:
- "$ref": "#/components/schemas/RatedShipment_TimeInTransit"
+ $ref: "#/components/schemas/RatedShipment_TimeInTransit"
GuaranteedDelivery:
- "$ref": "#/components/schemas/RatedShipment_GuaranteedDelivery"
+ $ref: "#/components/schemas/RatedShipment_GuaranteedDelivery"
ScheduledDeliveryDate:
description: The rated shipments scheduled delivery date, ScheduledDeliveryDate
returned only when Subversion of 2205 was sent in the request and the
@@ -4582,9 +4582,9 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/BillingWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/BillingWeight_UnitOfMeasurement"
Weight:
- description: The value for the billable weight associated with the shipment. When using a negotiated divisor different from the published UPS divisor (139 for inches and 5,000 for cm), the weight returned is based on the published divisor. Rates, however, are based on the negotiated divisor.
+ description: The value for the billable weight associated with the shipment. When using a negotiated divisor different from the published UPS divisor (139 for inches and 5,000 for cm), the weight returned is based on the published divisor. Rates, however, are based on the negotiated divisor.
maximum: 1
type: string
minLength: 1
@@ -4660,7 +4660,7 @@ components:
maxLength: 16
xml:
name: BaseServiceCharge
- description: Base Service Charge Container. These charges would be returned
+ description: Base Service Charge Container. These charges would be returned
only when subversion is greater than or equal to 1701
RatedShipment_ItemizedCharges:
type: object
@@ -4708,9 +4708,9 @@ components:
- TransportationCharges
properties:
TransportationCharges:
- "$ref": "#/components/schemas/FRSShipmentData_TransportationCharges"
+ $ref: "#/components/schemas/FRSShipmentData_TransportationCharges"
FreightDensityRate:
- "$ref": "#/components/schemas/FRSShipmentData_FreightDensityRate"
+ $ref: "#/components/schemas/FRSShipmentData_FreightDensityRate"
HandlingUnits:
description: |
Handling Unit for Density based rating container.
@@ -4718,10 +4718,10 @@ components:
**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"
+ $ref: "#/components/schemas/FRSShipmentData_HandlingUnits"
xml:
name: FRSShipmentData
- description: FRSShipmentData container. Only returned when the FRSShipmentIIndicator
+ description: FRSShipmentData container. Only returned when the FRSShipmentIIndicator
is used. UPS Ground Freight Pricing Only.
maximum: 1
FRSShipmentData_TransportationCharges:
@@ -4733,9 +4733,9 @@ components:
- NetCharge
properties:
GrossCharge:
- "$ref": "#/components/schemas/TransportationCharges_GrossCharge"
+ $ref: "#/components/schemas/TransportationCharges_GrossCharge"
DiscountAmount:
- "$ref": "#/components/schemas/TransportationCharges_DiscountAmount"
+ $ref: "#/components/schemas/TransportationCharges_DiscountAmount"
DiscountPercentage:
description: Discount Percentage
maximum: 1
@@ -4743,7 +4743,7 @@ components:
minLength: 2
maxLength: 2
NetCharge:
- "$ref": "#/components/schemas/TransportationCharges_NetCharge"
+ $ref: "#/components/schemas/TransportationCharges_NetCharge"
xml:
name: TransportationCharges
maximum: 1
@@ -4855,11 +4855,11 @@ components:
minLength: 1
maxLength: 8
Type:
- "$ref": "#/components/schemas/HandlingUnits_Type"
+ $ref: "#/components/schemas/HandlingUnits_Type"
Dimensions:
- "$ref": "#/components/schemas/HandlingUnits_Dimensions"
+ $ref: "#/components/schemas/HandlingUnits_Dimensions"
AdjustedHeight:
- "$ref": "#/components/schemas/HandlingUnits_AdjustedHeight"
+ $ref: "#/components/schemas/HandlingUnits_AdjustedHeight"
xml:
name: HandlingUnits
HandlingUnits_AdjustedHeight:
@@ -4870,14 +4870,14 @@ components:
- Value
properties:
Value:
- description: Adjusted Height value for the handling unit. Adjusted Height
+ description: Adjusted Height value for the handling unit. Adjusted Height
is done only when Handling unit type is SKD = Skid or PLT = Pallet.
maximum: 1
type: string
minLength: 1
maxLength: 19
UnitOfMeasurement:
- "$ref": "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
description: Container to hold Adjusted Height information.
@@ -4904,7 +4904,7 @@ components:
maxLength: 19
xml:
name: BaseServiceCharge
- description: Base Service Charge Container. These charges would be returned
+ description: Base Service Charge Container. These charges would be returned
only when subversion is greater than or equal to 1701
RatedShipment_ServiceOptionsCharges:
type: object
@@ -4942,7 +4942,7 @@ components:
minLength: 1
maxLength: 9
MonetaryValue:
- description: Tax Monetary Value represent the Tax amount. Valid values
+ description: Tax Monetary Value represent the Tax amount. Valid values
are from 0 to 99999999999999.99
maximum: 1
type: string
@@ -4987,7 +4987,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: TotalChargesWithTaxes monetary value amount. Valid values
+ description: TotalChargesWithTaxes monetary value amount. Valid values
are from 0 to 99999999999999.99
maximum: 1
type: string
@@ -5007,23 +5007,23 @@ components:
type: array
items:
- "$ref": "#/components/schemas/NegotiatedRateCharges_BaseServiceCharge"
+ $ref: "#/components/schemas/NegotiatedRateCharges_BaseServiceCharge"
RateModifier:
description: |
RateModifier inside Negotiated charges container to hold Modifier charges at package level
-
+
**Note:** Applies only if SubVersion is 2407 and greater (Rate OAuth)
type: array
items:
- "$ref": "#/components/schemas/NegotiatedRateCharges_RateModifier"
+ $ref: "#/components/schemas/NegotiatedRateCharges_RateModifier"
ItemizedCharges:
description: |
- Itemized Charges are returned only when the subversion element is present and greater than or equal to '1601'. These charges would be returned only when subversion is greater than or equal to 1601.
+ Itemized Charges are returned only when the subversion element is present and greater than or equal to '1601'. These charges would be returned only when subversion is greater than or equal to 1601.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/NegotiatedRateCharges_ItemizedCharges"
+ $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.
@@ -5031,16 +5031,16 @@ components:
**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"
+ $ref: "#/components/schemas/NegotiatedRateCharges_TaxCharges"
TotalCharge:
- "$ref": "#/components/schemas/NegotiatedRateCharges_TotalCharge"
+ $ref: "#/components/schemas/NegotiatedRateCharges_TotalCharge"
TotalChargesWithTaxes:
- "$ref": "#/components/schemas/NegotiatedRateCharges_TotalChargesWithTaxes"
+ $ref: "#/components/schemas/NegotiatedRateCharges_TotalChargesWithTaxes"
xml:
name: NegotiatedRateCharges
required:
- TotalCharge
- description: Negotiated Rate Charges Container. For tiered rates and promotional
+ description: Negotiated Rate Charges Container. For tiered rates and promotional
discounts, if a particular shipment based on zone, origin, destination or
even shipment size doesn't qualify for the existing discount then no negotiated
rates container will be returned. Published rates will be the applicable rate.
@@ -5139,7 +5139,7 @@ components:
to a shipment. Please refer to Appendix I for possible Tax Type codes.
type: string
MonetaryValue:
- description: Tax Monetary Value represent the Tax amount. Valid values
+ description: Tax Monetary Value represent the Tax amount. Valid values
are from 0 to 99999999999999.99
type: string
xml:
@@ -5188,7 +5188,7 @@ components:
used in the Shipment request is returned.
type: string
MonetaryValue:
- description: TotalChargesWithTaxes monetary value amount. Valid values
+ description: TotalChargesWithTaxes monetary value amount. Valid values
are from 0 to 99999999999999.99
type: string
xml:
@@ -5200,38 +5200,38 @@ components:
type: object
properties:
BaseServiceCharge:
- "$ref": "#/components/schemas/RatedPackage_BaseServiceCharge"
+ $ref: "#/components/schemas/RatedPackage_BaseServiceCharge"
TransportationCharges:
- "$ref": "#/components/schemas/RatedPackage_TransportationCharges"
+ $ref: "#/components/schemas/RatedPackage_TransportationCharges"
ServiceOptionsCharges:
- "$ref": "#/components/schemas/RatedPackage_ServiceOptionsCharges"
+ $ref: "#/components/schemas/RatedPackage_ServiceOptionsCharges"
TotalCharges:
- "$ref": "#/components/schemas/RatedPackage_TotalCharges"
+ $ref: "#/components/schemas/RatedPackage_TotalCharges"
Weight:
description: The weight of the package in the rated Package.
type: string
BillingWeight:
- "$ref": "#/components/schemas/RatedPackage_BillingWeight"
+ $ref: "#/components/schemas/RatedPackage_BillingWeight"
Accessorial:
description: |
- The container for Accessorial indicators. This information would be returned only if ItemizedChargesRequested was present during Rate request. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Mid-day service request with Dry Ice or Oversize Pallet and SubVersion greater than or equal to 1707. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Middday Service.
+ The container for Accessorial indicators. This information would be returned only if ItemizedChargesRequested was present during Rate request. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Mid-day service request with Dry Ice or Oversize Pallet and SubVersion greater than or equal to 1707. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Middday Service.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedPackage_Accessorial"
+ $ref: "#/components/schemas/RatedPackage_Accessorial"
ItemizedCharges:
description: |
- Itemized Charges are returned only when the subversion element is present and greater than or equal to '1607'. These charges would be returned only when subversion is greater than or equal to 1607.
+ Itemized Charges are returned only when the subversion element is present and greater than or equal to '1607'. These charges would be returned only when subversion is greater than or equal to 1607.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedPackage_ItemizedCharges"
+ $ref: "#/components/schemas/RatedPackage_ItemizedCharges"
NegotiatedCharges:
- "$ref": "#/components/schemas/RatedPackage_NegotiatedCharges"
+ $ref: "#/components/schemas/RatedPackage_NegotiatedCharges"
SimpleRate:
- "$ref": "#/components/schemas/RatedPackage_SimpleRate"
+ $ref: "#/components/schemas/RatedPackage_SimpleRate"
RateModifier:
description: |
Container for returned Rate Modifier information. Applies only if SubVersion is 2205 or greater.
@@ -5239,7 +5239,7 @@ components:
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/RatedPackage_RateModifier"
+ $ref: "#/components/schemas/RatedPackage_RateModifier"
xml:
name: RatedPackage
RatedPackage_TransportationCharges:
@@ -5307,9 +5307,9 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/RatedPackage_BillingWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/RatedPackage_BillingWeight_UnitOfMeasurement"
Weight:
- description: The value for the billable weight associated with the package. When
+ description: The value for the billable weight associated with the package. When
using a negotiated divisor different from the published UPS divisor (139
for inches and 5,000 for cm), the weight returned is based on the published
divisor. Rates, however, are based on the negotiated divisor.
@@ -5439,22 +5439,22 @@ components:
RateModifier:
description: |
RateModifier inside Negotiated charges container to hold Modifier charges at package level
-
+
**Note:** Applies only if SubVersion is 2407 and greater (Rate OAuth)
type: array
items:
- "$ref": "#/components/schemas/NegotiatedCharges_RateModifier"
+ $ref: "#/components/schemas/NegotiatedCharges_RateModifier"
ItemizedCharges:
description: |
- Negotiated Itemized Accessorial and Sur Charges. These charges would be returned only when subversion is greater than or equal to 1607.
+ Negotiated Itemized Accessorial and Sur Charges. These charges would be returned only when subversion is greater than or equal to 1607.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
- "$ref": "#/components/schemas/NegotiatedCharges_ItemizedCharges"
+ $ref: "#/components/schemas/NegotiatedCharges_ItemizedCharges"
xml:
name: NegotiatedCharges
- description: Negotiated Rates container. These charges would be returned only
+ description: Negotiated Rates container. These charges would be returned only
when -1) subversion is greater than or equal to 16072) if negotiated rates
were requested for GFP shipments and account number is eligible to receive
negotiated rates.
@@ -5556,7 +5556,7 @@ components:
description: 'The date the user requests UPS to pickup the package from
the origin. Format: YYYYMMDD. In the event this Pickup date differs from
the Pickup date in the Estimated Arrival Container, a warning will be
- returned. In the event this Pickup date differs from the Pickup date
+ returned. In the event this Pickup date differs from the Pickup date
in the Estimated Arrival Container, a warning will be returned.'
maximum: 1
type: string
@@ -5575,7 +5575,7 @@ components:
minLength: 2
maxLength: 2
ServiceSummary:
- "$ref": "#/components/schemas/TimeInTransit_ServiceSummary"
+ $ref: "#/components/schemas/TimeInTransit_ServiceSummary"
AutoDutyCode:
description: 'Required output for International requests. If Documents indicator
is set for Non-document a duty is automatically calculated. The possible
@@ -5595,7 +5595,7 @@ components:
type: string
xml:
name: TimeInTransit
- description: Container for returned Time in Transit information. Will only
+ description: Container for returned Time in Transit information. Will only
be returned if request option was either "ratetimeintransit" or "shoptimeintransit"
and DeliveryTimeInformation container was present in request.
TimeInTransit_ServiceSummary:
@@ -5605,10 +5605,10 @@ components:
- Service
properties:
Service:
- "$ref": "#/components/schemas/ServiceSummary_Service"
+ $ref: "#/components/schemas/ServiceSummary_Service"
GuaranteedIndicator:
description: Empty Tag. Indicates whether the service will be guaranteed
- or not. Required for International Requests.
+ or not. Required for International Requests.
maximum: 1
type: string
Disclaimer:
@@ -5620,7 +5620,7 @@ components:
maximum: 1
type: string
EstimatedArrival:
- "$ref": "#/components/schemas/ServiceSummary_EstimatedArrival"
+ $ref: "#/components/schemas/ServiceSummary_EstimatedArrival"
SaturdayDelivery:
description: Saturday delivery information for a service. Values are1 -
Saturday Delivery Available with additional charges 0 - Saturday Delivery
@@ -5638,12 +5638,12 @@ components:
Delivery Available with additional charges 0 - Sunday Delivery not available
or no additional charge, please check Delivery Date to confirm if the
Delivery will be SundayPlease see Saturday Delivery business rules section
- for more information. Applies only if SubVersion is greater than or equal
+ for more information. Applies only if SubVersion is greater than or equal
to 2007
maximum: 1
type: string
SundayDeliveryDisclaimer:
- description: Sunday delivery disclaimer message. Applies only if SubVersion
+ description: Sunday delivery disclaimer message. Applies only if SubVersion
is greater than or equal to 2007
maximum: 1
type: string
@@ -5671,7 +5671,7 @@ components:
- BusinessDaysInTransit
properties:
Arrival:
- "$ref": "#/components/schemas/EstimatedArrival_Arrival"
+ $ref: "#/components/schemas/EstimatedArrival_Arrival"
BusinessDaysInTransit:
description: Number of business days from Origin to Destination Locations.
maximum: 1
@@ -5679,7 +5679,7 @@ components:
minLength: 1
maxLength: 5
Pickup:
- "$ref": "#/components/schemas/EstimatedArrival_Pickup"
+ $ref: "#/components/schemas/EstimatedArrival_Pickup"
DayOfWeek:
description: 'Day of week for arrival. Valid values are: MONTUEWEDTHUFRISAT'
maximum: 1
@@ -5786,7 +5786,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/CommonErrorResponse"
+ $ref: "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
@@ -5795,7 +5795,7 @@ components:
type: array
description: The error array containing any errors that occurred.
items:
- "$ref": "#/components/schemas/ErrorMessage"
+ $ref: "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
diff --git a/Shipping.yaml b/Shipping.yaml
index f182c06..8d13712 100644
--- a/Shipping.yaml
+++ b/Shipping.yaml
@@ -4,7 +4,7 @@ info:
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
@@ -15,11 +15,11 @@ info:
- Best Practices
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -30,9 +30,9 @@ paths:
"/shipments/{version}/ship":
post:
description: "The Shipping API makes UPS shipping services available to client
- applications that communicate with UPS \nusing the Internet"
+ applications that communicate with UPS\nusing the Internet"
summary: Shipment
- tags:
+ tags:
- Shipping
security:
- OAuth2: []
@@ -57,7 +57,7 @@ paths:
schema:
type: string
minimum: 1
- description: "Valid Values: \ncity = validation will include city.Length 15"
+ description: "Valid Values:\ncity = validation will include city.Length 15"
required: false
- in: path
name: version
@@ -80,7 +80,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/SHIPRequestWrapper"
+ $ref: "#/components/schemas/SHIPRequestWrapper"
examples:
'1':
summary: Shipping Request(Standard Example)
@@ -1841,7 +1841,7 @@ paths:
Request:
RequestOption: Validate
SubVersion: "1607"
- TransactionReference:
+ TransactionReference:
CustomerContext: GovTest
TransactionIdentifier: UPS123
Shipment:
@@ -1877,7 +1877,7 @@ paths:
CountryCode: US
PostalCode: "21093"
StateProvinceCode: MD
- Phone: "1234567890"
+ Phone: "1234567890"
FaxNumber: "1234567999"
TaxIdentificationNumber: "456999"
Package:
@@ -1914,37 +1914,37 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/SHIPResponseWrapper"
+ $ref: "#/components/schemas/SHIPResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $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:
+ tags:
- Shipping
security:
- OAuth2: []
@@ -1969,11 +1969,11 @@ paths:
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\"]
+ 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"
+ Must be\nupper case. Length 18"
required: false
- in: path
name: version
@@ -1991,8 +1991,8 @@ paths:
schema:
type: string
minimum: 1
- description: "The shipment's identification number \nAlpha-numeric. Must pass
- 1Z rules. Must be \nupper case. Length 18"
+ description: "The shipment's identification number\nAlpha-numeric. Must pass
+ 1Z rules. Must be\nupper case. Length 18"
required: true
responses:
'200':
@@ -2000,37 +2000,37 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/VOIDSHIPMENTResponseWrapper"
+ $ref: "#/components/schemas/VOIDSHIPMENTResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $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:
+ tags:
- Shipping
security:
- OAuth2: []
@@ -2056,12 +2056,12 @@ paths:
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"
+ 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\nLength 5"
required: true
requestBody:
description: Generate sample code for popular API requests by selecting an
@@ -2072,7 +2072,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LABELRECOVERYRequestWrapper"
+ $ref: "#/components/schemas/LABELRECOVERYRequestWrapper"
examples:
json:
summary: A sample JSON request
@@ -2104,38 +2104,38 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LABELRECOVERYResponseWrapper"
+ $ref: "#/components/schemas/LABELRECOVERYResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $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"
+ applications that communicate with UPS\nusing the Internet"
summary: Shipment
- tags:
+ tags:
- Shipping
security:
- OAuth2: []
@@ -2160,7 +2160,7 @@ paths:
schema:
type: string
minimum: 1
- description: "Valid Values: \ncity = validation will include city.Length 15"
+ description: "Valid Values:\ncity = validation will include city.Length 15"
required: false
- in: path
name: deprecatedVersion
@@ -2191,7 +2191,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/SHIPRequestWrapper"
+ $ref: "#/components/schemas/SHIPRequestWrapper"
examples:
'1':
summary: Shipping Request(Standard Example)
@@ -3951,38 +3951,38 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/SHIPResponseWrapper"
+ $ref: "#/components/schemas/SHIPResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $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:
+ tags:
- Shipping
security:
- OAuth2: []
@@ -4007,11 +4007,11 @@ paths:
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\"]
+ 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"
+ Must be\nupper case. Length 18"
required: false
- in: path
name: deprecatedVersion
@@ -4029,8 +4029,8 @@ paths:
schema:
type: string
minimum: 1
- description: "The shipment's identification number \nAlpha-numeric. Must pass
- 1Z rules. Must be \nupper case. Length 18"
+ description: "The shipment's identification number\nAlpha-numeric. Must pass
+ 1Z rules. Must be\nupper case. Length 18"
required: true
responses:
'200':
@@ -4038,31 +4038,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/VOIDSHIPMENTResponseWrapper"
+ $ref: "#/components/schemas/VOIDSHIPMENTResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
@@ -4089,7 +4089,7 @@ components:
- ShipmentRequest
properties:
ShipmentRequest:
- "$ref": "#/components/schemas/ShipmentRequest"
+ $ref: "#/components/schemas/ShipmentRequest"
SHIPResponseWrapper:
xml:
name: ShipmentResponse
@@ -4100,7 +4100,7 @@ components:
- ShipmentResponse
properties:
ShipmentResponse:
- "$ref": "#/components/schemas/ShipmentResponse"
+ $ref: "#/components/schemas/ShipmentResponse"
ShipmentRequest:
type: object
required:
@@ -4108,13 +4108,13 @@ components:
- Shipment
properties:
Request:
- "$ref": "#/components/schemas/ShipmentRequest_Request"
+ $ref: "#/components/schemas/ShipmentRequest_Request"
Shipment:
- "$ref": "#/components/schemas/ShipmentRequest_Shipment"
+ $ref: "#/components/schemas/ShipmentRequest_Shipment"
LabelSpecification:
- "$ref": "#/components/schemas/ShipmentRequest_LabelSpecification"
+ $ref: "#/components/schemas/ShipmentRequest_LabelSpecification"
ReceiptSpecification:
- "$ref": "#/components/schemas/ShipmentRequest_ReceiptSpecification"
+ $ref: "#/components/schemas/ShipmentRequest_ReceiptSpecification"
xml:
name: ShipmentRequest
description: Shipment Request.
@@ -4124,7 +4124,7 @@ components:
AddressLine1:
type: string
description: Address Line 1
- maxLength: 35
+ maxLength: 35
example: 12380 Morris Rd.
AddressLine2:
type: string
@@ -4135,11 +4135,10 @@ components:
type: string
description: City
maxLength: 30
- example: Alpharetta
+ example: Alpharetta
StateProvinceCode:
type: string
- description: |
- The code of the address's admininstrative division (state, province, distict, prefecture, etc...).
+ description: The code of the address's admininstrative division (state, province, distict, prefecture, etc...).
minLength: 2
maxLength: 5
example: GA
@@ -4165,7 +4164,7 @@ components:
- 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.
@@ -4193,7 +4192,7 @@ components:
example: 123X56GPFWZ
MasterEUConsolidationIndicator:
type: string
- description: 1 indicates a Master Consolidation request for the European Union.
+ description: 1 indicates a Master Consolidation request for the European Union.
MasterHasDocBox:
type: string
description: This field is a flag to indicate if the request is a master shipment. This is required for Master shipment only. If MasterHasDocBox is "0" then request is considered a master shipment.
@@ -4204,7 +4203,7 @@ components:
| Code | Name | Description: |
| :--: | :-- | :-- |
- | CAF | Cost And Freight | Shipper pays to point of import, conignee pays balance. |
+ | 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 |
@@ -4213,8 +4212,8 @@ components:
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.
-
+ 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
@@ -4235,7 +4234,7 @@ components:
example: John Doe
Address:
description: Address of the POE. For Master/Child Shipment
- "$ref": "#/components/schemas/Address_POE"
+ $ref: "#/components/schemas/Address_POE"
required:
- Name
- ClearancePortCode
@@ -4244,9 +4243,9 @@ components:
required:
- DestinationCountryCode
- MasterShipmentChgType
-
+
- PortOfEntry
- type: object
+ type: object
ShipmentRequest_Request:
type: object
maximum: 1
@@ -4254,10 +4253,10 @@ components:
- RequestOption
properties:
RequestOption:
- description: "Optional Processing. \n\nNote: Full address validation is
+ 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
+ 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
@@ -4272,7 +4271,7 @@ components:
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
+ 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
@@ -4280,7 +4279,7 @@ components:
minLength: 4
maxLength: 4
TransactionReference:
- "$ref": "#/components/schemas/Request_TransactionReference"
+ $ref: "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Request Container
@@ -4305,10 +4304,10 @@ components:
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;
+ 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
@@ -4318,50 +4317,50 @@ components:
minLength: 1
maxLength: 50
ReturnService:
- "$ref": "#/components/schemas/Shipment_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
+ 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.
+ 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"
+ $ref: "#/components/schemas/Shipment_Shipper"
ShipTo:
- "$ref": "#/components/schemas/Shipment_ShipTo"
+ $ref: "#/components/schemas/Shipment_ShipTo"
AlternateDeliveryAddress:
- "$ref": "#/components/schemas/Shipment_AlternateDeliveryAddress"
+ $ref: "#/components/schemas/Shipment_AlternateDeliveryAddress"
ShipFrom:
- "$ref": "#/components/schemas/Shipment_ShipFrom"
+ $ref: "#/components/schemas/Shipment_ShipFrom"
PaymentInformation:
- "$ref": "#/components/schemas/Shipment_PaymentInformation"
+ $ref: "#/components/schemas/Shipment_PaymentInformation"
FRSPaymentInformation:
- "$ref": "#/components/schemas/Shipment_FRSPaymentInformation"
+ $ref: "#/components/schemas/Shipment_FRSPaymentInformation"
GlobalTaxInformation:
$ref: '#/components/schemas/Shipment_GlobalTaxInformation'
WorldEase:
- "$ref": "#/components/schemas/Shipment_WorldEase"
+ $ref: "#/components/schemas/Shipment_WorldEase"
FreightShipmentInformation:
- "$ref": "#/components/schemas/Shipment_FreightShipmentInformation"
+ $ref: "#/components/schemas/Shipment_FreightShipmentInformation"
GoodsNotInFreeCirculationIndicator:
- description: Goods Not In Free Circulation indicator. This is an empty
+ 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"
+ $ref: "#/components/schemas/Shipment_PromotionalDiscountInformation"
DGSignatoryInfo:
- "$ref": "#/components/schemas/Shipment_DGSignatoryInfo"
+ $ref: "#/components/schemas/Shipment_DGSignatoryInfo"
ShipmentRatingOptions:
- "$ref": "#/components/schemas/Shipment_ShipmentRatingOptions"
+ $ref: "#/components/schemas/Shipment_ShipmentRatingOptions"
MovementReferenceNumber:
- description: Movement Reference Number (MRN) information. Must contain
+ 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
@@ -4371,39 +4370,39 @@ components:
ReferenceNumber:
type: array
items:
- "$ref": "#/components/schemas/Shipment_ReferenceNumber"
+ $ref: "#/components/schemas/Shipment_ReferenceNumber"
Service:
- "$ref": "#/components/schemas/Shipment_Service"
+ $ref: "#/components/schemas/Shipment_Service"
InvoiceLineTotal:
- "$ref": "#/components/schemas/Shipment_InvoiceLineTotal"
+ $ref: "#/components/schemas/Shipment_InvoiceLineTotal"
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
+ 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
+ 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
+ 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
+ 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
+ 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
@@ -4412,7 +4411,7 @@ components:
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.
+ 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.
@@ -4429,7 +4428,7 @@ components:
type: string
PackageID:
description: Customer-assigned unique piece identifier that returns visibility
- events. Required only for Mail Innovations forward shipments. Alpha numeric
+ 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
@@ -4443,7 +4442,7 @@ components:
maximum: 1
type: string
IrregularIndicator:
- description: "Mail classification defined by the USPS. Valid values: \n1
+ description: "Mail classification defined by the USPS. Valid values:\n1
= Balloon\n2 = Oversize\n3 = Not Applicable"
maximum: 1
type: string
@@ -4452,24 +4451,24 @@ components:
ShipmentIndicationType:
type: array
items:
- "$ref": "#/components/schemas/Shipment_ShipmentIndicationType"
+ $ref: "#/components/schemas/Shipment_ShipmentIndicationType"
MIDualReturnShipmentKey:
description: "MIDualReturnShipmentKey is unique key required to process
- Mail Innovations Dual Return Shipment. \n\nThe unique identifier (key)
+ 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
+ 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
+ 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
+ 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
+ Label Shipment.\n\nThis field would be ignored if MIDualReturnShipmentIndicator
is not present in UPS Package Return Shipment request."
maximum: 1
type: string
@@ -4479,9 +4478,9 @@ components:
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
+ 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
+ Returns.\n\nThis indicator is not valid with UPS Mail Innovations Returns
Service code."
maximum: 1
type: string
@@ -4502,14 +4501,14 @@ components:
maximum: 1
type: string
ShipmentServiceOptions:
- "$ref": "#/components/schemas/Shipment_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
+ 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
+ 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
@@ -4522,7 +4521,7 @@ components:
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
+ 02 = Shipment value is above threshold value. NA = Not Applicable
maximum: 1
type: string
minLength: 2
@@ -4538,8 +4537,8 @@ components:
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
+ 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
@@ -4555,7 +4554,7 @@ components:
type: array
maximum: 200
items:
- "$ref": "#/components/schemas/Shipment_Package"
+ $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
@@ -4618,15 +4617,15 @@ components:
- Name
properties:
Name:
- description: "Shippers company name. \n\nFor forward Shipment 35 characters
+ 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
+ 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
@@ -4636,9 +4635,9 @@ components:
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
+ 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
+ Shipments. This is available for Shipper accounts enabled by UPS and
applies to Forward Shipments."
maximum: 1
type: string
@@ -4646,23 +4645,23 @@ components:
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.
+ 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"
+ $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,
+ 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
+ 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
+ (TD) enabled.\n\nAll other accounts must be either a daily pickup account
or an occasional account."
maximum: 1
type: string
@@ -4675,14 +4674,14 @@ components:
minLength: 1
maxLength: 14
EMailAddress:
- description: Shipper's email address. Must be associated with the UserId
+ description: Shipper's email address. Must be associated with the UserId
specified in the AccessRequest XML.
maximum: 1
type: string
minLength: 1
maxLength: 50
Address:
- "$ref": "#/components/schemas/Shipper_Address"
+ $ref: "#/components/schemas/Shipper_Address"
xml:
name: Shipper
description: Container for the Shipper's information.
@@ -4694,7 +4693,7 @@ components:
properties:
Number:
description: |
- Shipper's phone Number. Valid values are 0 - 9.
+ 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
@@ -4736,7 +4735,7 @@ components:
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.
+ 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
@@ -4745,7 +4744,7 @@ components:
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.
+ 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.
maximum: 1
type: string
minLength: 1
@@ -4770,7 +4769,7 @@ components:
xml:
name: Address
description: |
- Address tag Container. The package should be returned to this address if the package is undeliverable.
+ 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.
@@ -4783,7 +4782,7 @@ components:
- Name
properties:
Name:
- description: Consignee's company name. All other accounts must be either
+ description: Consignee's company name. All other accounts must be either
a daily pickup account or an occasional account.
maximum: 1
type: string
@@ -4791,7 +4790,7 @@ components:
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.
+ 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
@@ -4812,9 +4811,9 @@ components:
minLength: 1
maxLength: 15
Phone:
- "$ref": "#/components/schemas/ShipTo_Phone"
+ $ref: "#/components/schemas/ShipTo_Phone"
FaxNumber:
- description: Consignee's fax number. If ShipTo country or territory is
+ description: Consignee's fax number. If ShipTo country or territory is
US 10 digits allowed, otherwise 1-15 digits allowed.
maximum: 1
type: string
@@ -4827,10 +4826,10 @@ components:
minLength: 1
maxLength: 50
Address:
- "$ref": "#/components/schemas/ShipTo_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.
+ shipping/receiving location. Location ID must be alphanumeric characters.
All letters must be capitalized.
maximum: 1
type: string
@@ -4847,7 +4846,7 @@ components:
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.
+ 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
@@ -4892,7 +4891,7 @@ components:
maxLength: 30
StateProvinceCode:
description: |
- Consignee's state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/ Canadian Province code.
+ Consignee's state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/ Canadian Province code.
If the country or territory is Ireland, the StateProvinceCode will contain the county.
maximum: 1
@@ -4901,7 +4900,7 @@ components:
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.
+ 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.
@@ -4912,7 +4911,7 @@ components:
maxLength: 9
CountryCode:
description: |
- Consignee's country or territory code. Must be a valid UPS Billing country or territory code.
+ 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.
@@ -4923,7 +4922,7 @@ components:
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
+ location.\nTrue if ResidentialAddressIndicator tag exists. This is an
empty tag, any value inside is ignored."
maximum: 1
type: string
@@ -4962,10 +4961,10 @@ components:
minLength: 9
maxLength: 9
Address:
- "$ref": "#/components/schemas/AlternateDeliveryAddress_Address"
+ $ref: "#/components/schemas/AlternateDeliveryAddress_Address"
xml:
name: AlternateDeliveryAddress
- description: AlternateDeliveryAddress Container. Alternate Delivery Address
+ description: AlternateDeliveryAddress Container. Alternate Delivery Address
(UPS Access Point Address) required if ShipmentIndicationType is 01 or 02.
AlternateDeliveryAddress_Address:
type: object
@@ -4991,7 +4990,7 @@ components:
maxLength: 30
StateProvinceCode:
description: |
- Retail Location state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/Canadian Province code.
+ Retail Location state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/Canadian Province code.
If the country or territory is Ireland, the StateProvinceCode will contain the county.
maximum: 1
@@ -5028,15 +5027,15 @@ components:
- Name
properties:
Name:
- description: "The ship from location's name or company name. \n35 characters
+ 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."
+ 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,
+ 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
@@ -5061,23 +5060,23 @@ components:
minLength: 1
maxLength: 15
TaxIDType:
- "$ref": "#/components/schemas/ShipFrom_TaxIDType"
+ $ref: "#/components/schemas/ShipFrom_TaxIDType"
Phone:
- "$ref": "#/components/schemas/ShipFrom_Phone"
+ $ref: "#/components/schemas/ShipFrom_Phone"
FaxNumber:
- description: The Ship from fax number. If Ship from country or territory
+ 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"
+ $ref: "#/components/schemas/ShipFrom_Address"
VendorInfo:
- "$ref": "#/components/schemas/ShipFrom_VendorInfo"
+ $ref: "#/components/schemas/ShipFrom_VendorInfo"
xml:
name: ShipFrom
- description: "Ship From Container. Required for return shipment. \n\nRequired
+ description: "Ship From Container. Required for return shipment.\n\nRequired
if pickup location is different from the shipper's address."
ShipFrom_TaxIDType:
type: object
@@ -5086,24 +5085,24 @@ components:
- Code
properties:
Code:
- description: "Company's tax Identification type. Valid values: EIN, DNS,
- and FGN. \nApplies to EEI form only."
+ 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.
+ description: Description of TaxID submitted. Applies to EEI form only.
type: string
xml:
name: TaxIDType
- description: Tax Identification Container. Applies to EEI form only.
+ 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."
+ 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.
+ description: Description of TaxID submitted. Applies to EEI form only.
maximum: 1
type: string
minLength: 1
@@ -5128,11 +5127,11 @@ components:
maxLength: 4
xml:
name: Phone
- description: "Container for Phone Number. If ShipFrom country or territory
+ 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
+ code, 7 digit number.\n\nIf ShipFrom tag is in the XML and International
forms is requested."
ShipFrom_Address:
type: object
@@ -5156,14 +5155,14 @@ components:
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
+ 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.
+ Origin location's state or province code. Required if ShipFrom is supplied, and ShipFrom country or territory is US.
If ShipFrom country or territory is US or CA, then the value must be a valid US State/ Canadian Province code. If the country or territory is Ireland, the StateProvinceCode will contain the county or territory.
maximum: 1
@@ -5173,7 +5172,7 @@ components:
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.
+ 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.
@@ -5186,7 +5185,7 @@ components:
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:
+ 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.
@@ -5197,7 +5196,7 @@ components:
maxLength: 2
xml:
name: Address
- description: Ship from Address Container. The package will be originating from
+ 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:
@@ -5248,12 +5247,12 @@ components:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/PaymentInformation_ShipmentCharge"
+ $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,
+ 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.
@@ -5264,7 +5263,7 @@ components:
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
+ charges and Duties and Taxes. It is required for non-Ground Freight Pricing
shipments only.
PaymentInformation_ShipmentCharge:
type: object
@@ -5272,30 +5271,30 @@ components:
- Type
properties:
Type:
- description: "Valid values: \n01 = Transportation\n02 = Duties and Taxes
+ 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;
+ 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
+ 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
+ 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"
+ $ref: "#/components/schemas/ShipmentCharge_BillShipper"
BillReceiver:
- "$ref": "#/components/schemas/ShipmentCharge_BillReceiver"
+ $ref: "#/components/schemas/ShipmentCharge_BillReceiver"
BillThirdParty:
- "$ref": "#/components/schemas/ShipmentCharge_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.
+ 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.
@@ -5305,14 +5304,14 @@ components:
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.
+ 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
+ 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
@@ -5320,14 +5319,14 @@ components:
minLength: 6
maxLength: 6
CreditCard:
- "$ref": "#/components/schemas/BillShipper_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
+ 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
+ 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
@@ -5338,7 +5337,7 @@ components:
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
+ 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:
@@ -5379,7 +5378,7 @@ components:
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)
+ 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
@@ -5387,7 +5386,7 @@ components:
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
+ 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
@@ -5397,13 +5396,13 @@ components:
minLength: 3
maxLength: 4
Address:
- "$ref": "#/components/schemas/CreditCard_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."
+ 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
@@ -5446,7 +5445,7 @@ components:
maxLength: 2
xml:
name: Address
- description: Container to hold the Credit card Billing Address. It is required
+ 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:
@@ -5456,10 +5455,10 @@ components:
- 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
+ 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
+ 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
@@ -5467,10 +5466,10 @@ components:
minLength: 6
maxLength: 6
Address:
- "$ref": "#/components/schemas/BillReceiver_Address"
+ $ref: "#/components/schemas/BillReceiver_Address"
xml:
name: BillReceiver
- description: Container for the BillReceiver billing option. This element or
+ 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.
@@ -5480,7 +5479,7 @@ components:
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.
+ 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.
@@ -5501,10 +5500,10 @@ components:
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
+ 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
+ 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
@@ -5526,12 +5525,12 @@ components:
minLength: 1
maxLength: 15
Address:
- "$ref": "#/components/schemas/BillThirdParty_Address"
+ $ref: "#/components/schemas/BillThirdParty_Address"
xml:
name: BillThirdParty
required:
- Address
- description: Container for the third party billing option. This element or
+ 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:
@@ -5540,7 +5539,7 @@ components:
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.
+ 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.
@@ -5572,9 +5571,9 @@ components:
- AccountNumber
properties:
Type:
- "$ref": "#/components/schemas/FRSPaymentInformation_Type"
+ $ref: "#/components/schemas/FRSPaymentInformation_Type"
AccountNumber:
- description: The UPS account number. If the Ground Freight Pricing indicator
+ 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.
@@ -5583,11 +5582,11 @@ components:
minLength: 6
maxLength: 6
Address:
- "$ref": "#/components/schemas/FRSPaymentInformation_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.
+ Pricing Shipments. Required for Ground Freight Pricing Shipments only.
FRSPaymentInformation_Type:
type: object
maximum: 1
@@ -5610,7 +5609,7 @@ components:
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.
+ 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
@@ -5634,13 +5633,13 @@ components:
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
+ 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"
+ $ref: "#/components/schemas/FreightShipmentInformation_FreightDensityInfo"
DensityEligibleIndicator:
description: |-
The presence of the tag indicates that the rate request is density based.
@@ -5661,14 +5660,14 @@ components:
maximum: 1
type: string
AdjustedHeight:
- "$ref": "#/components/schemas/FreightDensityInfo_AdjustedHeight"
+ $ref: "#/components/schemas/FreightDensityInfo_AdjustedHeight"
HandlingUnits:
type: array
items:
- "$ref": "#/components/schemas/FreightDensityInfo_HandlingUnits"
+ $ref: "#/components/schemas/FreightDensityInfo_HandlingUnits"
xml:
name: FreightDensityInfo
- description: Freight Density Info container. Required if DensityEligibleIndicator
+ description: Freight Density Info container. Required if DensityEligibleIndicator
is present.
FreightDensityInfo_AdjustedHeight:
type: object
@@ -5684,10 +5683,10 @@ components:
minLength: 1
maxLength: 19
UnitOfMeasurement:
- "$ref": "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
- description: Container for the adjusted height. Required if AdjustedHeightIndicator
+ description: Container for the adjusted height. Required if AdjustedHeightIndicator
is present.
AdjustedHeight_UnitOfMeasurement:
type: object
@@ -5727,9 +5726,9 @@ components:
minLength: 8
maxLength: 8
Type:
- "$ref": "#/components/schemas/HandlingUnits_Type"
+ $ref: "#/components/schemas/HandlingUnits_Type"
Dimensions:
- "$ref": "#/components/schemas/HandlingUnits_Dimensions"
+ $ref: "#/components/schemas/HandlingUnits_Dimensions"
xml:
name: HandlingUnits
description: Handling Unit for Density based rating container.
@@ -5741,7 +5740,7 @@ components:
properties:
Code:
description: |
- Handling Unit Code for Density based rating. Valid values:
+ Handling Unit Code for Density based rating. Valid values:
- SKD = Skid
- CBY = Carboy
- PLT = Pallet
@@ -5770,7 +5769,7 @@ components:
- Width
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/HandlingUnits_UnitOfMeasurement"
+ $ref: "#/components/schemas/HandlingUnits_UnitOfMeasurement"
Length:
description: The length of the line item used to determine dimensional weight.
maximum: 1
@@ -5822,7 +5821,7 @@ components:
- PromoCode
properties:
PromoCode:
- description: Promotion Code. A discount that is applied to the user. Required
+ description: Promotion Code. A discount that is applied to the user. Required
if PromotionalDiscountInformation container is present.
maximum: 1
type: string
@@ -5845,7 +5844,7 @@ components:
maximum: 1
properties:
Name:
- description: "Name of the person signing the declaration. \n\nNote: The
+ 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
@@ -5866,13 +5865,13 @@ components:
minLength: 35
maxLength: 35
Date:
- description: Date of signing the declaration form. Valid format is YYYYMMDD.
+ 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
+ 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
@@ -5895,12 +5894,12 @@ components:
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
+ 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
+ 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
+ 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
@@ -5910,7 +5909,7 @@ components:
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
+ 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
@@ -5924,9 +5923,9 @@ components:
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
+ (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
+ 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
@@ -5946,17 +5945,17 @@ components:
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.
+ 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.
+ 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
+ description: Customer supplied reference number. Valid if the origin/destination pair is not US/US or PR/PR
maximum: 1
type: string
minLength: 1
@@ -6038,14 +6037,14 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Invoice Line Total amount for the entire shipment. Valid values are from 1 to 99999999
+ 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
+ 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.
@@ -6072,7 +6071,7 @@ components:
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."
+ 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
@@ -6080,25 +6079,25 @@ components:
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.
+ 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
+ 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"
+ $ref: "#/components/schemas/ShipmentServiceOptions_COD"
AccessPointCOD:
- "$ref": "#/components/schemas/ShipmentServiceOptions_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
+ the shipment. Only valid for Shipment Indication type "01 - Hold For
PickUp at UPS Access Point".
maximum: 1
type: string
@@ -6110,16 +6109,16 @@ components:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/ShipmentServiceOptions_Notification"
+ $ref: "#/components/schemas/ShipmentServiceOptions_Notification"
LabelDelivery:
- "$ref": "#/components/schemas/ShipmentServiceOptions_LabelDelivery"
+ $ref: "#/components/schemas/ShipmentServiceOptions_LabelDelivery"
InternationalForms:
- "$ref": "#/components/schemas/ShipmentServiceOptions_InternationalForms"
+ $ref: "#/components/schemas/ShipmentServiceOptions_InternationalForms"
DeliveryConfirmation:
- "$ref": "#/components/schemas/ShipmentServiceOptions_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.
+ requested. Valid for Poland to Poland forward shipment only.
maximum: 1
type: string
ImportControlIndicator:
@@ -6127,7 +6126,7 @@ components:
maximum: 1
type: string
LabelMethod:
- "$ref": "#/components/schemas/ShipmentServiceOptions_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
@@ -6142,45 +6141,45 @@ components:
PreAlertNotification:
type: array
items:
- "$ref": "#/components/schemas/ShipmentServiceOptions_PreAlertNotification"
+ $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
+ 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
+ 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
+ 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
+ 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
+ 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
+ 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
+ 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
+ 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
+ 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
@@ -6191,13 +6190,13 @@ components:
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."
+ 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"
+ $ref: "#/components/schemas/ShipmentServiceOptions_RestrictedArticles"
InsideDelivery:
description: |-
Inside delivery accessory. Valid values:
@@ -6205,7 +6204,7 @@ components:
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.
+ Default is Room of Choice. Shippers account needs to have a valid contract for Heavy Goods Service.
maximum: 1
type: string
minLength: 2
@@ -6213,7 +6212,7 @@ components:
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
+ items disposed. Shippers account needs to have a valid contract for Heavy
Goods Service.
maximum: 1
type: string
@@ -6235,7 +6234,7 @@ components:
minLength: 1
maxLength: 1
CODAmount:
- "$ref": "#/components/schemas/COD_CODAmount"
+ $ref: "#/components/schemas/COD_CODAmount"
xml:
name: COD
description: COD container Indicates COD is requested. Shipment COD is only
@@ -6285,10 +6284,10 @@ components:
maxLength: 8
xml:
name: AccessPointCOD
- description: "Access Point COD indicates COD is requested for a shipment. Valid
+ 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
+ within E.U.\nNot valid with (Shipment) COD.\nNot available to shipment with
return service."
ShipmentServiceOptions_Notification:
type: object
@@ -6320,18 +6319,18 @@ components:
minLength: 1
maxLength: 1
EMail:
- "$ref": "#/components/schemas/Notification_EMail"
+ $ref: "#/components/schemas/Notification_EMail"
VoiceMessage:
- "$ref": "#/components/schemas/Notification_VoiceMessage"
+ $ref: "#/components/schemas/Notification_VoiceMessage"
TextMessage:
- "$ref": "#/components/schemas/Notification_TextMessage"
+ $ref: "#/components/schemas/Notification_TextMessage"
Locale:
- "$ref": "#/components/schemas/Notification_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
+ 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:
@@ -6341,7 +6340,7 @@ components:
- 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.
+ 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.
type: array
maximum: 5
items:
@@ -6349,25 +6348,25 @@ components:
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.
+ 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."
+ 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.
+ 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.
+ 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
@@ -6390,7 +6389,7 @@ components:
xml:
name: VoiceMessage
description: VoiceMessage container is used for specifying phone number for
- receiving voice Alternate Delivery Location notification and UAP Shipper notification. Valid
+ 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.
@@ -6409,7 +6408,7 @@ components:
xml:
name: TextMessage
description: TextMessage container is used for specifying phone number for receiving
- text Alternate Delivery Location notification and UAP Shipper notification. Valid
+ 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.
@@ -6437,13 +6436,13 @@ components:
xml:
name: Locale
description: This container is used for providing Language and dialect details
- for Alternate Delivery Location notifications and UAP Shipper notifications. Valid
+ 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"
+ $ref: "#/components/schemas/LabelDelivery_EMail"
LabelLinksIndicator:
description: Indicates the Label and Receipt URLs are to be returned in
the XML response.
@@ -6453,10 +6452,10 @@ components:
name: LabelDelivery
maximum: 1
description: Container for the Label Delivery accessorial. Note - LabelDelivery
- is not applicable for GFP and Mail Innovations Forward shipment. Required
+ 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
+ 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
@@ -6476,7 +6475,7 @@ components:
minLength: 1
maxLength: 50
UndeliverableEMailAddress:
- description: The address where an undeliverable email message is sent if the Label Delivery email is undeliverable. Defaults to FromEMailAddress.
+ description: The address where an undeliverable email message is sent if the Label Delivery email is undeliverable. Defaults to FromEMailAddress.
maximum: 1
type: string
minLength: 1
@@ -6564,19 +6563,19 @@ components:
minLength: 2
maxLength: 2
UserCreatedForm:
- "$ref": "#/components/schemas/InternationalForms_UserCreatedForm"
+ $ref: "#/components/schemas/InternationalForms_UserCreatedForm"
UPSPremiumCareForm:
- "$ref": "#/components/schemas/InternationalForms_UPSPremiumCareForm"
+ $ref: "#/components/schemas/InternationalForms_UPSPremiumCareForm"
CN22Form:
- "$ref": "#/components/schemas/InternationalForms_CN22Form"
+ $ref: "#/components/schemas/InternationalForms_CN22Form"
AdditionalDocumentIndicator:
description: "Presence of the indicator means user will supply additional
- document, such as EEI, NAFTA_CO or CO. This indicator should be set when
+ document, such as EEI, NAFTA_CO 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, NAFTACO)
- 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
+ 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
@@ -6588,16 +6587,16 @@ components:
minLength: 1
maxLength: 50
EEIFilingOption:
- "$ref": "#/components/schemas/InternationalForms_EEIFilingOption"
+ $ref: "#/components/schemas/InternationalForms_EEIFilingOption"
Contacts:
- "$ref": "#/components/schemas/InternationalForms_Contacts"
+ $ref: "#/components/schemas/InternationalForms_Contacts"
Product:
type: array
maximum: 50
items:
- "$ref": "#/components/schemas/InternationalForms_Product"
+ $ref: "#/components/schemas/InternationalForms_Product"
InvoiceNumber:
- description: Commercial Invoice number assigned by the exporter. Applies
+ 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
@@ -6606,7 +6605,7 @@ components:
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.
+ 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.
@@ -6616,7 +6615,7 @@ components:
minLength: 8
maxLength: 8
PurchaseOrderNumber:
- description: The customer's order reference number. Applies to Invoice
+ description: The customer's order reference number. Applies to Invoice
and Partial Invoice forms only.
maximum: 1
type: string
@@ -6624,12 +6623,12 @@ components:
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 \nDDU: Delivery
- Duty Unpaid \nDEQ: Delivered Ex Quay \nDES: Delivered Ex Ship \nEXW: Ex
- Works \nFAS: Free Alongside Ship \nFCA: Free Carrier \nFOB: Free On Board"
+ 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\nDDU: Delivery
+ Duty Unpaid\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
@@ -6637,13 +6636,13 @@ components:
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. No validation.
+ 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. No validation.
maximum: 1
type: string
minLength: 1
maxLength: 20
Comments:
- description: Any extra information about the current shipment. Applies
+ description: Any extra information about the current shipment. Applies
to Invoice and Partial Invoice forms only.
maximum: 1
type: string
@@ -6656,10 +6655,10 @@ components:
field are: I hereby certify that the goods covered by this shipment qualify
as originating goods for purposes of preferential tariff treatment under
the NAFTA. 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
+ 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.
+ 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
@@ -6669,24 +6668,24 @@ components:
minLength: 1
maxLength: 550
Discount:
- "$ref": "#/components/schemas/InternationalForms_Discount"
+ $ref: "#/components/schemas/InternationalForms_Discount"
FreightCharges:
- "$ref": "#/components/schemas/InternationalForms_FreightCharges"
+ $ref: "#/components/schemas/InternationalForms_FreightCharges"
InsuranceCharges:
- "$ref": "#/components/schemas/InternationalForms_InsuranceCharges"
+ $ref: "#/components/schemas/InternationalForms_InsuranceCharges"
OtherCharges:
- "$ref": "#/components/schemas/InternationalForms_OtherCharges"
+ $ref: "#/components/schemas/InternationalForms_OtherCharges"
CurrencyCode:
- description: Currency code for all the monetary values of the Invoice form. Applies
+ 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"
+ $ref: "#/components/schemas/InternationalForms_BlanketPeriod"
ExportDate:
- description: The date the goods will be exiting the country or territory. Applies
+ 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
@@ -6696,7 +6695,7 @@ components:
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.
+ 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
@@ -6704,14 +6703,14 @@ components:
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
+ 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.
+ 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
@@ -6721,7 +6720,7 @@ components:
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
+ 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
@@ -6732,8 +6731,8 @@ components:
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.'
+ 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
@@ -6749,8 +6748,8 @@ components:
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
+ 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
@@ -6762,21 +6761,21 @@ components:
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.'
+ 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
+ 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
+ description: Pier where goods are loaded. For vessel shipments only. Applies
to EEI forms only. No validation is performed.
maximum: 1
type: string
@@ -6784,7 +6783,7 @@ components:
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.
+ 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
@@ -6801,12 +6800,12 @@ components:
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.
+ 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.
+ applies to vessel shipments only. Applies to EEI forms only.
maximum: 1
type: string
OverridePaperlessIndicator:
@@ -6817,7 +6816,7 @@ components:
maximum: 1
type: string
ShipperMemo:
- description: Text for the shipper to add additional information. Forward
+ description: Text for the shipper to add additional information. Forward
shipment only.
maximum: 1
type: string
@@ -6847,7 +6846,7 @@ components:
maxLength: 26
xml:
name: UserCreatedForm
- description: Data container for DocumentID(s). Required if Form Type is 07.
+ description: Data container for DocumentID(s). Required if Form Type is 07.
InternationalForms_UPSPremiumCareForm:
type: object
maximum: 1
@@ -6859,37 +6858,37 @@ components:
- LanguageForUPSPremiumCare
properties:
ShipmentDate:
- description: 'Shipment Date associated with UPS Premium Care Shipment. Valid
+ 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
+ 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
+ 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
+ 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"
+ $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.
+ is present on a package. Valid only for Canada to Canada movements.
UPSPremiumCareForm_LanguageForUPSPremiumCare:
type: object
maximum: 2
@@ -6898,7 +6897,7 @@ components:
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
+ for UPS Premium Care Form. Valid values:\neng = US English\nfra = Canadian
French"
maximum: 2
type: array
@@ -6920,14 +6919,14 @@ components:
- CN22Content
properties:
LabelSize:
- description: "Provide the valid values: \n6 = 4X6\n1 = 8.5X11\n Required
+ description: "Provide the valid values:\n6 = 4X6\n1 = 8.5X11\nRequired
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
+ description: Number of label per page. Currently 1 per page is supported. Required
if the CN22 form container is present.
maximum: 1
type: string
@@ -6942,14 +6941,14 @@ components:
minLength: 1
maxLength: 4
CN22Type:
- description: "Valid values: \n1 = GIFT\n2 = DOCUMENTS\n3 = COMMERCIAL SAMPLE\n4
+ 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
+ description: Required if CN22Type is OTHER. Required if the CN22 form container
is present.
maximum: 1
type: string
@@ -6966,10 +6965,10 @@ components:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/CN22Form_CN22Content"
+ $ref: "#/components/schemas/CN22Form_CN22Content"
xml:
name: CN22Form
- description: Container for the CN22 form. Required if the customer wants to
+ description: Container for the CN22 form. Required if the customer wants to
use the UPS generated CN22.
CN22Form_CN22Content:
type: object
@@ -6982,7 +6981,7 @@ components:
- CN22ContentQuantity
properties:
CN22ContentQuantity:
- description: Total number of items associated with this content. Required
+ description: Total number of items associated with this content. Required
if the CN22 form container is present.
maximum: 1
type: string
@@ -6990,22 +6989,22 @@ components:
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.
+ 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"
+ $ref: "#/components/schemas/CN22Content_CN22ContentWeight"
CN22ContentTotalValue:
- description: Total value of the items associated with this content. Required
+ 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
+ description: Currently only USD is supported. Required if the CN22 form
container is present.
maximum: 1
type: string
@@ -7026,8 +7025,8 @@ components:
maxLength: 40
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
+ 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_CN22ContentWeight:
type: object
@@ -7036,10 +7035,10 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/CN22ContentWeight_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.
+ up to 2 decimals. Required if the CN22 form container is present.
maximum: 1
type: string
minLength: 7
@@ -7055,7 +7054,7 @@ components:
- Code
properties:
Code:
- description: Required if weight is provided, valid values are lbs. and ozs. Required if weight is provided.
+ description: Required if weight is provided, valid values are lbs. and ozs. Required if weight is provided.
maximum: 1
type: string
minLength: 1
@@ -7076,8 +7075,8 @@ components:
- Code
properties:
Code:
- description: "Required for EEI Form. Applicable for EEI form.\nValid values:
- \n1 - Shipper filed,\n2 - AES Direct, \n3 - UPS filed."
+ 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
@@ -7091,25 +7090,25 @@ components:
minLength: 1
maxLength: 50
Description:
- description: Optional Description of Filing Code. Applicable for EEI form.
+ description: Optional Description of Filing Code. Applicable for EEI form.
maximum: 1
type: string
minLength: 1
maxLength: 20
UPSFiled:
- "$ref": "#/components/schemas/EEIFilingOption_UPSFiled"
+ $ref: "#/components/schemas/EEIFilingOption_UPSFiled"
ShipperFiled:
- "$ref": "#/components/schemas/EEIFilingOption_ShipperFiled"
+ $ref: "#/components/schemas/EEIFilingOption_ShipperFiled"
xml:
name: EEIFilingOption
- description: EEI Filing option. Applicable for EEI form and is required.
+ description: EEI Filing option. Applicable for EEI form and is required.
EEIFilingOption_UPSFiled:
type: object
required:
- POA
properties:
POA:
- "$ref": "#/components/schemas/UPSFiled_POA"
+ $ref: "#/components/schemas/UPSFiled_POA"
xml:
name: UPSFiled
description: Indicates the EEI UPS Filed option. (option 3) Applicable for
@@ -7122,21 +7121,21 @@ components:
- Code
properties:
Code:
- description: Indicates the EEI UPS Filed POA filing option. Applicable
+ 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.
+ 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.
+ description: Container for POA. Applicable for EEI form.
EEIFilingOption_ShipperFiled:
type: object
maximum: 1
@@ -7144,7 +7143,7 @@ components:
- Code
properties:
Code:
- description: 'Indicates the EEI Shipper sub option. Applicable for EEI
+ 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
@@ -7152,14 +7151,14 @@ components:
minLength: 1
maxLength: 1
Description:
- description: Description of ShipperFiled Code. Applicable for EEI form.
+ 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
+ is available from AESDirect website. Valid and Required for Shipper Filed
option A. EEI form only.
maximum: 1
type: string
@@ -7187,25 +7186,25 @@ components:
xml:
name: ShipperFiled
description: Indicates the EEI Shipper Filed option or AES Direct. (Option 1
- or 2). Applicable for EEI form.
+ or 2). Applicable for EEI form.
InternationalForms_Contacts:
type: object
properties:
ForwardAgent:
- "$ref": "#/components/schemas/Contacts_ForwardAgent"
+ $ref: "#/components/schemas/Contacts_ForwardAgent"
UltimateConsignee:
- "$ref": "#/components/schemas/Contacts_UltimateConsignee"
+ $ref: "#/components/schemas/Contacts_UltimateConsignee"
IntermediateConsignee:
- "$ref": "#/components/schemas/Contacts_IntermediateConsignee"
+ $ref: "#/components/schemas/Contacts_IntermediateConsignee"
Producer:
- "$ref": "#/components/schemas/Contacts_Producer"
+ $ref: "#/components/schemas/Contacts_Producer"
SoldTo:
- "$ref": "#/components/schemas/Contacts_SoldTo"
+ $ref: "#/components/schemas/Contacts_SoldTo"
xml:
name: Contacts
- description: Holds the contact information of various parties. Applicable for
+ description: Holds the contact information of various parties. Applicable for
EEI and NAFTA CO only. Required for NAFTA CO and EEI. Ultimate consignee contact
- information is required for EEI. Producer contact information is required
+ information is required for EEI. Producer contact information is required
for NAFTA CO
maximum: 1
Contacts_ForwardAgent:
@@ -7217,7 +7216,7 @@ components:
- TaxIdentificationNumber
properties:
CompanyName:
- description: Company Name or the Individual name of the Forwarding agent. Applicable
+ description: Company Name or the Individual name of the Forwarding agent. Applicable
for EEI form only.
maximum: 1
type: string
@@ -7225,18 +7224,18 @@ components:
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."
+ are applicable for EEIFilingOption Code =3)\n94-308351500\n13-168669100
+ \\nApplicable for EEI form only."
maximum: 1
type: string
minLength: 1
maxLength: 15
Address:
- "$ref": "#/components/schemas/ForwardAgent_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
+ the trans-shipping of freight to the destination country or territory. Applicable
for EEI form only.
ForwardAgent_Address:
type: object
@@ -7247,7 +7246,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: Address line of the Forwarding agent. Applicable for EEI form only.
+ description: Address line of the Forwarding agent. Applicable for EEI form only.
maximum: 3
type: array
items:
@@ -7255,38 +7254,38 @@ components:
minLength: 1
maxLength: 35
City:
- description: City of the Forwarding agent. Applicable for EEI form only.
+ 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.
+ description: State of the Forwarding agent. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
- description: Town of the Forwarding Agent. Applicable for EEI form only.
+ 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
+ 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.
+ 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
+ description: Address information of the Forwarding agent. Applicable for EEI
form only.
Contacts_UltimateConsignee:
type: object
@@ -7296,21 +7295,21 @@ components:
- Address
properties:
CompanyName:
- description: Company Name or the Individual name of the Ultimate consignee. Applicable
+ 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"
+ $ref: "#/components/schemas/UltimateConsignee_Address"
UltimateConsigneeType:
- "$ref": "#/components/schemas/UltimateConsignee_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.
+ is the end-user of the goods. Applicable for EEI form only.
UltimateConsignee_Address:
type: object
maximum: 1
@@ -7320,7 +7319,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: Address line of the Ultimate consignee. Applicable for EEI form only.
+ description: Address line of the Ultimate consignee. Applicable for EEI form only.
maximum: 3
type: array
items:
@@ -7328,38 +7327,38 @@ components:
minLength: 1
maxLength: 35
City:
- description: City of the Ultimate consignee. Applicable for EEI form only.
+ 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 certain countries or territories. The length of the postal code depends on the country or territory code
+ description: State 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: 5
Town:
- description: Town of the Ultimate consignee. Applicable for EEI form only.
+ 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.
+ 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.
+ 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
+ description: Address information of the Ultimate consignee. Applicable for
EEI form only.
UltimateConsignee_UltimateConsigneeType:
type: object
@@ -7368,15 +7367,15 @@ components:
- 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
+ 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
+ description: Ultimate Consignee Type Description. Applicable for EEI form
only.
maximum: 1
type: string
@@ -7384,7 +7383,7 @@ components:
maxLength: 20
xml:
name: UltimateConsigneeType
- description: Container for providing UltimateConsignee Type. Applicable for
+ description: Container for providing UltimateConsignee Type. Applicable for
EEI form only.
Contacts_IntermediateConsignee:
type: object
@@ -7394,18 +7393,18 @@ components:
- Address
properties:
CompanyName:
- description: Company Name or the Individual name of the Intermediate consignee. Applicable
+ 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"
+ $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
+ country or territory that makes final delivery to the ultimate consignee. Applicable
for EEI form only.
IntermediateConsignee_Address:
type: object
@@ -7416,7 +7415,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: Address line of the Intermediate Consignee. Applicable for EEI form only.
+ description: Address line of the Intermediate Consignee. Applicable for EEI form only.
maximum: 3
type: array
items:
@@ -7424,38 +7423,38 @@ components:
minLength: 1
maxLength: 35
City:
- description: City of the Intermediate Consignee. Applicable for EEI form only.
+ 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 certain countries or territories.
+ description: State of the Intermediate Consignee. Applicable for EEI form only. Required for certain countries or territories.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
- description: Town of the Intermediate consignee. Applicable for EEI form only.
+ 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.
+ 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.
+ 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
+ description: Address information of the Intermediate Consignee. Applicable
for EEI form only.
Contacts_Producer:
type: object
@@ -7463,44 +7462,44 @@ components:
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
+ 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
- NAFTA CO. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02
+ to the goods described in the Description of Goods field. Applies to
+ NAFTA CO.\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 NAFTA CO. Only applicable when producer option is empty or not present.
+ description: 'Company Name or the Individual name of the Producer. Applies
+ to NAFTA CO. Only applicable when producer option is empty or not present.
Conditionally required for: NAFTA CO, when Producer option is not specified.'
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
- description: Tax ID of the Producer. Applies to NAFTA CO. Only applicable
+ description: Tax ID of the Producer. Applies to NAFTA CO. Only applicable
when producer option is empty or not present
maximum: 1
type: string
minLength: 1
maxLength: 15
Address:
- "$ref": "#/components/schemas/Producer_Address"
+ $ref: "#/components/schemas/Producer_Address"
AttentionName:
- description: Contact name at the Producer location. Applies to NAFTA CO.
+ description: Contact name at the Producer location. Applies to NAFTA CO.
maximum: 1
type: string
minLength: 1
maxLength: 35
Phone:
- "$ref": "#/components/schemas/Producer_Phone"
+ $ref: "#/components/schemas/Producer_Phone"
EMailAddress:
- description: Producer email address. Applies to NAFTA CO.
+ description: Producer email address. Applies to NAFTA CO.
maximum: 1
type: string
minLength: 1
@@ -7508,10 +7507,10 @@ components:
xml:
name: Producer
description: "Information of the producer. The NAFTA Certificate of Origin must
- be completed, signed, and dated by the exporter. \nWhen the Certificate is
+ 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 NAFTA CO. Required for NAFTA CO forms."
+ and signed. Applies to NAFTA CO. Required for NAFTA CO forms."
Producer_Address:
type: object
maximum: 1
@@ -7529,13 +7528,13 @@ components:
minLength: 1
maxLength: 35
City:
- description: "City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified."
+ description: "City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified."
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
- description: State of the Producer. Applies to NAFTA CO. Required for certain countries or territories.
+ description: State of the Producer. Applies to NAFTA CO. Required for certain countries or territories.
maximum: 1
type: string
minLength: 1
@@ -7547,20 +7546,20 @@ components:
minLength: 1
maxLength: 30
PostalCode:
- description: Postal code of the Producer. Applies to NAFTA CO. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
+ description: Postal code of the Producer. Applies to NAFTA CO. 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 NAFTA CO.
+ description: Country or Territory code of the Producer. Applies to NAFTA CO.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
- description: 'Address information of the Producer. Applies to NAFTA CO. Only
+ description: 'Address information of the Producer. Applies to NAFTA CO. Only
applicable if producer option is empty or not present. Conditionally required
for: NAFTA CO, when Producer option is not specified.'
Producer_Phone:
@@ -7583,7 +7582,7 @@ components:
maxLength: 4
xml:
name: Phone
- description: Phone number information of Producer. Applies to NAFTA CO.
+ description: Phone number information of Producer. Applies to NAFTA CO.
Contacts_SoldTo:
type: object
maximum: 1
@@ -7612,15 +7611,15 @@ components:
minLength: 1
maxLength: 15
Phone:
- "$ref": "#/components/schemas/SoldTo_Phone"
+ $ref: "#/components/schemas/SoldTo_Phone"
Option:
- description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02."
+ description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02."
maximum: 1
type: string
minLength: 2
maxLength: 2
Address:
- "$ref": "#/components/schemas/SoldTo_Address"
+ $ref: "#/components/schemas/SoldTo_Address"
EMailAddress:
description: SoldTo email address.
maximum: 1
@@ -7637,7 +7636,7 @@ components:
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 NAFTA CO Forms. Required if Invoice
+ satellite countries. Applies to Invoice and NAFTA CO Forms. Required if Invoice
or NAFTA CO (International Form) is requested.
SoldTo_Phone:
type: object
@@ -7669,7 +7668,7 @@ components:
- CountryCode
properties:
AddressLine:
- description: SoldTo location's street address. Applies to NAFTA CO.
+ description: SoldTo location's street address. Applies to NAFTA CO.
maximum: 3
type: array
items:
@@ -7683,7 +7682,7 @@ components:
minLength: 1
maxLength: 30
StateProvinceCode:
- description: SoldTo location's state or province code. Required for certain countries or territories.
+ description: SoldTo location's state or province code. Required for certain countries or territories.
maximum: 1
type: string
minLength: 1
@@ -7708,7 +7707,7 @@ components:
maxLength: 2
xml:
name: Address
- description: Sold To Address Container. Applies to NAFTA CO.
+ description: Sold To Address Container. Applies to NAFTA CO.
InternationalForms_Product:
type: object
maximum: 1
@@ -7716,7 +7715,7 @@ components:
- Description
properties:
Description:
- description: Description of the product. Applies to all International Forms.
+ 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
@@ -7726,10 +7725,10 @@ components:
minLength: 1
maxLength: 35
Unit:
- "$ref": "#/components/schemas/Product_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 determine what duties should be assessed on the commodity. Applies
to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional
for Partial Invoice. Should be at least 6 alphanumeric. For NAFTA CO:
For each good described in Description of Goods field, identify the H.S.
@@ -7743,7 +7742,7 @@ components:
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
+ 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
@@ -7763,12 +7762,12 @@ components:
JointProductionIndicator:
description: If present, JNT will be used as the origin of country or territory
code on the NAFTA form and the Product/Origincountry or territoryCode
- tag will be ignored. Applies to NAFTA CO only.
+ tag will be ignored. Applies to NAFTA CO 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 NAFTA CO only. Required for NAFTA CO. Valid values:
+ 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 NAFTA CO only. Required for NAFTA CO. Valid values:
- NC
- ND
- NO
@@ -7777,14 +7776,14 @@ components:
minLength: 2
maxLength: 2
NetCostDateRange:
- "$ref": "#/components/schemas/Product_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
+ 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 NAFTA CO only."
+ goods and their parts). Applies to NAFTA CO only."
maximum: 1
type: string
minLength: 1
@@ -7792,18 +7791,18 @@ components:
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
+ 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 NAFTA CO and
+ good.\nNo [3] - A completed and signed Certificate for the good voluntarily
+ provided to the exporter by the producer. Applicable for NAFTA CO 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
+ description: Any special marks, codes, and numbers that may appear on package. Applies
to CO Only.
maximum: 1
type: string
@@ -7811,26 +7810,26 @@ components:
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
+ 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"
+ $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.'
+ 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"
+ $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
@@ -7838,7 +7837,7 @@ components:
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:
+ imported. Applies to EEI forms only. Required for EEI form. Valid values: D:
Domestic; F: Foreign.'
maximum: 1
type: string
@@ -7846,7 +7845,7 @@ components:
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.
+ 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
@@ -7857,16 +7856,16 @@ components:
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"
+ $ref: "#/components/schemas/Product_ExcludeFromForm"
PackingListInfo:
- "$ref": "#/components/schemas/Product_PackingListInfo"
+ $ref: "#/components/schemas/Product_PackingListInfo"
EEIInformation:
- "$ref": "#/components/schemas/Product_EEIInformation"
+ $ref: "#/components/schemas/Product_EEIInformation"
xml:
name: Product
- description: "Contains the commodity/product information. Applies to EEI, Invoice,
+ description: "Contains the commodity/product information. Applies to EEI, Invoice,
Partial Invoice, CO and NAFTA CO. When any International form is requested,
- at least one Product must be present. \n\nMaximum number of products allowed
+ 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,
NAFTA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice
this container is optional."
@@ -7880,7 +7879,7 @@ components:
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
+ 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
@@ -7888,12 +7887,12 @@ components:
minLength: 1
maxLength: 7
UnitOfMeasurement:
- "$ref": "#/components/schemas/Unit_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
+ 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
+ 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.(#####.######, ######.#####, #######.####, ########.###, #########.##,##########.#,############).
@@ -7916,7 +7915,7 @@ components:
properties:
Code:
description: |
- Code for the Unit of measurement of the commodity units. Required for Invoice forms and optional for Partial Invoice.
+ 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
@@ -7924,14 +7923,14 @@ components:
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.
+ 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
+ description: Container tag for the Unit of measurement for the commodity. Required
for Invoice forms and optional for Partial Invoice.
Product_NetCostDateRange:
type: object
@@ -7943,7 +7942,7 @@ components:
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 NAFTA CO only. Format is yyyyMMdd.'
+ Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.'
maximum: 1
type: string
minLength: 8
@@ -7951,14 +7950,14 @@ components:
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 NAFTA CO only. Format is yyyyMMdd.'
+ 402.1, 402.5). Applies to NAFTA CO 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 NAFTA
+ description: Date Range for regional value content (RVC). Applies to NAFTA
CO only.
Product_ProductWeight:
type: object
@@ -7967,9 +7966,9 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/ProductWeight_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."
+ 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
@@ -7979,7 +7978,7 @@ components:
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
+ include carrier equipment. Applies to CO and EEI forms only. Required for
CO and EEI forms.
ProductWeight_UnitOfMeasurement:
type: object
@@ -7989,7 +7988,7 @@ components:
properties:
Code:
description: |
- Code for unit of Measurement of weight. Applies to CO and EEI forms only. Valid values:
+ Code for unit of Measurement of weight. Applies to CO and EEI forms only. Valid values:
- KGS
- LBS
maximum: 1
@@ -8004,7 +8003,7 @@ components:
maxLength: 20
xml:
name: UnitOfMeasurement
- description: Container tag for the Unit of Measurement of weight. Applies to
+ description: Container tag for the Unit of Measurement of weight. Applies to
CO and EEI forms only.
Product_ScheduleB:
type: object
@@ -8016,7 +8015,7 @@ components:
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
+ http://www.census.gov/foreign-trade/schedules/b/#search). Applies to
EEI forms only. Has to be 10 characters.'
maximum: 1
type: string
@@ -8026,7 +8025,7 @@ components:
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
+ 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
@@ -8039,10 +8038,10 @@ components:
type: array
maximum: 2
items:
- "$ref": "#/components/schemas/ScheduleB_UnitOfMeasurement"
+ $ref: "#/components/schemas/ScheduleB_UnitOfMeasurement"
xml:
name: ScheduleB
- description: Container tag for the schedule B information of a commodity. Applies
+ description: Container tag for the schedule B information of a commodity. Applies
to EEI forms only. Required for EEI form
ScheduleB_UnitOfMeasurement:
type: object
@@ -8052,7 +8051,7 @@ components:
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.
+ 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
@@ -8067,7 +8066,7 @@ components:
maxLength: 20
xml:
name: UnitOfMeasurement
- description: The unit of measure indicated on the Export License. Applies to
+ description: The unit of measure indicated on the Export License. Applies to
EEI forms only.
Product_ExcludeFromForm:
type: object
@@ -8075,7 +8074,7 @@ components:
- FormType
properties:
FormType:
- description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED.
+ description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. 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
@@ -8084,7 +8083,7 @@ components:
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
+ 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
@@ -8097,10 +8096,10 @@ components:
type: array
maximum: 20
items:
- "$ref": "#/components/schemas/PackingListInfo_PackageAssociated"
+ $ref: "#/components/schemas/PackingListInfo_PackageAssociated"
xml:
name: PackingListInfo
- description: Data Container holding package related information. Required for
+ description: Data Container holding package related information. Required for
packaging list, Air Freight Packing list and multi-piece Economy shipments.
maximum: 1
PackingListInfo_PackageAssociated:
@@ -8112,11 +8111,11 @@ components:
properties:
PackageNumber:
description: Package number the product should be allocated to ont he packing
- list. Required for packaging list and Air Freight Packing list.
+ 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
+ description: Amount of Product associated with a package. Required for
packaging list and Air Freight Packing list.
maximum: 1
type: string
@@ -8126,7 +8125,7 @@ components:
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
+ 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_EEIInformation:
type: object
@@ -8142,19 +8141,19 @@ components:
minLength: 2
maxLength: 2
License:
- "$ref": "#/components/schemas/EEIInformation_License"
+ $ref: "#/components/schemas/EEIInformation_License"
DDTCInformation:
- "$ref": "#/components/schemas/EEIInformation_DDTCInformation"
+ $ref: "#/components/schemas/EEIInformation_DDTCInformation"
xml:
name: EEIInformation
- description: Required for EEI form. Applies to EEI form only.
+ 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.
+ 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
@@ -8162,11 +8161,11 @@ components:
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
+ 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
+ each product as SDL or non-SDL. It is also used to identify which piece
of information is applicable."
maximum: 1
type: string
@@ -8175,7 +8174,7 @@ components:
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.
+ 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
@@ -8192,7 +8191,7 @@ components:
maxLength: 5
xml:
name: License
- description: Licence information for SDL commodity. Applies to EEI form only.
+ description: Licence information for SDL commodity. Applies to EEI form only.
EEIInformation_DDTCInformation:
type: object
maximum: 1
@@ -8202,7 +8201,7 @@ components:
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.
+ (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
@@ -8212,7 +8211,7 @@ components:
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
+ as it applies to the article reported. Applies to EEI form only. It is
required for EEIFilingOption code 3.
maximum: 1
type: string
@@ -8227,31 +8226,31 @@ components:
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
+ 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
+ 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"
+ $ref: "#/components/schemas/DDTCInformation_UnitOfMeasurement"
SignificantMilitaryEquipmentIndicator:
- description: Presence/ Absence Indicator. Applies to EEI form only.
+ 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
+ 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
@@ -8262,7 +8261,7 @@ components:
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.
+ an SDL code. Applies to EEI Form only.
DDTCInformation_UnitOfMeasurement:
type: object
maximum: 1
@@ -8270,14 +8269,14 @@ components:
- 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."
+ 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.
+ 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
+ description: Container for unit of measurement. Applies to EEI form only. It
is required for EEIFilingOption code 3.
InternationalForms_Discount:
type: object
@@ -8286,14 +8285,14 @@ components:
- 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."
+ 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
+ description: Container tag that holds the discount. Applies to Invoice and
Partial Invoice forms only.
InternationalForms_FreightCharges:
type: object
@@ -8302,14 +8301,14 @@ components:
- 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."
+ 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
+ description: Container tag that holds the Freight Charges. Applies to Invoice
and Partial Invoice forms only.
InternationalForms_InsuranceCharges:
type: object
@@ -8319,7 +8318,7 @@ components:
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
+ 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
@@ -8330,7 +8329,7 @@ components:
maxLength: 15
xml:
name: InsuranceCharges
- description: Container tag that holds the Insurance Charges. Applies to Invoice
+ description: Container tag that holds the Insurance Charges. Applies to Invoice
and Partial Invoice forms only.
InternationalForms_OtherCharges:
type: object
@@ -8340,13 +8339,13 @@ components:
- 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."
+ 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
+ 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
@@ -8356,7 +8355,7 @@ components:
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
+ additional charges not already listed on the invoice. Applies to Invoice
and Partial Invoice forms only.
InternationalForms_BlanketPeriod:
type: object
@@ -8368,7 +8367,7 @@ components:
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
+ Certificate (it may be prior to the date of signing this Certificate). Applies
to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This
is not valid for a paperless shipment.
maximum: 1
@@ -8377,8 +8376,8 @@ components:
maxLength: 8
EndDate:
description: End Date of the blanket period. It is the date upon which the
- blanket period expires. Applies to NAFTA CO form only. Required for NAFTA
- CO. Format is yyyyMMdd. This is not valid for a paperless shipment.
+ blanket period expires. Applies to NAFTA CO form only. Required for NAFTA
+ CO. Format is yyyyMMdd. This is not valid for a paperless shipment.
maximum: 1
type: string
minLength: 8
@@ -8390,7 +8389,7 @@ components:
that are imported into a NAFTA 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 NAFTA CO form only. Required for NAFTA CO. This
+ these dates. Applies to NAFTA CO form only. Required for NAFTA CO. This
is not valid for a paperless shipment.
ShipmentServiceOptions_DeliveryConfirmation:
type: object
@@ -8399,7 +8398,7 @@ components:
- DCISType
properties:
DCISType:
- description: "Type of delivery confirmation. Valid values: \n1 - Delivery
+ 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
@@ -8415,7 +8414,7 @@ components:
xml:
name: DeliveryConfirmation
description: |-
- Delivery Confirmation container. Valid for forward shipments only.
+ 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:
@@ -8445,19 +8444,19 @@ components:
xml:
name: LabelMethod
description: Type of ImportControl Label. This container is applicable only
- for ImportControl shipments. This container is applicable only for ImportControl
+ for ImportControl shipments. This container is applicable only for ImportControl
shipments.
ShipmentServiceOptions_PreAlertNotification:
type: object
properties:
EMailMessage:
- "$ref": "#/components/schemas/PreAlertNotification_EMailMessage"
+ $ref: "#/components/schemas/PreAlertNotification_EMailMessage"
VoiceMessage:
- "$ref": "#/components/schemas/PreAlertNotification_VoiceMessage"
+ $ref: "#/components/schemas/PreAlertNotification_VoiceMessage"
TextMessage:
- "$ref": "#/components/schemas/PreAlertNotification_TextMessage"
+ $ref: "#/components/schemas/PreAlertNotification_TextMessage"
Locale:
- "$ref": "#/components/schemas/PreAlertNotification_Locale"
+ $ref: "#/components/schemas/PreAlertNotification_Locale"
xml:
name: PreAlertNotification
required:
@@ -8495,7 +8494,7 @@ components:
properties:
PhoneNumber:
description: |
- Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.
+ 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:
@@ -8520,7 +8519,7 @@ components:
properties:
PhoneNumber:
description: |
- Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.
+ 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:
@@ -8568,7 +8567,7 @@ components:
properties:
DiagnosticSpecimensIndicator:
description: This field is a flag to indicate if the package has Biological
- substances. True if present; false otherwise. Shippers account needs
+ 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
@@ -8583,7 +8582,7 @@ components:
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
+ Perishable items. Shippers account needs to have a valid contract for
Perishables.
maximum: 1
type: string
@@ -8596,13 +8595,13 @@ components:
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.
+ 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
+ Special Exception items. Shippers account needs to have a valid contract
for Special Exceptions.
maximum: 1
type: string
@@ -8617,7 +8616,7 @@ components:
value is ignored. If present, indicates that the package contains
Ecigarettes Shippers account needs to have a valid contract for
Ecigarettes.
- maximum: 1
+ maximum: 1
type: string
xml:
name: RestrictedArticles
@@ -8627,7 +8626,7 @@ components:
maximum: 1
properties:
Description:
- description: Merchandise description of package. Required for shipment
+ description: Merchandise description of package. Required for shipment
with return service.
maximum: 1
type: string
@@ -8653,13 +8652,13 @@ components:
minLength: 1
maxLength: 12
Packaging:
- "$ref": "#/components/schemas/Package_Packaging"
+ $ref: "#/components/schemas/Package_Packaging"
Dimensions:
- "$ref": "#/components/schemas/Package_Dimensions"
+ $ref: "#/components/schemas/Package_Dimensions"
DimWeight:
- "$ref": "#/components/schemas/Package_DimWeight"
+ $ref: "#/components/schemas/Package_DimWeight"
PackageWeight:
- "$ref": "#/components/schemas/Package_PackageWeight"
+ $ref: "#/components/schemas/Package_PackageWeight"
LargePackageIndicator:
description: |-
Presence of the indicator mentions that the package is Large Package.
@@ -8668,18 +8667,18 @@ components:
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.
+ 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.
+ 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"
+ $ref: "#/components/schemas/Package_ReferenceNumber"
AdditionalHandlingIndicator:
description: Additional Handling Required. The presence indicates additional
handling is required, the absence indicates no additional handling is
@@ -8688,20 +8687,20 @@ components:
maximum: 1
type: string
SimpleRate:
- "$ref": "#/components/schemas/Package_SimpleRate"
+ $ref: "#/components/schemas/Package_SimpleRate"
UPSPremier:
- "$ref": "#/components/schemas/Package_UPSPremier"
+ $ref: "#/components/schemas/Package_UPSPremier"
PackageServiceOptions:
- "$ref": "#/components/schemas/Package_PackageServiceOptions"
+ $ref: "#/components/schemas/Package_PackageServiceOptions"
Commodity:
- "$ref": "#/components/schemas/Package_Commodity"
+ $ref: "#/components/schemas/Package_Commodity"
HazMatPackageInformation:
- "$ref": "#/components/schemas/Package_HazMatPackageInformation"
+ $ref: "#/components/schemas/Package_HazMatPackageInformation"
xml:
name: Package
required:
- Packaging
- description: Package Information container. For Return Shipments up to and
+ description: Package Information container. For Return Shipments up to and
including 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.
@@ -8712,14 +8711,14 @@ components:
- 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
+ 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\n65 = Media Mail
+\n66 = BPM Flat\n67 = Standard Flat.\nNote: Only packaging type code
+ 02 is applicable to Ground Freight Pricing.\nPackage 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
@@ -8740,7 +8739,7 @@ components:
maxLength: 35
xml:
name: Packaging
- description: Packaging container. Container for Packaging Type.
+ description: Packaging container. Container for Packaging Type.
Package_Dimensions:
type: object
required:
@@ -8750,9 +8749,9 @@ components:
- Width
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/Dimensions_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.
+ 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
@@ -8773,7 +8772,7 @@ components:
name: Dimensions
maximum: 1
description: 'Dimensions information container. Note: Currently dimensions are
- not applicable to Ground Freight Pricing. Length + 2*(Width + Height) must
+ 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:
@@ -8802,9 +8801,9 @@ components:
type: object
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/DimWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/DimWeight_UnitOfMeasurement"
Weight:
- description: Actual package weight. Weight accepted for letters/envelopes.
+ description: Actual package weight. Weight accepted for letters/envelopes.
maximum: 1
type: string
minLength: 6
@@ -8813,7 +8812,7 @@ components:
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
+ 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:
@@ -8834,7 +8833,7 @@ components:
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.
+ 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
@@ -8849,9 +8848,9 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/PackageWeight_UnitOfMeasurement"
Weight:
- description: Packages weight. Weight accepted for letters/envelopes. Only
+ description: Packages weight. Weight accepted for letters/envelopes. Only
average package weight is required for Ground Freight Pricing Shipment.
maximum: 1
type: string
@@ -8860,7 +8859,7 @@ components:
xml:
name: PackageWeight
maximum: 1
- description: Container to hold package weight information. Package weight is
+ 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:
@@ -8901,15 +8900,15 @@ components:
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,
+ is ignored.\nOnly 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.
+ 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
@@ -8917,7 +8916,7 @@ components:
minLength: 1
maxLength: 2
Value:
- description: Customer supplied reference number. Valid if the origin/destination
+ description: Customer supplied reference number. Valid if the origin/destination
pair is US/US or PR/PR.
maximum: 1
type: string
@@ -8928,7 +8927,7 @@ components:
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..
+ 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.
Package_SimpleRate:
@@ -8939,7 +8938,7 @@ components:
properties:
Code:
description: |
- SimpleRate code. Valid Values
+ SimpleRate code. Valid Values
- XS = Extra Small
- S = Small
- M = Medium
@@ -8950,7 +8949,7 @@ components:
minLength: 2
maxLength: 2
Description:
- description: Simple Rate description of the code above. Currently ignored if provided in the Request. Length is not validated.
+ 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
@@ -8968,7 +8967,7 @@ components:
properties:
Category:
description: |-
- UPS Premier Category. Valid values are 01,02,03 UPS Premier Silver -01
+ UPS Premier Category. Valid values are 01,02,03 UPS Premier Silver -01
UPS Premier Gold - 02
UPS Premier Platinum - 03
maximum: 1
@@ -8983,7 +8982,7 @@ components:
minLength: 1
maxLength: 50
HandlingInstructions:
- "$ref": "#/components/schemas/UPSPremier_HandlingInstructions"
+ $ref: "#/components/schemas/UPSPremier_HandlingInstructions"
xml:
name: UPSPremier
description: UPS Premier Container.
@@ -8993,7 +8992,7 @@ components:
- Instruction
properties:
Instruction:
- description: Handling Instruction for UPS Premier package. Please refer
+ description: Handling Instruction for UPS Premier package. Please refer
Apendix UPS Premier Handling Instructions.
type: string
minLength: 3
@@ -9006,35 +9005,35 @@ components:
type: object
properties:
DeliveryConfirmation:
- "$ref": "#/components/schemas/PackageServiceOptions_DeliveryConfirmation"
+ $ref: "#/components/schemas/PackageServiceOptions_DeliveryConfirmation"
DeclaredValue:
- "$ref": "#/components/schemas/PackageServiceOptions_DeclaredValue"
+ $ref: "#/components/schemas/PackageServiceOptions_DeclaredValue"
COD:
- "$ref": "#/components/schemas/PackageServiceOptions_COD"
+ $ref: "#/components/schemas/PackageServiceOptions_COD"
AccessPointCOD:
- "$ref": "#/components/schemas/PackageServiceOptions_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
+ 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"
+ $ref: "#/components/schemas/PackageServiceOptions_Notification"
HazMat:
type: array
maximum: 3
items:
- "$ref": "#/components/schemas/PackageServiceOptions_HazMat"
+ $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 SurePost and Mail Innovations 'USPS Limited Quantities HazMat' Shipments (but may be extended for other types of HazMat in the future).
- Valid values are 01.
+ 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 SurePost 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"
+ $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.
@@ -9060,12 +9059,12 @@ components:
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
+ 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
+ description: Identifies the package containing Dangerous Goods. Required
for Hazmat shipment if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
@@ -9079,7 +9078,7 @@ components:
maxLength: 20
RefrigerationIndicator:
description: Presence/Absence Indicator. Any value is ignored. If present,
- indicates that the package contains an item that needs refrigeration. Shippers
+ indicates that the package contains an item that needs refrigeration. Shippers
account needs to have a valid contract for Refrigeration.
maximum: 1
type: string
@@ -9095,7 +9094,7 @@ components:
properties:
DCISType:
description: |-
- Type of delivery confirmation. Valid values:
+ Type of delivery confirmation. Valid values:
- 1 - Unsupported
- 2 - Delivery Confirmation Signature Required
- 3 - Delivery Confirmation Adult Signature Required
@@ -9105,24 +9104,24 @@ components:
maxLength: 1
DCISNumber:
description: Delivery Confirmation Control number associated with the delivery
- confirmation for the package. Valid for forward shipments only.
+ 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
+ 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"
+ $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
+ 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
@@ -9153,7 +9152,7 @@ components:
- 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.
+ 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
@@ -9184,10 +9183,10 @@ components:
minLength: 1
maxLength: 1
CODAmount:
- "$ref": "#/components/schemas/PackageServiceOptions_COD_CODAmount"
+ $ref: "#/components/schemas/PackageServiceOptions_COD_CODAmount"
xml:
name: COD
- description: Container for COD. Indicates COD is requested. Package level 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.
@@ -9234,7 +9233,7 @@ components:
maxLength: 8
xml:
name: AccessPointCOD
- description: Access Point COD indicates Package COD is requested for a shipment. Valid
+ 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.
@@ -9246,9 +9245,9 @@ components:
- EMail
properties:
NotificationCode:
- description: "Notification Code. Valid values:\n3 - Receiver Return Notification\n6
+ 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
+ Notification\nFor Mail Innovations forward shipments, QV Email Notifications
are allowed for First Class, Priority Mail, and Expedited Mail Innovation
services."
maximum: 1
@@ -9256,10 +9255,10 @@ components:
minLength: 1
maxLength: 1
EMail:
- "$ref": "#/components/schemas/PackageServiceOptions_Notification_EMail"
+ $ref: "#/components/schemas/PackageServiceOptions_Notification_EMail"
xml:
name: Notification
- description: Receiver Return Notification. Applicable for Shipment with returned
+ description: Receiver Return Notification. Applicable for Shipment with returned
service.
PackageServiceOptions_Notification_EMail:
type: object
@@ -9268,7 +9267,7 @@ components:
- EMailAddress
properties:
Subject:
- description: The eMails subject. Defaults to the UPS Receiver Return Notification plus the shipment ID. Only allowed at the first package.
+ 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
@@ -9315,7 +9314,7 @@ components:
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."
+ 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
@@ -9341,7 +9340,7 @@ components:
properties:
PackagingTypeQuantity:
description: The number of pieces of the specific commodity. Required if
- CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
+ CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
maximum: 1
type: string
minLength: 1
@@ -9376,7 +9375,7 @@ components:
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:
+ 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",
@@ -9395,7 +9394,7 @@ components:
maxLength: 200
HazardLabelRequired:
description: "Defines the type of label that is required on the package
- for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode =
+ for the commodity.\n\nNot applicable if CommodityRegulatedLevelCode =
LR or EQ."
maximum: 1
type: string
@@ -9418,7 +9417,7 @@ components:
maxLength: 15
Quantity:
description: Required if CommodityRegulatedLevelCode = EQ, LQ or FR. The
- numerical value of the mass capacity of the regulated good. Should be
+ 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.
@@ -9428,7 +9427,7 @@ components:
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
+ 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
@@ -9437,7 +9436,7 @@ components:
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). 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
@@ -9450,7 +9449,7 @@ components:
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
+ 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
@@ -9522,9 +9521,9 @@ components:
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
+ 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
@@ -9537,9 +9536,9 @@ components:
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
+ 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
@@ -9548,14 +9547,14 @@ components:
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.
+ 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.
+ description: Transport Category. Valid values are 0 to 4.
maximum: 1
type: string
minLength: 1
@@ -9567,7 +9566,7 @@ components:
minLength: 1
maxLength: 10
ChemicalRecordIdentifier:
- description: Identifies the Chemical Record. Required if SubVersion is
+ description: Identifies the Chemical Record. Required if SubVersion is
greater than or equal to 1701.
maximum: 1
type: string
@@ -9602,14 +9601,14 @@ components:
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. The following values are valid:
+ to Canada, IATA= Worldwide Air movement. The following values are valid:
IATA, CFR.'
maximum: 1
type: string
minLength: 3
maxLength: 4
DryIceWeight:
- "$ref": "#/components/schemas/DryIce_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
@@ -9619,7 +9618,7 @@ components:
type: string
xml:
name: DryIce
- description: Container for Dry Ice. Maximum 1 Dry Ice is allowed. Lane check
+ description: Container for Dry Ice. Maximum 1 Dry Ice is allowed. Lane check
will happen based on postal code/ city.
DryIce_DryIceWeight:
type: object
@@ -9628,9 +9627,9 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/DryIceWeight_UnitOfMeasurement"
+ $ref: "#/components/schemas/DryIceWeight_UnitOfMeasurement"
Weight:
- description: Dry Ice Weight. Cannot be more than package weight. Should
+ 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.
@@ -9658,7 +9657,7 @@ components:
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
+ 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.
@@ -9674,17 +9673,17 @@ components:
properties:
FreightClass:
description: Freight Classification. Freight class partially determines
- the freight rate for the article. Required for Ground Freight Pricing
+ 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"
+ $ref: "#/components/schemas/Commodity_NMFC"
xml:
name: Commodity
- description: Container to hold the Commodity information. It is required if
+ 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
@@ -9693,14 +9692,14 @@ components:
- PrimeCode
properties:
PrimeCode:
- description: Specifies the Commodity's NMFC prime code. Required if NMFC
+ 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
+ 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.
@@ -9726,7 +9725,7 @@ components:
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,
+ package. When number of Hazmat containers in a package is more than one,
either AllPackedInOneIndicator or OverPackedIndicator is needed
maximum: 1
type: string
@@ -9740,7 +9739,7 @@ components:
minLength: 3
maxLength: 3
OuterPackagingType:
- description: This field is used for the Outer Hazmat packaging type. Ex.
+ 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
@@ -9754,7 +9753,7 @@ components:
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
+ box or multiple boxes. Required when number of hazmat container in a package
is greater than 1.
ShipmentRequest_LabelSpecification:
type: object
@@ -9763,10 +9762,10 @@ components:
- LabelStockSize
properties:
LabelImageFormat:
- "$ref": "#/components/schemas/LabelSpecification_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
+ 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
@@ -9774,17 +9773,17 @@ components:
minLength: 1
maxLength: 64
LabelStockSize:
- "$ref": "#/components/schemas/LabelSpecification_LabelStockSize"
+ $ref: "#/components/schemas/LabelSpecification_LabelStockSize"
Instruction:
type: array
items:
- "$ref": "#/components/schemas/LabelSpecification_Instruction"
+ $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
+ = 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
@@ -9797,7 +9796,7 @@ components:
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
+ 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.
@@ -9811,7 +9810,7 @@ components:
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,
+ 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.
@@ -9836,7 +9835,7 @@ components:
- Width
properties:
Height:
- description: 'Height of the label image. For IN, use whole inches. For
+ 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
@@ -9844,7 +9843,7 @@ components:
minLength: 1
maxLength: 3
Width:
- description: 'Width of the label image. For IN, use whole inches. For EPL2,
+ 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
@@ -9853,7 +9852,7 @@ components:
maxLength: 3
xml:
name: LabelStockSize
- description: Container for the EPL2, ZPL or SPL label size. Valid for EPL2,
+ description: Container for the EPL2, ZPL or SPL label size. Valid for EPL2,
ZPL and SPL Labels.
LabelSpecification_Instruction:
type: object
@@ -9885,7 +9884,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/ReceiptSpecification_ImageFormat"
+ $ref: "#/components/schemas/ReceiptSpecification_ImageFormat"
xml:
name: ReceiptSpecification
description: Container used to allow the user to choose to print a thermal receipt.
@@ -9919,9 +9918,9 @@ components:
- ShipmentResults
properties:
Response:
- "$ref": "#/components/schemas/ShipmentResponse_Response"
+ $ref: "#/components/schemas/ShipmentResponse_Response"
ShipmentResults:
- "$ref": "#/components/schemas/ShipmentResponse_ShipmentResults"
+ $ref: "#/components/schemas/ShipmentResponse_ShipmentResults"
xml:
name: ShipmentResponse
description: Shipment Response.
@@ -9932,17 +9931,17 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/Response_ResponseStatus"
+ $ref: "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
- Alert Container. There can be zero to many alert containers with code and 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"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/Response_TransactionReference"
+ $ref: "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response container for Shipment response.
@@ -10016,16 +10015,16 @@ components:
**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"
+ $ref: "#/components/schemas/ShipmentResults_Disclaimer"
ShipmentCharges:
- "$ref": "#/components/schemas/ShipmentResults_ShipmentCharges"
+ $ref: "#/components/schemas/ShipmentResults_ShipmentCharges"
NegotiatedRateCharges:
- "$ref": "#/components/schemas/ShipmentResults_NegotiatedRateCharges"
+ $ref: "#/components/schemas/ShipmentResults_NegotiatedRateCharges"
FRSShipmentData:
- "$ref": "#/components/schemas/ShipmentResults_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:
+ 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
@@ -10034,7 +10033,7 @@ components:
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:
+ 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
@@ -10042,7 +10041,7 @@ components:
minLength: 2
maxLength: 2
BillingWeight:
- "$ref": "#/components/schemas/ShipmentResults_BillingWeight"
+ $ref: "#/components/schemas/ShipmentResults_BillingWeight"
ShipmentIdentificationNumber:
description: Returned UPS shipment ID number.1Z Number of the first package
in the shipment.
@@ -10052,14 +10051,14 @@ components:
maxLength: 18
MIDualReturnShipmentKey:
description: "MIDualReturnShipmentKey is unique key required to process
- Mail Innovations Dual Return Shipment. \n\nThe unique identifier (key)
+ 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
+ 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
+ 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,
+ 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
@@ -10078,27 +10077,27 @@ components:
**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"
+ $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.
+ 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"
+ $ref: "#/components/schemas/ShipmentResults_ControlLogReceipt"
Form:
- "$ref": "#/components/schemas/ShipmentResults_Form"
+ $ref: "#/components/schemas/ShipmentResults_Form"
CODTurnInPage:
- "$ref": "#/components/schemas/ShipmentResults_CODTurnInPage"
+ $ref: "#/components/schemas/ShipmentResults_CODTurnInPage"
HighValueReport:
- "$ref": "#/components/schemas/ShipmentResults_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
+ ImportControl shipment\nPrint/Electronic Return shipment.\nForward shipment
except for Mail Innovations Forward."
maximum: 1
type: string
@@ -10107,8 +10106,8 @@ components:
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
+ 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
@@ -10123,7 +10122,7 @@ components:
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.
+ Print/Electronic Return shipment. Not returned if LabelLinksIndicator is requested with Locale element.
maximum: 1
type: string
DGPaperImage:
@@ -10160,7 +10159,7 @@ components:
- Code
properties:
Code:
- description: Code representing type of Disclaimer. Refer to Disclaimer
+ 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
@@ -10169,7 +10168,7 @@ components:
maxLength: 2
Description:
description: |-
- Disclaimer description. This field would be returned only if TaxInformationIndicator is present in a request.
+ 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
@@ -10204,9 +10203,9 @@ components:
minLength: 1
maxLength: 1
BaseServiceCharge:
- "$ref": "#/components/schemas/ShipmentCharges_BaseServiceCharge"
+ $ref: "#/components/schemas/ShipmentCharges_BaseServiceCharge"
TransportationCharges:
- "$ref": "#/components/schemas/ShipmentCharges_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.
@@ -10214,9 +10213,9 @@ components:
**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"
+ $ref: "#/components/schemas/ShipmentCharges_ItemizedCharges"
ServiceOptionsCharges:
- "$ref": "#/components/schemas/ShipmentCharges_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.
@@ -10224,11 +10223,11 @@ components:
**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"
+ $ref: "#/components/schemas/ShipmentCharges_TaxCharges"
TotalCharges:
- "$ref": "#/components/schemas/ShipmentCharges_TotalCharges"
+ $ref: "#/components/schemas/ShipmentCharges_TotalCharges"
TotalChargesWithTaxes:
- "$ref": "#/components/schemas/ShipmentCharges_TotalChargesWithTaxes"
+ $ref: "#/components/schemas/ShipmentCharges_TotalChargesWithTaxes"
xml:
name: ShipmentCharges
required:
@@ -10251,7 +10250,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Base Service Charge value amount. Valid values are from 0
+ description: Base Service Charge value amount. Valid values are from 0
to 99999999999999.99
maximum: 1
type: string
@@ -10277,7 +10276,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Transportation and surcharges value amount. Valid values are
+ description: Transportation and surcharges value amount. Valid values are
from 0 to 99999999999999.99
maximum: 1
type: string
@@ -10313,7 +10312,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
+ description: Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10340,7 +10339,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Accessorial charges value amount. Valid values are from 0 to 99999999999999.99
+ description: Accessorial charges value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10357,14 +10356,14 @@ components:
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
+ 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
+ description: Tax Monetary Value represent the Tax amount. Valid values
are from 0 to 99999999999999.99
maximum: 1
type: string
@@ -10387,7 +10386,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Total charges value amount. Valid values are from 0 to 99999999999999.99.
+ description: Total charges value amount. Valid values are from 0 to 99999999999999.99.
maximum: 1
type: string
minLength: 1
@@ -10410,7 +10409,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
+ description: TotalChargesWithTaxes monetary value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10424,15 +10423,15 @@ components:
type: object
properties:
ItemizedCharges:
- description: |
- Itemized Charges are returned only when the Subversion element is present and greater than or equal to 1601.
+ 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.
+ 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.
+ **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"
+ $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.
@@ -10440,18 +10439,18 @@ components:
**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"
+ $ref: "#/components/schemas/NegotiatedRateCharges_TaxCharges"
TotalCharge:
- "$ref": "#/components/schemas/NegotiatedRateCharges_TotalCharge"
+ $ref: "#/components/schemas/NegotiatedRateCharges_TotalCharge"
RateModifier:
type: array
items:
- "$ref": "#/components/schemas/NegotiatedRateCharges_RateModifier"
+ $ref: "#/components/schemas/NegotiatedRateCharges_RateModifier"
TotalChargesWithTaxes:
- "$ref": "#/components/schemas/NegotiatedRateCharges_TotalChargesWithTaxes"
+ $ref: "#/components/schemas/NegotiatedRateCharges_TotalChargesWithTaxes"
xml:
name: NegotiatedRateCharges
- description: Negotiated Rates Charge Container. For tiered rates and promotional
+ 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.
@@ -10483,7 +10482,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
+ description: Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10505,14 +10504,14 @@ components:
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
+ 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
+ description: Tax Monetary Value represent the Tax amount. Valid values
are from 0 to 99999999999999.99
maximum: 1
type: string
@@ -10534,7 +10533,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Total charges monetary value. Valid values are from 0 to 9999999999999999.99
+ description: Total charges monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10554,9 +10553,9 @@ components:
properties:
ModifierType:
description: >-
- Rate Modifier Type .
+ Rate Modifier Type.
- Example- "ORM" Applies if SubVersion is 2407 or greater and
+ Example- "ORM" Applies if SubVersion is 2407 or greater and
supports only for oAuth shipments.
maximum: 1
type: string
@@ -10564,9 +10563,9 @@ components:
maxLength: 3
ModifierDesc:
description: >-
- Rate Modifier Description .
+ Rate Modifier Description.
- Example- "Origin Modifier" Applies if SubVersion is 2407 or greater
+ Example- "Origin Modifier" Applies if SubVersion is 2407 or greater
and supports only for oAuth shipments.
maximum: 1
type: string
@@ -10574,12 +10573,11 @@ components:
maxLength: 50
Amount:
description: >-
- Amount .
+ Amount.
Example- "-1.00","0.25"
-
- It contains positive or negative values. Applies if SubVersion is
+ It contains positive or negative values. Applies if SubVersion is
2407 or greater and supports only for oAuth shipments.
maximum: 1
type: string
@@ -10588,7 +10586,7 @@ components:
xml:
name: RateModifier
description: >-
- Container for returned Rate Modifier information. Applies if SubVersion
+ Container for returned Rate Modifier information. Applies if SubVersion
is 2407 or greater and supports only for oAuth shipments.
NegotiatedRateCharges_TotalChargesWithTaxes:
type: object
@@ -10605,7 +10603,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: TotalChargesWithTaxes monetary value amount. Valid values
+ description: TotalChargesWithTaxes monetary value amount. Valid values
are from 0 to 9999999999999999.99
maximum: 1
type: string
@@ -10622,9 +10620,9 @@ components:
- TransportationCharges
properties:
TransportationCharges:
- "$ref": "#/components/schemas/FRSShipmentData_TransportationCharges"
+ $ref: "#/components/schemas/FRSShipmentData_TransportationCharges"
FreightDensityRate:
- "$ref": "#/components/schemas/FRSShipmentData_FreightDensityRate"
+ $ref: "#/components/schemas/FRSShipmentData_FreightDensityRate"
HandlingUnits:
description: |
Handling Unit for Density based rating container.
@@ -10632,7 +10630,7 @@ components:
**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"
+ $ref: "#/components/schemas/FRSShipmentData_HandlingUnits"
xml:
name: FRSShipmentData
description: Ground Freight Pricing Shipment data container. Ground Freight
@@ -10648,9 +10646,9 @@ components:
- NetCharge
properties:
GrossCharge:
- "$ref": "#/components/schemas/TransportationCharges_GrossCharge"
+ $ref: "#/components/schemas/TransportationCharges_GrossCharge"
DiscountAmount:
- "$ref": "#/components/schemas/TransportationCharges_DiscountAmount"
+ $ref: "#/components/schemas/TransportationCharges_DiscountAmount"
DiscountPercentage:
description: It indicates the shipment level discount percentage for transportation
charges.
@@ -10659,7 +10657,7 @@ components:
minLength: 1
maxLength: 5
NetCharge:
- "$ref": "#/components/schemas/TransportationCharges_NetCharge"
+ $ref: "#/components/schemas/TransportationCharges_NetCharge"
xml:
name: TransportationCharges
maximum: 1
@@ -10680,7 +10678,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Gross charges monetary value. Valid values are from 0 to 9999999999999999.99
+ description: Gross charges monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10703,7 +10701,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Discount amount monetary value. Valid values are from 0 to
+ description: Discount amount monetary value. Valid values are from 0 to
9999999999999999.99
maximum: 1
type: string
@@ -10727,7 +10725,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Net charges monetary value. Valid values are from 0 to 9999999999999999.99
+ description: Net charges monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
@@ -10745,14 +10743,14 @@ components:
properties:
Density:
description: Density is returned if the Shipper is eligible for Density
- based rate. Valid values are 0 to 999.9
+ 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
+ Density based rate. Valid values are 0 to 99999.999
maximum: 1
type: string
minLength: 1
@@ -10775,11 +10773,11 @@ components:
minLength: 1
maxLength: 8
Type:
- "$ref": "#/components/schemas/HandlingUnits_Type"
+ $ref: "#/components/schemas/HandlingUnits_Type"
Dimensions:
- "$ref": "#/components/schemas/HandlingUnits_Dimensions"
+ $ref: "#/components/schemas/HandlingUnits_Dimensions"
AdjustedHeight:
- "$ref": "#/components/schemas/HandlingUnits_AdjustedHeight"
+ $ref: "#/components/schemas/HandlingUnits_AdjustedHeight"
xml:
name: HandlingUnits
HandlingUnits_AdjustedHeight:
@@ -10790,14 +10788,14 @@ components:
- Value
properties:
Value:
- description: Adjusted Height value for the handling unit. Height Adjustment
+ 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"
+ $ref: "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
description: Container to hold Adjusted Height information.
@@ -10808,10 +10806,10 @@ components:
- Weight
properties:
UnitOfMeasurement:
- "$ref": "#/components/schemas/BillingWeight_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
+ 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.
@@ -10853,7 +10851,7 @@ components:
- TrackingNumber
properties:
TrackingNumber:
- description: "Package 1Z number. \nFor Mail Innovations shipments, please
+ 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
@@ -10861,21 +10859,21 @@ components:
minLength: 18
maxLength: 18
RateModifier:
- description: |
- Returned Package Information.
+ 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"
+ **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"
+ $ref: "#/components/schemas/PackageResults_BaseServiceCharge"
ServiceOptionsCharges:
- "$ref": "#/components/schemas/PackageResults_ServiceOptionsCharges"
+ $ref: "#/components/schemas/PackageResults_ServiceOptionsCharges"
ShippingLabel:
- "$ref": "#/components/schemas/PackageResults_ShippingLabel"
+ $ref: "#/components/schemas/PackageResults_ShippingLabel"
ShippingReceipt:
- "$ref": "#/components/schemas/PackageResults_ShippingReceipt"
+ $ref: "#/components/schemas/PackageResults_ShippingReceipt"
USPSPICNumber:
description: USPSPICNumber is USPS Package Identification; it should be
used for tracking Mail Innovations shipments.
@@ -10883,7 +10881,7 @@ components:
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
+ 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
@@ -10894,11 +10892,11 @@ components:
**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"
+ $ref: "#/components/schemas/PackageResults_Accessorial"
SimpleRate:
- "$ref": "#/components/schemas/PackageResults_SimpleRate"
+ $ref: "#/components/schemas/PackageResults_SimpleRate"
Form:
- "$ref": "#/components/schemas/PackageResults_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.
@@ -10906,9 +10904,9 @@ components:
**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"
+ $ref: "#/components/schemas/PackageResults_ItemizedCharges"
NegotiatedCharges:
- "$ref": "#/components/schemas/PackageResults_NegotiatedCharges"
+ $ref: "#/components/schemas/PackageResults_NegotiatedCharges"
xml:
name: PackageResults
PackageResults_BaseServiceCharge:
@@ -10926,7 +10924,7 @@ components:
minLength: 3
maxLength: 3
MonetaryValue:
- description: Base Service Charge value amount. Valid values are from 0
+ description: Base Service Charge value amount. Valid values are from 0
to 99999999999999.99
maximum: 1
type: string
@@ -10972,7 +10970,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/ShippingLabel_ImageFormat"
+ $ref: "#/components/schemas/ShippingLabel_ImageFormat"
GraphicImage:
description: Base 64 encoded graphic image.
maximum: 1
@@ -11009,7 +11007,7 @@ components:
name: ShippingLabel
maximum: 1
description: "The container for UPS shipping label. Returned for following shipments
- -\nForward shipments,\nShipments with PRL returns service, \nElectronic Return
+ -\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."
@@ -11045,7 +11043,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/ShippingReceipt_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."
@@ -11123,20 +11121,20 @@ components:
properties:
Code:
description: |
- Code that indicates the type of form. Valid values:
+ 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."
+ 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"
+ $ref: "#/components/schemas/Form_Image"
FormGroupId:
description: Unique Id for later retrieval of saved version of the completed international forms.
maximum: 1
@@ -11152,7 +11150,7 @@ components:
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 -
+ 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.
@@ -11163,7 +11161,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/ShipmentResults_Image_ImageFormat"
+ $ref: "#/components/schemas/ShipmentResults_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded International forms image.
maximum: 1
@@ -11179,7 +11177,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/Image_ImageFormat"
+ $ref: "#/components/schemas/Image_ImageFormat"
GraphicImage:
description: Base 64 encoded International forms image.
maximum: 1
@@ -11340,15 +11338,15 @@ components:
**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"
+ $ref: "#/components/schemas/NegotiatedCharges_ItemizedCharges"
RateModifier:
type: array
items:
- "$ref": "#/components/schemas/NegotiatedCharges_RateModifier"
+ $ref: "#/components/schemas/NegotiatedCharges_RateModifier"
xml:
name: NegotiatedCharges
description: |-
- Negotiated Rates Charge Container. These charges are returned when:
+ 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
@@ -11405,7 +11403,7 @@ components:
description: >-
Rate Modifier Type .
- Example- "ORM" Applies if SubVersion is 2407 or greater and
+ Example- "ORM" Applies if SubVersion is 2407 or greater and
supports only for oAuth shipments.
maximum: 1
type: string
@@ -11415,7 +11413,7 @@ components:
description: >-
Rate Modifier Description .
- Example- "Origin Modifier" Applies if SubVersion is 2407 or greater
+ Example- "Origin Modifier" Applies if SubVersion is 2407 or greater
and supports only for oAuth shipments.
maximum: 1
type: string
@@ -11427,8 +11425,7 @@ components:
Example- "-1.00","0.25"
-
- It contains positive or negative values. Applies if SubVersion is
+ It contains positive or negative values. Applies if SubVersion is
2407 or greater and supports only for oAuth shipments.
maximum: 1
type: string
@@ -11437,7 +11434,7 @@ components:
xml:
name: RateModifier
description: >-
- Container for returned Rate Modifier information. Applies if SubVersion
+ Container for returned Rate Modifier information. Applies if SubVersion
is 2407 or greater and supports only for oAuth shipments.
PackageResults_RateModifier:
type: object
@@ -11477,10 +11474,9 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/ControlLogReceipt_ImageFormat"
+ $ref: "#/components/schemas/ControlLogReceipt_ImageFormat"
GraphicImage:
- description: |-
- Base 64 encoded html, EPL2, ZPL or SPL image.
+ description: Base 64 encoded html, EPL2, ZPL or SPL image.
maximum: 1
type: string
xml:
@@ -11535,7 +11531,7 @@ components:
minLength: 1
maxLength: 35
Image:
- "$ref": "#/components/schemas/ShipmentResults_Form_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
@@ -11555,7 +11551,7 @@ components:
xml:
name: Form
description: |-
- Container tag for the International forms image. Form is returned for following shipments -
+ 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.
@@ -11565,7 +11561,7 @@ components:
- Image
properties:
Image:
- "$ref": "#/components/schemas/CODTurnInPage_Image"
+ $ref: "#/components/schemas/CODTurnInPage_Image"
xml:
name: CODTurnInPage
description: The container of the COD Turn In Page.
@@ -11577,7 +11573,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/CODTurnInPage_Image_ImageFormat"
+ $ref: "#/components/schemas/CODTurnInPage_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded html browser image rendering software
type: string
@@ -11592,7 +11588,7 @@ components:
- Image
properties:
Image:
- "$ref": "#/components/schemas/HighValueReport_Image"
+ $ref: "#/components/schemas/HighValueReport_Image"
xml:
name: HighValueReport
description: Container for the High Value Report generated for ImportControl
@@ -11605,7 +11601,7 @@ components:
- ImageFormat
properties:
ImageFormat:
- "$ref": "#/components/schemas/HighValueReport_Image_ImageFormat"
+ $ref: "#/components/schemas/HighValueReport_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded High Value Report image.
type: string
@@ -11624,7 +11620,7 @@ components:
- VoidShipmentRequest
properties:
VoidShipmentRequest:
- "$ref": "#/components/schemas/VoidShipmentRequest"
+ $ref: "#/components/schemas/VoidShipmentRequest"
VOIDSHIPMENTResponseWrapper:
xml:
name: VoidShipmentResponse
@@ -11635,7 +11631,7 @@ components:
- VoidShipmentResponse
properties:
VoidShipmentResponse:
- "$ref": "#/components/schemas/VoidShipmentResponse"
+ $ref: "#/components/schemas/VoidShipmentResponse"
VoidShipmentRequest:
type: object
required:
@@ -11643,9 +11639,9 @@ components:
- VoidShipment
properties:
Request:
- "$ref": "#/components/schemas/VoidShipmentRequest_Request"
+ $ref: "#/components/schemas/VoidShipmentRequest_Request"
VoidShipment:
- "$ref": "#/components/schemas/VoidShipmentRequest_VoidShipment"
+ $ref: "#/components/schemas/VoidShipmentRequest_VoidShipment"
xml:
name: VoidShipmentRequest
description: Void Shipment Request Container
@@ -11659,7 +11655,7 @@ components:
uses
type: string
TransactionReference:
- "$ref": "#/components/schemas/VoidRequest_TransactionReference"
+ $ref: "#/components/schemas/VoidRequest_TransactionReference"
xml:
name: Request
description: Request Container
@@ -11719,9 +11715,9 @@ components:
- SummaryResult
properties:
Response:
- "$ref": "#/components/schemas/VoidShipmentResponse_Response"
+ $ref: "#/components/schemas/VoidShipmentResponse_Response"
SummaryResult:
- "$ref": "#/components/schemas/VoidShipmentResponse_SummaryResult"
+ $ref: "#/components/schemas/VoidShipmentResponse_SummaryResult"
PackageLevelResults:
description: |
Contains the Package Level Results.
@@ -11729,7 +11725,7 @@ components:
**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"
+ $ref: "#/components/schemas/VoidShipmentResponse_PackageLevelResults"
xml:
name: VoidShipmentResponse
description: Void Response Container.
@@ -11740,11 +11736,11 @@ components:
- ResponseStatus
properties:
ResponseStatus:
- "$ref": "#/components/schemas/VoidResponse_ResponseStatus"
+ $ref: "#/components/schemas/VoidResponse_ResponseStatus"
Alert:
- "$ref": "#/components/schemas/Response_Alert"
+ $ref: "#/components/schemas/Response_Alert"
TransactionReference:
- "$ref": "#/components/schemas/VoidResponse_TransactionReference"
+ $ref: "#/components/schemas/VoidResponse_TransactionReference"
xml:
name: Response
description: Response Container.
@@ -11791,7 +11787,7 @@ components:
- Status
properties:
Status:
- "$ref": "#/components/schemas/SummaryResult_Status"
+ $ref: "#/components/schemas/SummaryResult_Status"
xml:
name: SummaryResult
description: Container for the Summary Result
@@ -11832,7 +11828,7 @@ components:
minLength: 18
maxLength: 18
Status:
- "$ref": "#/components/schemas/PackageLevelResults_Status"
+ $ref: "#/components/schemas/PackageLevelResults_Status"
xml:
name: PackageLevelResults
PackageLevelResults_Status:
@@ -11843,7 +11839,7 @@ components:
- Code
properties:
Code:
- description: The Package Level void status code. A numeric value that describes
+ 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
@@ -11870,7 +11866,7 @@ components:
- LabelRecoveryRequest
properties:
LabelRecoveryRequest:
- "$ref": "#/components/schemas/LabelRecoveryRequest"
+ $ref: "#/components/schemas/LabelRecoveryRequest"
LABELRECOVERYResponseWrapper:
xml:
name: LabelRecoveryResponse
@@ -11881,31 +11877,31 @@ components:
- LabelRecoveryResponse
properties:
LabelRecoveryResponse:
- "$ref": "#/components/schemas/LabelRecoveryResponse"
+ $ref: "#/components/schemas/LabelRecoveryResponse"
LabelRecoveryRequest:
type: object
required:
- Request
properties:
Request:
- "$ref": "#/components/schemas/LabelRecoveryRequest_Request"
+ $ref: "#/components/schemas/LabelRecoveryRequest_Request"
LabelSpecification:
- "$ref": "#/components/schemas/LabelRecoveryRequest_LabelSpecification"
+ $ref: "#/components/schemas/LabelRecoveryRequest_LabelSpecification"
Translate:
- "$ref": "#/components/schemas/LabelRecoveryRequest_Translate"
+ $ref: "#/components/schemas/LabelRecoveryRequest_Translate"
LabelDelivery:
- "$ref": "#/components/schemas/LabelRecoveryRequest_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.
+ 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
MailInnovationsTrackingNumber:
- description: "Mail Innovations Tracking Number. Required if Tracking Number
- or ReferenceNumber/Value is not populated. \nIf only 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
@@ -11917,23 +11913,23 @@ components:
minLength: 1
maxLength: 34
ReferenceValues:
- "$ref": "#/components/schemas/LabelRecoveryRequest_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
+ 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
+ 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"
+ $ref: "#/components/schemas/LabelRecoveryRequest_UPSPremiumCareForm"
xml:
name: LabelRecoveryRequest
maximum: 1
@@ -11955,7 +11951,7 @@ components:
description: Request option is no longer used.
type: string
TransactionReference:
- "$ref": "#/components/schemas/LRRequest_TransactionReference"
+ $ref: "#/components/schemas/LRRequest_TransactionReference"
xml:
name: Request
description: Request Container.
@@ -11979,7 +11975,7 @@ components:
properties:
HTTPUserAgent:
description: Browser HTTPUserAgent String. This is the preferred way of
- identifying GIF image type to be generated. Required if Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -53,7 +53,7 @@ paths:
schema:
type: string
default: testing
- description: Identifies the clients/source application that is calling. Length
+ description: Identifies the clients/source application that is calling. Length
512
required: true
requestBody:
@@ -65,7 +65,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/TimeInTransitRequest"
+ $ref: "#/components/schemas/TimeInTransitRequest"
examples:
'1':
summary: A sample JSON request (Standard Example)
@@ -96,31 +96,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/TimeInTransitResponse"
+ $ref: "#/components/schemas/TimeInTransitResponse"
'400':
description: Invalid Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/errorResponse"
+ $ref: "#/components/schemas/errorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
- "$ref": "#/components/schemas/errorResponse"
+ $ref: "#/components/schemas/errorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/errorResponse"
+ $ref: "#/components/schemas/errorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
- "$ref": "#/components/schemas/errorResponse"
+ $ref: "#/components/schemas/errorResponse"
components:
securitySchemes:
OAuth2:
@@ -144,17 +144,17 @@ components:
- originCountryCode
properties:
originCountryCode:
- description: "The country code of the origin shipment. \nValid Values: \nMust
- conform to the ISO-defined, two-letter country or territory codes. Refer
+ description: "The country code of the origin shipment.\nValid Values:\nMust
+ conform to the ISO-defined, two-letter country or territory codes. Refer
to Country or Territory Codes in the Appendix above for valid values."
type: string
maximum: 1
minLength: 2
maxLength: 2
originStateProvince:
- description: "The shipment origin state or province. For U.S. addresses,
+ description: "The shipment origin state or province. For U.S. addresses,
the value must be a valid 2-character value (per U.S. Mail standards)
- \n For non-U.S. addresses the full State or Province name should be provided."
+ \nFor non-U.S. addresses the full State or Province name should be provided."
type: string
maximum: 1
minLength: 1
@@ -173,8 +173,8 @@ components:
minLength: 1
maxLength: 50
originPostalCode:
- description: "Required for Domestic requests. The shipment origin postal
- code. \nEither the 5, or 9-digit US zip codes must be used for U.S. addresses.
+ description: "Required for Domestic requests. The shipment origin postal
+ code.\nEither the 5, or 9-digit US zip codes must be used for U.S. addresses.
\ For non-U.S. addresses, this is recommended for all countries that utilize
postal codes."
type: string
@@ -182,16 +182,16 @@ components:
minLength: 1
maxLength: 10
destinationCountryCode:
- description: "The country code of the destination. \n Valid values: \n
+ description: "The country code of the destination.\nValid values:\n
Must conform to ISO-defined country codes."
type: string
maximum: 1
minLength: 2
maxLength: 2
destinationStateProvince:
- description: "The shipment destination state or province. For U.S. addresses,
+ description: "The shipment destination state or province. For U.S. addresses,
the value must be a valid 2-character value (per U.S. Mail standards).
- \ \n For non-U.S. addresses the full State or Province name should be
+ \\nFor non-U.S. addresses the full State or Province name should be
provided."
type: string
maximum: 1
@@ -205,13 +205,13 @@ components:
minLength: 1
maxLength: 50
destinationTownName:
- description: The shipment destination town. Town is a subdivision of city.
+ description: The shipment destination town. Town is a subdivision of city.
type: string
maximum: 1
minLength: 1
maxLength: 50
destinationPostalCode:
- description: "The shipment destination postal code. \n Required for Domestic
+ description: "The shipment destination postal code.\nRequired for Domestic
requests. Either 5, or 9-digit U.S. zip codes must be used for U.S. addresses.
\ For non-U.S. addresses, this is recommended for all countries that utilize
postal codes."
@@ -221,26 +221,26 @@ components:
maxLength: 10
residentialIndicator:
description: "Indicates if address is residential or commercial. Required
- for Domestic requests. \n \n Valid values: \"01\", \"02\" \n \n 01 = Residential
- \n 02 = Commercial \n \n Defaults to commercial for International Requests."
+ for Domestic requests.\n\nValid values: \"01\", \"02\"\n\n01 = Residential
+ \n02 = Commercial\n\nDefaults to commercial for International Requests."
type: string
maximum: 1
minLength: 2
maxLength: 2
shipDate:
description: "The date the shipment is tendered to UPS for shipping (can
- be dropped off at UPS or picked up by UPS). Allowed range is up to 60
+ be dropped off at UPS or picked up by UPS). Allowed range is up to 60
days in future and 35 days in past. This date may or may not be the UPS
- business date. \n\nFormat is YYYY-MM-DD. \n\nYYYY = 4 digit year; \n\nMM
- = 2 digit month, valid values 01-12; \n\nDD = 2 digit day of month, valid
- values 01-31 \n If no value is provided, defaults to current system date."
+ business date.\n\nFormat is YYYY-MM-DD.\n\nYYYY = 4 digit year;\n\nMM
+ = 2 digit month, valid values 01-12;\n\nDD = 2 digit day of month, valid
+ values 01-31\nIf no value is provided, defaults to current system date."
type: string
maximum: 1
minLength: 1
maxLength: 10
shipTime:
description: "The time the shipment is tendered to UPS for shipping (can
- be dropped off at UPS or picked up by UPS). \n Format is HH:MM:SS \n\n
+ be dropped off at UPS or picked up by UPS).\nFormat is HH:MM:SS\n\n
Defaults to current time if not provided."
type: string
maximum: 1
@@ -248,25 +248,25 @@ components:
maxLength: 8
weight:
description: "The weight of the shipment. Required for International requests.
- \n \n Note: If decimal values are used, valid values will be rounded to
- the tenths. \n \n Note: Maximum value is 70 kilograms or 150 pounds."
+ \n\nNote: If decimal values are used, valid values will be rounded to
+ the tenths.\n\nNote: Maximum value is 70 kilograms or 150 pounds."
type: number
maximum: 1
minLength: 1
maxLength: 8
weightUnitOfMeasure:
description: "Required for International requests and when weight value
- is provided. \n \n Valid Values: \"LBS\", \"KGS\""
+ is provided.\n\nValid Values: \"LBS\", \"KGS\""
type: string
maximum: 1
minLength: 1
maxLength: 3
shipmentContentsValue:
- description: "The monetary value of shipment contents. \n \n Required when
+ description: "The monetary value of shipment contents.\n\nRequired when
origin country does not equal destination country and BillType is 03 (non-documented)
- or 04 (WWEF) \n \n Required when origin country does not equal destination
- country, and destination country = CA, and BillType = 02 (document). \n
- \n Note: If decimal values are used, valid values will be rounded to the
+ or 04 (WWEF)\n\nRequired when origin country does not equal destination
+ country, and destination country = CA, and BillType = 02 (document).\n
+ \nNote: If decimal values are used, valid values will be rounded to the
tenths."
type: number
maximum: 3
@@ -274,55 +274,55 @@ components:
maxLength: 11
shipmentContentsCurrencyCode:
description: "The unit of currency used for values. Required if ShipmentContentsValue
- is populated. \n Valid value: must conform to ISO standards."
+ is populated.\nValid value: must conform to ISO standards."
type: string
maximum: 1
minLength: 1
maxLength: 3
billType:
- description: "Required for International Requests. \n Valid values: \"02\",\"03\",\"04\"
- \n 02 - Document \n 03 - Non Document \n 04 - WWEF (Pallet)"
+ description: "Required for International Requests.\nValid values: \"02\",\"03\",\"04\"
+ \n02 - Document\n03 - Non Document\n04 - WWEF (Pallet)"
type: string
maximum: 1
minLength: 2
maxLength: 2
avvFlag:
description: "Used to bypass address validation when the address has already
- been validated by the calling application. \n \n Valid values: true,
- false \n \n Defaults to true \n Note: not to be exposed to external customers."
+ been validated by the calling application.\n\nValid values: true,
+ false\n\nDefaults to true\nNote: not to be exposed to external customers."
type: boolean
maximum: 1
numberOfPackages:
- description: Sets the number of packages in shipment. Default value is
+ description: Sets the number of packages in shipment. Default value is
1.
type: integer
maximum: 1
dropOffAtFacilityIndicator:
description: "Sets the indicator for an international Freight Pallet shipment
- that is going to be dropped off by shipper to a UPS facility. The indicator
- is used when the Bill Type is \"04\". \n \n Valid values: \"0\", \"1\".
- \n \n 0 = WWDTProcessIF.PICKUP_BY_UPS \n 1 = WWDTProcessIf.DROPOFF_BY_SHIPPER
- \n \n The default value is \"0\" "
+ that is going to be dropped off by shipper to a UPS facility. The indicator
+ is used when the Bill Type is \"04\".\n\nValid values: \"0\", \"1\".
+ \n\n0 = WWDTProcessIF.PICKUP_BY_UPS\n1 = WWDTProcessIf.DROPOFF_BY_SHIPPER
+\n\nThe default value is \"0\" "
type: integer
maximum: 1
holdForPickupIndicator:
description: "Sets the indicator for an international Freight Pallet shipment
- that is going to be pick-up by consignee in a destination facility. The
- indicator is used when the Bill Type is \"04\". \n \n Valid values: \"0\",
- \"1\". \n \n 0 = WWDTProcessIF.DELIVERY_BY_UPS \n 1 = WWDTProcessIf.PICKUP_BY_CONSIGNEE
- \n \n The default value is \"0\" "
+ that is going to be pick-up by consignee in a destination facility. The
+ indicator is used when the Bill Type is \"04\".\n\nValid values: \"0\",
+ \"1\".\n\n0 = WWDTProcessIF.DELIVERY_BY_UPS\n1 = WWDTProcessIf.PICKUP_BY_CONSIGNEE
+ \n\nThe default value is \"0\" "
type: integer
maximum: 1
returnUnfilterdServices:
description: "Used to get back a full list of services - bypassing current
WWDT business rules to remove services from the list being returned to
- clients for US domestic that are slower than UPS Ground. \n \n Default
+ clients for US domestic that are slower than UPS Ground.\n\nDefault
value is false."
type: boolean
maximum: 1
maxList:
description: "Sets the limit for the number of candidates returned in candidate
- list. \n \n Default value is 200."
+ list.\n\nDefault value is 200."
type: integer
maximum: 1
maximum: 1
@@ -331,13 +331,13 @@ components:
type: object
properties:
validationList:
- "$ref": "#/components/schemas/validationList"
+ $ref: "#/components/schemas/validationList"
destinationPickList:
- "$ref": "#/components/schemas/destinationPickList"
+ $ref: "#/components/schemas/destinationPickList"
originPickList:
- "$ref": "#/components/schemas/originPickList"
+ $ref: "#/components/schemas/originPickList"
emsResponse:
- "$ref": "#/components/schemas/emsResponse"
+ $ref: "#/components/schemas/emsResponse"
maximum: 1
description: N/A
errorResponse:
@@ -346,7 +346,7 @@ components:
errors:
type: array
items:
- "$ref": "#/components/schemas/errors"
+ $ref: "#/components/schemas/errors"
validationList:
type: object
properties:
@@ -369,11 +369,11 @@ components:
destinationPickList:
type: array
items:
- "$ref": "#/components/schemas/candidateAddress"
+ $ref: "#/components/schemas/candidateAddress"
originPickList:
type: array
items:
- "$ref": "#/components/schemas/candidateAddress"
+ $ref: "#/components/schemas/candidateAddress"
emsResponse:
type: object
required:
@@ -391,44 +391,44 @@ components:
properties:
shipDate:
description: "The date the shipment is tendered to UPS for shipping (can
- be dropped off at UPS or picked up by UPS). This date may or may not
- be the UPS business date. \n \n Valid Format: YYYY-MM-DD"
+ be dropped off at UPS or picked up by UPS). This date may or may not
+ be the UPS business date.\n\nValid Format: YYYY-MM-DD"
type: string
maximum: 1
minLength: 8
maxLength: 8
shipTime:
description: "The time the shipment is tendered to UPS for shipping (can
- be dropped off at UPS or picked up by UPS). \n \n Valid Format: HH:MM:SS"
+ be dropped off at UPS or picked up by UPS).\n\nValid Format: HH:MM:SS"
type: string
maximum: 1
serviceLevel:
- description: "Service Levels being returned. \n \n A = all service levels.
- \n \n Blank is the default for all Service Level values."
+ description: "Service Levels being returned.\n\nA = all service levels.
+ \n\nBlank is the default for all Service Level values."
type: string
maximum: 1
minLength: 1
maxLength: 3
billType:
- description: "Represents the shipment type. \n \n Valid values: \"02\",\"03\",\"04\",\"07\"
- \n 02 - Document \n 03 - Non-Document \n 04 - WWEF \n 07 - Pallet"
+ description: "Represents the shipment type.\n\nValid values: \"02\",\"03\",\"04\",\"07\"
+ \n02 - Document\n03 - Non-Document\n04 - WWEF\n07 - Pallet"
type: string
maximum: 1
minLength: 2
maxLength: 2
dutyType:
description: "Populated with valid duty types for international transactions
- only. \n \n Valid Duty Types: \"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\"
- \n 01 - Dutiable \n 02 - Non Dutiable \n 03 - Low Value \n 04 - Courier
- Remission \n 05 - Gift \n 06 - Military \n 07 - Exception \n 08 - Line
- Release \n 09 - Low Value"
+ only.\n\nValid Duty Types: \"01\",\"02\",\"03\",\"04\",\"05\",\"06\",\"07\",\"08\",\"09\"
+ \n01 - Dutiable\n02 - Non Dutiable\n03 - Low Value\n04 - Courier
+ Remission\n05 - Gift\n06 - Military\n07 - Exception\n08 - Line
+ Release\n09 - Low Value"
type: string
maximum: 1
minLength: 2
maxLength: 2
residentialIndicator:
- description: "residential Indicator that was sent in on the request. \n
- \n Valid values: \"01\",\"02\" \n \n 01 - Residential \n 02 - Commercial"
+ description: "residential Indicator that was sent in on the request.\n
+ \nValid values: \"01\",\"02\"\n\n01 - Residential\n02 - Commercial"
type: string
maximum: 1
minLength: 2
@@ -446,43 +446,43 @@ components:
minLength: 2
maxLength: 2
destinationPostalCode:
- description: "The shipment destination postal code. Required for US domestic
- requests. \n \n Either 5, or 9-digit US zip codes must be used for U.S.
- addresses. For non-US addresses, this is recommended for all countries
+ description: "The shipment destination postal code. Required for US domestic
+ requests.\n\nEither 5, or 9-digit US zip codes must be used for U.S.
+ addresses. For non-US addresses, this is recommended for all countries
that utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 10
destinationPostalCodeLow:
- description: "The shipment destination postal code low range. Value may
- or may not differ from destinationPostalCode. \n \n Either 5, or 9-digit
- US zip codes must be used for U.S. addresses. For non-US addresses, this
+ description: "The shipment destination postal code low range. Value may
+ or may not differ from destinationPostalCode.\n\nEither 5, or 9-digit
+ US zip codes must be used for U.S. addresses. For non-US addresses, this
is recommended for all countries that utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 10
destinationPostalCodeHigh:
- description: "The shipment destination postal code high range. Value may
- or may not differ from destinationPostalCode. \n \n Either 5, or 9-digit
- US zip codes must be used for U.S. addresses. For non-US addresses, this
+ description: "The shipment destination postal code high range. Value may
+ or may not differ from destinationPostalCode.\n\nEither 5, or 9-digit
+ US zip codes must be used for U.S. addresses. For non-US addresses, this
is recommended for all countries that utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 10
destinationStateProvince:
- description: "The shipment destination state or province. \n \n For U.S.
+ description: "The shipment destination state or province.\n\nFor U.S.
addresses, the value will be a valid 2-Character value (per U.S. Mail
- Standards). \n \n For non-U.S. addresses the full State or Province name
+ Standards).\n\nFor non-U.S. addresses the full State or Province name
will be returned."
type: string
maximum: 1
minLength: 1
maxLength: 50
destinationCityName:
- description: "The shipment destination city. \n \n Required for International
+ description: "The shipment destination city.\n\nRequired for International
requests for those countries that do not utilize postal codes."
type: string
maximum: 1
@@ -501,50 +501,50 @@ components:
minLength: 2
maxLength: 2
originPostalCode:
- description: "The shipment origin postal code. Required for US domestic
- requests. \n \n Either 5, or 9-digit US zip codes must be used for U.S.
- addresses. For non-US addresses, this is recommended for all countries
+ description: "The shipment origin postal code. Required for US domestic
+ requests.\n\nEither 5, or 9-digit US zip codes must be used for U.S.
+ addresses. For non-US addresses, this is recommended for all countries
that utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 10
originPostalCodeLow:
- description: "The shipment origin postal code low range. Value may or may
- not differ from destinationPostalCode. \n \n Either 5, or 9-digit US
- zip codes must be used for U.S. addresses. For non-US addresses, this
+ description: "The shipment origin postal code low range. Value may or may
+ not differ from destinationPostalCode.\n\nEither 5, or 9-digit US
+ zip codes must be used for U.S. addresses. For non-US addresses, this
is recommended for all countries that utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 10
originPostalCodeHigh:
- description: "The shipment origin postal code high range. Value may or
- may not differ from destinationPostalCode. \n \n Either 5, or 9-digit
- US zip codes must be used for U.S. addresses. For non-US addresses, this
+ description: "The shipment origin postal code high range. Value may or
+ may not differ from destinationPostalCode.\n\nEither 5, or 9-digit
+ US zip codes must be used for U.S. addresses. For non-US addresses, this
is recommended for all countries that utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 10
originStateProvince:
- description: "The shipment origin state or province. \n \n For U.S. addresses,
+ description: "The shipment origin state or province.\n\nFor U.S. addresses,
the value will be a valid 2-Character value (per U.S. Mail Standards).
- \n \n For non-U.S. addresses the full State or Province name will be returned."
+ \n\nFor non-U.S. addresses the full State or Province name will be returned."
type: string
maximum: 1
minLength: 1
maxLength: 50
originCityName:
- description: "The shipment origin city. \n \n Required for International
+ description: "The shipment origin city.\n\nRequired for International
requests for those countries that do not utilize postal codes."
type: string
maximum: 1
minLength: 1
maxLength: 50
weight:
- description: "Shipment weight. Value is only required for international
- shipment. \n \n Defaults to 0.0"
+ description: "Shipment weight. Value is only required for international
+ shipment.\n\nDefaults to 0.0"
type: string
maximum: 1
minLength: 1
@@ -557,7 +557,7 @@ components:
maxLength: 3
shipmentContentsValue:
description: "Shipment contents value. Value is only required for international
- shipment. \n \n Defaults to 0.0"
+ shipment.\n\nDefaults to 0.0"
type: string
maximum: 1
minLength: 1
@@ -572,10 +572,10 @@ components:
guaranteeSuspended:
description: "Returns TRUE if the shipment dates fall within a defined peak
date range. When the guarantee is suspended, it is suspended for all services
- in the response. \n \n The logic for determining if guarantees are suspended
- applies per origin country. \n \n The following will be used to determine
+ in the response.\n\nThe logic for determining if guarantees are suspended
+ applies per origin country.\n\nThe following will be used to determine
if a shipment falls within a defined peak date range: shipDate (from the
- response), deliveryDate (from the response), server Date. \n \n Defined
+ response), deliveryDate (from the response), server Date.\n\nDefined
peak date range (range for when guarantees are suspended) is inclusive
of start and end dates."
type: boolean
@@ -587,7 +587,7 @@ components:
services:
type: array
items:
- "$ref": "#/components/schemas/services"
+ $ref: "#/components/schemas/services"
candidateAddress:
type: object
required:
@@ -672,8 +672,8 @@ components:
- cstccutoffTime
properties:
serviceLevel:
- description: "Service level code \n \n Valid domestic service codes: \"1DMS\",\"1DAS\",\"1DM\",\"1DA\",\"1DP\",\"2DM\",\"2DA\",\"3DS\",\"GND\".
- \n \n Valid International service codes (not a complete list) ,\"01\",\"02\",\"03\",\"05\",\"08\",\"09\",\"10\",\"11\",\"18\",\"19\",\"20\",\"21\",\"22\",\"23\",\"24\",\"25\",\"26\",\"28\",\"29\",\"33\",\"68\". "
+ description: "Service level code\n\nValid domestic service codes: \"1DMS\",\"1DAS\",\"1DM\",\"1DA\",\"1DP\",\"2DM\",\"2DA\",\"3DS\",\"GND\".
+ \n\nValid International service codes (not a complete list) ,\"01\",\"02\",\"03\",\"05\",\"08\",\"09\",\"10\",\"11\",\"18\",\"19\",\"20\",\"21\",\"22\",\"23\",\"24\",\"25\",\"26\",\"28\",\"29\",\"33\",\"68\". "
type: string
maximum: 1
minLength: 2
@@ -685,35 +685,35 @@ components:
maximum: 1
shipDate:
description: "The date the shipment is tendered to UPS for shipping (can
- be dropped off at UPS or picked up by UPS). This date may or may not
- be the UPS business date. \n \n Valid Format: YYYY-MM-DD"
+ be dropped off at UPS or picked up by UPS). This date may or may not
+ be the UPS business date.\n\nValid Format: YYYY-MM-DD"
type: string
maximum: 1
minLength: 10
maxLength: 10
deliveryDate:
- description: "Scheduled delivery date. \n \n Valid format: YYYY-MM-DD"
+ description: "Scheduled delivery date.\n\nValid format: YYYY-MM-DD"
type: string
maximum: 1
minLength: 10
maxLength: 10
commitTime:
- description: "Scheduled commit time. \n \n For international shipments the
+ description: "Scheduled commit time.\n\nFor international shipments the
value always come back from SE (OPSYS data) but for domestic, value may
- be used from NRF commit time. \n \n Valid format: HH:MM:SS"
+ be used from NRF commit time.\n\nValid format: HH:MM:SS"
type: string
maximum: 1
minLength: 8
maxLength: 8
deliveryTime:
description: "Scheduled Delivery Time, value may be later then commit time.
- \n \n Valid format: HH:MM:SS"
+ \n\nValid format: HH:MM:SS"
type: string
maximum: 1
minLength: 8
maxLength: 8
deliveryDayOfWeek:
- description: "Three character scheduled delivery day of week. \n \n Valid
+ description: "Three character scheduled delivery day of week.\n\nValid
values: \"MON\",\"TUE\",\"WED\",\"THU\",\"FRI\", \"SAT\""
type: string
maximum: 1
@@ -721,7 +721,7 @@ components:
maxLength: 3
nextDayPickupIndicator:
description: "Returns a \"1\" if the requested shipped on date was changed.
- This data is available only for international transactions. \n \n When
+ This data is available only for international transactions.\n\nWhen
this flag is set, WWDTDisclaimer.getNextDayDisclaimer method could be
called to return the next day disclaimer message."
type: string
@@ -730,20 +730,20 @@ components:
maxLength: 1
saturdayPickupIndicator:
description: "Returns \"1\" if Saturday Pickup is available for an extra
- charge otherwise it will return \"0\". \n \n When this flag is set, WWDTDisclaimer.getSaturdayPickupDisclaimer
+ charge otherwise it will return \"0\".\n\nWhen this flag is set, WWDTDisclaimer.getSaturdayPickupDisclaimer
method could be called to return the Saturday pickup extra charge message"
type: string
maximum: 1
minLength: 1
maxLength: 1
saturdayDeliveryDate:
- description: "Delivery date of Saturday Delivery \n \n Valid Format: YYYY-MM-DD"
+ description: "Delivery date of Saturday Delivery\n\nValid Format: YYYY-MM-DD"
type: string
maximum: 1
minLength: 10
maxLength: 10
saturdayDeliveryTime:
- description: "Delivery time of Saturday deliver \n \n Valid format: HH:MM:SS"
+ description: "Delivery time of Saturday deliver\n\nValid format: HH:MM:SS"
type: string
maximum: 1
minLength: 8
@@ -756,9 +756,9 @@ components:
maximum: 1
guaranteeIndicator:
description: "Return \"1\" Guaranteed, or \"0\" Not Guaranteed based on
- below conditions: \n \n If the ship date, delivery date, and system date
+ below conditions:\n\nIf the ship date, delivery date, and system date
are not within a defined peak date range, and a value for service guarantee
- is available in SE (OPSYS data) that will be returned. \n \n If the ship
+ is available in SE (OPSYS data) that will be returned.\n\nIf the ship
date or delivery date or system date are within a defined peak date range
and the service is within the list of services to remove guarantees for,
\"0\" wil be returned."
@@ -768,8 +768,8 @@ components:
maxLength: 1
totalTransitDays:
description: "Available for International requests. Number of calendar days
- from origin location to destination location. TotalTransitDays = BusinessTransitDays
- + RestDaysCount + HolidayCount. \n \n Defaults to 0."
+ from origin location to destination location. TotalTransitDays = BusinessTransitDays
+ + RestDaysCount + HolidayCount.\n\nDefaults to 0."
type: integer
maximum: 1
businessTransitDays:
@@ -779,25 +779,25 @@ components:
maximum: 1
restDaysCount:
description: "Returns the number of rest days encountered at the origin
- location. this data is available only for international transactions.
- \n \n Defaults to 0."
+ location. this data is available only for international transactions.
+ \n\nDefaults to 0."
type: integer
maximum: 1
holidayCount:
description: "Returns the number of holidays encountered at the origin and
- destination location, if it effects the time and transit. This data is
- available only for international transactions. \n \n Defaults to 0."
+ destination location, if it effects the time and transit. This data is
+ available only for international transactions.\n\nDefaults to 0."
type: integer
maximum: 1
delayCount:
description: "Returns the number of delay needed for customs encounter at
- the origin or destination location. This data is available only for international
- transactions. \n \n Defaults to 0."
+ the origin or destination location. This data is available only for international
+ transactions.\n\nDefaults to 0."
type: integer
maximum: 1
pickupDate:
- description: "Planned pickup date. \n \n Note: This value may not equal
- the shipped on value requested. This could happen when the requested
+ description: "Planned pickup date.\n\nNote: This value may not equal
+ the shipped on value requested. This could happen when the requested
shipped on date is a holiday or for locations needing 24 hour notice before
a pickup could be made."
type: string
@@ -822,7 +822,7 @@ components:
minLength: 8
maxLength: 8
poddate:
- description: Returns the date proof of delivery information would be available. This
+ description: Returns the date proof of delivery information would be available. This
data is available only for international transactions.
type: string
maximum: 1
@@ -830,7 +830,7 @@ components:
maxLength: 10
poddays:
description: Returns the number of days proof of delivery information will
- be available. This data is available only for international transactions.
+ be available. This data is available only for international transactions.
type: integer
maximum: 1
errors:
diff --git a/Tracking.yaml b/Tracking.yaml
index 9fcf899..95b3584 100644
--- a/Tracking.yaml
+++ b/Tracking.yaml
@@ -4,7 +4,7 @@ info:
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
-
+
The Track API helps retrieves current status of shipments such as Small Package 1Z, Infonotice, Mail Innovations, FGV, or UPS Freight shipments using the package number or the reference number. The tracking response data typically includes package movements/activities, destination UPS access point information, expected delivery dates/times, etc. Required parameters are the inquiryNumber, transaction ID, and transaction source.Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
servers:
- url: https://wwwcie.ups.com/api
@@ -95,37 +95,37 @@ paths:
content:
"application/json":
schema:
- "$ref": "#/components/schemas/TrackApiResponse"
+ $ref: "#/components/schemas/TrackApiResponse"
'400':
description: Invalid request
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'404':
description: Tracking number information not found
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'500':
description: Internal server error
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'503':
description: Resource is not available
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
deprecated: false
"/track/v1/reference/details/{referenceNumber}":
get:
@@ -187,37 +187,37 @@ paths:
content:
"application/json":
schema:
- "$ref": "#/components/schemas/TrackApiResponse"
+ $ref: "#/components/schemas/TrackApiResponse"
'400':
description: Invalid request
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'403':
description: Blocked Merchant
content:
application/json:
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'404':
description: Tracking number information not found
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'500':
description: Internal server error
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
'503':
description: Resource is not available
content:
"application/json":
schema:
- "$ref": "#/components/schemas/Response"
+ $ref: "#/components/schemas/Response"
deprecated: false
components:
securitySchemes:
@@ -267,9 +267,9 @@ components:
description: 'gmtTime'
example: '74700'
location:
- "$ref": "#/components/schemas/Location"
+ $ref: "#/components/schemas/Location"
status:
- "$ref": "#/components/schemas/Status"
+ $ref: "#/components/schemas/Status"
time:
type: string
description: 'The time of the activity. Format: HHMMSS (24 hr)'
@@ -335,7 +335,7 @@ components:
description: The date of this delivery detail. Format - YYYYMMDD
type:
type: string
- description: 'The list of delivery dates associated with the package.
+ description: 'The list of delivery dates associated with the package.
Valid values:
SDD - Scheduled Delivery Date
RDD - Rescheduled Delivery Date
@@ -347,7 +347,7 @@ components:
Populated only when the package is delivered.
properties:
deliveryPhoto:
- "$ref": "#/components/schemas/DeliveryPhoto"
+ $ref: "#/components/schemas/DeliveryPhoto"
location:
type: string
description: 'The location where the package was dropped off. For example:
@@ -358,24 +358,24 @@ components:
description: The individual who took possession of the package at delivery.
example: ''
signature:
- "$ref": "#/components/schemas/Signature"
+ $ref: "#/components/schemas/Signature"
pod:
- title: POD
- type: object
- description: Container which contains Proof of Delivery.
- properties:
+ title: POD
+ type: object
+ description: Container which contains Proof of Delivery.
+ properties:
content:
type: string
description: 'The base64 encoded string representation of the Delivery Proof. Note: This is considered sensitive data and may only be returned for a user that has rights to the package.'
DeliveryPhoto:
title: DeliveryPhoto
type: object
- description: Container with all information related to the delivery photo of the
+ description: Container with all information related to the delivery photo of the
package.
properties:
isNonPostalCodeCountry:
type: boolean
- description: 'The indication if the country does not use postal code.
+ description: 'The indication if the country does not use postal code.
Valid values: ''true'' this country does not use postal code.
''false'' this country uses postal code'
photo:
@@ -386,7 +386,7 @@ components:
photo capture. ''N'' the photo is not a capture'
photoDispositionCode:
type: string
- description: 'The photo disposition code. Valid values: ''V'' the photo is
+ description: 'The photo disposition code. Valid values: ''V'' the photo is
viewable. ''N'' the photo is not viewable. ''U'' the photo is not stored'
DeliveryTime:
title: DeliveryTime
@@ -453,7 +453,7 @@ components:
type: object
properties:
address:
- "$ref": "#/components/schemas/Address"
+ $ref: "#/components/schemas/Address"
slic:
type: string
description: Site Location Indicator Code (SLIC)
@@ -476,7 +476,7 @@ components:
type: boolean
description: 'The indication if the milestone represents the current state
of the package. Valid values: ''true'' this milestone is the current state
- of the package. ''false'' this milestone is not current.'
+ of the package. ''false'' this milestone is not current.'
description:
type: string
description: 'The milestone description. Note: this is not translated at
@@ -491,17 +491,17 @@ components:
description: 'The milestone state. Valid values: ''This milestone has already
occurred''/''This milestone has not yet been completed''.'
subMilestone:
- "$ref": "#/components/schemas/SubMilestone"
+ $ref: "#/components/schemas/SubMilestone"
Package:
title: Package
type: object
properties:
accessPointInformation:
- "$ref": "#/components/schemas/AccessPointInformation"
+ $ref: "#/components/schemas/AccessPointInformation"
activity:
type: array
items:
- "$ref": "#/components/schemas/Activity"
+ $ref: "#/components/schemas/Activity"
additionalAttributes:
type: array
description: The list of additional attributes that may be associated with
@@ -528,19 +528,19 @@ components:
alternateTrackingNumber:
type: array
items:
- "$ref": "#/components/schemas/AlternateTrackingNumber"
+ $ref: "#/components/schemas/AlternateTrackingNumber"
currentStatus:
- "$ref": "#/components/schemas/Status"
+ $ref: "#/components/schemas/Status"
deliveryDate:
type: array
items:
- "$ref": "#/components/schemas/DeliveryDate"
+ $ref: "#/components/schemas/DeliveryDate"
deliveryInformation:
- "$ref": "#/components/schemas/DeliveryInformation"
+ $ref: "#/components/schemas/DeliveryInformation"
deliveryTime:
- "$ref": "#/components/schemas/DeliveryTime"
+ $ref: "#/components/schemas/DeliveryTime"
dimension:
- "$ref": "#/components/schemas/Dimension"
+ $ref: "#/components/schemas/Dimension"
isSmartPackage:
type: boolean
description: 'Indicator of whether the package is a smart package'
@@ -548,11 +548,11 @@ components:
type: array
description: milestones
items:
- "$ref": "#/components/schemas/Milestones"
+ $ref: "#/components/schemas/Milestones"
packageAddress:
type: array
items:
- "$ref": "#/components/schemas/PackageAddress"
+ $ref: "#/components/schemas/PackageAddress"
packageCount:
type: integer
description: The total number of packages in the shipment. Note that this
@@ -563,13 +563,13 @@ components:
paymentInformation:
type: array
items:
- "$ref": "#/components/schemas/PaymentInformation"
+ $ref: "#/components/schemas/PaymentInformation"
referenceNumber:
type: array
items:
- "$ref": "#/components/schemas/ReferenceNumber"
+ $ref: "#/components/schemas/ReferenceNumber"
service:
- "$ref": "#/components/schemas/Service"
+ $ref: "#/components/schemas/Service"
statusCode:
type: string
statusDescription:
@@ -591,7 +591,7 @@ components:
description: 'This indicator provides UCIX (UPS Customer Information Exchange) status
Valid values: ''O'' means open. ''C'' means closed.'
weight:
- "$ref": "#/components/schemas/Weight"
+ $ref: "#/components/schemas/Weight"
PackageAddress:
title: PackageAddress
type: object
@@ -600,7 +600,7 @@ components:
addresses
properties:
address:
- "$ref": "#/components/schemas/Address"
+ $ref: "#/components/schemas/Address"
attentionName:
type: string
description: The specific name of an individual associated with the address
@@ -665,7 +665,7 @@ components:
type: object
properties:
response:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
ErrorResponse:
title: Response
type: object
@@ -673,7 +673,7 @@ components:
errors:
type: array
items:
- "$ref": "#/components/schemas/Error"
+ $ref: "#/components/schemas/Error"
Service:
title: Service
type: object
@@ -703,7 +703,7 @@ components:
package:
type: array
items:
- "$ref": "#/components/schemas/Package"
+ $ref: "#/components/schemas/Package"
userRelation:
type: array
description: The relationship of the user to the package(s) in the shipment.
@@ -719,7 +719,7 @@ components:
warnings:
type: array
items:
- "$ref": "#/components/schemas/Warning"
+ $ref: "#/components/schemas/Warning"
Signature:
title: Signature
type: object
@@ -776,7 +776,7 @@ components:
type: object
properties:
trackResponse:
- "$ref": "#/components/schemas/TrackResponse"
+ $ref: "#/components/schemas/TrackResponse"
TrackResponse:
title: TrackResponse
type: object
@@ -784,7 +784,7 @@ components:
shipment:
type: array
items:
- "$ref": "#/components/schemas/Shipment"
+ $ref: "#/components/schemas/Shipment"
Warning:
title: Warning
type: object
diff --git a/UPSExportAssure.yaml b/UPSExportAssure.yaml
index 6820cd9..e9dda92 100644
--- a/UPSExportAssure.yaml
+++ b/UPSExportAssure.yaml
@@ -5,18 +5,18 @@ info:
description: |
This API offers businesses a powerful tool to manage shipping compliance with Description Guidance, Power of Attorney (POA) Requirements, UPS Prohibited Goods, and Commodity Compliance Guidance in order to help prevent delays, avoid fines, and keep your customers happy with fast, hassle-free customs clearances.
-
+
For more information on the Export Assure API, please visit the Product Info page.
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
-
+
## Key Features
### 1. Basic Description Guidance (Free Feature)
@@ -36,7 +36,7 @@ info:
### 3. UPS Prohibited Goods Guidance (Free Feature)
- Note that this must be turned on in order to use feature 4,
+ Note that this must be turned on in order to use feature 4,
- Reviews commodity details for POA requirements.
- Note 1: evaluateImportExportRequirements is the name of the endpoint which performs the UPS Prohibited goods check. There is no charge to call this endpoint.
@@ -50,9 +50,9 @@ info:
- Information specific to the commodities and origins/destinations.
- Notification for international shipping forms needed for the commodity to clear customs.
- Note 1: evaluateImportExportRequirements - the free feature for UPS Prohibited Goods - MUST be set to true in order to use Commodity Compliance Guidance
- - Note 2: advancedImportExportRequirements is the endpoint for Commodity Compliance Guidance, and will incur a charge each time guidance is provided
-
-security:
+ - Note 2: advancedImportExportRequirements is the endpoint for Commodity Compliance Guidance, and will incur a charge each time guidance is provided
+
+security:
- OAuth2: []
servers:
@@ -91,16 +91,16 @@ paths:
default: v1
enum:
- v1
-
+
description: |
- Submit shipment details and receive guidance from UPS.
-
+ Submit shipment details and receive guidance from UPS.
+
This endpoint includes four separate operations which may be requested individually or simultaneously:
- Basic Description Guidance (Free Feature)
- Power of Attorney (POA) Requirements (Free Feature)
- UPS Prohibited Goods Guidance (Free Feature)
- Commodity Compliance Guidance (Premium Feature)
- - NOTE: requires UPS Prohibited Goods Guidance (evaluateImportExportRequirements) to be set to true.
+ - NOTE: requires UPS Prohibited Goods Guidance (evaluateImportExportRequirements) to be set to true.
To request a specific operation, set the respective value for that property to true:
- evaluateDescriptions to request basic description guidance for the shipment (free)
@@ -113,7 +113,7 @@ paths:
- To request Commodity Compliance Guidance, set advancedImportExportRequirements: true, evaluateImportExportRequirements: true, and include all required properties for all operations.
- If you do not wish to be charged, set advancedImportExportRequirements: false
security:
- - OAuth2: []
+ - OAuth2: []
requestBody:
content:
application/json:
@@ -128,14 +128,14 @@ paths:
$ref: "#/components/examples/sample-import-export-compliance-request"
allGuidanceRequestExample:
$ref: "#/components/examples/sample-all-guidance-request"
-
+
responses:
"200":
description: OK
headers:
application/json:
schema:
- $ref: "#/components/schemas/SuccessResponseHeaders"
+ $ref: "#/components/schemas/SuccessResponseHeaders"
content:
application/json:
schema:
@@ -174,11 +174,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/ErrorResponse"
+ $ref: "#/components/schemas/ErrorResponse"
example:
response:
errors:
- - code: "EA_POA_04"
+ - code: "EA_POA_04"
message: Country code is not valid
field: evaluateImportExportRequirements
value: 'NB'
@@ -192,10 +192,10 @@ paths:
headers:
application/json:
schema:
- $ref: "#/components/schemas/GatewayErrorResponseHeaders"
- content:
- application/json:
- schema:
+ $ref: "#/components/schemas/GatewayErrorResponseHeaders"
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
@@ -211,10 +211,10 @@ paths:
headers:
application/json:
schema:
- $ref: "#/components/schemas/GatewayErrorResponseHeaders"
- content:
- application/json:
- schema:
+ $ref: "#/components/schemas/GatewayErrorResponseHeaders"
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
@@ -230,10 +230,10 @@ paths:
headers:
application/json:
schema:
- $ref: "#/components/schemas/GatewayErrorResponseHeaders"
- content:
- application/json:
- schema:
+ $ref: "#/components/schemas/GatewayErrorResponseHeaders"
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
@@ -249,16 +249,16 @@ paths:
headers:
application/json:
schema:
- $ref: "#/components/schemas/GatewayErrorResponseHeaders"
+ $ref: "#/components/schemas/GatewayErrorResponseHeaders"
'500':
description: Internal Server Error
headers:
application/json:
schema:
$ref: "#/components/schemas/BackendErrorResponseHeaders"
- content:
- application/json:
- schema:
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
example:
response:
@@ -270,32 +270,32 @@ paths:
fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024
receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024
-components:
+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 values for all parameters and properties
- 5. Select **Send** to send your API request
+ 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 values for all parameters and properties
+ 5. Select **Send** to send your API request
flows:
clientCredentials:
x-tokenEndpointAuthMethod: client_secret_basic
tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token
- scopes: {}
+ scopes: {}
schemas:
- AccountNumber:
+ AccountNumber:
description: UPS account number
- type:
+ type:
- string
- "null"
maxLength: 10
pattern: '^[a-zA-Z0-9]*$'
- examples:
+ examples:
- "985123"
- "766554"
- "446332"
@@ -305,8 +305,8 @@ components:
type: string
maxLength: 50
pattern: ^[\s\S]*$
- examples:
- - "28b210b9-e686-4617-8cf4-9973e3ed4087"
+ examples:
+ - "28b210b9-e686-4617-8cf4-9973e3ed4087"
- "8f971462-5e68-469a-809f-637a12af1305"
ComplianceDetails:
@@ -315,10 +315,10 @@ components:
properties:
categoryType:
description: Whether the compliance assessment regards imports or exports
- type: string
+ type: string
minLength: 6
maxLength: 6
- enum:
+ enum:
- Import
- Export
controlTypes:
@@ -332,18 +332,18 @@ components:
- controlTypes
ControlDetails:
- description: This object contains an array of warning messages related to this control type.
+ description: This object contains an array of warning messages related to this control type.
type: object
properties:
controlDetailName:
type: string
description: |-
- The formal name or title of the control measure. This property serves as the header for `ControlDetails`. Where no specific control name is applicable, this field may be left empty (and consequently, no header will be displayed in the response). This property is translated to the user's language as required.
-
+ The formal name or title of the control measure. This property serves as the header for `ControlDetails`. Where no specific control name is applicable, this field may be left empty (and consequently, no header will be displayed in the response). This property is translated to the user's language as required.
+
**Note**: When the `controlTypeCode` is set to `DOC`, the `controlDetailName` is also the identifier for the corresponding DocuSign template.
maxLength: 150
pattern: ^[\s\S]*$
- examples:
+ examples:
- Controlling Authority
- Free Trade Agreement
controlDetailDescription:
@@ -351,11 +351,11 @@ components:
type: string
maxLength: 4000
pattern: '^[\s\S]*$'
- examples:
+ examples:
- Trade Agreement between the United States and Canada (USMCA)
- Caribbean Basin Economic Recovery Act
additionalProperties: false
- required:
+ required:
- controlDetailName
- controlDetailDescription
@@ -364,29 +364,29 @@ components:
type: object
properties:
controlType:
- description: The category of customs control applicable to the shipment. This property is translated to the user's language as required.
+ description: The category of customs control applicable to the shipment. This property is translated to the user's language as required.
type: string
minLength: 1
maxLength: 100
pattern: ^[\s\S]*$
- examples:
+ examples:
- Prohibition
- Embargo/Sanction
- Sample Data
- Import License
controlTypeCode:
- description: A unique code that distinctly identifies each control type. This code is not translated and is used for specific system-logic related to the control type.
+ description: A unique code that distinctly identifies each control type. This code is not translated and is used for specific system-logic related to the control type.
type: string
maxLength: 50
pattern: ^[\s\S]*$
- examples:
+ examples:
- DOC
- FTA
isRequired:
description: Whether shipment compliance with a specific control type is required
type: string
maxLength: 10
- enum:
+ enum:
- "Yes"
- Maybe
- Applicable
@@ -396,7 +396,7 @@ components:
minLength: 1
maxLength: 4000
pattern: ^[\s\S]*$
- examples:
+ examples:
- Import Certificate may be required
- Free Trade Agreement may be applicable
controlDetails:
@@ -406,7 +406,7 @@ components:
items:
$ref: "#/components/schemas/ControlDetails"
additionalProperties: false
- required:
+ required:
- controlType
- controlTypeCode
- controlTypeMessage
@@ -418,7 +418,7 @@ components:
minLength: 2
maxLength: 2
pattern: ^[a-zA-Z0-9]{2}$
- examples:
+ examples:
- AU
- US
- UK
@@ -464,7 +464,7 @@ components:
minLength: 3
maxLength: 3
pattern: ^[a-zA-Z0-9]{3}$
- enum:
+ enum:
- ARS
- AUD
- BRL
@@ -503,14 +503,14 @@ components:
description: Whether the description guidance service has matched a keyword from the shipment description
type: boolean
default: false
- examples:
+ examples:
- true
- false
message:
description: A message with guidance on how to improve the shipment description
type: string
pattern: ^[\s\S]*$
- examples:
+ examples:
- DVD Player
- Stereo
sourceListName:
@@ -518,8 +518,8 @@ components:
type: string
maxLength: 250
pattern: ^[\s\S]*$
- examples:
- - USA
+ examples:
+ - USA
- France
- Germany
matchedKeyword:
@@ -527,12 +527,12 @@ components:
type: string
maxLength: 250
pattern: ^[\s\S]*$
- examples:
+ examples:
- goods
- clothing
- - perishables
+ - perishables
- ErrorResponse:
+ ErrorResponse:
description: This object is the primary container for error responses.
type: object
properties:
@@ -540,20 +540,20 @@ components:
$ref: "#/components/schemas/ErrorResponseWrapper"
perfStats:
$ref: "#/components/schemas/ALPerfStats"
- required:
+ required:
- response
- perfStats
ErrorResponseWrapper:
description: This object contains an array of error codes.
type: object
- properties:
+ properties:
errors:
type: array
items:
- $ref: '#/components/schemas/ErrorCode'
- required:
- - errors
+ $ref: '#/components/schemas/ErrorCode'
+ required:
+ - errors
ErrorCode:
description: This object contains error codes, error descriptions and other error properties.
@@ -563,28 +563,28 @@ components:
description: The error code.
type: string
pattern: '^[a-zA-Z0-9\-_\.]+$'
- examples:
+ examples:
- 400
- 401
- 404
description:
description: Description of the error.
- pattern: '^[a-zA-Z0-9\-_\s:]+$'
- examples:
- - Not Found
+ pattern: '^[a-zA-Z0-9\-_\s:]+$'
+ examples:
+ - Not Found
- Unauthorized
message:
description: Additional information for the user.
type: string
- pattern: '^[a-zA-Z0-9\-_\s:]+$'
- examples:
+ pattern: '^[a-zA-Z0-9\-_\s:]+$'
+ examples:
- Country Code is not valid
- Value is too large
field:
description: The path to the field causing the error as returned from the API backend services
type: string
- pattern: '^[a-zA-Z0-9\-_\s:\.\[\]]+$'
- examples:
+ pattern: '^[a-zA-Z0-9\-_\s:\.\[\]]+$'
+ examples:
- evaluateImportExportRequirements
- evaluatePoaRequirements
- evaluateImportExportRequirements
@@ -592,7 +592,7 @@ components:
description: The value that caused the error
type: string
pattern: ^[\s\S]*$
- examples:
+ examples:
- US
- EU
- NB
@@ -608,16 +608,16 @@ components:
type: string
minLength: 2
maxLength: 3
- enum:
+ enum:
- DG
- IEC
- POA
- additionalProperties: false
+ additionalProperties: false
EvaluationCriteria:
description: |-
Criteria for evaluating POA requirements for both importer and exporter. Supported values:
-
+
| Supported enum values |
| :-------------------------------------------------------------------------------------------------------------- |
| `NonConditional`Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
-
+
-
+
-
+
# Business Values
- **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust.
@@ -23,39 +23,39 @@ info:
- **Data-Driven Decision Making**: Access to near real-time data can help businesses optimize their supply chain and make informed logistics decisions.
- **Optimizing Cash Flow Through Near Real-Time Delivery Tracking**: Improve cash flow by knowing that deliveries occurred in near real time.
- **Mitigating Fraud and Theft through Near Real-Time Package Status Monitoring**: Reduce fraud and theft by knowing any time something happens to your packages.
-
+
# How does it work once I am setup as a user?
- You submit up to 100 UPS 1Z package tracking numbers to the API at a time, using OAUTH in a JSON format. Your submission needs to include the URL where Track Alert will send a message with any events that occur to your 1Z package for the next 14 days. This saves you the effort of polling UPS to determine what is the current status of your package.
-
+ You submit up to 100 UPS 1Z package tracking numbers to the API at a time, using OAUTH in a JSON format. Your submission needs to include the URL where Track Alert will send a message with any events that occur to your 1Z package for the next 14 days. This saves you the effort of polling UPS to determine what is the current status of your package.
+
# FAQs
- **How do I check if a subscription to a 1Z was successful?**
- > Within 8 seconds of submitting a 1Z package tracking number to Track Alert, you will receive a message confirming successful and un-successful 1Z's.
+ > Within 8 seconds of submitting a 1Z package tracking number to Track Alert, you will receive a message confirming successful and un-successful 1Z's.
- **I stopped receiving event messages after 2 weeks and my package hasn’t been delivered. Why?**
- > Each 1Z subscription is valid for 14 days. If the package has not been delivered within 14 days, you must resubscribe to the 1Z to continue receiving updates/events.
+ > Each 1Z subscription is valid for 14 days. If the package has not been delivered within 14 days, you must resubscribe to the 1Z to continue receiving updates/events.
- **How do I get events that occurred prior to subscription?**
- > Track Alert does not retain any history. You should use the UPS Track API to receive history about your package.
+ > Track Alert does not retain any history. You should use the UPS Track API to receive history about your package.
- **How many 1Z tracking numbers can a subscriber subscribe to in one request?**
- > You can subscribe to up to 100 1Z in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful 1Z's submissions.
+ > You can subscribe to up to 100 1Z in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful 1Z's submissions.
- **What types of event data does Track Alert provide?**
> In addition to the expected local dates and times when the event occurred (including GMT date and time), you will receive details about the event that include status-type, status-code, status-description and status-description code.
Status types are:
- M and MV = manifest information,
- X = exception information (something out of the normal happened to your package, but it may still be delivered on time),
- I = in-progress (on the way or moving normally through the UPS network),
+ M and MV = manifest information,
+ X = exception information (something out of the normal happened to your package, but it may still be delivered on time),
+ I = in-progress (on the way or moving normally through the UPS network),
U = update (there is an update to your package, normally the scheduled delivery has been updated, but it may still be delivered on time)
D = delivery information (loaded on delivery vehicle, out for delivery, delivered)
- Status codes are a 2-character code that provide details about the event. There is a list of these codes and their translations elsewhere on this portal.
+ Status codes are a 2-character code that provide details about the event. There is a list of these codes and their translations elsewhere on this portal.
Status descriptions are a very brief (a few words) describing the status code.
- Status-description code is a overly simplified description of the event. This description is intended for those who do not understand transportation.
+ Status-description code is a overly simplified description of the event. This description is intended for those who do not understand transportation.
- **What does the message look like?**
- > This is what a message looks like for an event that is sent to your URL. Not every field will have a value for every message. We have converted the JSON format message to text format for clarity.
- Those fields are:
- 1Z package tracking number
+ > This is what a message looks like for an event that is sent to your URL. Not every field will have a value for every message. We have converted the JSON format message to text format for clarity.
+ Those fields are:
+ 1Z package tracking number
scheduled delivery date (this field maybe updated, example '20240905')
actual delivery date (this field is blank until the delivery event occurs)
actual delivery time (this field is blank until the delivery event occurs)
@@ -77,33 +77,33 @@ info:
delivery photo (this field is only available for enhanced users)
- **Can I test this process?**
- > Yes, there are two test 1Z's that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test 1Z's are 1ZCIETST0111111114 and 1ZCIETST0422222228. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these 1Z's as often as you like. (no stress testing please.)
+ > Yes, there are two test 1Z's that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test 1Z's are 1ZCIETST0111111114 and 1ZCIETST0422222228. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these 1Z's as often as you like. (no stress testing please.)
# Error Codes
| Error Code | HTTP Status | Description |
|------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- | VSS000 | 400 | Invalid request and The Subscription request has been rejected. |
- | VSS002 | 400 | Missing transId. |
- | VSS003 | 400 | Please enter a valid Transaction ID, The Subscription request has been rejected. |
- | VSS004 | 400 | Missing transactionSrc. |
- | VSS006 | 400 | Please enter a valid Transaction SRC, The Subscription request has been rejected. |
- | VSS100 | 500 | We're sorry, the system is temporarily unavailable. Please try again later. |
- | VSS110 | 400 | Subscription request is empty or not present. The Subscription request has been rejected. |
- | VSS200 | 400 | Tracking Number List is required. The Subscription request has been rejected. |
- | VSS210 | 400 | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. |
- | VSS215 | 400 | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. |
- | VSS220 | 400 | You have submitted over 100 1Z numbers which is not allowed. The entire submission of 1Z numbers has been rejected. Please resubmit your request again using groups of no more than 100 1Z numbers. |
- | VSS300 | 400 | Locale is required. The Subscription request has been rejected. |
- | VSS310 | 400 | Please enter a valid locale. The Subscription request has been rejected. |
- | VSS400 | 400 | Please enter a valid country code. The Subscription request has been rejected. |
- | VSS500 | 400 | Destination is required. The Subscription request has been rejected. |
- | VSS600 | 400 | URL is empty or not present. The Subscription request has been rejected. |
- | VSS610 | 400 | URL is too long. The Subscription request has been rejected. |
- | VSS700 | 400 | Credential is empty or not present. The Subscription request has been rejected. |
- | VSS800 | 400 | CredentialType is empty or not present. The Subscription request has been rejected. |
- | VSS930 | 400 | Type is missing or invalid, The Subscription request has been rejected.
+ | VSS000 | 400 | Invalid request and The Subscription request has been rejected. |
+ | VSS002 | 400 | Missing transId. |
+ | VSS003 | 400 | Please enter a valid Transaction ID, The Subscription request has been rejected. |
+ | VSS004 | 400 | Missing transactionSrc. |
+ | VSS006 | 400 | Please enter a valid Transaction SRC, The Subscription request has been rejected. |
+ | VSS100 | 500 | We're sorry, the system is temporarily unavailable. Please try again later. |
+ | VSS110 | 400 | Subscription request is empty or not present. The Subscription request has been rejected. |
+ | VSS200 | 400 | Tracking Number List is required. The Subscription request has been rejected. |
+ | VSS210 | 400 | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. |
+ | VSS215 | 400 | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. |
+ | VSS220 | 400 | You have submitted over 100 1Z numbers which is not allowed. The entire submission of 1Z numbers has been rejected. Please resubmit your request again using groups of no more than 100 1Z numbers. |
+ | VSS300 | 400 | Locale is required. The Subscription request has been rejected. |
+ | VSS310 | 400 | Please enter a valid locale. The Subscription request has been rejected. |
+ | VSS400 | 400 | Please enter a valid country code. The Subscription request has been rejected. |
+ | VSS500 | 400 | Destination is required. The Subscription request has been rejected. |
+ | VSS600 | 400 | URL is empty or not present. The Subscription request has been rejected. |
+ | VSS610 | 400 | URL is too long. The Subscription request has been rejected. |
+ | VSS700 | 400 | Credential is empty or not present. The Subscription request has been rejected. |
+ | VSS800 | 400 | CredentialType is empty or not present. The Subscription request has been rejected. |
+ | VSS930 | 400 | Type is missing or invalid, The Subscription request has been rejected.
servers:
@@ -111,8 +111,8 @@ servers:
description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription.
variables:
version:
- default: v1
- enum:
+ default: v1
+ enum:
- v1
- url: https://onlinetools.ups.com/api/track/{version}
description: UPS Production OAuth.
@@ -124,11 +124,11 @@ servers:
paths:
/subscription/standard/package:
post:
- description: |
- This endpoint takes a list of tracking numbers and creates a subscription for each.
- Clients must provide the tracking numbers in the correct format.
+ description: |-
+ This endpoint takes a list of tracking numbers and creates a subscription for each.
+ Clients must provide the tracking numbers in the correct format.
- Upon success it should return:
+ Upon success it should return:
- List of valid tracking number for which subscription created.
- List of invalid tracking number for which subscription not created.
tags:
@@ -220,7 +220,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/TrackSubsServiceErrorResponse"
+ $ref: "#/components/schemas/TrackSubsServiceErrorResponse"
'405':
description: Method Not Allowed
content:
@@ -236,7 +236,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/TrackSubsServiceErrorResponse"
+ $ref: "#/components/schemas/TrackSubsServiceErrorResponse"
'500':
description: Internal Server Error
webhooks:
@@ -443,13 +443,13 @@ 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"
+ 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
@@ -551,7 +551,7 @@ components:
Response:
type: object
properties:
- errors:
+ errors:
type: array
description: The error response containing any errors that occurred.
items:
@@ -580,9 +580,9 @@ components:
pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$
example: "235959"
activityLocation:
- "$ref": "#/components/schemas/ActivityLocation"
+ $ref: "#/components/schemas/ActivityLocation"
activityStatus:
- "$ref": "#/components/schemas/ActivityStatus"
+ $ref: "#/components/schemas/ActivityStatus"
scheduledDeliveryDate:
type: string
description: 'Original scheduled delivery date of the package. Format: YYYYMMDD'
@@ -672,23 +672,20 @@ components:
properties:
type:
type: string
- description: |
+ description: |
The current activity status type.
| Code | Type |
| :--: | :-- |
| D | Delivery |
| I | On the Way |
- | M | Manifest |
- | MV | Manifest Void |
- | U | Updated Delivery Date or Time |
- | X | Package Exception |
+ | M | Manifest |
+ | MV | Manifest Void |
+ | U | Updated Delivery Date or Time |
+ | X | Package Exception |
code:
type: string
description: The current activity status code.
description:
type: string
description: The current activity status description.
-
-
-
\ No newline at end of file
diff --git a/UPSTrackAlertEnhanced.yaml b/UPSTrackAlertEnhanced.yaml
index bbb2e1d..bd226a5 100644
--- a/UPSTrackAlertEnhanced.yaml
+++ b/UPSTrackAlertEnhanced.yaml
@@ -9,11 +9,11 @@ info:
Updates are pushed to the user as soon as available with no constant polling required, thereby improving operational efficiency. For more information on the UPS Track Alert API with Photo, please visit the Product Info page.
Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.
- + -
+
-
+
# Business Values
@@ -25,40 +25,40 @@ info:
- **Mitigating Fraud and Theft through Near Real-Time Package Status Monitoring**: Reduce fraud and theft by knowing any time something happens to your packages.
# How does it work once I am setup as a user?
- You submit up to 100 UPS 1Z package tracking numbers to the API at a time, using OAUTH in a JSON format. Your submission needs to include the URL where Track Alert will send a message with any events that occur to your 1Z package for the next 14 days. This saves you the effort of polling UPS to determine what is the current status of your package.
+ You submit up to 100 UPS 1Z package tracking numbers to the API at a time, using OAUTH in a JSON format. Your submission needs to include the URL where Track Alert will send a message with any events that occur to your 1Z package for the next 14 days. This saves you the effort of polling UPS to determine what is the current status of your package.
- # FAQs
+ # FAQs
- **When can I expect a delivery photo?**
> Delivery photos are only available with residential deliveries in package release areas. Additional message with the delivery photo will be sent, if and when the photo is made available.
- **How do I check if a subscription to a 1Z was successful?**
- > Once 1Z package tracking number(s) is submitted to Track Alert, you will receive a response confirming successful and unsuccessful 1Z's.
+ > Once 1Z package tracking number(s) is submitted to Track Alert, you will receive a response confirming successful and unsuccessful 1Z's.
- **I stopped receiving event messages after 2 weeks and my package hasn’t been delivered. Why?**
> Each 1Z subscription is valid for 14 days If the package has not been delivered within 14 days, you must resubscribe to the 1Z to continue receiving updates/events.
- **How do I get events that occurred prior to subscription?**
- > Track Alert does not retain any history. You should use the UPS Track API to receive history about your package.
+ > Track Alert does not retain any history. You should use the UPS Track API to receive history about your package.
- **How many 1Z tracking numbers can a subscriber subscribe to in one request?**
- > You can subscribe to up to 100 1Z in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful 1Z's submissions.
+ > You can subscribe to up to 100 1Z in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful 1Z's submissions.
- **What types of event data does Track Alert provide?**
- > In addition to the expected local dates and times when the event occurred (including GMT date and time), you will receive details about the event that include status-type, status-code, status-description and status-description code.
+ > In addition to the expected local dates and times when the event occurred (including GMT date and time), you will receive details about the event that include status-type, status-code, status-description and status-description code.
Status types are:
- M and MV = manifest information,
- X = exception information (something out of the normal happened to your package, but it may still be delivered on time),
- I = in-progress (on the way or moving normally through the UPS network),
+ M and MV = manifest information,
+ X = exception information (something out of the normal happened to your package, but it may still be delivered on time),
+ I = in-progress (on the way or moving normally through the UPS network),
U = update (there is an update to your package, normally the scheduled delivery has been updated, but it may still be delivered on time)
D = delivery information (loaded on delivery vehicle, out for delivery, delivered)
- Status codes are a 2-character code that provide details about the event. There is a list of these codes and their translations elsewhere on this portal.
+ Status codes are a 2-character code that provide details about the event. There is a list of these codes and their translations elsewhere on this portal.
Status descriptions are a very brief (a few words) describing the status code.
- Status-description code is a overly simplified description of the event. This description is intended for those who do not understand transportation.
+ Status-description code is a overly simplified description of the event. This description is intended for those who do not understand transportation.
- **What does the message look like?**
- > This is what a message looks like for an event that is sent to your URL. Not every field will have a value for every message. We have converted the JSON format message to text format for clarity.
- Those fields are:
- 1Z package tracking number
+ > This is what a message looks like for an event that is sent to your URL. Not every field will have a value for every message. We have converted the JSON format message to text format for clarity.
+ Those fields are:
+ 1Z package tracking number
scheduled delivery date (this field maybe updated, example '20240905')
actual delivery date (this field is blank until the delivery event occurs)
actual delivery time (this field is blank until the delivery event occurs)
@@ -80,33 +80,33 @@ info:
delivery photo (this field is only available for enhanced users)
- **Can I test this process?**
- > Yes, there are two test 1Z's that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test 1Z's are 1ZCIETST0111111114 and 1ZCIETST0422222228. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these 1Z's as often as you like. (no stress testing please.)
+ > Yes, there are two test 1Z's that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test 1Z's are 1ZCIETST0111111114 and 1ZCIETST0422222228. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these 1Z's as often as you like. (no stress testing please.)
# Error Codes
-
+
| Error Code | HTTP Status |Description |
|------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- | VSS000 | 400 | Invalid request and The Subscription request has been rejected. |
- | VSS002 | 400 | Missing transId. |
- | VSS003 | 400 | Please enter a valid Transaction ID, The Subscription request has been rejected. |
- | VSS004 | 400 | Missing transactionSrc. |
- | VSS006 | 400 | Please enter a valid Transaction SRC, The Subscription request has been rejected. |
- | VSS100 | 500 | We're sorry, the system is temporarily unavailable. Please try again later. |
- | VSS110 | 400 | Subscription request is empty or not present. The Subscription request has been rejected. |
- | VSS200 | 400 | Tracking Number List is required. The Subscription request has been rejected. |
- | VSS210 | 400 | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. |
- | VSS215 | 400 | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. |
- | VSS220 | 400 | You have submitted over 100 1Z numbers which is not allowed. The entire submission of 1Z numbers has been rejected. Please resubmit your request again using groups of no more than 100 1Z numbers. |
- | VSS300 | 400 | Locale is required. The Subscription request has been rejected. |
- | VSS310 | 400 | Please enter a valid locale. The Subscription request has been rejected. |
- | VSS400 | 400 | Please enter a valid country code. The Subscription request has been rejected. |
- | VSS500 | 400 | Destination is required. The Subscription request has been rejected. |
- | VSS600 | 400 | URL is empty or not present. The Subscription request has been rejected. |
- | VSS610 | 400 | URL is too long. The Subscription request has been rejected. |
- | VSS700 | 400 | Credential is empty or not present. The Subscription request has been rejected. |
- | VSS800 | 400 | CredentialType is empty or not present. The Subscription request has been rejected. |
- | VSS930 | 400 | Type is missing or invalid, The Subscription request has been rejected.
+ | VSS000 | 400 | Invalid request and The Subscription request has been rejected. |
+ | VSS002 | 400 | Missing transId. |
+ | VSS003 | 400 | Please enter a valid Transaction ID, The Subscription request has been rejected. |
+ | VSS004 | 400 | Missing transactionSrc. |
+ | VSS006 | 400 | Please enter a valid Transaction SRC, The Subscription request has been rejected. |
+ | VSS100 | 500 | We're sorry, the system is temporarily unavailable. Please try again later. |
+ | VSS110 | 400 | Subscription request is empty or not present. The Subscription request has been rejected. |
+ | VSS200 | 400 | Tracking Number List is required. The Subscription request has been rejected. |
+ | VSS210 | 400 | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. |
+ | VSS215 | 400 | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. |
+ | VSS220 | 400 | You have submitted over 100 1Z numbers which is not allowed. The entire submission of 1Z numbers has been rejected. Please resubmit your request again using groups of no more than 100 1Z numbers. |
+ | VSS300 | 400 | Locale is required. The Subscription request has been rejected. |
+ | VSS310 | 400 | Please enter a valid locale. The Subscription request has been rejected. |
+ | VSS400 | 400 | Please enter a valid country code. The Subscription request has been rejected. |
+ | VSS500 | 400 | Destination is required. The Subscription request has been rejected. |
+ | VSS600 | 400 | URL is empty or not present. The Subscription request has been rejected. |
+ | VSS610 | 400 | URL is too long. The Subscription request has been rejected. |
+ | VSS700 | 400 | Credential is empty or not present. The Subscription request has been rejected. |
+ | VSS800 | 400 | CredentialType is empty or not present. The Subscription request has been rejected. |
+ | VSS930 | 400 | Type is missing or invalid, The Subscription request has been rejected.
servers:
@@ -114,8 +114,8 @@ servers:
description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription.
variables:
version:
- default: v1
- enum:
+ default: v1
+ enum:
- v1
- url: https://onlinetools.ups.com/api/track/{version}
description: UPS Production OAuth.
@@ -127,13 +127,13 @@ servers:
paths:
/subscription/enhanced/package:
post:
- description: |
- This endpoint takes a list of tracking numbers and creates a subscription for each.
- Clients must provide the tracking numbers in the correct format.
+ description: |-
+ This endpoint takes a list of tracking numbers and creates a subscription for each.
+ Clients must provide the tracking numbers in the correct format.
- Upon success it should return:
- - List of valid tracking number for which subscription created.
- - List of invalid tracking number for which subscription not created.
+ Upon success it should return:
+ - List of valid tracking number for which subscription created.
+ - List of invalid tracking number for which subscription not created.
tags:
- UPS Track Alert with Photo
summary: API to create subscriptions by tracking numbers.
@@ -223,7 +223,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/TrackSubsServiceErrorResponse"
+ $ref: "#/components/schemas/TrackSubsServiceErrorResponse"
'405':
description: Method Not Allowed
content:
@@ -239,7 +239,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/TrackSubsServiceErrorResponse"
+ $ref: "#/components/schemas/TrackSubsServiceErrorResponse"
'500':
description: Internal Server Error
webhooks:
@@ -446,13 +446,13 @@ 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"
+ 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
@@ -554,7 +554,7 @@ components:
Response:
type: object
properties:
- errors:
+ errors:
type: array
description: The error response containing any errors that occurred.
items:
@@ -583,9 +583,9 @@ components:
pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$
example: "235959"
activityLocation:
- "$ref": "#/components/schemas/ActivityLocation"
+ $ref: "#/components/schemas/ActivityLocation"
activityStatus:
- "$ref": "#/components/schemas/ActivityStatus"
+ $ref: "#/components/schemas/ActivityStatus"
scheduledDeliveryDate:
type: string
description: 'Original scheduled delivery date of the package. Format: YYYYMMDD'
@@ -678,17 +678,17 @@ components:
properties:
type:
type: string
- description: |
+ description: |
The current activity status type.
| Code | Type |
| :--: | :-- |
| D | Delivery |
| I | On the Way |
- | M | Manifest |
- | MV | Manifest Void |
- | U | Updated Delivery Date or Time |
- | X | Package Exception |
+ | M | Manifest |
+ | MV | Manifest Void |
+ | U | Updated Delivery Date or Time |
+ | X | Package Exception |
code:
type: string
description: The current activity status code.
diff --git a/WorldEaseShipmentManagement.yaml b/WorldEaseShipmentManagement.yaml
index 12cc57e..2b88abf 100644
--- a/WorldEaseShipmentManagement.yaml
+++ b/WorldEaseShipmentManagement.yaml
@@ -1,5 +1,5 @@
openapi: 3.1.0
-info:
+info:
title: WorldEase Shipment Management API v1
description: |
## Purpose
@@ -7,27 +7,27 @@ info:
tags:
- name: World Ease Shipment Management - Shipment
description: For endpoint that allows user to finalize the close out shipments
- - name: Shipment Modification
+ - name: Shipment Modification
description: For endpoints that allow deletion of master and child shipments
servers:
- url: "https://wwwcie.ups.com/api/ship/{version}"
description: "Customer Integration Environment"
variables:
- version:
+ version:
description: Indicates WorldEase Shipment Management API to display the new release features
default: v1
- enum:
+ enum:
- v1
- url: "https://onlinetools.ups.com/api/ship/{version}"
description: "Production"
variables:
- version:
+ version:
description: Indicates WorldEase Shipment Management API to display the new release features
default: v1
- enum:
+ enum:
- v1
-
+
paths:
/master-shipment/closeout/{shipment-gccn}:
post:
@@ -35,14 +35,13 @@ paths:
- World Ease Shipment Management - Shipment
operationId: saveCloseOutShipment
summary: Close Out Shipment
- description: |
- Finalizes the shipment process by marking a package or set of packages as ready for dispatch, effectively ending the consolidation stage.
- parameters:
+ description: Finalizes the shipment process by marking a package or set of packages as ready for dispatch, effectively ending the consolidation stage.
+ parameters:
- name: shipment-gccn
in: path
required: true
description: The unique identifier of the shipment to close Out. It also known as GCCN.
- schema:
+ schema:
type: string
maxLength: 11
pattern: '^[A-Za-z0-9]{11}$'
@@ -50,12 +49,12 @@ paths:
in: header
required: true
schema:
- $ref: "#/components/schemas/CustomTransactionId"
- - name: transactionSrc
+ $ref: "#/components/schemas/CustomTransactionId"
+ - name: transactionSrc
in: header
required: true
schema:
- $ref: "#/components/schemas/CustomTransactionSrc"
+ $ref: "#/components/schemas/CustomTransactionSrc"
- name: version
in: path
description: Indicates WorldEase Shipment Management API to display the new release features
@@ -88,58 +87,58 @@ paths:
CloseOutResponse:
value:
transId: "4ce27ff5-8e17-4797-a8c1-089796db"
- label:
- opTyp: "PNG"
- lblNmbr: "MVpJU1VTMDE2NzIzODc4Mjc3"
- lblData: "asdfhkjuiovrtyuiopfghjkxcv"
-
-
-
+ label:
+ opTyp: "PNG"
+ lblNmbr: "MVpJU1VTMDE2NzIzODc4Mjc3"
+ lblData: "asdfhkjuiovrtyuiopfghjkxcv"
+
+
+
'400':
description: "Missing required values or incorrect values or validation fails"
content:
- application/json:
+ application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
- BadGCCNExample:
+ BadGCCNExample:
value:
errors:
- code: "20007"
- message: "Missing GCCN"
-
- '401':
+ message: "Missing GCCN"
+
+ '401':
description: Unauthorized
- content:
- application/json:
- schema:
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
- Invalid Token:
+ Invalid Token:
value:
errors:
- code: "250002"
- message: "Invalid Authentication Information"
+ message: "Invalid Authentication Information"
'404':
- description: Not Found
- content:
- application/json:
- schema:
+ description: Not Found
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
- GCCNNotFound:
+ GCCNNotFound:
value:
errors:
- - code: "20008"
- message: "GCCN Not Found"
- AccountNumberNotFound:
+ - code: "20008"
+ message: "GCCN Not Found"
+ AccountNumberNotFound:
value:
errors:
- code: "20008"
- message: "Shipper Account Number Not Found"
-
-
+ message: "Shipper Account Number Not Found"
+
+
/master-shipment/{shipment-gccn}:
delete:
tags:
@@ -147,12 +146,12 @@ paths:
operationId: "deleteMasterShipment"
summary: "Deletes the master shipment"
description: " Deletes the specified master shipment from the system. Once deleted system cannot be recovered"
- parameters:
+ parameters:
- name: shipment-gccn
in: path
required: true
description: The unique identifier of the shipment to delete the master shipment. It is also known as GCCN.
- schema:
+ schema:
type: string
maxLength: 11
pattern: '^[A-Za-z0-9]{11}$'
@@ -160,12 +159,12 @@ paths:
in: header
required: true
schema:
- $ref: "#/components/schemas/CustomTransactionId"
- - name: transactionSrc
+ $ref: "#/components/schemas/CustomTransactionId"
+ - name: transactionSrc
in: header
required: true
schema:
- $ref: "#/components/schemas/CustomTransactionSrc"
+ $ref: "#/components/schemas/CustomTransactionSrc"
- name: version
in: path
description: Indicates WorldEase Shipment Management API to display the new release features
@@ -174,10 +173,10 @@ paths:
type: string
default: v1
enum:
- - v1
+ - v1
security:
- OAuth2: []
-
+
requestBody:
content:
application/json:
@@ -186,7 +185,7 @@ paths:
examples:
DeleteRequest:
value:
- shipperAccountNumber: "ISUS01"
+ shipperAccountNumber: "ISUS01"
responses:
'200':
description: "Successful Operation"
@@ -196,10 +195,10 @@ paths:
$ref: '#/components/schemas/deleteResponse'
examples:
WeDeleteResponseSummary:
- value:
- code: "1"
- message: "The Delete request has been done successfully for the following GCCN - 12345678901 "
-
+ value:
+ code: "1"
+ message: "The Delete request has been done successfully for the following GCCN - 12345678901 "
+
'400':
description: "Missing required values or incorrect values or validation fails"
content:
@@ -207,43 +206,43 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
- BadGCCNExample:
+ BadGCCNExample:
value:
errors:
- code: "20007"
- message: "Missing GCCN"
-
- '401':
+ message: "Missing GCCN"
+
+ '401':
description: Unauthorized
- content:
- application/json:
- schema:
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
- Invalid Token:
+ Invalid Token:
value:
errors:
- code: "250002"
- message: "Invalid Authentication Information"
+ message: "Invalid Authentication Information"
'404':
- description: Not Found
- content:
- application/json:
- schema:
+ description: Not Found
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
GCCNNotFound:
- value:
+ value:
errors:
- - code: "20008"
- message: "GCCN Not Found"
+ - code: "20008"
+ message: "GCCN Not Found"
AccountNumberNotFound:
value:
errors:
- code: "20008"
- message: "Shipper Account Number Not Found"
-
-
+ message: "Shipper Account Number Not Found"
+
+
/child-shipment/{shipment-gccn}/{tracking-number}:
delete:
tags:
@@ -251,12 +250,12 @@ paths:
operationId: "deleteChildShipment"
summary: "Delete the child shipment "
description: " This is used to delete the child shipment record from the database"
- parameters:
+ parameters:
- name: shipment-gccn
in: path
required: true
- description: The unique identifier of the shipment to identify the master shipment. It is also known as GCCN.
- schema:
+ description: The unique identifier of the shipment to identify the master shipment. It is also known as GCCN.
+ schema:
type: string
maxLength: 11
pattern: '^[A-Za-z0-9]{11}$'
@@ -264,18 +263,18 @@ paths:
in: path
required: true
description: The identifier of the shipment to identify the child shipment. It is also known as 1Z Tracking Number.
- schema:
- type: string
+ schema:
+ type: string
- name: transId
in: header
required: true
schema:
- $ref: "#/components/schemas/CustomTransactionId"
- - name: transactionSrc
+ $ref: "#/components/schemas/CustomTransactionId"
+ - name: transactionSrc
in: header
required: true
schema:
- $ref: "#/components/schemas/CustomTransactionSrc"
+ $ref: "#/components/schemas/CustomTransactionSrc"
- name: version
in: path
description: Indicates WorldEase Shipment Management API to display the new release features
@@ -286,11 +285,11 @@ paths:
enum:
- v1
-
+
security:
- OAuth2: []
-
-
+
+
responses:
'200':
description: "Successful Operation"
@@ -300,9 +299,9 @@ paths:
$ref: '#/components/schemas/deleteResponse'
examples:
WeDeleteResponseSummary:
- value:
- code: "1"
- message: "The Delete request has been done successfully for the following 1Z tracking Number- 1Z9991450419000046 "
+ value:
+ code: "1"
+ message: "The Delete request has been done successfully for the following 1Z tracking Number- 1Z9991450419000046 "
'400':
description: "Missing required values or incorrect values or validation fails"
content:
@@ -310,56 +309,56 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
- BadGCCNExample:
+ BadGCCNExample:
value:
errors:
- code: "20007"
- message: "Missing GCCN"
- '401':
+ message: "Missing GCCN"
+ '401':
description: Unauthorized
- content:
- application/json:
- schema:
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
- Invalid Token:
+ Invalid Token:
value:
errors:
- code: "250002"
- message: "Invalid Authentication Information"
-
+ message: "Invalid Authentication Information"
+
'404':
- description: Not Found
- content:
- application/json:
- schema:
+ description: Not Found
+ content:
+ application/json:
+ schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
GCCNNotFound:
value:
- errors:
- - code: "20008"
- message: "GCCN Not Found"
+ errors:
+ - code: "20008"
+ message: "GCCN Not Found"
TrackingNumberNotFound:
value:
- errors:
- - code: "20008"
- message: "1Z Tracking Number Not Found"
+ errors:
+ - code: "20008"
+ message: "1Z Tracking Number Not Found"
+
+
+
-
-
-
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"
+ 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
@@ -367,8 +366,8 @@ components:
scopes: {}
schemas:
-
-
+
+
PostRequest:
type: "object"
required:
@@ -377,8 +376,8 @@ components:
shipperAccountNumber:
type: "string"
description: "This is the unique account number associated with the Shipper. It is also known as UPS Shipper Account Number"
-
-
+
+
PostResponse:
type: "object"
required:
@@ -395,14 +394,14 @@ components:
type: 'string'
enum: [PNG, GIF, PDF, ZPL, EPL, STAR, SPL]
description: "The is the output type in which label is generated "
- lblNmbr:
+ lblNmbr:
type: "string"
description: "The label number assigned to this label"
- lblData:
+ lblData:
type: "string"
description: "Base64 encoded label image"
-
-
+
+
deleteResponse:
type: "object"
required:
@@ -415,34 +414,34 @@ components:
message:
type: "string"
description: "Succesful text message"
-
-
- ErrorResponse:
+
+
+ ErrorResponse:
description: Error response entity
type: object
required:
- errors
properties:
- errors:
+ errors:
type: array
- description: error payload - array containing one or more Errors
+ description: error payload - array containing one or more Errors
items:
- $ref: "#/components/schemas/Error"
+ $ref: "#/components/schemas/Error"
- Error:
- type: object
- properties:
- code:
- type: "string"
- description: "The code is specific to the error "
- message:
- type: "string"
- description: "The message that associated with the above error code "
+ Error:
+ type: object
+ properties:
+ code:
+ type: "string"
+ description: "The code is specific to the error "
+ message:
+ type: "string"
+ description: "The message that associated with the above error code "
CustomTransactionId:
- description: Client generated id which is treated as the Transaction ID
+ description: Client generated id which is treated as the Transaction ID
type: string
minLength: 32
maxLength: 32
@@ -453,6 +452,6 @@ components:
CustomTransactionSrc:
description: An identifier of the client/source application that is making the request.Length 512
type: string
- maxLength: 512
+ maxLength: 512
example:
SAM