From 436c5450d7ca699e4f72fc7c9f65cae6ee5a0f01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20F=C3=B6rster?= Date: Tue, 28 Oct 2025 16:40:32 +0100 Subject: [PATCH] [FIX] 8221445 LFs #185 --- AddressValidation-Ready.yaml | 1393 +- AddressValidation.yaml | 1379 +- CommerceGuard.yaml | 1284 +- DangerousGoods-Ready.yaml | 3290 +-- DangerousGoods.yaml | 3274 +-- DeliveryDefense-Ready.yaml | 670 +- DeliveryDefense.yaml | 658 +- DeliveryIntercept.yaml | 4470 ++-- GlobalCheckout.yaml | 1449 +- InteractiveDescriptionGuidance.yaml | 1790 +- LandedCost-Ready.yaml | 1340 +- LandedCost.yaml | 1328 +- Locator.yaml | 5268 ++--- OAuthAuthCode-Ready.yaml | 844 +- OAuthAuthCode.yaml | 830 +- OAuthClientCredentials-Ready.yaml | 296 +- OAuthClientCredentials.yaml | 284 +- Paperless-Ready.yaml | 2328 +-- Paperless.yaml | 2316 +-- Pickup.yaml | 7038 +++---- PreNotification-Ready.yaml | 1816 +- PreNotification.yaml | 1804 +- QuantumView-Ready.yaml | 6026 +++--- QuantumView.yaml | 6014 +++--- Rating.yaml | 11963 ++++++----- Shipping.yaml | 28032 +++++++++++++------------- TimeInTransit.yaml | 1706 +- Tracking-Ready.yaml | 1674 +- Tracking.yaml | 1660 +- TradeDirect.yaml | 2910 +-- UPSExportAssure.yaml | 4056 ++-- UPSTrackAlert-Ready.yaml | 1463 +- UPSTrackAlert.yaml | 1459 +- UPSTrackAlertEnhanced-Ready.yaml | 1557 +- UPSTrackAlertEnhanced.yaml | 1555 +- WorldEaseShipmentManagement.yaml | 916 +- mainspec1.yaml | 454 +- mainspec2.yaml | 396 +- mainspec3.yaml | 342 +- mainspec4.yaml | 374 +- mainspec5.yaml | 316 +- mainspec6.yaml | 420 +- mainspec7.yaml | 440 +- 43 files changed, 59434 insertions(+), 59448 deletions(-) diff --git a/AddressValidation-Ready.yaml b/AddressValidation-Ready.yaml index 9621ade..88d5cb3 100644 --- a/AddressValidation-Ready.yaml +++ b/AddressValidation-Ready.yaml @@ -1,697 +1,696 @@ -openapi: 3.0.3 -info: - title: Address Validation - Street Level - termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html - version: '' - description: | - - The Address Validation Street Level API can be used to. - check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico. - # Reference - - Appendix - - Business Rules - - Errors - - FAQ - - Accelerate API Integration with UPS MCP Server - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/addressvalidation/{version}/{requestoption}": - post: - summary: Address Validation - tags: - - Address Validation - security: - - OAuth2: [] - description: | - The Address Validation Street Level API can be used to check addresses - against the United States Postal Service database of valid addresses in the - U.S. and Puerto Rico. - - NOTE: In the Customer Integration Environment, Street Level Address Validation will only produce results for addresses in New York (NY) and California (CA). - operationId: AddressValidation - parameters: - - in: query - name: regionalrequestindicator - schema: - type: string - minimum: 1 - 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 - in addition to the urbanization element. If False or no indicator, street - level address validation is provided" - required: false - - in: query - name: maximumcandidatelistsize - schema: - type: integer - minimum: 1 - description: "Valid values: 0 – 50 The maximum number of Candidates to return - for this request. If not provided, the default size of 15 is returned." - required: false - - in: path - name: requestoption - schema: - type: integer - minimum: 1 - description: | - Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. - - Valid values: - - 1 - Address Validation - - 2 - Address Classification - - 3 - Address Validation and Address Classification. - - For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2 - description: | - Identifies the version of the API. - - Valid values: - - v2 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - XAVRequest: - AddressKeyFormat: - ConsigneeName: RITZ CAMERA CENTERS-1749 - BuildingName: Innoplex - AddressLine: - - 26601 ALISO CREEK ROAD - - STE D - - ALISO VIEJO TOWN CENTER - Region: ROSWELL,GA,30076-1521 - PoliticalDivision2: ALISO VIEJO - PoliticalDivision1: CA - PostcodePrimaryLow: '92656' - PostcodeExtendedLow: '1521' - Urbanization: porto arundal - CountryCode: US - responses: - '200': - description: Successful Operation - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - post: - deprecated: true - summary: Address Validation - tags: - - Address Validation - security: - - OAuth2: [] - description: The Address Validation Street Level API can be used to check addresses - against the United States Postal Service database of valid addresses in the - U.S. and Puerto Rico. - operationId: DeprecatedAddressValidation - parameters: - - in: query - name: regionalrequestindicator - schema: - type: string - minimum: 1 - 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 - in addition to the urbanization element. If False or no indicator, street - level address validation is provided" - required: false - - in: query - name: maximumcandidatelistsize - schema: - type: integer - minimum: 1 - description: "Valid values: 0 – 50 The maximum number of Candidates to return - for this request. If not provided, the default size of 15 is returned." - required: false - - in: path - name: requestoption - schema: - type: integer - minimum: 1 - description: | - Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. - - Valid values: - - - 1 - Address Validation - - 2 - Address Classification - - 3 - Address Validation and Address Classification. - - For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. - required: true - - in: path - name: deprecatedVersion - schema: - type: string - minimum: 1 - default: v1 - description: | - Identifies the version of the API. - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - XAVRequest: - AddressKeyFormat: - ConsigneeName: RITZ CAMERA CENTERS-1749 - BuildingName: Innoplex - AddressLine: - - 26601 ALISO CREEK ROAD - - STE D - - ALISO VIEJO TOWN CENTER - Region: ROSWELL,GA,30076-1521 - PoliticalDivision2: ALISO VIEJO - PoliticalDivision1: CA - PostcodePrimaryLow: '92656' - PostcodeExtendedLow: '1521' - Urbanization: porto arundal - CountryCode: US - responses: - '200': - description: Successful Operation - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - XAVRequestWrapper: - xml: - name: XAVRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - XAVRequest - properties: - XAVRequest: - "$ref": "#/components/schemas/XAVRequest" - XAVResponseWrapper: - xml: - name: XAVResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - XAVResponse - properties: - XAVResponse: - "$ref": "#/components/schemas/XAVResponse" - XAVRequest: - type: object - required: - - AddressKeyFormat - properties: - AddressKeyFormat: - "$ref": "#/components/schemas/XAVRequest_AddressKeyFormat" - XAVRequest_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name of business, company or person. Ignored if user selects the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AttentionName: - description: Name of the building. Ignored if user selects the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AddressLine: - description: Address line (street number, street name and street type) used for street level information. Additional secondary information (apartment, suite, floor, etc.). Applicable to US and PR only. Ignored if user selects the RegionalRequestIndicator. - type: array - maximum: 3 - minLength: 1 - maxLength: 100 - items: - type: string - Region: - description: | - If this node is present the following tags will be ignored: - - - Political Division 2 - - Political Division 1 - - PostcodePrimaryLow - - PostcodeExtendedLow - - 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 - maxLength: 100 - PoliticalDivision2: - description: City or Town name. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: State or Province/Territory name. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostcodePrimaryLow: - description: Postal Code. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PostcodeExtendedLow: - description: 4 digit Postal Code extension. For US use only. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Urbanization: - description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - CountryCode: - description: Country or Territory Code. For a list of valid values, refer to the Address Validation API Supported Countries or Territories table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: AddressKeyFormat - required: - - 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. - XAVResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/XAVResponse_Response" - ValidAddressIndicator: - description: Indicates query found a valid match. - maximum: 1 - type: string - AmbiguousAddressIndicator: - description: Indicates query could not find exact match. Candidate list - follows. - maximum: 1 - type: string - NoCandidatesIndicator: - description: No Candidate found. - maximum: 1 - type: string - AddressClassification: - "$ref": "#/components/schemas/XAVResponse_AddressClassification" - Candidate: - description: | - Candidate Container. - - **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" - xml: - name: XAVResponse - maximum: 1 - description: XAV Response Container. - XAVResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: |- - Identifies the success or failure of the transaction. Valid values: - 1 = Success - 0 = Failure - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of 'Success' - or 'Failure'. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response Status Container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - XAVResponse_AddressClassification: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Contains the classification code of the input address. - - Valid values: - - - 0 - UnClassified - - 1 - Commercial - - 2 - Residential - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: "Contains the text description of the address classification code: UnClassified, Commercial, Residential" - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - xml: - name: AddressClassification - description: AddressClassification Container. - XAVResponse_Candidate: - type: object - properties: - AddressClassification: - "$ref": "#/components/schemas/Candidate_AddressClassification" - AddressKeyFormat: - "$ref": "#/components/schemas/Candidate_AddressKeyFormat" - xml: - name: Candidate - required: - - AddressKeyFormat - maximum: 1 - Candidate_AddressClassification: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: |- - Contains the classification code of the address: - 0 - UnClassified - 1 - Commercial - 2 - Residential - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Contains the text description of the address classification - code (see Code above). - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - xml: - name: AddressClassification - description: AddressClassification Container. - Candidate_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name of business, company or person. Not returned if user selects - the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AttentionName: - description: Name of building. Not returned if user selects the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AddressLine: - 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 - selects the RegionalRequestIndicator." - type: array - maximum: 3 - minLength: 1 - maxLength: 100 - items: - type: string - Region: - description: Single entry containing in this order Political Division 2, - Political Division 1 and Post Code Primary Low and/or PostcodeExtendedLow. - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - PoliticalDivision2: - description: City or Town name. - maximum: 1 - type: string - 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 - International the full State or Province name will be returned." - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostcodePrimaryLow: - description: Low-end Postal Code. Returned for countries or territories - with Postal Codes. May be alphanumeric. - maximum: 1 - type: string - minLength: 1 - 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" - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Urbanization: - description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - CountryCode: - description: A country or territory code. Required to be returned. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: AddressKeyFormat - required: - - CountryCode - description: AddressKeyFormat Container. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. - +openapi: 3.0.3 +info: + title: Address Validation - Street Level + termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html + version: '' + description: | + + The Address Validation Street Level API can be used to. + check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico. + # Reference + - Appendix + - Business Rules + - Errors + - FAQ + - Accelerate API Integration with UPS MCP Server + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +
+

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/addressvalidation/{version}/{requestoption}": + post: + summary: Address Validation + tags: + - Address Validation + security: + - OAuth2: [] + description: | + The Address Validation Street Level API can be used to check addresses + against the United States Postal Service database of valid addresses in the + U.S. and Puerto Rico. + + NOTE: In the Customer Integration Environment, Street Level Address Validation will only produce results for addresses in New York (NY) and California (CA). + operationId: AddressValidation + parameters: + - in: query + name: regionalrequestindicator + schema: + type: string + minimum: 1 + 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 + in addition to the urbanization element. If False or no indicator, street + level address validation is provided" + required: false + - in: query + name: maximumcandidatelistsize + schema: + type: integer + minimum: 1 + description: "Valid values: 0 – 50 The maximum number of Candidates to return + for this request. If not provided, the default size of 15 is returned." + required: false + - in: path + name: requestoption + schema: + type: integer + minimum: 1 + description: | + Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. + + Valid values: + - 1 - Address Validation + - 2 - Address Classification + - 3 - Address Validation and Address Classification. + + For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2 + description: | + Identifies the version of the API. + + Valid values: + - v2 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + XAVRequest: + AddressKeyFormat: + ConsigneeName: RITZ CAMERA CENTERS-1749 + BuildingName: Innoplex + AddressLine: + - 26601 ALISO CREEK ROAD + - STE D + - ALISO VIEJO TOWN CENTER + Region: ROSWELL,GA,30076-1521 + PoliticalDivision2: ALISO VIEJO + PoliticalDivision1: CA + PostcodePrimaryLow: '92656' + PostcodeExtendedLow: '1521' + Urbanization: porto arundal + CountryCode: US + responses: + '200': + description: Successful Operation + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + post: + deprecated: true + summary: Address Validation + tags: + - Address Validation + security: + - OAuth2: [] + description: The Address Validation Street Level API can be used to check addresses + against the United States Postal Service database of valid addresses in the + U.S. and Puerto Rico. + operationId: DeprecatedAddressValidation + parameters: + - in: query + name: regionalrequestindicator + schema: + type: string + minimum: 1 + 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 + in addition to the urbanization element. If False or no indicator, street + level address validation is provided" + required: false + - in: query + name: maximumcandidatelistsize + schema: + type: integer + minimum: 1 + description: "Valid values: 0 – 50 The maximum number of Candidates to return + for this request. If not provided, the default size of 15 is returned." + required: false + - in: path + name: requestoption + schema: + type: integer + minimum: 1 + description: | + Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. + + Valid values: + + - 1 - Address Validation + - 2 - Address Classification + - 3 - Address Validation and Address Classification. + + For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. + required: true + - in: path + name: deprecatedVersion + schema: + type: string + minimum: 1 + default: v1 + description: | + Identifies the version of the API. + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + XAVRequest: + AddressKeyFormat: + ConsigneeName: RITZ CAMERA CENTERS-1749 + BuildingName: Innoplex + AddressLine: + - 26601 ALISO CREEK ROAD + - STE D + - ALISO VIEJO TOWN CENTER + Region: ROSWELL,GA,30076-1521 + PoliticalDivision2: ALISO VIEJO + PoliticalDivision1: CA + PostcodePrimaryLow: '92656' + PostcodeExtendedLow: '1521' + Urbanization: porto arundal + CountryCode: US + responses: + '200': + description: Successful Operation + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + XAVRequestWrapper: + xml: + name: XAVRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - XAVRequest + properties: + XAVRequest: + "$ref": "#/components/schemas/XAVRequest" + XAVResponseWrapper: + xml: + name: XAVResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - XAVResponse + properties: + XAVResponse: + "$ref": "#/components/schemas/XAVResponse" + XAVRequest: + type: object + required: + - AddressKeyFormat + properties: + AddressKeyFormat: + "$ref": "#/components/schemas/XAVRequest_AddressKeyFormat" + XAVRequest_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name of business, company or person. Ignored if user selects the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AttentionName: + description: Name of the building. Ignored if user selects the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AddressLine: + description: Address line (street number, street name and street type) used for street level information. Additional secondary information (apartment, suite, floor, etc.). Applicable to US and PR only. Ignored if user selects the RegionalRequestIndicator. + type: array + maximum: 3 + minLength: 1 + maxLength: 100 + items: + type: string + Region: + description: | + If this node is present the following tags will be ignored: + + - Political Division 2 + - Political Division 1 + - PostcodePrimaryLow + - PostcodeExtendedLow + + 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 + maxLength: 100 + PoliticalDivision2: + description: City or Town name. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: State or Province/Territory name. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostcodePrimaryLow: + description: Postal Code. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PostcodeExtendedLow: + description: 4 digit Postal Code extension. For US use only. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Urbanization: + description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + CountryCode: + description: Country or Territory Code. For a list of valid values, refer to the Address Validation API Supported Countries or Territories table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: AddressKeyFormat + required: + - 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. + XAVResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/XAVResponse_Response" + ValidAddressIndicator: + description: Indicates query found a valid match. + maximum: 1 + type: string + AmbiguousAddressIndicator: + description: Indicates query could not find exact match. Candidate list + follows. + maximum: 1 + type: string + NoCandidatesIndicator: + description: No Candidate found. + maximum: 1 + type: string + AddressClassification: + "$ref": "#/components/schemas/XAVResponse_AddressClassification" + Candidate: + description: | + Candidate Container. + + **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" + xml: + name: XAVResponse + maximum: 1 + description: XAV Response Container. + XAVResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: |- + Identifies the success or failure of the transaction. Valid values: + 1 = Success + 0 = Failure + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of 'Success' + or 'Failure'. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response Status Container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + XAVResponse_AddressClassification: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Contains the classification code of the input address. + + Valid values: + + - 0 - UnClassified + - 1 - Commercial + - 2 - Residential + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: "Contains the text description of the address classification code: UnClassified, Commercial, Residential" + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + xml: + name: AddressClassification + description: AddressClassification Container. + XAVResponse_Candidate: + type: object + properties: + AddressClassification: + "$ref": "#/components/schemas/Candidate_AddressClassification" + AddressKeyFormat: + "$ref": "#/components/schemas/Candidate_AddressKeyFormat" + xml: + name: Candidate + required: + - AddressKeyFormat + maximum: 1 + Candidate_AddressClassification: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: |- + Contains the classification code of the address: + 0 - UnClassified + 1 - Commercial + 2 - Residential + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Contains the text description of the address classification + code (see Code above). + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + xml: + name: AddressClassification + description: AddressClassification Container. + Candidate_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name of business, company or person. Not returned if user selects + the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AttentionName: + description: Name of building. Not returned if user selects the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AddressLine: + 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 + selects the RegionalRequestIndicator." + type: array + maximum: 3 + minLength: 1 + maxLength: 100 + items: + type: string + Region: + description: Single entry containing in this order Political Division 2, + Political Division 1 and Post Code Primary Low and/or PostcodeExtendedLow. + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + PoliticalDivision2: + description: City or Town name. + maximum: 1 + type: string + 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 + International the full State or Province name will be returned." + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostcodePrimaryLow: + description: Low-end Postal Code. Returned for countries or territories + with Postal Codes. May be alphanumeric. + maximum: 1 + type: string + minLength: 1 + 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" + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Urbanization: + description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + CountryCode: + description: A country or territory code. Required to be returned. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: AddressKeyFormat + required: + - CountryCode + description: AddressKeyFormat Container. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/AddressValidation.yaml b/AddressValidation.yaml index 4a39f1e..181b7b7 100644 --- a/AddressValidation.yaml +++ b/AddressValidation.yaml @@ -1,690 +1,689 @@ -openapi: 3.0.3 -info: - title: Address Validation - Street Level - termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html - version: '' - description: | - - The Address Validation Street Level API can be used to. - check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico. - # Reference - - Appendix - - Business Rules - - Errors - - FAQ - - Accelerate API Integration with UPS MCP Server - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/addressvalidation/{version}/{requestoption}": - post: - summary: Address Validation - tags: - - Address Validation - security: - - OAuth2: [] - description: | - The Address Validation Street Level API can be used to check addresses - against the United States Postal Service database of valid addresses in the - U.S. and Puerto Rico. - - NOTE: In the Customer Integration Environment, Street Level Address Validation will only produce results for addresses in New York (NY) and California (CA). - operationId: AddressValidation - parameters: - - in: query - name: regionalrequestindicator - schema: - type: string - minimum: 1 - 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 - in addition to the urbanization element. If False or no indicator, street - level address validation is provided" - required: false - - in: query - name: maximumcandidatelistsize - schema: - type: integer - minimum: 1 - description: "Valid values: 0 – 50 The maximum number of Candidates to return - for this request. If not provided, the default size of 15 is returned." - required: false - - in: path - name: requestoption - schema: - type: integer - minimum: 1 - description: | - Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. - - Valid values: - - 1 - Address Validation - - 2 - Address Classification - - 3 - Address Validation and Address Classification. - - For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2 - description: | - Identifies the version of the API. - - Valid values: - - v2 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - XAVRequest: - AddressKeyFormat: - ConsigneeName: RITZ CAMERA CENTERS-1749 - BuildingName: Innoplex - AddressLine: - - 26601 ALISO CREEK ROAD - - STE D - - ALISO VIEJO TOWN CENTER - Region: ROSWELL,GA,30076-1521 - PoliticalDivision2: ALISO VIEJO - PoliticalDivision1: CA - PostcodePrimaryLow: '92656' - PostcodeExtendedLow: '1521' - Urbanization: porto arundal - CountryCode: US - responses: - '200': - description: Successful Operation - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - post: - deprecated: true - summary: Address Validation - tags: - - Address Validation - security: - - OAuth2: [] - description: The Address Validation Street Level API can be used to check addresses - against the United States Postal Service database of valid addresses in the - U.S. and Puerto Rico. - operationId: DeprecatedAddressValidation - parameters: - - in: query - name: regionalrequestindicator - schema: - type: string - minimum: 1 - 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 - in addition to the urbanization element. If False or no indicator, street - level address validation is provided" - required: false - - in: query - name: maximumcandidatelistsize - schema: - type: integer - minimum: 1 - description: "Valid values: 0 – 50 The maximum number of Candidates to return - for this request. If not provided, the default size of 15 is returned." - required: false - - in: path - name: requestoption - schema: - type: integer - minimum: 1 - description: | - Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. - - Valid values: - - - 1 - Address Validation - - 2 - Address Classification - - 3 - Address Validation and Address Classification. - - For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. - required: true - - in: path - name: deprecatedVersion - schema: - type: string - minimum: 1 - default: v1 - description: | - Identifies the version of the API. - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - XAVRequest: - AddressKeyFormat: - ConsigneeName: RITZ CAMERA CENTERS-1749 - BuildingName: Innoplex - AddressLine: - - 26601 ALISO CREEK ROAD - - STE D - - ALISO VIEJO TOWN CENTER - Region: ROSWELL,GA,30076-1521 - PoliticalDivision2: ALISO VIEJO - PoliticalDivision1: CA - PostcodePrimaryLow: '92656' - PostcodeExtendedLow: '1521' - Urbanization: porto arundal - CountryCode: US - responses: - '200': - description: Successful Operation - content: - application/json: - schema: - "$ref": "#/components/schemas/XAVResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - XAVRequestWrapper: - xml: - name: XAVRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - XAVRequest - properties: - XAVRequest: - "$ref": "#/components/schemas/XAVRequest" - XAVResponseWrapper: - xml: - name: XAVResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - XAVResponse - properties: - XAVResponse: - "$ref": "#/components/schemas/XAVResponse" - XAVRequest: - type: object - required: - - AddressKeyFormat - properties: - AddressKeyFormat: - "$ref": "#/components/schemas/XAVRequest_AddressKeyFormat" - XAVRequest_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name of business, company or person. Ignored if user selects the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AttentionName: - description: Name of the building. Ignored if user selects the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AddressLine: - description: Address line (street number, street name and street type) used for street level information. Additional secondary information (apartment, suite, floor, etc.). Applicable to US and PR only. Ignored if user selects the RegionalRequestIndicator. - type: array - maximum: 3 - minLength: 1 - maxLength: 100 - items: - type: string - Region: - description: | - If this node is present the following tags will be ignored: - - - Political Division 2 - - Political Division 1 - - PostcodePrimaryLow - - PostcodeExtendedLow - - 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 - maxLength: 100 - PoliticalDivision2: - description: City or Town name. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: State or Province/Territory name. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostcodePrimaryLow: - description: Postal Code. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PostcodeExtendedLow: - description: 4 digit Postal Code extension. For US use only. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Urbanization: - description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - CountryCode: - description: Country or Territory Code. For a list of valid values, refer to the Address Validation API Supported Countries or Territories table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: AddressKeyFormat - required: - - 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. - XAVResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/XAVResponse_Response" - ValidAddressIndicator: - description: Indicates query found a valid match. - maximum: 1 - type: string - AmbiguousAddressIndicator: - description: Indicates query could not find exact match. Candidate list - follows. - maximum: 1 - type: string - NoCandidatesIndicator: - description: No Candidate found. - maximum: 1 - type: string - AddressClassification: - "$ref": "#/components/schemas/XAVResponse_AddressClassification" - Candidate: - description: | - Candidate Container. - - **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" - xml: - name: XAVResponse - maximum: 1 - description: XAV Response Container. - XAVResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: |- - Identifies the success or failure of the transaction. Valid values: - 1 = Success - 0 = Failure - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of 'Success' - or 'Failure'. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response Status Container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - XAVResponse_AddressClassification: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Contains the classification code of the input address. - - Valid values: - - - 0 - UnClassified - - 1 - Commercial - - 2 - Residential - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: "Contains the text description of the address classification code: UnClassified, Commercial, Residential" - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - xml: - name: AddressClassification - description: AddressClassification Container. - XAVResponse_Candidate: - type: object - properties: - AddressClassification: - "$ref": "#/components/schemas/Candidate_AddressClassification" - AddressKeyFormat: - "$ref": "#/components/schemas/Candidate_AddressKeyFormat" - xml: - name: Candidate - required: - - AddressKeyFormat - maximum: 1 - Candidate_AddressClassification: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: |- - Contains the classification code of the address: - 0 - UnClassified - 1 - Commercial - 2 - Residential - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Contains the text description of the address classification - code (see Code above). - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - xml: - name: AddressClassification - description: AddressClassification Container. - Candidate_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name of business, company or person. Not returned if user selects - the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AttentionName: - description: Name of building. Not returned if user selects the RegionalRequestIndicator. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AddressLine: - 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 - selects the RegionalRequestIndicator." - type: array - maximum: 3 - minLength: 1 - maxLength: 100 - items: - type: string - Region: - description: Single entry containing in this order Political Division 2, - Political Division 1 and Post Code Primary Low and/or PostcodeExtendedLow. - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - PoliticalDivision2: - description: City or Town name. - maximum: 1 - type: string - 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 - International the full State or Province name will be returned." - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostcodePrimaryLow: - description: Low-end Postal Code. Returned for countries or territories - with Postal Codes. May be alphanumeric. - maximum: 1 - type: string - minLength: 1 - 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" - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Urbanization: - description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - CountryCode: - description: A country or territory code. Required to be returned. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: AddressKeyFormat - required: - - CountryCode - description: AddressKeyFormat Container. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. - +openapi: 3.0.3 +info: + title: Address Validation - Street Level + termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html + version: '' + description: | + + The Address Validation Street Level API can be used to. + check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico. + # Reference + - Appendix + - Business Rules + - Errors + - FAQ + - Accelerate API Integration with UPS MCP Server + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/addressvalidation/{version}/{requestoption}": + post: + summary: Address Validation + tags: + - Address Validation + security: + - OAuth2: [] + description: | + The Address Validation Street Level API can be used to check addresses + against the United States Postal Service database of valid addresses in the + U.S. and Puerto Rico. + + NOTE: In the Customer Integration Environment, Street Level Address Validation will only produce results for addresses in New York (NY) and California (CA). + operationId: AddressValidation + parameters: + - in: query + name: regionalrequestindicator + schema: + type: string + minimum: 1 + 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 + in addition to the urbanization element. If False or no indicator, street + level address validation is provided" + required: false + - in: query + name: maximumcandidatelistsize + schema: + type: integer + minimum: 1 + description: "Valid values: 0 – 50 The maximum number of Candidates to return + for this request. If not provided, the default size of 15 is returned." + required: false + - in: path + name: requestoption + schema: + type: integer + minimum: 1 + description: | + Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. + + Valid values: + - 1 - Address Validation + - 2 - Address Classification + - 3 - Address Validation and Address Classification. + + For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2 + description: | + Identifies the version of the API. + + Valid values: + - v2 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + XAVRequest: + AddressKeyFormat: + ConsigneeName: RITZ CAMERA CENTERS-1749 + BuildingName: Innoplex + AddressLine: + - 26601 ALISO CREEK ROAD + - STE D + - ALISO VIEJO TOWN CENTER + Region: ROSWELL,GA,30076-1521 + PoliticalDivision2: ALISO VIEJO + PoliticalDivision1: CA + PostcodePrimaryLow: '92656' + PostcodeExtendedLow: '1521' + Urbanization: porto arundal + CountryCode: US + responses: + '200': + description: Successful Operation + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + post: + deprecated: true + summary: Address Validation + tags: + - Address Validation + security: + - OAuth2: [] + description: The Address Validation Street Level API can be used to check addresses + against the United States Postal Service database of valid addresses in the + U.S. and Puerto Rico. + operationId: DeprecatedAddressValidation + parameters: + - in: query + name: regionalrequestindicator + schema: + type: string + minimum: 1 + 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 + in addition to the urbanization element. If False or no indicator, street + level address validation is provided" + required: false + - in: query + name: maximumcandidatelistsize + schema: + type: integer + minimum: 1 + description: "Valid values: 0 – 50 The maximum number of Candidates to return + for this request. If not provided, the default size of 15 is returned." + required: false + - in: path + name: requestoption + schema: + type: integer + minimum: 1 + description: | + Identifies the optional processing to be performed. If not present or invalid value then an error will be sent back. + + Valid values: + + - 1 - Address Validation + - 2 - Address Classification + - 3 - Address Validation and Address Classification. + + For a list of valid values, refer to Address Validation API Supported Countries or Territories in the Appendix. + required: true + - in: path + name: deprecatedVersion + schema: + type: string + minimum: 1 + default: v1 + description: | + Identifies the version of the API. + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + XAVRequest: + AddressKeyFormat: + ConsigneeName: RITZ CAMERA CENTERS-1749 + BuildingName: Innoplex + AddressLine: + - 26601 ALISO CREEK ROAD + - STE D + - ALISO VIEJO TOWN CENTER + Region: ROSWELL,GA,30076-1521 + PoliticalDivision2: ALISO VIEJO + PoliticalDivision1: CA + PostcodePrimaryLow: '92656' + PostcodeExtendedLow: '1521' + Urbanization: porto arundal + CountryCode: US + responses: + '200': + description: Successful Operation + content: + application/json: + schema: + "$ref": "#/components/schemas/XAVResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + XAVRequestWrapper: + xml: + name: XAVRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - XAVRequest + properties: + XAVRequest: + "$ref": "#/components/schemas/XAVRequest" + XAVResponseWrapper: + xml: + name: XAVResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - XAVResponse + properties: + XAVResponse: + "$ref": "#/components/schemas/XAVResponse" + XAVRequest: + type: object + required: + - AddressKeyFormat + properties: + AddressKeyFormat: + "$ref": "#/components/schemas/XAVRequest_AddressKeyFormat" + XAVRequest_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name of business, company or person. Ignored if user selects the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AttentionName: + description: Name of the building. Ignored if user selects the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AddressLine: + description: Address line (street number, street name and street type) used for street level information. Additional secondary information (apartment, suite, floor, etc.). Applicable to US and PR only. Ignored if user selects the RegionalRequestIndicator. + type: array + maximum: 3 + minLength: 1 + maxLength: 100 + items: + type: string + Region: + description: | + If this node is present the following tags will be ignored: + + - Political Division 2 + - Political Division 1 + - PostcodePrimaryLow + - PostcodeExtendedLow + + 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 + maxLength: 100 + PoliticalDivision2: + description: City or Town name. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: State or Province/Territory name. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostcodePrimaryLow: + description: Postal Code. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PostcodeExtendedLow: + description: 4 digit Postal Code extension. For US use only. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Urbanization: + description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + CountryCode: + description: Country or Territory Code. For a list of valid values, refer to the Address Validation API Supported Countries or Territories table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: AddressKeyFormat + required: + - 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. + XAVResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/XAVResponse_Response" + ValidAddressIndicator: + description: Indicates query found a valid match. + maximum: 1 + type: string + AmbiguousAddressIndicator: + description: Indicates query could not find exact match. Candidate list + follows. + maximum: 1 + type: string + NoCandidatesIndicator: + description: No Candidate found. + maximum: 1 + type: string + AddressClassification: + "$ref": "#/components/schemas/XAVResponse_AddressClassification" + Candidate: + description: | + Candidate Container. + + **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" + xml: + name: XAVResponse + maximum: 1 + description: XAV Response Container. + XAVResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: |- + Identifies the success or failure of the transaction. Valid values: + 1 = Success + 0 = Failure + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of 'Success' + or 'Failure'. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response Status Container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + XAVResponse_AddressClassification: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Contains the classification code of the input address. + + Valid values: + + - 0 - UnClassified + - 1 - Commercial + - 2 - Residential + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: "Contains the text description of the address classification code: UnClassified, Commercial, Residential" + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + xml: + name: AddressClassification + description: AddressClassification Container. + XAVResponse_Candidate: + type: object + properties: + AddressClassification: + "$ref": "#/components/schemas/Candidate_AddressClassification" + AddressKeyFormat: + "$ref": "#/components/schemas/Candidate_AddressKeyFormat" + xml: + name: Candidate + required: + - AddressKeyFormat + maximum: 1 + Candidate_AddressClassification: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: |- + Contains the classification code of the address: + 0 - UnClassified + 1 - Commercial + 2 - Residential + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Contains the text description of the address classification + code (see Code above). + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + xml: + name: AddressClassification + description: AddressClassification Container. + Candidate_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name of business, company or person. Not returned if user selects + the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AttentionName: + description: Name of building. Not returned if user selects the RegionalRequestIndicator. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AddressLine: + 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 + selects the RegionalRequestIndicator." + type: array + maximum: 3 + minLength: 1 + maxLength: 100 + items: + type: string + Region: + description: Single entry containing in this order Political Division 2, + Political Division 1 and Post Code Primary Low and/or PostcodeExtendedLow. + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + PoliticalDivision2: + description: City or Town name. + maximum: 1 + type: string + 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 + International the full State or Province name will be returned." + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostcodePrimaryLow: + description: Low-end Postal Code. Returned for countries or territories + with Postal Codes. May be alphanumeric. + maximum: 1 + type: string + minLength: 1 + 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" + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Urbanization: + description: Puerto Rico Political Division 3. Only Valid for Puerto Rico. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + CountryCode: + description: A country or territory code. Required to be returned. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: AddressKeyFormat + required: + - CountryCode + description: AddressKeyFormat Container. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/CommerceGuard.yaml b/CommerceGuard.yaml index be48f74..2e7793e 100644 --- a/CommerceGuard.yaml +++ b/CommerceGuard.yaml @@ -1,642 +1,642 @@ -openapi: 3.1.0 -info: - title: Chargeback Protection API v1 - version: "1.0" - description: API to verify and score risk of an order for chargeback protection. -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - /commerce-guard/{version}/verify: - post: - summary: Verify chargeback risk - description: | - Evaluates chargeback risk based on user, payment, and address details. - Returns scores and decision for risk classification. - operationId: verifyChargebackRisk - tags: - - Commerce Guard - security: - - OAuth2: [] - parameters: - - in: path - name: version - schema: - type: string - minimum: 1 - default: v1 - description: | - Denotes which version of the API to be called as new features are released. - - v1 - - in: header - name: partnerId - schema: - type: string - minLength: 1 - maxLength: 64 - example: PARTNER_001 - required: true - description: Unique Partner ID - - in: header - name: transSrc - schema: - type: string - minLength: 1 - maxLength: 36 - example: webstore - required: false - description: Optional transaction source - - in: header - name: transId - schema: - type: string - minLength: 3 - maxLength: 36 - pattern: '^[a-zA-Z0-9-.]{3,36}$' - example: trans-001-a1b2c3 - required: false - description: Optional unique transaction ID for idempotency - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackVerifyRequestV1' - example: - userInformation: - email: alice.smith@example.com - ipAddress: 192.168.1.101 - billingContact: - name: - firstName: Alice - lastName: Smith - phone: - countryCode: "1" - number: "3125556789" - address: - addressLine: - - 456 Elm Street - - Unit 12B - city: Chicago - stateProvinceCode: IL - postalCode: "60616" - countryCode: US - shippingContact: - name: - firstName: Alice - lastName: Smith - phone: - countryCode: "1" - number: "3125556789" - address: - addressLine: - - 456 Elm Street - - Unit 12B - city: Chicago - stateProvinceCode: IL - postalCode: "60616" - countryCode: US - paymentInformation: - txnId: TXN20250716001 - method: card - issuerIdNumber: 411111 - lastDigits: 4242 - issuer: Visa - products: - - sku: ROD-ABC-123 - name: Wireless Bluetooth Headphones - orderValue: 199.99 - currencyCode: USD - orderId: ORDER1001 - orderCreatedAt: 2025-07-16T10:53:11.893Z - responses: - '200': - description: Success - headers: - BkndTransId: - $ref: '#/components/headers/BkndTransId' - transId: - $ref: '#/components/headers/transId' - transactionSrc: - $ref: '#/components/headers/transactionSrc' - Content-Type: - $ref: '#/components/headers/Content-Type' - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackVerifyResponseV1' - example: - superScore: 500 - decision: review - categoryScores: - addressReliabilityScore: - score: 520 - rank: medium - digitalIdentityScore: - score: 999 - rank: high - proxyScore: - score: 0 - rank: no_risk - paymentReliabilityScore: - score: 140 - rank: low - '400': - description: Validation error - headers: - BkndTransId: - $ref: '#/components/headers/BkndTransId' - transId: - $ref: '#/components/headers/transId' - transactionSrc: - $ref: '#/components/headers/transactionSrc' - Content-Type: - $ref: '#/components/headers/Content-Type' - APIErrorCode: - $ref: '#/components/headers/APIErrorCode' - APIErrorMessage: - $ref: '#/components/headers/APIErrorMsg' - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackErrorResponseV1' - example: - response: - errors: - - code: MISSING_FIELD - message: shippingContact.address.postalCode is required - '401': - description: Unauthorized - headers: - BkndTransId: - $ref: '#/components/headers/BkndTransId' - transId: - $ref: '#/components/headers/transId' - transactionSrc: - $ref: '#/components/headers/transactionSrc' - Content-Type: - $ref: '#/components/headers/Content-Type' - APIErrorCode: - $ref: '#/components/headers/APIErrorCode' - APIErrorMessage: - $ref: '#/components/headers/APIErrorMsg' - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackErrorResponseV1' - example: - response: - errors: - - code: UNAUTHORIZED - message: Invalid credentials - '403': - description: Forbidden - headers: - BkndTransId: - $ref: '#/components/headers/BkndTransId' - transId: - $ref: '#/components/headers/transId' - transactionSrc: - $ref: '#/components/headers/transactionSrc' - Content-Type: - $ref: '#/components/headers/Content-Type' - APIErrorCode: - $ref: '#/components/headers/APIErrorCode' - APIErrorMessage: - $ref: '#/components/headers/APIErrorMsg' - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackErrorResponseV1' - example: - response: - errors: - - code: UNSUPPORTED - message: Merchant does not have permission for this product - '422': - description: Unprocessable Content (Dependency Validation Failed) - headers: - BkndTransId: - $ref: '#/components/headers/BkndTransId' - transId: - $ref: '#/components/headers/transId' - transactionSrc: - $ref: '#/components/headers/transactionSrc' - Content-Type: - $ref: '#/components/headers/Content-Type' - APIErrorCode: - $ref: '#/components/headers/APIErrorCode' - APIErrorMessage: - $ref: '#/components/headers/APIErrorMsg' - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackErrorResponseV1' - example: - response: - errors: - - code: DEPENDENCY_VALIDATION_FAILED - message: Invalid IP address format - '500': - description: Internal server error - headers: - BkndTransId: - $ref: '#/components/headers/BkndTransId' - transId: - $ref: '#/components/headers/transId' - transactionSrc: - $ref: '#/components/headers/transactionSrc' - Content-Type: - $ref: '#/components/headers/Content-Type' - APIErrorCode: - $ref: '#/components/headers/APIErrorCode' - APIErrorMessage: - $ref: '#/components/headers/APIErrorMsg' - content: - application/json: - schema: - $ref: '#/components/schemas/ChargebackErrorResponseV1' - example: - response: - errors: - - code: SERVER_ERROR - message: system Unexpected exception while processing the request -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - headers: - BkndTransId: - description: The backend transaction id. - required: true - schema: - type: string - minLength: 1 - maxLength: 64 - example: 383f7d397a48 - transId: - description: An identifier unique to the request. - required: true - schema: - type: string - minLength: 3 - maxLength: 36 - pattern: '^[a-zA-Z0-9-.]{3,36}$' - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - minLength: 1 - maxLength: 36 - pattern: '^[a-zA-Z0-9-.]{1,36}$' - example: UPS.com - Content-Type: - description: The Content-Type header provides the client with the actual content/media type of the returned content. - required: true - schema: - type: string - example: application/json - APIErrorCode: - description: The API error code. - required: true - schema: - type: string - example: UJ0001 - APIErrorMsg: - description: The API error message. - required: true - schema: - type: string - example: Invalid token or token is not present. - schemas: - ChargebackVerifyRequestV1: - type: object - required: - - userInformation - - billingContact - - shippingContact - - products - - orderValue - - currencyCode - - orderId - - orderCreatedAt - properties: - userInformation: - type: object - required: - - email - - ipAddress - properties: - email: - type: string - format: email - description: Customer's email address - minLength: 5 - maxLength: 256 - example: alice.smith@example.com - ipAddress: - type: string - description: IPv4 or IPv6 address - minLength: 7 - maxLength: 45 - pattern: "^(?:(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[a-fA-F0-9:]+:+)+[a-fA-F0-9]+)$" - example: "192.168.1.1" - - billingContact: - $ref: '#/components/schemas/ChargebackContactInformationV1' - shippingContact: - $ref: '#/components/schemas/ChargebackContactInformationV1' - paymentInformation: - type: - - object - - "null" - description: Payment details, nullable - properties: - txnId: - type: string - description: Payment transaction ID - minLength: 1 - maxLength: 64 - example: TXN20250716001 - method: - type: string - description: Payment method used for transaction - minLength: 1 - maxLength: 32 - example: card - issuerIdNumber: - type: integer - description: First 6 digits of the card number (issuer identification number) - minimum: 1 - maximum: 999999 - example: 411111 - lastDigits: - type: integer - description: Last 4 digits of the card used - minimum: 0 - maximum: 9999 - example: 4242 - issuer: - type: string - description: Card issuer (e.g., Visa) - minLength: 1 - maxLength: 32 - example: Visa - additionalProperties: false - products: - type: array - description: List of products in the order - minItems: 1 - maxItems: 999 - items: - type: object - required: - - sku - - name - properties: - sku: - type: string - description: Stock keeping unit identifier - minLength: 1 - maxLength: 64 - example: PROD-ABC-123 - name: - type: string - description: Product name - minLength: 1 - maxLength: 128 - example: Wireless Bluetooth Headphones - additionalProperties: false - orderValue: - type: number - format: float - description: Total order value - minimum: 0 - maximum: 1000000 - example: 199.99 - currencyCode: - type: string - description: >- - The ISO 4217 currency - minLength: 3 - maxLength: 3 - pattern: '^[A-Z]{3}$' - example: USD - orderId: - type: string - description: Unique order identifier - minLength: 1 - maxLength: 64 - example: ORDER1001 - orderCreatedAt: - type: string - description: >- - The RFC 3339 date and time - format: date-time - minLength: 24 - maxLength: 24 - pattern: '^(20)\d{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d).\d{3}Z$' - example: "2025-07-16T10:53:11.893Z" - additionalProperties: false - ChargebackVerifyResponseV1: - type: object - properties: - superScore: - type: number - description: Overall risk score from 0 (lowest) to 999 (highest risk) - minimum: 0 - maximum: 999 - example: 585 - decision: - type: string - description: Risk decision—whether to reject, review, or undecided - enum: - - reject - - review - - undecided - categoryScores: - type: object - description: Detailed category risk scores - properties: - addressReliabilityScore: - $ref: '#/components/schemas/ChargebackScoreRankV1' - digitalIdentityScore: - $ref: '#/components/schemas/ChargebackScoreRankV1' - proxyScore: - $ref: '#/components/schemas/ChargebackScoreRankV1' - paymentReliabilityScore: - $ref: '#/components/schemas/ChargebackScoreRankV1' - additionalProperties: false - ChargebackContactInformationV1: - type: object - description: Contact information structure used for billing and shipping - required: - - name - - phone - - address - properties: - name: - type: object - description: Person's name details - required: - - firstName - - lastName - properties: - firstName: - type: string - description: First name - minLength: 1 - maxLength: 64 - example: Alice - lastName: - type: string - description: Last name - minLength: 1 - maxLength: 64 - example: Smith - additionalProperties: false - phone: - type: object - description: Contact phone number details - required: - - countryCode - - number - properties: - countryCode: - type: string - description: Numeric country calling code - pattern: '^\d{1,4}$' - minLength: 1 - maxLength: 4 - example: "1" - number: - type: string - description: Phone number excluding country code - pattern: '^\d{10}$' - minLength: 10 - maxLength: 10 - example: "3125556789" - additionalProperties: false - address: - type: object - description: Address details - required: - - addressLine - - city - - stateProvinceCode - - postalCode - - countryCode - properties: - addressLine: - type: array - description: Street address lines - minItems: 1 - maxItems: 3 - items: - type: string - minLength: 1 - maxLength: 128 - example: - - "456 Elm Street" - - "Unit 12B" - city: - type: string - description: City or locality - minLength: 1 - maxLength: 64 - example: Chicago - stateProvinceCode: - type: string - description: State or province abbreviation - minLength: 2 - maxLength: 2 - example: IL - postalCode: - type: string - description: Postal or ZIP code - pattern: '^\d{5}(-\d{4})?$' - minLength: 5 - maxLength: 10 - example: "60616" - countryCode: - type: string - description: >- - The ISO 3166 country or territory code - minLength: 2 - maxLength: 2 - pattern: '^[A-Z]{2}$' - example: US - additionalProperties: false - additionalProperties: false - ChargebackScoreRankV1: - type: object - properties: - score: - type: number - description: Score value for this risk category, range 0 to 999 - minimum: 0 - maximum: 999 - example: 710 - rank: - type: string - description: Risk rank for the category - enum: - - no_risk - - low - - medium - - high - ChargebackErrorResponseV1: - type: object - properties: - response: - type: object - properties: - errors: - type: array - items: - type: object - properties: - code: - type: string - description: Error code for the error type - enum: - - INVALID_REQUEST - - UNAUTHORIZED - - RATE_LIMIT_EXCEEDED - - INTERNAL_SERVER_ERROR - - DEPENDENCY_VALIDATION_FAILED - - MISSING_FIELD - - INVALID_FIELD - - UNSUPPORTED - - SERVER_ERROR - message: - type: string - description: Detailed error message - required: - - code - - message - description: List of error objects - required: - - errors - required: - - response - description: Standard error response structure for invalid or failed requests +openapi: 3.1.0 +info: + title: Chargeback Protection API v1 + version: "1.0" + description: API to verify and score risk of an order for chargeback protection. +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + /commerce-guard/{version}/verify: + post: + summary: Verify chargeback risk + description: | + Evaluates chargeback risk based on user, payment, and address details. + Returns scores and decision for risk classification. + operationId: verifyChargebackRisk + tags: + - Commerce Guard + security: + - OAuth2: [] + parameters: + - in: path + name: version + schema: + type: string + minimum: 1 + default: v1 + description: | + Denotes which version of the API to be called as new features are released. + - v1 + - in: header + name: partnerId + schema: + type: string + minLength: 1 + maxLength: 64 + example: PARTNER_001 + required: true + description: Unique Partner ID + - in: header + name: transSrc + schema: + type: string + minLength: 1 + maxLength: 36 + example: webstore + required: false + description: Optional transaction source + - in: header + name: transId + schema: + type: string + minLength: 3 + maxLength: 36 + pattern: '^[a-zA-Z0-9-.]{3,36}$' + example: trans-001-a1b2c3 + required: false + description: Optional unique transaction ID for idempotency + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackVerifyRequestV1' + example: + userInformation: + email: alice.smith@example.com + ipAddress: 192.168.1.101 + billingContact: + name: + firstName: Alice + lastName: Smith + phone: + countryCode: "1" + number: "3125556789" + address: + addressLine: + - 456 Elm Street + - Unit 12B + city: Chicago + stateProvinceCode: IL + postalCode: "60616" + countryCode: US + shippingContact: + name: + firstName: Alice + lastName: Smith + phone: + countryCode: "1" + number: "3125556789" + address: + addressLine: + - 456 Elm Street + - Unit 12B + city: Chicago + stateProvinceCode: IL + postalCode: "60616" + countryCode: US + paymentInformation: + txnId: TXN20250716001 + method: card + issuerIdNumber: 411111 + lastDigits: 4242 + issuer: Visa + products: + - sku: ROD-ABC-123 + name: Wireless Bluetooth Headphones + orderValue: 199.99 + currencyCode: USD + orderId: ORDER1001 + orderCreatedAt: 2025-07-16T10:53:11.893Z + responses: + '200': + description: Success + headers: + BkndTransId: + $ref: '#/components/headers/BkndTransId' + transId: + $ref: '#/components/headers/transId' + transactionSrc: + $ref: '#/components/headers/transactionSrc' + Content-Type: + $ref: '#/components/headers/Content-Type' + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackVerifyResponseV1' + example: + superScore: 500 + decision: review + categoryScores: + addressReliabilityScore: + score: 520 + rank: medium + digitalIdentityScore: + score: 999 + rank: high + proxyScore: + score: 0 + rank: no_risk + paymentReliabilityScore: + score: 140 + rank: low + '400': + description: Validation error + headers: + BkndTransId: + $ref: '#/components/headers/BkndTransId' + transId: + $ref: '#/components/headers/transId' + transactionSrc: + $ref: '#/components/headers/transactionSrc' + Content-Type: + $ref: '#/components/headers/Content-Type' + APIErrorCode: + $ref: '#/components/headers/APIErrorCode' + APIErrorMessage: + $ref: '#/components/headers/APIErrorMsg' + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackErrorResponseV1' + example: + response: + errors: + - code: MISSING_FIELD + message: shippingContact.address.postalCode is required + '401': + description: Unauthorized + headers: + BkndTransId: + $ref: '#/components/headers/BkndTransId' + transId: + $ref: '#/components/headers/transId' + transactionSrc: + $ref: '#/components/headers/transactionSrc' + Content-Type: + $ref: '#/components/headers/Content-Type' + APIErrorCode: + $ref: '#/components/headers/APIErrorCode' + APIErrorMessage: + $ref: '#/components/headers/APIErrorMsg' + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackErrorResponseV1' + example: + response: + errors: + - code: UNAUTHORIZED + message: Invalid credentials + '403': + description: Forbidden + headers: + BkndTransId: + $ref: '#/components/headers/BkndTransId' + transId: + $ref: '#/components/headers/transId' + transactionSrc: + $ref: '#/components/headers/transactionSrc' + Content-Type: + $ref: '#/components/headers/Content-Type' + APIErrorCode: + $ref: '#/components/headers/APIErrorCode' + APIErrorMessage: + $ref: '#/components/headers/APIErrorMsg' + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackErrorResponseV1' + example: + response: + errors: + - code: UNSUPPORTED + message: Merchant does not have permission for this product + '422': + description: Unprocessable Content (Dependency Validation Failed) + headers: + BkndTransId: + $ref: '#/components/headers/BkndTransId' + transId: + $ref: '#/components/headers/transId' + transactionSrc: + $ref: '#/components/headers/transactionSrc' + Content-Type: + $ref: '#/components/headers/Content-Type' + APIErrorCode: + $ref: '#/components/headers/APIErrorCode' + APIErrorMessage: + $ref: '#/components/headers/APIErrorMsg' + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackErrorResponseV1' + example: + response: + errors: + - code: DEPENDENCY_VALIDATION_FAILED + message: Invalid IP address format + '500': + description: Internal server error + headers: + BkndTransId: + $ref: '#/components/headers/BkndTransId' + transId: + $ref: '#/components/headers/transId' + transactionSrc: + $ref: '#/components/headers/transactionSrc' + Content-Type: + $ref: '#/components/headers/Content-Type' + APIErrorCode: + $ref: '#/components/headers/APIErrorCode' + APIErrorMessage: + $ref: '#/components/headers/APIErrorMsg' + content: + application/json: + schema: + $ref: '#/components/schemas/ChargebackErrorResponseV1' + example: + response: + errors: + - code: SERVER_ERROR + message: system Unexpected exception while processing the request +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + headers: + BkndTransId: + description: The backend transaction id. + required: true + schema: + type: string + minLength: 1 + maxLength: 64 + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + required: true + schema: + type: string + minLength: 3 + maxLength: 36 + pattern: '^[a-zA-Z0-9-.]{3,36}$' + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + minLength: 1 + maxLength: 36 + pattern: '^[a-zA-Z0-9-.]{1,36}$' + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + required: true + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + required: true + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + required: true + schema: + type: string + example: Invalid token or token is not present. + schemas: + ChargebackVerifyRequestV1: + type: object + required: + - userInformation + - billingContact + - shippingContact + - products + - orderValue + - currencyCode + - orderId + - orderCreatedAt + properties: + userInformation: + type: object + required: + - email + - ipAddress + properties: + email: + type: string + format: email + description: Customer's email address + minLength: 5 + maxLength: 256 + example: alice.smith@example.com + ipAddress: + type: string + description: IPv4 or IPv6 address + minLength: 7 + maxLength: 45 + pattern: "^(?:(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|(?:[a-fA-F0-9:]+:+)+[a-fA-F0-9]+)$" + example: "192.168.1.1" + + billingContact: + $ref: '#/components/schemas/ChargebackContactInformationV1' + shippingContact: + $ref: '#/components/schemas/ChargebackContactInformationV1' + paymentInformation: + type: + - object + - "null" + description: Payment details, nullable + properties: + txnId: + type: string + description: Payment transaction ID + minLength: 1 + maxLength: 64 + example: TXN20250716001 + method: + type: string + description: Payment method used for transaction + minLength: 1 + maxLength: 32 + example: card + issuerIdNumber: + type: integer + description: First 6 digits of the card number (issuer identification number) + minimum: 1 + maximum: 999999 + example: 411111 + lastDigits: + type: integer + description: Last 4 digits of the card used + minimum: 0 + maximum: 9999 + example: 4242 + issuer: + type: string + description: Card issuer (e.g., Visa) + minLength: 1 + maxLength: 32 + example: Visa + additionalProperties: false + products: + type: array + description: List of products in the order + minItems: 1 + maxItems: 999 + items: + type: object + required: + - sku + - name + properties: + sku: + type: string + description: Stock keeping unit identifier + minLength: 1 + maxLength: 64 + example: PROD-ABC-123 + name: + type: string + description: Product name + minLength: 1 + maxLength: 128 + example: Wireless Bluetooth Headphones + additionalProperties: false + orderValue: + type: number + format: float + description: Total order value + minimum: 0 + maximum: 1000000 + example: 199.99 + currencyCode: + type: string + description: >- + The ISO 4217 currency + minLength: 3 + maxLength: 3 + pattern: '^[A-Z]{3}$' + example: USD + orderId: + type: string + description: Unique order identifier + minLength: 1 + maxLength: 64 + example: ORDER1001 + orderCreatedAt: + type: string + description: >- + The RFC 3339 date and time + format: date-time + minLength: 24 + maxLength: 24 + pattern: '^(20)\d{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d).\d{3}Z$' + example: "2025-07-16T10:53:11.893Z" + additionalProperties: false + ChargebackVerifyResponseV1: + type: object + properties: + superScore: + type: number + description: Overall risk score from 0 (lowest) to 999 (highest risk) + minimum: 0 + maximum: 999 + example: 585 + decision: + type: string + description: Risk decision—whether to reject, review, or undecided + enum: + - reject + - review + - undecided + categoryScores: + type: object + description: Detailed category risk scores + properties: + addressReliabilityScore: + $ref: '#/components/schemas/ChargebackScoreRankV1' + digitalIdentityScore: + $ref: '#/components/schemas/ChargebackScoreRankV1' + proxyScore: + $ref: '#/components/schemas/ChargebackScoreRankV1' + paymentReliabilityScore: + $ref: '#/components/schemas/ChargebackScoreRankV1' + additionalProperties: false + ChargebackContactInformationV1: + type: object + description: Contact information structure used for billing and shipping + required: + - name + - phone + - address + properties: + name: + type: object + description: Person's name details + required: + - firstName + - lastName + properties: + firstName: + type: string + description: First name + minLength: 1 + maxLength: 64 + example: Alice + lastName: + type: string + description: Last name + minLength: 1 + maxLength: 64 + example: Smith + additionalProperties: false + phone: + type: object + description: Contact phone number details + required: + - countryCode + - number + properties: + countryCode: + type: string + description: Numeric country calling code + pattern: '^\d{1,4}$' + minLength: 1 + maxLength: 4 + example: "1" + number: + type: string + description: Phone number excluding country code + pattern: '^\d{10}$' + minLength: 10 + maxLength: 10 + example: "3125556789" + additionalProperties: false + address: + type: object + description: Address details + required: + - addressLine + - city + - stateProvinceCode + - postalCode + - countryCode + properties: + addressLine: + type: array + description: Street address lines + minItems: 1 + maxItems: 3 + items: + type: string + minLength: 1 + maxLength: 128 + example: + - "456 Elm Street" + - "Unit 12B" + city: + type: string + description: City or locality + minLength: 1 + maxLength: 64 + example: Chicago + stateProvinceCode: + type: string + description: State or province abbreviation + minLength: 2 + maxLength: 2 + example: IL + postalCode: + type: string + description: Postal or ZIP code + pattern: '^\d{5}(-\d{4})?$' + minLength: 5 + maxLength: 10 + example: "60616" + countryCode: + type: string + description: >- + The ISO 3166 country or territory code + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}$' + example: US + additionalProperties: false + additionalProperties: false + ChargebackScoreRankV1: + type: object + properties: + score: + type: number + description: Score value for this risk category, range 0 to 999 + minimum: 0 + maximum: 999 + example: 710 + rank: + type: string + description: Risk rank for the category + enum: + - no_risk + - low + - medium + - high + ChargebackErrorResponseV1: + type: object + properties: + response: + type: object + properties: + errors: + type: array + items: + type: object + properties: + code: + type: string + description: Error code for the error type + enum: + - INVALID_REQUEST + - UNAUTHORIZED + - RATE_LIMIT_EXCEEDED + - INTERNAL_SERVER_ERROR + - DEPENDENCY_VALIDATION_FAILED + - MISSING_FIELD + - INVALID_FIELD + - UNSUPPORTED + - SERVER_ERROR + message: + type: string + description: Detailed error message + required: + - code + - message + description: List of error objects + required: + - errors + required: + - response + description: Standard error response structure for invalid or failed requests diff --git a/DangerousGoods-Ready.yaml b/DangerousGoods-Ready.yaml index 2fe0664..7164fcd 100644 --- a/DangerousGoods-Ready.yaml +++ b/DangerousGoods-Ready.yaml @@ -1,1645 +1,1645 @@ -openapi: 3.0.3 -info: - title: Dangerous Goods Utility - 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 - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/dangerousgoods/{version}/chemicalreferencedata": - post: - summary: Chemical Reference Data - tags: - - Dangerous Goods - security: - - OAuth2: [] - description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. - operationId: Chemical Reference Data - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of the API. - - Valid values: - - v2409 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - ChemicalReferenceDataRequest: - IDNumber: UN1088 - ProperShippingName: Acetal - ShipperNumber: Your Shipper Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/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. - tags: - - Dangerous Goods - security: - - OAuth2: [] - summary: Acceptance Audit Pre-check - operationId: Acceptance Audit Pre-Check - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: version - schema: - type: string - default: v3 - description: | - API version - - Valid values: - - v2 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" - examples: - json: - summary: A sample JSON request - value: - AcceptanceAuditPreCheckRequest: - Request: - RequestOption: Request - TransactionReference: - CustomerContext: '' - OriginRecordTransactionTimestamp: " " - Shipment: - ShipperNumber: " " - ShipFromAddress: - AddressLine: 226 ELMWOOD AVE - City: BOGOTA - StateProvinceCode: NJ - PostalCode: '7603' - CountryCode: US - ShipToAddress: - AddressLinde: MY STREET 11 - City: DIEGEM - StateProvinceCode: " " - PostalCode: '1831' - CountryCode: BE - Service: - Code: '01' - Description: 'GROUND ' - RegulationSet: IATA - Package: - PackageIdentifier: '12' - PackageWeight: - Weight: '12' - UnitOfMeasurement: - Code: KGS - Description: KILOS - QValue: '0' - OverPackedIndicator: I - TransportationMode: PAX - EmergencyContact: SELF - ChemicalRecord: - ChemicalRecordIdentifier: '12' - ReportableQuantity: RQ - ClassDivisionNumber: '3' - SubRiskClass: " " - IDNumber: UN2621 - PackagingGroupType: III - Quantity: '10' - UOM: KGS - PackagingInstructionCode: Y344 - ProperShippingName: ACETYL METHYL CARBINOL - TechnicalName: " " - AdditionalDescription: N - PackagingType: Fiberboard Box - HazardLabelRequired: LABEL IT - PackagingTypeQuantity: '22' - CommodityRegulatedLevelCode: LQ - TransportCategory: '3' - TunnelRestrictionCode: '1' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - post: - deprecated: true - summary: Chemical Reference Data - tags: - - Dangerous Goods - security: - - OAuth2: [] - description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. - operationId: Deprecated Chemical Reference Data - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: deprecatedVersion - schema: - type: string - minimum: 1 - default: v1 - description: | - Version of the API. - - Valid values: - - v1 - - v1801. - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - ChemicalReferenceDataRequest: - IDNumber: UN1088 - ProperShippingName: Acetal - ShipperNumber: Your Shipper Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - post: - deprecated: true - tags: - - Dangerous Goods - security: - - OAuth2: [] - description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code. - summary: Acceptance Audit Pre-check - operationId: Deprecated Acceptance Audit Pre-Check - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - API version - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" - examples: - json: - summary: A sample JSON request - value: - AcceptanceAuditPreCheckRequest: - Request: - RequestOption: Request - TransactionReference: - CustomerContext: '' - OriginRecordTransactionTimestamp: " " - Shipment: - ShipperNumber: " " - ShipFromAddress: - AddressLine: 226 ELMWOOD AVE - City: BOGOTA - StateProvinceCode: NJ - PostalCode: '7603' - CountryCode: US - ShipToAddress: - AddressLinde: MY STREET 11 - City: DIEGEM - StateProvinceCode: " " - PostalCode: '1831' - CountryCode: BE - Service: - Code: '01' - Description: 'GROUND ' - RegulationSet: IATA - Package: - PackageIdentifier: '12' - PackageWeight: - Weight: '12' - UnitOfMeasurement: - Code: KGS - Description: KILOS - QValue: '0' - OverPackedIndicator: I - TransportationMode: PAX - EmergencyContact: SELF - ChemicalRecord: - ChemicalRecordIdentifier: '12' - ReportableQuantity: RQ - ClassDivisionNumber: '3' - SubRiskClass: " " - IDNumber: UN2621 - PackagingGroupType: III - Quantity: '10' - UOM: KGS - PackagingInstructionCode: Y344 - ProperShippingName: ACETYL METHYL CARBINOL - TechnicalName: " " - AdditionalDescription: N - PackagingType: Fiberboard Box - HazardLabelRequired: LABEL IT - PackagingTypeQuantity: '22' - CommodityRegulatedLevelCode: LQ - TransportCategory: '3' - TunnelRestrictionCode: '1' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - DANGEROUSGOODSUTILITYRequestWrapper: - xml: - name: ChemicalReferenceDataRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - ChemicalReferenceDataRequest - properties: - ChemicalReferenceDataRequest: - "$ref": "#/components/schemas/ChemicalReferenceDataRequest" - DANGEROUSGOODSUTILITYResponseWrapper: - xml: - name: ChemicalReferenceDataResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - ChemicalReferenceDataResponse - properties: - ChemicalReferenceDataResponse: - "$ref": "#/components/schemas/ChemicalReferenceDataResponse" - ChemicalReferenceDataRequest: - type: object - required: - - Request - - ShipperNumber - properties: - 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 - - IDNumber or ProperShippingName should be provided to retrieve Chemical - Reference Data. - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - ProperShippingName: - 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 - type: string - minLength: 1 - maxLength: 250 - ShipperNumber: - 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 - xml: - name: ChemicalReferenceDataRequest - maximum: 1 - description: Dangerous Goods Utility Request container for Chemical Reference - Data. - ChemicalReferenceDataRequest_Request: - type: object - properties: - RequestOption: - type: array - items: - type: string - description: Enables the user to specify optional processing. Currently, - there is no optional process in Dangerous Goods Utiltiy WS. - minLength: 1 - maxLength: 1 - SubVersion: - description: |- - When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility. - - To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. - - Format: YYMM = Year and month of the release. - - Example: 1801 = 2018 January Supported values: 1801 - type: string - maximum: 1 - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Chemical Reference Data request criteria components. - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - ChemicalReferenceDataResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/ChemicalReferenceDataResponse_Response" - ChemicalData: - description: | - Container to hold Chemical Data 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/ChemicalReferenceDataResponse_ChemicalData" - xml: - name: ChemicalReferenceDataResponse - description: Dangerous Goods Utility Response container for Chemical Reference - Data. - maximum: 1 - ChemicalReferenceDataResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Contains Dangerous Goods Utility Chemical Reference Data response - components. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: 'Identifies the success or failure of the transaction. Valid - values: 0 = Failed and 1 = Successful.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of "Success" or - "Failure". - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response status container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - ChemicalReferenceDataResponse_ChemicalData: - type: object - properties: - ChemicalDetail: - "$ref": "#/components/schemas/ChemicalData_ChemicalDetail" - 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. - - **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" - xml: - name: ChemicalData - ChemicalData_ChemicalDetail: - type: object - maximum: 1 - properties: - RegulationSet: - description: "The Regulatory set associated with every regulated shipment. - \ 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." - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - 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 - for a given chemical record. - maximum: 1 - type: string - minLength: 1 - 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 - chemical record. - maximum: 1 - type: string - minLength: 1 - maxLength: 250 - ClassDivisionNumber: - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - 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 - for a given chemical record. - maximum: 1 - type: string - minLength: 1 - 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" - 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. - - Y = TechnicalName is required. - N = TechnicalName is not required. - maximum: 1 - type: string - minLength: 1 - 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 - for the shipping papers are not required.\nY = Yes, additional information - for the shipping papers are required." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: |- - 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 - minLength: 1 - maxLength: 10 - TransportCategory: - description: |- - Code representing a category of transportation, assigned by a regulation set for each regulated commodity. Each value of this category is associated with a multiplier that is used to calculate a value.This value is then used to determine the placarding to be place on the vehicle or container that holds the related regulated commodity EXAMPLES OF VALUES: - 0 = No multiplier - must use placarding - 1 = Use a multiplier of 50 - 2 = Use a multiplier of 3 - 3 = Use a multiplier of 1 - 4 = Use a multiplier of 0 - do not apply a placard - maximum: 1 - type: string - minLength: 1 - 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: - 0 = No multiplier - must use placarding - 1 = Use a multiplier of 50 - 2 = Use a multiplier of 3 - 3 = Use a multiplier of 1 - 4 = Use a multiplier of 0 - do not apply a placard - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChannelTunnelAcceptedIndicator: - description: |- - ChannelTunnelAcceptedIndicator indicates if the chemical is accepted through channel tunnel or not Y= Accepted through channel tunnel - N=Not accepted through channel tunnel - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChemicalType: - description: |- - A set of chemical records in HMMS that correspond to a sub-set of chemicals for a regulation set, or the entire set of chemicals for a regulation set EXAMPLES OF VALUES: - FREIGHT - TDG - IATA US DOMESTIC AIR - 49CFR - ADR - IATA INTERNATIONAL AIR - maximum: 1 - type: string - minLength: 25 - maxLength: 25 - CAToUSShipmentAllowedIndicator: - description: |- - CAToUSShipmentAllowedIndicator indicates whether this checmical is allowed from CA to US - Applicable only for TDG shipments Y = Permitted from CA to US - N = Not Permitted from CA to US - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: ChemicalDetail - description: Container to hold Chemical details. - ChemicalData_ProperShippingNameDetail: - type: object - required: - - ProperShippingName - properties: - ProperShippingName: - description: The Proper Shipping Name assigned by ADR, CFR or IATA. - type: array - minLength: 1 - maxLength: 250 - xml: - name: ProperShippingNameDetail - description: Container to hold Proper Shipping Name Detail information. It - will be returned if applies for a given chemical record. - maximum: 1 - ChemicalData_PackageQuantityLimitDetail: - type: object - maximum: 1 - properties: - PackageQuantityLimitTypeCode: - description: |- - The type of package quantity limit. It will be returned if applies for a given chemical record. - - Valid values: - CAO - Cargo Aircraft Only - LTD QTY - Limited Quantity - GND - Ground - PAX - Passenger Aircraft - COMAT CAO - Company Material CAO - COMAT LTD - Company Material LTD - COMAT PAX - Company Material PAX - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Quantity: - 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 - minLength: 15 - maxLength: 15 - UOM: - description: |- - The unit of measure used for the mass capacity of the regulated good. - It will be returned if applies for a given chemical record. Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PackagingInstructionCode: - description: The packing instructions related to the chemical record. It - will be returned if applies for a given chemical record. - maximum: 1 - type: string - minLength: 1 - maxLength: 353 - xml: - name: PackageQuantityLimitDetail - DANGEROUSGOODSUTILITYAPCRequestWrapper: - xml: - name: AcceptanceAuditPreCheckRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - AcceptanceAuditPreCheckRequest - properties: - AcceptanceAuditPreCheckRequest: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest" - DANGEROUSGOODSUTILITYAPCResponseWrapper: - xml: - name: AcceptanceAuditPreCheckResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - AcceptanceAuditPreCheckResponse - properties: - AcceptanceAuditPreCheckResponse: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse" - AcceptanceAuditPreCheckRequest: - type: object - required: - - Request - - Shipment - properties: - 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" - type: string - maximum: 1 - Shipment: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment" - xml: - name: AcceptanceAuditPreCheckRequest - maximum: 1 - description: Dangerous Goods Utility Request container for Acceptance Audit - Pre-check. - AcceptanceAuditPreCheckRequest_Request: - type: object - properties: - RequestOption: - 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" - xml: - name: Request - maximum: 1 - description: Contains Dangerous Goods Utility Acceptance Audit Pre-check request - criteria elements. - AcceptanceAuditPreCheckRequest_Shipment: - type: object - maximum: 1 - required: - - ShipToAddress - - ShipFromAddress - - Service - - ShipperNumber - - Package - properties: - ShipperNumber: - 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" - ShipToAddress: - "$ref": "#/components/schemas/Shipment_ShipToAddress" - 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 - Movement\n49CFR = HazMat regulated by US Dept. of Transportation within - the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement." - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - Package: - type: array - maximum: 1000 - items: - "$ref": "#/components/schemas/Shipment_Package" - xml: - name: Shipment - description: Contains shipment information. - Shipment_ShipFromAddress: - type: object - maximum: 1 - properties: - AddressLine: - description: The Ship From street address including name and number (when - applicable). - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: The Ship From city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship From locations state or province code. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostalCode: - description: The Ship From locations postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship From locations country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipFromAddress - required: - - CountryCode - description: Ship From address container. - Shipment_ShipToAddress: - type: object - maximum: 1 - properties: - AddressLine: - description: The Ship To street address including name and number (when applicable). - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: The Ship To city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship To locations state or province code. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostalCode: - description: The Ship To locations postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship To locations country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipToAddress - required: - - CountryCode - description: Ship To address container. - Shipment_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: UPS service type code. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: UPS service type description. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: Service - description: UPS service type. - Shipment_Package: - type: object - maximum: 1 - required: - - ChemicalRecord - - PackageIdentifier - - PackageWeight - properties: - PackageIdentifier: - description: Identifies the package containing Dangerous Goods. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - 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; - 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - OverPackedIndicator: - description: Presence/Absence Indicator. Any value is ignored. Presence - indicates that shipment is over pack. - type: string - 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: - GND, CAO, and PAX." - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - EmergencyPhone: - description: | - 24 Hour Emergency Phone Number of the shipper. - - Valid values for this field are (0) through (9) with trailing blanks. - - For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. The 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) - maximum: 1 - type: string - minLength: 1 - maxLength: 25 - EmergencyContact: - description: |- - The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhone. - - The information is required if there is a value in the EmergencyPhone field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ChemicalRecord: - type: array - maximum: 3 - items: - "$ref": "#/components/schemas/Package_ChemicalRecord" - xml: - name: Package - description: Package Information container. - Package_PackageWeight: - type: object - maximum: 1 - required: - - UnitOfMeasurement - - Weight - properties: - Weight: - description: Packages weight. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - UnitOfMeasurement: - "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" - xml: - name: PackageWeight - description: Container to hold package weight information. - PackageWeight_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - Package weight unit of measurement code. Valid values: - LBS = Pounds - KGS = Kilograms - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the unit of measurement for package weight. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: Container to hold UnitOfMeasurement information for package weight. - Package_ChemicalRecord: - type: object - maximum: 1 - required: - - ChemicalRecordIdentifier - - CommodityRegulatedLevelCode - properties: - ChemicalRecordIdentifier: - description: Identifies the Chemcial Record. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - ClassDivisionNumber: - description: | - This is the hazard class associated to the specified commodity. - - Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - 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). - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - 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 - Number assigned to the specified regulated good. (Include the UN/NA/ID - as part of the entry)." - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - PackagingGroupType: - description: "This is the packing group category associated to the specified - 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" - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Quantity: - description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical - value of the mass capacity of the regulated good. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - UOM: - description: |- - Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. - Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PackagingInstructionCode: - description: The packing instructions related to the chemical record. Required - if CommodityRegulatedLevelCode = LQ or FR and if the field applies to - the material by regulation. - maximum: 1 - type: string - minLength: 1 - maxLength: 353 - ProperShippingName: - description: "The Proper Shipping Name assigned by ADR, CFR or IATA. \n\nRequired - if CommodityRegulatedLevelCode = LR, LQ or FR." - maximum: 1 - type: string - minLength: 1 - maxLength: 250 - TechnicalName: - description: "The technical name (when required) for the specified commodity. - \n\nRequired if CommodityRegulatedLevelCode = LQ or FR and if the field - applies to the material by regulation." - maximum: 1 - type: string - minLength: 1 - maxLength: 300 - AdditionalDescription: - description: | - Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. - - Additional information that may be required by regulation about a hazardous material, such as, “Limited Quantity”, DOT-SP numbers, EX numbers. - maximum: 1 - type: string - minLength: 1 - maxLength: 75 - PackagingType: - description: "The package type code identifying the type of packaging used - for the commodity. (Ex: Fiberboard Box). \nRequired if CommodityRegulatedLevelCode - = LQ or FR." - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - HazardLabelRequired: - description: "Defines the type of label that is required on the package - for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode = - LR or EQ." - maximum: 1 - type: string - minLength: 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" - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - CommodityRegulatedLevelCode: - description: |- - Indicates the type of commodity. Valid values: LR, FR, LQ, EQ - - FR = Fully Regulated - LQ = Limited Quantity - EQ = Excepted Quantity - LR = Lightly Regulated - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - TransportCategory: - description: 'Transport Category. Valid values: 0 to 4' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: Defines what is restricted to pass through a tunnel. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - AllPackedInOneIndicator: - description: Indicates the hazmat shipment/package is all packed in one. - maximum: 1 - type: string - xml: - name: ChemicalRecord - description: Container to hold Chemical Record information. - AcceptanceAuditPreCheckResponse: - type: object - required: - - Response - properties: - 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. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - 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: - ADR - 49CFR - IATA - TDG - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - PackageResults: - description: | - Package Results container. - - **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 - maximum: 20 - items: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_PackageResults" - xml: - name: AcceptanceAuditPreCheckResponse - maximum: 1 - description: Dangerous Goods Utility Response container for Acceptance Audit - Pre-check. - AcceptanceAuditPreCheckResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - AlertDetail: - description: | - Alert Detail Container. - - **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" - - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Contains Dangerous Goods Utility Acceptance Audit Pre-check response - components. - maximum: 1 - Response_AlertDetail: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - ElementLevelInformation: - "$ref": "#/components/schemas/AlertDetail_ElementLevelInformation" - xml: - name: AlertDetail - AlertDetail_ElementLevelInformation: - type: object - maximum: 1 - required: - - Level - properties: - Level: - description: "Define type of element in request. Possible values: \nH - for the header details level\nS for the shipment level\nP for the package - level\nC for the commodity level" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ElementIdentifier: - type: array - items: - "$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier" - xml: - name: ElementLevelInformation - description: Provides more information about the element that represents the - alert. - ElementLevelInformation_ElementIdentifier: - type: object - maximum: 1 - required: - - Value - - Code - properties: - Code: - description: Represents the type of element. Possible values are P and C. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Value: - description: Represents the value of element. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - xml: - name: ElementIdentifier - description: "Contains more information about the type of element. \nReturned - if Level is P or C." - AcceptanceAuditPreCheckResponse_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: UPS service type code. - type: string - xml: - name: Service - description: UPS service type. This is same UPS Service present in the request - that is played back in response. - AcceptanceAuditPreCheckResponse_PackageResults: - type: object - maximum: 1 - required: - - PackageIdentifier - properties: - PackageIdentifier: - description: Identifies the package containing Dangerous Goods. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - AccessibleIndicator: - description: |- - Indicates if a package is crew accessible or not. Y = Package is crew accessible. - N = Package is not crew accessible. - maximum: 1 - type: string - minLength: 1 - 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 - Unit.\nN = Origin country or territory is not in the Europe Business Unit." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChemicalRecordResults: - description: | - Chemical Records Results container. - - **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 - maximum: 3 - items: - "$ref": "#/components/schemas/PackageResults_ChemicalRecordResults" - xml: - name: PackageResults - PackageResults_ChemicalRecordResults: - type: object - maximum: 1 - required: - - ChemicalRecordIdentifier - properties: - ChemicalRecordIdentifier: - description: Identifies the Chemical Record. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - ADRPoints: - description: Total points for the chemical records. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - TransportCategory: - description: 'Transport Category. Valid values: 0 to 4' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: Defines what is restricted to pass through a tunnel. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - ADRUnits: - description: |- - Number of ADR Units (Liters/Kg) - Format: 9999.99 - maximum: 1 - type: string - minLength: 7 - maxLength: 7 - xml: - name: ChemicalRecordResults - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +info: + title: Dangerous Goods Utility + 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 + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +
+

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/dangerousgoods/{version}/chemicalreferencedata": + post: + summary: Chemical Reference Data + tags: + - Dangerous Goods + security: + - OAuth2: [] + description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. + operationId: Chemical Reference Data + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of the API. + + Valid values: + - v2409 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + ChemicalReferenceDataRequest: + IDNumber: UN1088 + ProperShippingName: Acetal + ShipperNumber: Your Shipper Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/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. + tags: + - Dangerous Goods + security: + - OAuth2: [] + summary: Acceptance Audit Pre-check + operationId: Acceptance Audit Pre-Check + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: version + schema: + type: string + default: v3 + description: | + API version + + Valid values: + - v2 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" + examples: + json: + summary: A sample JSON request + value: + AcceptanceAuditPreCheckRequest: + Request: + RequestOption: Request + TransactionReference: + CustomerContext: '' + OriginRecordTransactionTimestamp: " " + Shipment: + ShipperNumber: " " + ShipFromAddress: + AddressLine: 226 ELMWOOD AVE + City: BOGOTA + StateProvinceCode: NJ + PostalCode: '7603' + CountryCode: US + ShipToAddress: + AddressLinde: MY STREET 11 + City: DIEGEM + StateProvinceCode: " " + PostalCode: '1831' + CountryCode: BE + Service: + Code: '01' + Description: 'GROUND ' + RegulationSet: IATA + Package: + PackageIdentifier: '12' + PackageWeight: + Weight: '12' + UnitOfMeasurement: + Code: KGS + Description: KILOS + QValue: '0' + OverPackedIndicator: I + TransportationMode: PAX + EmergencyContact: SELF + ChemicalRecord: + ChemicalRecordIdentifier: '12' + ReportableQuantity: RQ + ClassDivisionNumber: '3' + SubRiskClass: " " + IDNumber: UN2621 + PackagingGroupType: III + Quantity: '10' + UOM: KGS + PackagingInstructionCode: Y344 + ProperShippingName: ACETYL METHYL CARBINOL + TechnicalName: " " + AdditionalDescription: N + PackagingType: Fiberboard Box + HazardLabelRequired: LABEL IT + PackagingTypeQuantity: '22' + CommodityRegulatedLevelCode: LQ + TransportCategory: '3' + TunnelRestrictionCode: '1' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + post: + deprecated: true + summary: Chemical Reference Data + tags: + - Dangerous Goods + security: + - OAuth2: [] + description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. + operationId: Deprecated Chemical Reference Data + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: deprecatedVersion + schema: + type: string + minimum: 1 + default: v1 + description: | + Version of the API. + + Valid values: + - v1 + - v1801. + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + ChemicalReferenceDataRequest: + IDNumber: UN1088 + ProperShippingName: Acetal + ShipperNumber: Your Shipper Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + post: + deprecated: true + tags: + - Dangerous Goods + security: + - OAuth2: [] + description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code. + summary: Acceptance Audit Pre-check + operationId: Deprecated Acceptance Audit Pre-Check + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + API version + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" + examples: + json: + summary: A sample JSON request + value: + AcceptanceAuditPreCheckRequest: + Request: + RequestOption: Request + TransactionReference: + CustomerContext: '' + OriginRecordTransactionTimestamp: " " + Shipment: + ShipperNumber: " " + ShipFromAddress: + AddressLine: 226 ELMWOOD AVE + City: BOGOTA + StateProvinceCode: NJ + PostalCode: '7603' + CountryCode: US + ShipToAddress: + AddressLinde: MY STREET 11 + City: DIEGEM + StateProvinceCode: " " + PostalCode: '1831' + CountryCode: BE + Service: + Code: '01' + Description: 'GROUND ' + RegulationSet: IATA + Package: + PackageIdentifier: '12' + PackageWeight: + Weight: '12' + UnitOfMeasurement: + Code: KGS + Description: KILOS + QValue: '0' + OverPackedIndicator: I + TransportationMode: PAX + EmergencyContact: SELF + ChemicalRecord: + ChemicalRecordIdentifier: '12' + ReportableQuantity: RQ + ClassDivisionNumber: '3' + SubRiskClass: " " + IDNumber: UN2621 + PackagingGroupType: III + Quantity: '10' + UOM: KGS + PackagingInstructionCode: Y344 + ProperShippingName: ACETYL METHYL CARBINOL + TechnicalName: " " + AdditionalDescription: N + PackagingType: Fiberboard Box + HazardLabelRequired: LABEL IT + PackagingTypeQuantity: '22' + CommodityRegulatedLevelCode: LQ + TransportCategory: '3' + TunnelRestrictionCode: '1' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + DANGEROUSGOODSUTILITYRequestWrapper: + xml: + name: ChemicalReferenceDataRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - ChemicalReferenceDataRequest + properties: + ChemicalReferenceDataRequest: + "$ref": "#/components/schemas/ChemicalReferenceDataRequest" + DANGEROUSGOODSUTILITYResponseWrapper: + xml: + name: ChemicalReferenceDataResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - ChemicalReferenceDataResponse + properties: + ChemicalReferenceDataResponse: + "$ref": "#/components/schemas/ChemicalReferenceDataResponse" + ChemicalReferenceDataRequest: + type: object + required: + - Request + - ShipperNumber + properties: + 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 + - IDNumber or ProperShippingName should be provided to retrieve Chemical + Reference Data. + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + ProperShippingName: + 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 + type: string + minLength: 1 + maxLength: 250 + ShipperNumber: + 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 + xml: + name: ChemicalReferenceDataRequest + maximum: 1 + description: Dangerous Goods Utility Request container for Chemical Reference + Data. + ChemicalReferenceDataRequest_Request: + type: object + properties: + RequestOption: + type: array + items: + type: string + description: Enables the user to specify optional processing. Currently, + there is no optional process in Dangerous Goods Utiltiy WS. + minLength: 1 + maxLength: 1 + SubVersion: + description: |- + When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility. + + To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. + + Format: YYMM = Year and month of the release. + + Example: 1801 = 2018 January Supported values: 1801 + type: string + maximum: 1 + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Chemical Reference Data request criteria components. + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + ChemicalReferenceDataResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/ChemicalReferenceDataResponse_Response" + ChemicalData: + description: | + Container to hold Chemical Data 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/ChemicalReferenceDataResponse_ChemicalData" + xml: + name: ChemicalReferenceDataResponse + description: Dangerous Goods Utility Response container for Chemical Reference + Data. + maximum: 1 + ChemicalReferenceDataResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Contains Dangerous Goods Utility Chemical Reference Data response + components. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: 'Identifies the success or failure of the transaction. Valid + values: 0 = Failed and 1 = Successful.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of "Success" or + "Failure". + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response status container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + ChemicalReferenceDataResponse_ChemicalData: + type: object + properties: + ChemicalDetail: + "$ref": "#/components/schemas/ChemicalData_ChemicalDetail" + 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. + + **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" + xml: + name: ChemicalData + ChemicalData_ChemicalDetail: + type: object + maximum: 1 + properties: + RegulationSet: + description: "The Regulatory set associated with every regulated shipment. + \ 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." + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + 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 + for a given chemical record. + maximum: 1 + type: string + minLength: 1 + 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 + chemical record. + maximum: 1 + type: string + minLength: 1 + maxLength: 250 + ClassDivisionNumber: + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + 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 + for a given chemical record. + maximum: 1 + type: string + minLength: 1 + 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" + 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. + + Y = TechnicalName is required. + N = TechnicalName is not required. + maximum: 1 + type: string + minLength: 1 + 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 + for the shipping papers are not required.\nY = Yes, additional information + for the shipping papers are required." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: |- + 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 + minLength: 1 + maxLength: 10 + TransportCategory: + description: |- + Code representing a category of transportation, assigned by a regulation set for each regulated commodity. Each value of this category is associated with a multiplier that is used to calculate a value.This value is then used to determine the placarding to be place on the vehicle or container that holds the related regulated commodity EXAMPLES OF VALUES: + 0 = No multiplier - must use placarding + 1 = Use a multiplier of 50 + 2 = Use a multiplier of 3 + 3 = Use a multiplier of 1 + 4 = Use a multiplier of 0 - do not apply a placard + maximum: 1 + type: string + minLength: 1 + 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: + 0 = No multiplier - must use placarding + 1 = Use a multiplier of 50 + 2 = Use a multiplier of 3 + 3 = Use a multiplier of 1 + 4 = Use a multiplier of 0 - do not apply a placard + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChannelTunnelAcceptedIndicator: + description: |- + ChannelTunnelAcceptedIndicator indicates if the chemical is accepted through channel tunnel or not Y= Accepted through channel tunnel + N=Not accepted through channel tunnel + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChemicalType: + description: |- + A set of chemical records in HMMS that correspond to a sub-set of chemicals for a regulation set, or the entire set of chemicals for a regulation set EXAMPLES OF VALUES: + FREIGHT + TDG + IATA US DOMESTIC AIR + 49CFR + ADR + IATA INTERNATIONAL AIR + maximum: 1 + type: string + minLength: 25 + maxLength: 25 + CAToUSShipmentAllowedIndicator: + description: |- + CAToUSShipmentAllowedIndicator indicates whether this checmical is allowed from CA to US + Applicable only for TDG shipments Y = Permitted from CA to US + N = Not Permitted from CA to US + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: ChemicalDetail + description: Container to hold Chemical details. + ChemicalData_ProperShippingNameDetail: + type: object + required: + - ProperShippingName + properties: + ProperShippingName: + description: The Proper Shipping Name assigned by ADR, CFR or IATA. + type: array + minLength: 1 + maxLength: 250 + xml: + name: ProperShippingNameDetail + description: Container to hold Proper Shipping Name Detail information. It + will be returned if applies for a given chemical record. + maximum: 1 + ChemicalData_PackageQuantityLimitDetail: + type: object + maximum: 1 + properties: + PackageQuantityLimitTypeCode: + description: |- + The type of package quantity limit. It will be returned if applies for a given chemical record. + + Valid values: + CAO - Cargo Aircraft Only + LTD QTY - Limited Quantity + GND - Ground + PAX - Passenger Aircraft + COMAT CAO - Company Material CAO + COMAT LTD - Company Material LTD + COMAT PAX - Company Material PAX + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Quantity: + 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 + minLength: 15 + maxLength: 15 + UOM: + description: |- + The unit of measure used for the mass capacity of the regulated good. + It will be returned if applies for a given chemical record. Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PackagingInstructionCode: + description: The packing instructions related to the chemical record. It + will be returned if applies for a given chemical record. + maximum: 1 + type: string + minLength: 1 + maxLength: 353 + xml: + name: PackageQuantityLimitDetail + DANGEROUSGOODSUTILITYAPCRequestWrapper: + xml: + name: AcceptanceAuditPreCheckRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - AcceptanceAuditPreCheckRequest + properties: + AcceptanceAuditPreCheckRequest: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest" + DANGEROUSGOODSUTILITYAPCResponseWrapper: + xml: + name: AcceptanceAuditPreCheckResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - AcceptanceAuditPreCheckResponse + properties: + AcceptanceAuditPreCheckResponse: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse" + AcceptanceAuditPreCheckRequest: + type: object + required: + - Request + - Shipment + properties: + 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" + type: string + maximum: 1 + Shipment: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment" + xml: + name: AcceptanceAuditPreCheckRequest + maximum: 1 + description: Dangerous Goods Utility Request container for Acceptance Audit + Pre-check. + AcceptanceAuditPreCheckRequest_Request: + type: object + properties: + RequestOption: + 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" + xml: + name: Request + maximum: 1 + description: Contains Dangerous Goods Utility Acceptance Audit Pre-check request + criteria elements. + AcceptanceAuditPreCheckRequest_Shipment: + type: object + maximum: 1 + required: + - ShipToAddress + - ShipFromAddress + - Service + - ShipperNumber + - Package + properties: + ShipperNumber: + 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" + ShipToAddress: + "$ref": "#/components/schemas/Shipment_ShipToAddress" + 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 + Movement\n49CFR = HazMat regulated by US Dept. of Transportation within + the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement." + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + Package: + type: array + maximum: 1000 + items: + "$ref": "#/components/schemas/Shipment_Package" + xml: + name: Shipment + description: Contains shipment information. + Shipment_ShipFromAddress: + type: object + maximum: 1 + properties: + AddressLine: + description: The Ship From street address including name and number (when + applicable). + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: The Ship From city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship From locations state or province code. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostalCode: + description: The Ship From locations postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship From locations country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipFromAddress + required: + - CountryCode + description: Ship From address container. + Shipment_ShipToAddress: + type: object + maximum: 1 + properties: + AddressLine: + description: The Ship To street address including name and number (when applicable). + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: The Ship To city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship To locations state or province code. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostalCode: + description: The Ship To locations postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship To locations country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipToAddress + required: + - CountryCode + description: Ship To address container. + Shipment_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: UPS service type code. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: UPS service type description. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: Service + description: UPS service type. + Shipment_Package: + type: object + maximum: 1 + required: + - ChemicalRecord + - PackageIdentifier + - PackageWeight + properties: + PackageIdentifier: + description: Identifies the package containing Dangerous Goods. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + 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; + 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + OverPackedIndicator: + description: Presence/Absence Indicator. Any value is ignored. Presence + indicates that shipment is over pack. + type: string + 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: + GND, CAO, and PAX." + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + EmergencyPhone: + description: | + 24 Hour Emergency Phone Number of the shipper. + + Valid values for this field are (0) through (9) with trailing blanks. + + For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. The 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) + maximum: 1 + type: string + minLength: 1 + maxLength: 25 + EmergencyContact: + description: |- + The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhone. + + The information is required if there is a value in the EmergencyPhone field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ChemicalRecord: + type: array + maximum: 3 + items: + "$ref": "#/components/schemas/Package_ChemicalRecord" + xml: + name: Package + description: Package Information container. + Package_PackageWeight: + type: object + maximum: 1 + required: + - UnitOfMeasurement + - Weight + properties: + Weight: + description: Packages weight. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + UnitOfMeasurement: + "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" + xml: + name: PackageWeight + description: Container to hold package weight information. + PackageWeight_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + Package weight unit of measurement code. Valid values: + LBS = Pounds + KGS = Kilograms + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the unit of measurement for package weight. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: Container to hold UnitOfMeasurement information for package weight. + Package_ChemicalRecord: + type: object + maximum: 1 + required: + - ChemicalRecordIdentifier + - CommodityRegulatedLevelCode + properties: + ChemicalRecordIdentifier: + description: Identifies the Chemcial Record. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + ClassDivisionNumber: + description: | + This is the hazard class associated to the specified commodity. + + Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + 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). + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + 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 + Number assigned to the specified regulated good. (Include the UN/NA/ID + as part of the entry)." + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + PackagingGroupType: + description: "This is the packing group category associated to the specified + 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" + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Quantity: + description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical + value of the mass capacity of the regulated good. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + UOM: + description: |- + Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. + Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PackagingInstructionCode: + description: The packing instructions related to the chemical record. Required + if CommodityRegulatedLevelCode = LQ or FR and if the field applies to + the material by regulation. + maximum: 1 + type: string + minLength: 1 + maxLength: 353 + ProperShippingName: + description: "The Proper Shipping Name assigned by ADR, CFR or IATA. \n\nRequired + if CommodityRegulatedLevelCode = LR, LQ or FR." + maximum: 1 + type: string + minLength: 1 + maxLength: 250 + TechnicalName: + description: "The technical name (when required) for the specified commodity. + \n\nRequired if CommodityRegulatedLevelCode = LQ or FR and if the field + applies to the material by regulation." + maximum: 1 + type: string + minLength: 1 + maxLength: 300 + AdditionalDescription: + description: | + Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. + + Additional information that may be required by regulation about a hazardous material, such as, “Limited Quantity”, DOT-SP numbers, EX numbers. + maximum: 1 + type: string + minLength: 1 + maxLength: 75 + PackagingType: + description: "The package type code identifying the type of packaging used + for the commodity. (Ex: Fiberboard Box). \nRequired if CommodityRegulatedLevelCode + = LQ or FR." + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + HazardLabelRequired: + description: "Defines the type of label that is required on the package + for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode = + LR or EQ." + maximum: 1 + type: string + minLength: 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" + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + CommodityRegulatedLevelCode: + description: |- + Indicates the type of commodity. Valid values: LR, FR, LQ, EQ + + FR = Fully Regulated + LQ = Limited Quantity + EQ = Excepted Quantity + LR = Lightly Regulated + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + TransportCategory: + description: 'Transport Category. Valid values: 0 to 4' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: Defines what is restricted to pass through a tunnel. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + AllPackedInOneIndicator: + description: Indicates the hazmat shipment/package is all packed in one. + maximum: 1 + type: string + xml: + name: ChemicalRecord + description: Container to hold Chemical Record information. + AcceptanceAuditPreCheckResponse: + type: object + required: + - Response + properties: + 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. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + 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: + ADR + 49CFR + IATA + TDG + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + PackageResults: + description: | + Package Results container. + + **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 + maximum: 20 + items: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_PackageResults" + xml: + name: AcceptanceAuditPreCheckResponse + maximum: 1 + description: Dangerous Goods Utility Response container for Acceptance Audit + Pre-check. + AcceptanceAuditPreCheckResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + AlertDetail: + description: | + Alert Detail Container. + + **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" + + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Contains Dangerous Goods Utility Acceptance Audit Pre-check response + components. + maximum: 1 + Response_AlertDetail: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + ElementLevelInformation: + "$ref": "#/components/schemas/AlertDetail_ElementLevelInformation" + xml: + name: AlertDetail + AlertDetail_ElementLevelInformation: + type: object + maximum: 1 + required: + - Level + properties: + Level: + description: "Define type of element in request. Possible values: \nH + for the header details level\nS for the shipment level\nP for the package + level\nC for the commodity level" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ElementIdentifier: + type: array + items: + "$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier" + xml: + name: ElementLevelInformation + description: Provides more information about the element that represents the + alert. + ElementLevelInformation_ElementIdentifier: + type: object + maximum: 1 + required: + - Value + - Code + properties: + Code: + description: Represents the type of element. Possible values are P and C. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Value: + description: Represents the value of element. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + xml: + name: ElementIdentifier + description: "Contains more information about the type of element. \nReturned + if Level is P or C." + AcceptanceAuditPreCheckResponse_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: UPS service type code. + type: string + xml: + name: Service + description: UPS service type. This is same UPS Service present in the request + that is played back in response. + AcceptanceAuditPreCheckResponse_PackageResults: + type: object + maximum: 1 + required: + - PackageIdentifier + properties: + PackageIdentifier: + description: Identifies the package containing Dangerous Goods. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + AccessibleIndicator: + description: |- + Indicates if a package is crew accessible or not. Y = Package is crew accessible. + N = Package is not crew accessible. + maximum: 1 + type: string + minLength: 1 + 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 + Unit.\nN = Origin country or territory is not in the Europe Business Unit." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChemicalRecordResults: + description: | + Chemical Records Results container. + + **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 + maximum: 3 + items: + "$ref": "#/components/schemas/PackageResults_ChemicalRecordResults" + xml: + name: PackageResults + PackageResults_ChemicalRecordResults: + type: object + maximum: 1 + required: + - ChemicalRecordIdentifier + properties: + ChemicalRecordIdentifier: + description: Identifies the Chemical Record. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + ADRPoints: + description: Total points for the chemical records. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + TransportCategory: + description: 'Transport Category. Valid values: 0 to 4' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: Defines what is restricted to pass through a tunnel. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + ADRUnits: + description: |- + Number of ADR Units (Liters/Kg) + Format: 9999.99 + maximum: 1 + type: string + minLength: 7 + maxLength: 7 + xml: + name: ChemicalRecordResults + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/DangerousGoods.yaml b/DangerousGoods.yaml index 14e2b99..5f09660 100644 --- a/DangerousGoods.yaml +++ b/DangerousGoods.yaml @@ -1,1637 +1,1637 @@ -openapi: 3.0.3 -info: - title: Dangerous Goods Utility - 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/dangerousgoods/{version}/chemicalreferencedata": - post: - summary: Chemical Reference Data - tags: - - Dangerous Goods - security: - - OAuth2: [] - description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. - operationId: Chemical Reference Data - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of the API. - - Valid values: - - v2409 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - ChemicalReferenceDataRequest: - IDNumber: UN1088 - ProperShippingName: Acetal - ShipperNumber: Your Shipper Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/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. - tags: - - Dangerous Goods - security: - - OAuth2: [] - summary: Acceptance Audit Pre-check - operationId: Acceptance Audit Pre-Check - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: version - schema: - type: string - default: v3 - description: | - API version - - Valid values: - - v2 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" - examples: - json: - summary: A sample JSON request - value: - AcceptanceAuditPreCheckRequest: - Request: - RequestOption: Request - TransactionReference: - CustomerContext: '' - OriginRecordTransactionTimestamp: " " - Shipment: - ShipperNumber: " " - ShipFromAddress: - AddressLine: 226 ELMWOOD AVE - City: BOGOTA - StateProvinceCode: NJ - PostalCode: '7603' - CountryCode: US - ShipToAddress: - AddressLinde: MY STREET 11 - City: DIEGEM - StateProvinceCode: " " - PostalCode: '1831' - CountryCode: BE - Service: - Code: '01' - Description: 'GROUND ' - RegulationSet: IATA - Package: - PackageIdentifier: '12' - PackageWeight: - Weight: '12' - UnitOfMeasurement: - Code: KGS - Description: KILOS - QValue: '0' - OverPackedIndicator: I - TransportationMode: PAX - EmergencyContact: SELF - ChemicalRecord: - ChemicalRecordIdentifier: '12' - ReportableQuantity: RQ - ClassDivisionNumber: '3' - SubRiskClass: " " - IDNumber: UN2621 - PackagingGroupType: III - Quantity: '10' - UOM: KGS - PackagingInstructionCode: Y344 - ProperShippingName: ACETYL METHYL CARBINOL - TechnicalName: " " - AdditionalDescription: N - PackagingType: Fiberboard Box - HazardLabelRequired: LABEL IT - PackagingTypeQuantity: '22' - CommodityRegulatedLevelCode: LQ - TransportCategory: '3' - TunnelRestrictionCode: '1' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - post: - deprecated: true - summary: Chemical Reference Data - tags: - - Dangerous Goods - security: - - OAuth2: [] - description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. - operationId: Deprecated Chemical Reference Data - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: deprecatedVersion - schema: - type: string - minimum: 1 - default: v1 - description: | - Version of the API. - - Valid values: - - v1 - - v1801. - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - ChemicalReferenceDataRequest: - IDNumber: UN1088 - ProperShippingName: Acetal - ShipperNumber: Your Shipper Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - post: - deprecated: true - tags: - - Dangerous Goods - security: - - OAuth2: [] - description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code. - summary: Acceptance Audit Pre-check - operationId: Deprecated Acceptance Audit Pre-Check - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - API version - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" - examples: - json: - summary: A sample JSON request - value: - AcceptanceAuditPreCheckRequest: - Request: - RequestOption: Request - TransactionReference: - CustomerContext: '' - OriginRecordTransactionTimestamp: " " - Shipment: - ShipperNumber: " " - ShipFromAddress: - AddressLine: 226 ELMWOOD AVE - City: BOGOTA - StateProvinceCode: NJ - PostalCode: '7603' - CountryCode: US - ShipToAddress: - AddressLinde: MY STREET 11 - City: DIEGEM - StateProvinceCode: " " - PostalCode: '1831' - CountryCode: BE - Service: - Code: '01' - Description: 'GROUND ' - RegulationSet: IATA - Package: - PackageIdentifier: '12' - PackageWeight: - Weight: '12' - UnitOfMeasurement: - Code: KGS - Description: KILOS - QValue: '0' - OverPackedIndicator: I - TransportationMode: PAX - EmergencyContact: SELF - ChemicalRecord: - ChemicalRecordIdentifier: '12' - ReportableQuantity: RQ - ClassDivisionNumber: '3' - SubRiskClass: " " - IDNumber: UN2621 - PackagingGroupType: III - Quantity: '10' - UOM: KGS - PackagingInstructionCode: Y344 - ProperShippingName: ACETYL METHYL CARBINOL - TechnicalName: " " - AdditionalDescription: N - PackagingType: Fiberboard Box - HazardLabelRequired: LABEL IT - PackagingTypeQuantity: '22' - CommodityRegulatedLevelCode: LQ - TransportCategory: '3' - TunnelRestrictionCode: '1' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - DANGEROUSGOODSUTILITYRequestWrapper: - xml: - name: ChemicalReferenceDataRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - ChemicalReferenceDataRequest - properties: - ChemicalReferenceDataRequest: - "$ref": "#/components/schemas/ChemicalReferenceDataRequest" - DANGEROUSGOODSUTILITYResponseWrapper: - xml: - name: ChemicalReferenceDataResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - ChemicalReferenceDataResponse - properties: - ChemicalReferenceDataResponse: - "$ref": "#/components/schemas/ChemicalReferenceDataResponse" - ChemicalReferenceDataRequest: - type: object - required: - - Request - - ShipperNumber - properties: - 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 - - IDNumber or ProperShippingName should be provided to retrieve Chemical - Reference Data. - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - ProperShippingName: - 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 - type: string - minLength: 1 - maxLength: 250 - ShipperNumber: - 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 - xml: - name: ChemicalReferenceDataRequest - maximum: 1 - description: Dangerous Goods Utility Request container for Chemical Reference - Data. - ChemicalReferenceDataRequest_Request: - type: object - properties: - RequestOption: - type: array - items: - type: string - description: Enables the user to specify optional processing. Currently, - there is no optional process in Dangerous Goods Utiltiy WS. - minLength: 1 - maxLength: 1 - SubVersion: - description: |- - When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility. - - To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. - - Format: YYMM = Year and month of the release. - - Example: 1801 = 2018 January Supported values: 1801 - type: string - maximum: 1 - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Chemical Reference Data request criteria components. - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - ChemicalReferenceDataResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/ChemicalReferenceDataResponse_Response" - ChemicalData: - description: | - Container to hold Chemical Data 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/ChemicalReferenceDataResponse_ChemicalData" - xml: - name: ChemicalReferenceDataResponse - description: Dangerous Goods Utility Response container for Chemical Reference - Data. - maximum: 1 - ChemicalReferenceDataResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Contains Dangerous Goods Utility Chemical Reference Data response - components. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: 'Identifies the success or failure of the transaction. Valid - values: 0 = Failed and 1 = Successful.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of "Success" or - "Failure". - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response status container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - ChemicalReferenceDataResponse_ChemicalData: - type: object - properties: - ChemicalDetail: - "$ref": "#/components/schemas/ChemicalData_ChemicalDetail" - 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. - - **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" - xml: - name: ChemicalData - ChemicalData_ChemicalDetail: - type: object - maximum: 1 - properties: - RegulationSet: - description: "The Regulatory set associated with every regulated shipment. - \ 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." - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - 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 - for a given chemical record. - maximum: 1 - type: string - minLength: 1 - 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 - chemical record. - maximum: 1 - type: string - minLength: 1 - maxLength: 250 - ClassDivisionNumber: - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - 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 - for a given chemical record. - maximum: 1 - type: string - minLength: 1 - 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" - 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. - - Y = TechnicalName is required. - N = TechnicalName is not required. - maximum: 1 - type: string - minLength: 1 - 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 - for the shipping papers are not required.\nY = Yes, additional information - for the shipping papers are required." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: |- - 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 - minLength: 1 - maxLength: 10 - TransportCategory: - description: |- - Code representing a category of transportation, assigned by a regulation set for each regulated commodity. Each value of this category is associated with a multiplier that is used to calculate a value.This value is then used to determine the placarding to be place on the vehicle or container that holds the related regulated commodity EXAMPLES OF VALUES: - 0 = No multiplier - must use placarding - 1 = Use a multiplier of 50 - 2 = Use a multiplier of 3 - 3 = Use a multiplier of 1 - 4 = Use a multiplier of 0 - do not apply a placard - maximum: 1 - type: string - minLength: 1 - 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: - 0 = No multiplier - must use placarding - 1 = Use a multiplier of 50 - 2 = Use a multiplier of 3 - 3 = Use a multiplier of 1 - 4 = Use a multiplier of 0 - do not apply a placard - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChannelTunnelAcceptedIndicator: - description: |- - ChannelTunnelAcceptedIndicator indicates if the chemical is accepted through channel tunnel or not Y= Accepted through channel tunnel - N=Not accepted through channel tunnel - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChemicalType: - description: |- - A set of chemical records in HMMS that correspond to a sub-set of chemicals for a regulation set, or the entire set of chemicals for a regulation set EXAMPLES OF VALUES: - FREIGHT - TDG - IATA US DOMESTIC AIR - 49CFR - ADR - IATA INTERNATIONAL AIR - maximum: 1 - type: string - minLength: 25 - maxLength: 25 - CAToUSShipmentAllowedIndicator: - description: |- - CAToUSShipmentAllowedIndicator indicates whether this checmical is allowed from CA to US - Applicable only for TDG shipments Y = Permitted from CA to US - N = Not Permitted from CA to US - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: ChemicalDetail - description: Container to hold Chemical details. - ChemicalData_ProperShippingNameDetail: - type: object - required: - - ProperShippingName - properties: - ProperShippingName: - description: The Proper Shipping Name assigned by ADR, CFR or IATA. - type: array - minLength: 1 - maxLength: 250 - xml: - name: ProperShippingNameDetail - description: Container to hold Proper Shipping Name Detail information. It - will be returned if applies for a given chemical record. - maximum: 1 - ChemicalData_PackageQuantityLimitDetail: - type: object - maximum: 1 - properties: - PackageQuantityLimitTypeCode: - description: |- - The type of package quantity limit. It will be returned if applies for a given chemical record. - - Valid values: - CAO - Cargo Aircraft Only - LTD QTY - Limited Quantity - GND - Ground - PAX - Passenger Aircraft - COMAT CAO - Company Material CAO - COMAT LTD - Company Material LTD - COMAT PAX - Company Material PAX - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Quantity: - 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 - minLength: 15 - maxLength: 15 - UOM: - description: |- - The unit of measure used for the mass capacity of the regulated good. - It will be returned if applies for a given chemical record. Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PackagingInstructionCode: - description: The packing instructions related to the chemical record. It - will be returned if applies for a given chemical record. - maximum: 1 - type: string - minLength: 1 - maxLength: 353 - xml: - name: PackageQuantityLimitDetail - DANGEROUSGOODSUTILITYAPCRequestWrapper: - xml: - name: AcceptanceAuditPreCheckRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - AcceptanceAuditPreCheckRequest - properties: - AcceptanceAuditPreCheckRequest: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest" - DANGEROUSGOODSUTILITYAPCResponseWrapper: - xml: - name: AcceptanceAuditPreCheckResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - AcceptanceAuditPreCheckResponse - properties: - AcceptanceAuditPreCheckResponse: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse" - AcceptanceAuditPreCheckRequest: - type: object - required: - - Request - - Shipment - properties: - 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" - type: string - maximum: 1 - Shipment: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment" - xml: - name: AcceptanceAuditPreCheckRequest - maximum: 1 - description: Dangerous Goods Utility Request container for Acceptance Audit - Pre-check. - AcceptanceAuditPreCheckRequest_Request: - type: object - properties: - RequestOption: - 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" - xml: - name: Request - maximum: 1 - description: Contains Dangerous Goods Utility Acceptance Audit Pre-check request - criteria elements. - AcceptanceAuditPreCheckRequest_Shipment: - type: object - maximum: 1 - required: - - ShipToAddress - - ShipFromAddress - - Service - - ShipperNumber - - Package - properties: - ShipperNumber: - 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" - ShipToAddress: - "$ref": "#/components/schemas/Shipment_ShipToAddress" - 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 - Movement\n49CFR = HazMat regulated by US Dept. of Transportation within - the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement." - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - Package: - type: array - maximum: 1000 - items: - "$ref": "#/components/schemas/Shipment_Package" - xml: - name: Shipment - description: Contains shipment information. - Shipment_ShipFromAddress: - type: object - maximum: 1 - properties: - AddressLine: - description: The Ship From street address including name and number (when - applicable). - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: The Ship From city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship From locations state or province code. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostalCode: - description: The Ship From locations postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship From locations country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipFromAddress - required: - - CountryCode - description: Ship From address container. - Shipment_ShipToAddress: - type: object - maximum: 1 - properties: - AddressLine: - description: The Ship To street address including name and number (when applicable). - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: The Ship To city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship To locations state or province code. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PostalCode: - description: The Ship To locations postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship To locations country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipToAddress - required: - - CountryCode - description: Ship To address container. - Shipment_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: UPS service type code. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: UPS service type description. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: Service - description: UPS service type. - Shipment_Package: - type: object - maximum: 1 - required: - - ChemicalRecord - - PackageIdentifier - - PackageWeight - properties: - PackageIdentifier: - description: Identifies the package containing Dangerous Goods. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - 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; - 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - OverPackedIndicator: - description: Presence/Absence Indicator. Any value is ignored. Presence - indicates that shipment is over pack. - type: string - 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: - GND, CAO, and PAX." - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - EmergencyPhone: - description: | - 24 Hour Emergency Phone Number of the shipper. - - Valid values for this field are (0) through (9) with trailing blanks. - - For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. The 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) - maximum: 1 - type: string - minLength: 1 - maxLength: 25 - EmergencyContact: - description: |- - The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhone. - - The information is required if there is a value in the EmergencyPhone field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ChemicalRecord: - type: array - maximum: 3 - items: - "$ref": "#/components/schemas/Package_ChemicalRecord" - xml: - name: Package - description: Package Information container. - Package_PackageWeight: - type: object - maximum: 1 - required: - - UnitOfMeasurement - - Weight - properties: - Weight: - description: Packages weight. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - UnitOfMeasurement: - "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" - xml: - name: PackageWeight - description: Container to hold package weight information. - PackageWeight_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - Package weight unit of measurement code. Valid values: - LBS = Pounds - KGS = Kilograms - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the unit of measurement for package weight. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: Container to hold UnitOfMeasurement information for package weight. - Package_ChemicalRecord: - type: object - maximum: 1 - required: - - ChemicalRecordIdentifier - - CommodityRegulatedLevelCode - properties: - ChemicalRecordIdentifier: - description: Identifies the Chemcial Record. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - ClassDivisionNumber: - description: | - This is the hazard class associated to the specified commodity. - - Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - 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). - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - 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 - Number assigned to the specified regulated good. (Include the UN/NA/ID - as part of the entry)." - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - PackagingGroupType: - description: "This is the packing group category associated to the specified - 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" - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Quantity: - description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical - value of the mass capacity of the regulated good. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - UOM: - description: |- - Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. - Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PackagingInstructionCode: - description: The packing instructions related to the chemical record. Required - if CommodityRegulatedLevelCode = LQ or FR and if the field applies to - the material by regulation. - maximum: 1 - type: string - minLength: 1 - maxLength: 353 - ProperShippingName: - description: "The Proper Shipping Name assigned by ADR, CFR or IATA. \n\nRequired - if CommodityRegulatedLevelCode = LR, LQ or FR." - maximum: 1 - type: string - minLength: 1 - maxLength: 250 - TechnicalName: - description: "The technical name (when required) for the specified commodity. - \n\nRequired if CommodityRegulatedLevelCode = LQ or FR and if the field - applies to the material by regulation." - maximum: 1 - type: string - minLength: 1 - maxLength: 300 - AdditionalDescription: - description: | - Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. - - Additional information that may be required by regulation about a hazardous material, such as, “Limited Quantity”, DOT-SP numbers, EX numbers. - maximum: 1 - type: string - minLength: 1 - maxLength: 75 - PackagingType: - description: "The package type code identifying the type of packaging used - for the commodity. (Ex: Fiberboard Box). \nRequired if CommodityRegulatedLevelCode - = LQ or FR." - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - HazardLabelRequired: - description: "Defines the type of label that is required on the package - for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode = - LR or EQ." - maximum: 1 - type: string - minLength: 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" - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - CommodityRegulatedLevelCode: - description: |- - Indicates the type of commodity. Valid values: LR, FR, LQ, EQ - - FR = Fully Regulated - LQ = Limited Quantity - EQ = Excepted Quantity - LR = Lightly Regulated - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - TransportCategory: - description: 'Transport Category. Valid values: 0 to 4' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: Defines what is restricted to pass through a tunnel. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - AllPackedInOneIndicator: - description: Indicates the hazmat shipment/package is all packed in one. - maximum: 1 - type: string - xml: - name: ChemicalRecord - description: Container to hold Chemical Record information. - AcceptanceAuditPreCheckResponse: - type: object - required: - - Response - properties: - 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. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - 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: - ADR - 49CFR - IATA - TDG - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - PackageResults: - description: | - Package Results container. - - **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 - maximum: 20 - items: - "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_PackageResults" - xml: - name: AcceptanceAuditPreCheckResponse - maximum: 1 - description: Dangerous Goods Utility Response container for Acceptance Audit - Pre-check. - AcceptanceAuditPreCheckResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - AlertDetail: - description: | - Alert Detail Container. - - **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" - - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Contains Dangerous Goods Utility Acceptance Audit Pre-check response - components. - maximum: 1 - Response_AlertDetail: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - ElementLevelInformation: - "$ref": "#/components/schemas/AlertDetail_ElementLevelInformation" - xml: - name: AlertDetail - AlertDetail_ElementLevelInformation: - type: object - maximum: 1 - required: - - Level - properties: - Level: - description: "Define type of element in request. Possible values: \nH - for the header details level\nS for the shipment level\nP for the package - level\nC for the commodity level" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ElementIdentifier: - type: array - items: - "$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier" - xml: - name: ElementLevelInformation - description: Provides more information about the element that represents the - alert. - ElementLevelInformation_ElementIdentifier: - type: object - maximum: 1 - required: - - Value - - Code - properties: - Code: - description: Represents the type of element. Possible values are P and C. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Value: - description: Represents the value of element. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - xml: - name: ElementIdentifier - description: "Contains more information about the type of element. \nReturned - if Level is P or C." - AcceptanceAuditPreCheckResponse_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: UPS service type code. - type: string - xml: - name: Service - description: UPS service type. This is same UPS Service present in the request - that is played back in response. - AcceptanceAuditPreCheckResponse_PackageResults: - type: object - maximum: 1 - required: - - PackageIdentifier - properties: - PackageIdentifier: - description: Identifies the package containing Dangerous Goods. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - AccessibleIndicator: - description: |- - Indicates if a package is crew accessible or not. Y = Package is crew accessible. - N = Package is not crew accessible. - maximum: 1 - type: string - minLength: 1 - 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 - Unit.\nN = Origin country or territory is not in the Europe Business Unit." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChemicalRecordResults: - description: | - Chemical Records Results container. - - **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 - maximum: 3 - items: - "$ref": "#/components/schemas/PackageResults_ChemicalRecordResults" - xml: - name: PackageResults - PackageResults_ChemicalRecordResults: - type: object - maximum: 1 - required: - - ChemicalRecordIdentifier - properties: - ChemicalRecordIdentifier: - description: Identifies the Chemical Record. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - ADRPoints: - description: Total points for the chemical records. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - TransportCategory: - description: 'Transport Category. Valid values: 0 to 4' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: Defines what is restricted to pass through a tunnel. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - ADRUnits: - description: |- - Number of ADR Units (Liters/Kg) - Format: 9999.99 - maximum: 1 - type: string - minLength: 7 - maxLength: 7 - xml: - name: ChemicalRecordResults - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +info: + title: Dangerous Goods Utility + 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/dangerousgoods/{version}/chemicalreferencedata": + post: + summary: Chemical Reference Data + tags: + - Dangerous Goods + security: + - OAuth2: [] + description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. + operationId: Chemical Reference Data + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of the API. + + Valid values: + - v2409 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + ChemicalReferenceDataRequest: + IDNumber: UN1088 + ProperShippingName: Acetal + ShipperNumber: Your Shipper Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/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. + tags: + - Dangerous Goods + security: + - OAuth2: [] + summary: Acceptance Audit Pre-check + operationId: Acceptance Audit Pre-Check + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: version + schema: + type: string + default: v3 + description: | + API version + + Valid values: + - v2 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" + examples: + json: + summary: A sample JSON request + value: + AcceptanceAuditPreCheckRequest: + Request: + RequestOption: Request + TransactionReference: + CustomerContext: '' + OriginRecordTransactionTimestamp: " " + Shipment: + ShipperNumber: " " + ShipFromAddress: + AddressLine: 226 ELMWOOD AVE + City: BOGOTA + StateProvinceCode: NJ + PostalCode: '7603' + CountryCode: US + ShipToAddress: + AddressLinde: MY STREET 11 + City: DIEGEM + StateProvinceCode: " " + PostalCode: '1831' + CountryCode: BE + Service: + Code: '01' + Description: 'GROUND ' + RegulationSet: IATA + Package: + PackageIdentifier: '12' + PackageWeight: + Weight: '12' + UnitOfMeasurement: + Code: KGS + Description: KILOS + QValue: '0' + OverPackedIndicator: I + TransportationMode: PAX + EmergencyContact: SELF + ChemicalRecord: + ChemicalRecordIdentifier: '12' + ReportableQuantity: RQ + ClassDivisionNumber: '3' + SubRiskClass: " " + IDNumber: UN2621 + PackagingGroupType: III + Quantity: '10' + UOM: KGS + PackagingInstructionCode: Y344 + ProperShippingName: ACETYL METHYL CARBINOL + TechnicalName: " " + AdditionalDescription: N + PackagingType: Fiberboard Box + HazardLabelRequired: LABEL IT + PackagingTypeQuantity: '22' + CommodityRegulatedLevelCode: LQ + TransportCategory: '3' + TunnelRestrictionCode: '1' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + post: + deprecated: true + summary: Chemical Reference Data + tags: + - Dangerous Goods + security: + - OAuth2: [] + description: The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated good. + operationId: Deprecated Chemical Reference Data + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: deprecatedVersion + schema: + type: string + minimum: 1 + default: v1 + description: | + Version of the API. + + Valid values: + - v1 + - v1801. + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + ChemicalReferenceDataRequest: + IDNumber: UN1088 + ProperShippingName: Acetal + ShipperNumber: Your Shipper Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + post: + deprecated: true + tags: + - Dangerous Goods + security: + - OAuth2: [] + description: Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code. + summary: Acceptance Audit Pre-check + operationId: Deprecated Acceptance Audit Pre-Check + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + API version + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCRequestWrapper" + examples: + json: + summary: A sample JSON request + value: + AcceptanceAuditPreCheckRequest: + Request: + RequestOption: Request + TransactionReference: + CustomerContext: '' + OriginRecordTransactionTimestamp: " " + Shipment: + ShipperNumber: " " + ShipFromAddress: + AddressLine: 226 ELMWOOD AVE + City: BOGOTA + StateProvinceCode: NJ + PostalCode: '7603' + CountryCode: US + ShipToAddress: + AddressLinde: MY STREET 11 + City: DIEGEM + StateProvinceCode: " " + PostalCode: '1831' + CountryCode: BE + Service: + Code: '01' + Description: 'GROUND ' + RegulationSet: IATA + Package: + PackageIdentifier: '12' + PackageWeight: + Weight: '12' + UnitOfMeasurement: + Code: KGS + Description: KILOS + QValue: '0' + OverPackedIndicator: I + TransportationMode: PAX + EmergencyContact: SELF + ChemicalRecord: + ChemicalRecordIdentifier: '12' + ReportableQuantity: RQ + ClassDivisionNumber: '3' + SubRiskClass: " " + IDNumber: UN2621 + PackagingGroupType: III + Quantity: '10' + UOM: KGS + PackagingInstructionCode: Y344 + ProperShippingName: ACETYL METHYL CARBINOL + TechnicalName: " " + AdditionalDescription: N + PackagingType: Fiberboard Box + HazardLabelRequired: LABEL IT + PackagingTypeQuantity: '22' + CommodityRegulatedLevelCode: LQ + TransportCategory: '3' + TunnelRestrictionCode: '1' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/DANGEROUSGOODSUTILITYAPCResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + DANGEROUSGOODSUTILITYRequestWrapper: + xml: + name: ChemicalReferenceDataRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - ChemicalReferenceDataRequest + properties: + ChemicalReferenceDataRequest: + "$ref": "#/components/schemas/ChemicalReferenceDataRequest" + DANGEROUSGOODSUTILITYResponseWrapper: + xml: + name: ChemicalReferenceDataResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - ChemicalReferenceDataResponse + properties: + ChemicalReferenceDataResponse: + "$ref": "#/components/schemas/ChemicalReferenceDataResponse" + ChemicalReferenceDataRequest: + type: object + required: + - Request + - ShipperNumber + properties: + 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 + - IDNumber or ProperShippingName should be provided to retrieve Chemical + Reference Data. + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + ProperShippingName: + 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 + type: string + minLength: 1 + maxLength: 250 + ShipperNumber: + 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 + xml: + name: ChemicalReferenceDataRequest + maximum: 1 + description: Dangerous Goods Utility Request container for Chemical Reference + Data. + ChemicalReferenceDataRequest_Request: + type: object + properties: + RequestOption: + type: array + items: + type: string + description: Enables the user to specify optional processing. Currently, + there is no optional process in Dangerous Goods Utiltiy WS. + minLength: 1 + maxLength: 1 + SubVersion: + description: |- + When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility. + + To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. + + Format: YYMM = Year and month of the release. + + Example: 1801 = 2018 January Supported values: 1801 + type: string + maximum: 1 + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Chemical Reference Data request criteria components. + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + ChemicalReferenceDataResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/ChemicalReferenceDataResponse_Response" + ChemicalData: + description: | + Container to hold Chemical Data 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/ChemicalReferenceDataResponse_ChemicalData" + xml: + name: ChemicalReferenceDataResponse + description: Dangerous Goods Utility Response container for Chemical Reference + Data. + maximum: 1 + ChemicalReferenceDataResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1. + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Contains Dangerous Goods Utility Chemical Reference Data response + components. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: 'Identifies the success or failure of the transaction. Valid + values: 0 = Failed and 1 = Successful.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of "Success" or + "Failure". + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response status container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + ChemicalReferenceDataResponse_ChemicalData: + type: object + properties: + ChemicalDetail: + "$ref": "#/components/schemas/ChemicalData_ChemicalDetail" + 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. + + **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" + xml: + name: ChemicalData + ChemicalData_ChemicalDetail: + type: object + maximum: 1 + properties: + RegulationSet: + description: "The Regulatory set associated with every regulated shipment. + \ 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." + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + 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 + for a given chemical record. + maximum: 1 + type: string + minLength: 1 + 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 + chemical record. + maximum: 1 + type: string + minLength: 1 + maxLength: 250 + ClassDivisionNumber: + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + 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 + for a given chemical record. + maximum: 1 + type: string + minLength: 1 + 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" + 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. + + Y = TechnicalName is required. + N = TechnicalName is not required. + maximum: 1 + type: string + minLength: 1 + 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 + for the shipping papers are not required.\nY = Yes, additional information + for the shipping papers are required." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: |- + 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 + minLength: 1 + maxLength: 10 + TransportCategory: + description: |- + Code representing a category of transportation, assigned by a regulation set for each regulated commodity. Each value of this category is associated with a multiplier that is used to calculate a value.This value is then used to determine the placarding to be place on the vehicle or container that holds the related regulated commodity EXAMPLES OF VALUES: + 0 = No multiplier - must use placarding + 1 = Use a multiplier of 50 + 2 = Use a multiplier of 3 + 3 = Use a multiplier of 1 + 4 = Use a multiplier of 0 - do not apply a placard + maximum: 1 + type: string + minLength: 1 + 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: + 0 = No multiplier - must use placarding + 1 = Use a multiplier of 50 + 2 = Use a multiplier of 3 + 3 = Use a multiplier of 1 + 4 = Use a multiplier of 0 - do not apply a placard + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChannelTunnelAcceptedIndicator: + description: |- + ChannelTunnelAcceptedIndicator indicates if the chemical is accepted through channel tunnel or not Y= Accepted through channel tunnel + N=Not accepted through channel tunnel + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChemicalType: + description: |- + A set of chemical records in HMMS that correspond to a sub-set of chemicals for a regulation set, or the entire set of chemicals for a regulation set EXAMPLES OF VALUES: + FREIGHT + TDG + IATA US DOMESTIC AIR + 49CFR + ADR + IATA INTERNATIONAL AIR + maximum: 1 + type: string + minLength: 25 + maxLength: 25 + CAToUSShipmentAllowedIndicator: + description: |- + CAToUSShipmentAllowedIndicator indicates whether this checmical is allowed from CA to US + Applicable only for TDG shipments Y = Permitted from CA to US + N = Not Permitted from CA to US + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: ChemicalDetail + description: Container to hold Chemical details. + ChemicalData_ProperShippingNameDetail: + type: object + required: + - ProperShippingName + properties: + ProperShippingName: + description: The Proper Shipping Name assigned by ADR, CFR or IATA. + type: array + minLength: 1 + maxLength: 250 + xml: + name: ProperShippingNameDetail + description: Container to hold Proper Shipping Name Detail information. It + will be returned if applies for a given chemical record. + maximum: 1 + ChemicalData_PackageQuantityLimitDetail: + type: object + maximum: 1 + properties: + PackageQuantityLimitTypeCode: + description: |- + The type of package quantity limit. It will be returned if applies for a given chemical record. + + Valid values: + CAO - Cargo Aircraft Only + LTD QTY - Limited Quantity + GND - Ground + PAX - Passenger Aircraft + COMAT CAO - Company Material CAO + COMAT LTD - Company Material LTD + COMAT PAX - Company Material PAX + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Quantity: + 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 + minLength: 15 + maxLength: 15 + UOM: + description: |- + The unit of measure used for the mass capacity of the regulated good. + It will be returned if applies for a given chemical record. Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PackagingInstructionCode: + description: The packing instructions related to the chemical record. It + will be returned if applies for a given chemical record. + maximum: 1 + type: string + minLength: 1 + maxLength: 353 + xml: + name: PackageQuantityLimitDetail + DANGEROUSGOODSUTILITYAPCRequestWrapper: + xml: + name: AcceptanceAuditPreCheckRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - AcceptanceAuditPreCheckRequest + properties: + AcceptanceAuditPreCheckRequest: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest" + DANGEROUSGOODSUTILITYAPCResponseWrapper: + xml: + name: AcceptanceAuditPreCheckResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - AcceptanceAuditPreCheckResponse + properties: + AcceptanceAuditPreCheckResponse: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse" + AcceptanceAuditPreCheckRequest: + type: object + required: + - Request + - Shipment + properties: + 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" + type: string + maximum: 1 + Shipment: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckRequest_Shipment" + xml: + name: AcceptanceAuditPreCheckRequest + maximum: 1 + description: Dangerous Goods Utility Request container for Acceptance Audit + Pre-check. + AcceptanceAuditPreCheckRequest_Request: + type: object + properties: + RequestOption: + 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" + xml: + name: Request + maximum: 1 + description: Contains Dangerous Goods Utility Acceptance Audit Pre-check request + criteria elements. + AcceptanceAuditPreCheckRequest_Shipment: + type: object + maximum: 1 + required: + - ShipToAddress + - ShipFromAddress + - Service + - ShipperNumber + - Package + properties: + ShipperNumber: + 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" + ShipToAddress: + "$ref": "#/components/schemas/Shipment_ShipToAddress" + 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 + Movement\n49CFR = HazMat regulated by US Dept. of Transportation within + the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement." + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + Package: + type: array + maximum: 1000 + items: + "$ref": "#/components/schemas/Shipment_Package" + xml: + name: Shipment + description: Contains shipment information. + Shipment_ShipFromAddress: + type: object + maximum: 1 + properties: + AddressLine: + description: The Ship From street address including name and number (when + applicable). + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: The Ship From city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship From locations state or province code. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostalCode: + description: The Ship From locations postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship From locations country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipFromAddress + required: + - CountryCode + description: Ship From address container. + Shipment_ShipToAddress: + type: object + maximum: 1 + properties: + AddressLine: + description: The Ship To street address including name and number (when applicable). + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: The Ship To city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship To locations state or province code. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PostalCode: + description: The Ship To locations postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship To locations country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipToAddress + required: + - CountryCode + description: Ship To address container. + Shipment_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: UPS service type code. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: UPS service type description. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: Service + description: UPS service type. + Shipment_Package: + type: object + maximum: 1 + required: + - ChemicalRecord + - PackageIdentifier + - PackageWeight + properties: + PackageIdentifier: + description: Identifies the package containing Dangerous Goods. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + 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; + 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + OverPackedIndicator: + description: Presence/Absence Indicator. Any value is ignored. Presence + indicates that shipment is over pack. + type: string + 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: + GND, CAO, and PAX." + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + EmergencyPhone: + description: | + 24 Hour Emergency Phone Number of the shipper. + + Valid values for this field are (0) through (9) with trailing blanks. + + For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number. The 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) + maximum: 1 + type: string + minLength: 1 + maxLength: 25 + EmergencyContact: + description: |- + The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhone. + + The information is required if there is a value in the EmergencyPhone field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ChemicalRecord: + type: array + maximum: 3 + items: + "$ref": "#/components/schemas/Package_ChemicalRecord" + xml: + name: Package + description: Package Information container. + Package_PackageWeight: + type: object + maximum: 1 + required: + - UnitOfMeasurement + - Weight + properties: + Weight: + description: Packages weight. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + UnitOfMeasurement: + "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" + xml: + name: PackageWeight + description: Container to hold package weight information. + PackageWeight_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + Package weight unit of measurement code. Valid values: + LBS = Pounds + KGS = Kilograms + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the unit of measurement for package weight. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: Container to hold UnitOfMeasurement information for package weight. + Package_ChemicalRecord: + type: object + maximum: 1 + required: + - ChemicalRecordIdentifier + - CommodityRegulatedLevelCode + properties: + ChemicalRecordIdentifier: + description: Identifies the Chemcial Record. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + ClassDivisionNumber: + description: | + This is the hazard class associated to the specified commodity. + + Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + 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). + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + 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 + Number assigned to the specified regulated good. (Include the UN/NA/ID + as part of the entry)." + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + PackagingGroupType: + description: "This is the packing group category associated to the specified + 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" + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Quantity: + description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical + value of the mass capacity of the regulated good. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + UOM: + description: |- + Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. + Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PackagingInstructionCode: + description: The packing instructions related to the chemical record. Required + if CommodityRegulatedLevelCode = LQ or FR and if the field applies to + the material by regulation. + maximum: 1 + type: string + minLength: 1 + maxLength: 353 + ProperShippingName: + description: "The Proper Shipping Name assigned by ADR, CFR or IATA. \n\nRequired + if CommodityRegulatedLevelCode = LR, LQ or FR." + maximum: 1 + type: string + minLength: 1 + maxLength: 250 + TechnicalName: + description: "The technical name (when required) for the specified commodity. + \n\nRequired if CommodityRegulatedLevelCode = LQ or FR and if the field + applies to the material by regulation." + maximum: 1 + type: string + minLength: 1 + maxLength: 300 + AdditionalDescription: + description: | + Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. + + Additional information that may be required by regulation about a hazardous material, such as, “Limited Quantity”, DOT-SP numbers, EX numbers. + maximum: 1 + type: string + minLength: 1 + maxLength: 75 + PackagingType: + description: "The package type code identifying the type of packaging used + for the commodity. (Ex: Fiberboard Box). \nRequired if CommodityRegulatedLevelCode + = LQ or FR." + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + HazardLabelRequired: + description: "Defines the type of label that is required on the package + for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode = + LR or EQ." + maximum: 1 + type: string + minLength: 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" + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + CommodityRegulatedLevelCode: + description: |- + Indicates the type of commodity. Valid values: LR, FR, LQ, EQ + + FR = Fully Regulated + LQ = Limited Quantity + EQ = Excepted Quantity + LR = Lightly Regulated + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + TransportCategory: + description: 'Transport Category. Valid values: 0 to 4' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: Defines what is restricted to pass through a tunnel. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + AllPackedInOneIndicator: + description: Indicates the hazmat shipment/package is all packed in one. + maximum: 1 + type: string + xml: + name: ChemicalRecord + description: Container to hold Chemical Record information. + AcceptanceAuditPreCheckResponse: + type: object + required: + - Response + properties: + 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. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + 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: + ADR + 49CFR + IATA + TDG + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + PackageResults: + description: | + Package Results container. + + **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 + maximum: 20 + items: + "$ref": "#/components/schemas/AcceptanceAuditPreCheckResponse_PackageResults" + xml: + name: AcceptanceAuditPreCheckResponse + maximum: 1 + description: Dangerous Goods Utility Response container for Acceptance Audit + Pre-check. + AcceptanceAuditPreCheckResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + AlertDetail: + description: | + Alert Detail Container. + + **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" + + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Contains Dangerous Goods Utility Acceptance Audit Pre-check response + components. + maximum: 1 + Response_AlertDetail: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + ElementLevelInformation: + "$ref": "#/components/schemas/AlertDetail_ElementLevelInformation" + xml: + name: AlertDetail + AlertDetail_ElementLevelInformation: + type: object + maximum: 1 + required: + - Level + properties: + Level: + description: "Define type of element in request. Possible values: \nH + for the header details level\nS for the shipment level\nP for the package + level\nC for the commodity level" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ElementIdentifier: + type: array + items: + "$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier" + xml: + name: ElementLevelInformation + description: Provides more information about the element that represents the + alert. + ElementLevelInformation_ElementIdentifier: + type: object + maximum: 1 + required: + - Value + - Code + properties: + Code: + description: Represents the type of element. Possible values are P and C. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Value: + description: Represents the value of element. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + xml: + name: ElementIdentifier + description: "Contains more information about the type of element. \nReturned + if Level is P or C." + AcceptanceAuditPreCheckResponse_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: UPS service type code. + type: string + xml: + name: Service + description: UPS service type. This is same UPS Service present in the request + that is played back in response. + AcceptanceAuditPreCheckResponse_PackageResults: + type: object + maximum: 1 + required: + - PackageIdentifier + properties: + PackageIdentifier: + description: Identifies the package containing Dangerous Goods. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + AccessibleIndicator: + description: |- + Indicates if a package is crew accessible or not. Y = Package is crew accessible. + N = Package is not crew accessible. + maximum: 1 + type: string + minLength: 1 + 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 + Unit.\nN = Origin country or territory is not in the Europe Business Unit." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChemicalRecordResults: + description: | + Chemical Records Results container. + + **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 + maximum: 3 + items: + "$ref": "#/components/schemas/PackageResults_ChemicalRecordResults" + xml: + name: PackageResults + PackageResults_ChemicalRecordResults: + type: object + maximum: 1 + required: + - ChemicalRecordIdentifier + properties: + ChemicalRecordIdentifier: + description: Identifies the Chemical Record. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + ADRPoints: + description: Total points for the chemical records. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + TransportCategory: + description: 'Transport Category. Valid values: 0 to 4' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: Defines what is restricted to pass through a tunnel. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + ADRUnits: + description: |- + Number of ADR Units (Liters/Kg) + Format: 9999.99 + maximum: 1 + type: string + minLength: 7 + maxLength: 7 + xml: + name: ChemicalRecordResults + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/DeliveryDefense-Ready.yaml b/DeliveryDefense-Ready.yaml index 9a9cd3f..0012891 100644 --- a/DeliveryDefense-Ready.yaml +++ b/DeliveryDefense-Ready.yaml @@ -1,335 +1,335 @@ -openapi: 3.1.0 -info: - title: DeliveryDefense API - description: | - Address Confidence - - For more information on the Delivery Defense API, please visit the Product Info page. - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in 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: - - name: Delivery Defense -servers: - - url: https://wwwcie.ups.com/api/deliverydefense/external/v1.0 - description: DeliveryDefense Customer Integration Environment - - url: https://onlinetools.ups.com/api/deliverydefense/external/v1.0 - description: DeliveryDefense Production Environment -paths: - /address/score: - post: - tags: - - 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. - security: - - OAuth2: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddressRequestBody' - examples: - SampleAddressScoreCheck: - value: - street: "1173 CLARENDON DR" - city: "MARIETTA" - state: "GA" - zipCode: "30068" - - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/success' - examples: - "Low Likelihood of loss": - value: - status: - message: OK - data: - address: 1173 CLARENDON DR, MARIETTA, GA 30068, US, - street: 1173 CLARENDON DR - city: MARIETTA - state: GA - zipCode: "30068" - country: US - score: 988 - resiComFlag: Residential - "4X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1201 CLENDON DR, MARIETTA, GA 30169, US - street: 1201 CLENDON DR - city: MARIETTA - state: GA - zipCode: "30169" - country: US - score: 870 - resiComFlag: Residential - "16X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1305 CLENDON DR, MARIETTA, GA 20169, US - street: 1305 CLENDON DR - city: MARIETTA - state: GA - zipCode: "20169" - country: US - score: 650 - resiComFlag: Residential - "18X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1301 CLENDON DR, MARIETTA, GA 20169, US - street: 1301 CLENDON DR - city: MARIETTA - state: GA - zipCode: "20169" - country: US - score: 350 - resiComFlag: Residential - "21X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1301 CLENDON DR, MARIETTA, GA 20169, US - street: 1301 CLENDON DR - city: MARIETTA - state: GA - zipCode: "20169" - country: US - score: 250 - resiComFlag: Residential - - '204': - description: | - The request was successful, and the address format is valid, but no score could be calculated.
- This response means that while the address format is correct, there is no scoring information available for it.
- **Example Scenario**: - - **Request**: A client submits an address for scoring. - - **Response**: The server returns a `204 No Content` status. - - - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/Error400' - examples: - StateFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - State: - - The State field is required. - StreetFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - Street: - - The Street field is required. - CityFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - City: - - The City field is required. - ZipCodeFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - ZipCode: - - The ZipCode field is required. - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - InvalidToken: - value: - errorCode: "401" - 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" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - - schemas: - AddressRequestBody: - type: object - properties: - street: - type: string - description: >- - Indicates street address and unit number (if applicable) required - for lookup - city: - type: string - description: Indicates city required for lookup - state: - type: string - description: Indicates state required for lookup - zipCode: - type: string - pattern: ^[0-9]{5}(?:-[0-9]{4})?$ - description: Indicates zipcode required for lookup - required: - - street - - city - - state - - zipCode - additionalProperties: false - Error: - type: object - properties: - errorCode: - type: string - description: An error code representing the type of error. - errorMessage: - type: string - description: | - * Invalid Authentication Information. - required: - - errorCode - - errorMessage - - Error400: - type: object - properties: - type: - type: string - format: uri - description: url - title: - type: string - description: One or more validation errors occurred - status: - type: integer - description: | - * 400 - traceId: - type: string - description: auto generated Id - errors: - type: object - additionalProperties: true - description: | - * The Street field is required. - * The City field is required. - * The State field is required. - * The ZipCode field is required. - * Invalid Address. - * Please enter address in appropriate format. - * Invalid ZipCode. - success: - type: object - properties: - status: - type: object - properties: - message: - type: string - description: Indicates request information was accepted and processed - data: - type: object - properties: - address: - type: string - description: Indicates address used for search - street: - type: string - description: Street name in address - city: - type: string - description: City name in address - state: - type: string - description: State code in address - zipCode: - type: string - description: Zipcode in address - country: - type: string - description: Country code in address - score: - type: integer - description: > - * If range is between 900-1000 then there is a low likelihood of - loss. - - * If range is between 700-899 then likelihood of loss is 4x - higher than a score of 900-1000. - - * If range is between 500-699 then likelihood of loss is 16x - higher than a score of 900-1000. - - * If range is between 300-499 then likelihood of loss is 18x - higher than a score of 900-1000. - - * If range between 100-299 then likelihood of loss is 21x higher - than a score of 900-1000. - resiComFlag: - type: string - description: >- - Indicates if the address used for lookup is residential or - commercial \ No newline at end of file +openapi: 3.1.0 +info: + title: DeliveryDefense API + description: | + Address Confidence + + For more information on the Delivery Defense API, please visit the Product Info page. + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in 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: + - name: Delivery Defense +servers: + - url: https://wwwcie.ups.com/api/deliverydefense/external/v1.0 + description: DeliveryDefense Customer Integration Environment + - url: https://onlinetools.ups.com/api/deliverydefense/external/v1.0 + description: DeliveryDefense Production Environment +paths: + /address/score: + post: + tags: + - 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. + security: + - OAuth2: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddressRequestBody' + examples: + SampleAddressScoreCheck: + value: + street: "1173 CLARENDON DR" + city: "MARIETTA" + state: "GA" + zipCode: "30068" + + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/success' + examples: + "Low Likelihood of loss": + value: + status: + message: OK + data: + address: 1173 CLARENDON DR, MARIETTA, GA 30068, US, + street: 1173 CLARENDON DR + city: MARIETTA + state: GA + zipCode: "30068" + country: US + score: 988 + resiComFlag: Residential + "4X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1201 CLENDON DR, MARIETTA, GA 30169, US + street: 1201 CLENDON DR + city: MARIETTA + state: GA + zipCode: "30169" + country: US + score: 870 + resiComFlag: Residential + "16X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1305 CLENDON DR, MARIETTA, GA 20169, US + street: 1305 CLENDON DR + city: MARIETTA + state: GA + zipCode: "20169" + country: US + score: 650 + resiComFlag: Residential + "18X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1301 CLENDON DR, MARIETTA, GA 20169, US + street: 1301 CLENDON DR + city: MARIETTA + state: GA + zipCode: "20169" + country: US + score: 350 + resiComFlag: Residential + "21X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1301 CLENDON DR, MARIETTA, GA 20169, US + street: 1301 CLENDON DR + city: MARIETTA + state: GA + zipCode: "20169" + country: US + score: 250 + resiComFlag: Residential + + '204': + description: | + The request was successful, and the address format is valid, but no score could be calculated.
+ This response means that while the address format is correct, there is no scoring information available for it.
+ **Example Scenario**: + - **Request**: A client submits an address for scoring. + - **Response**: The server returns a `204 No Content` status. + + + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/Error400' + examples: + StateFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + State: + - The State field is required. + StreetFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + Street: + - The Street field is required. + CityFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + City: + - The City field is required. + ZipCodeFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + ZipCode: + - The ZipCode field is required. + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + InvalidToken: + value: + errorCode: "401" + 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" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + + schemas: + AddressRequestBody: + type: object + properties: + street: + type: string + description: >- + Indicates street address and unit number (if applicable) required + for lookup + city: + type: string + description: Indicates city required for lookup + state: + type: string + description: Indicates state required for lookup + zipCode: + type: string + pattern: ^[0-9]{5}(?:-[0-9]{4})?$ + description: Indicates zipcode required for lookup + required: + - street + - city + - state + - zipCode + additionalProperties: false + Error: + type: object + properties: + errorCode: + type: string + description: An error code representing the type of error. + errorMessage: + type: string + description: | + * Invalid Authentication Information. + required: + - errorCode + - errorMessage + + Error400: + type: object + properties: + type: + type: string + format: uri + description: url + title: + type: string + description: One or more validation errors occurred + status: + type: integer + description: | + * 400 + traceId: + type: string + description: auto generated Id + errors: + type: object + additionalProperties: true + description: | + * The Street field is required. + * The City field is required. + * The State field is required. + * The ZipCode field is required. + * Invalid Address. + * Please enter address in appropriate format. + * Invalid ZipCode. + success: + type: object + properties: + status: + type: object + properties: + message: + type: string + description: Indicates request information was accepted and processed + data: + type: object + properties: + address: + type: string + description: Indicates address used for search + street: + type: string + description: Street name in address + city: + type: string + description: City name in address + state: + type: string + description: State code in address + zipCode: + type: string + description: Zipcode in address + country: + type: string + description: Country code in address + score: + type: integer + description: > + * If range is between 900-1000 then there is a low likelihood of + loss. + + * If range is between 700-899 then likelihood of loss is 4x + higher than a score of 900-1000. + + * If range is between 500-699 then likelihood of loss is 16x + higher than a score of 900-1000. + + * If range is between 300-499 then likelihood of loss is 18x + higher than a score of 900-1000. + + * If range between 100-299 then likelihood of loss is 21x higher + than a score of 900-1000. + resiComFlag: + type: string + description: >- + Indicates if the address used for lookup is residential or + commercial diff --git a/DeliveryDefense.yaml b/DeliveryDefense.yaml index 3e30f76..5e1459f 100644 --- a/DeliveryDefense.yaml +++ b/DeliveryDefense.yaml @@ -1,329 +1,329 @@ -openapi: 3.1.0 -info: - title: DeliveryDefense API - description: | - 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in 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: - - name: Delivery Defense -servers: - - url: https://wwwcie.ups.com/api/deliverydefense/external/v1.0 - description: DeliveryDefense Customer Integration Environment - - url: https://onlinetools.ups.com/api/deliverydefense/external/v1.0 - description: DeliveryDefense Production Environment -paths: - /address/score: - post: - tags: - - 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. - security: - - OAuth2: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddressRequestBody' - examples: - SampleAddressScoreCheck: - value: - street: "1173 CLARENDON DR" - city: "MARIETTA" - state: "GA" - zipCode: "30068" - - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/success' - examples: - "Low Likelihood of loss": - value: - status: - message: OK - data: - address: 1173 CLARENDON DR, MARIETTA, GA 30068, US, - street: 1173 CLARENDON DR - city: MARIETTA - state: GA - zipCode: "30068" - country: US - score: 988 - resiComFlag: Residential - "4X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1201 CLENDON DR, MARIETTA, GA 30169, US - street: 1201 CLENDON DR - city: MARIETTA - state: GA - zipCode: "30169" - country: US - score: 870 - resiComFlag: Residential - "16X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1305 CLENDON DR, MARIETTA, GA 20169, US - street: 1305 CLENDON DR - city: MARIETTA - state: GA - zipCode: "20169" - country: US - score: 650 - resiComFlag: Residential - "18X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1301 CLENDON DR, MARIETTA, GA 20169, US - street: 1301 CLENDON DR - city: MARIETTA - state: GA - zipCode: "20169" - country: US - score: 350 - resiComFlag: Residential - "21X Likelihood of loss than score of 900-1000": - value: - status: - message: OK - data: - address: 1301 CLENDON DR, MARIETTA, GA 20169, US - street: 1301 CLENDON DR - city: MARIETTA - state: GA - zipCode: "20169" - country: US - score: 250 - resiComFlag: Residential - - '204': - description: | - The request was successful, and the address format is valid, but no score could be calculated.
- This response means that while the address format is correct, there is no scoring information available for it.
- **Example Scenario**: - - **Request**: A client submits an address for scoring. - - **Response**: The server returns a `204 No Content` status. - - - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/Error400' - examples: - StateFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - State: - - The State field is required. - StreetFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - Street: - - The Street field is required. - CityFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - City: - - The City field is required. - ZipCodeFieldMissing: - value: - type: https://tools.ietf.org/html/rfc7231#section-6.5.1 - title: One or more validation errors occurred. - status: 400 - traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 - errors: - ZipCode: - - The ZipCode field is required. - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - InvalidToken: - value: - errorCode: "401" - 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" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - - schemas: - AddressRequestBody: - type: object - properties: - street: - type: string - description: >- - Indicates street address and unit number (if applicable) required - for lookup - city: - type: string - description: Indicates city required for lookup - state: - type: string - description: Indicates state required for lookup - zipCode: - type: string - pattern: ^[0-9]{5}(?:-[0-9]{4})?$ - description: Indicates zipcode required for lookup - required: - - street - - city - - state - - zipCode - additionalProperties: false - Error: - type: object - properties: - errorCode: - type: string - description: An error code representing the type of error. - errorMessage: - type: string - description: | - * Invalid Authentication Information. - required: - - errorCode - - errorMessage - - Error400: - type: object - properties: - type: - type: string - format: uri - description: url - title: - type: string - description: One or more validation errors occurred - status: - type: integer - description: | - * 400 - traceId: - type: string - description: auto generated Id - errors: - type: object - additionalProperties: true - description: | - * The Street field is required. - * The City field is required. - * The State field is required. - * The ZipCode field is required. - * Invalid Address. - * Please enter address in appropriate format. - * Invalid ZipCode. - success: - type: object - properties: - status: - type: object - properties: - message: - type: string - description: Indicates request information was accepted and processed - data: - type: object - properties: - address: - type: string - description: Indicates address used for search - street: - type: string - description: Street name in address - city: - type: string - description: City name in address - state: - type: string - description: State code in address - zipCode: - type: string - description: Zipcode in address - country: - type: string - description: Country code in address - score: - type: integer - description: > - * If range is between 900-1000 then there is a low likelihood of - loss. - - * If range is between 700-899 then likelihood of loss is 4x - higher than a score of 900-1000. - - * If range is between 500-699 then likelihood of loss is 16x - higher than a score of 900-1000. - - * If range is between 300-499 then likelihood of loss is 18x - higher than a score of 900-1000. - - * If range between 100-299 then likelihood of loss is 21x higher - than a score of 900-1000. - resiComFlag: - type: string - description: >- - Indicates if the address used for lookup is residential or - commercial \ No newline at end of file +openapi: 3.1.0 +info: + title: DeliveryDefense API + description: | + 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in 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: + - name: Delivery Defense +servers: + - url: https://wwwcie.ups.com/api/deliverydefense/external/v1.0 + description: DeliveryDefense Customer Integration Environment + - url: https://onlinetools.ups.com/api/deliverydefense/external/v1.0 + description: DeliveryDefense Production Environment +paths: + /address/score: + post: + tags: + - 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. + security: + - OAuth2: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddressRequestBody' + examples: + SampleAddressScoreCheck: + value: + street: "1173 CLARENDON DR" + city: "MARIETTA" + state: "GA" + zipCode: "30068" + + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/success' + examples: + "Low Likelihood of loss": + value: + status: + message: OK + data: + address: 1173 CLARENDON DR, MARIETTA, GA 30068, US, + street: 1173 CLARENDON DR + city: MARIETTA + state: GA + zipCode: "30068" + country: US + score: 988 + resiComFlag: Residential + "4X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1201 CLENDON DR, MARIETTA, GA 30169, US + street: 1201 CLENDON DR + city: MARIETTA + state: GA + zipCode: "30169" + country: US + score: 870 + resiComFlag: Residential + "16X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1305 CLENDON DR, MARIETTA, GA 20169, US + street: 1305 CLENDON DR + city: MARIETTA + state: GA + zipCode: "20169" + country: US + score: 650 + resiComFlag: Residential + "18X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1301 CLENDON DR, MARIETTA, GA 20169, US + street: 1301 CLENDON DR + city: MARIETTA + state: GA + zipCode: "20169" + country: US + score: 350 + resiComFlag: Residential + "21X Likelihood of loss than score of 900-1000": + value: + status: + message: OK + data: + address: 1301 CLENDON DR, MARIETTA, GA 20169, US + street: 1301 CLENDON DR + city: MARIETTA + state: GA + zipCode: "20169" + country: US + score: 250 + resiComFlag: Residential + + '204': + description: | + The request was successful, and the address format is valid, but no score could be calculated.
+ This response means that while the address format is correct, there is no scoring information available for it.
+ **Example Scenario**: + - **Request**: A client submits an address for scoring. + - **Response**: The server returns a `204 No Content` status. + + + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/Error400' + examples: + StateFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + State: + - The State field is required. + StreetFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + Street: + - The Street field is required. + CityFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + City: + - The City field is required. + ZipCodeFieldMissing: + value: + type: https://tools.ietf.org/html/rfc7231#section-6.5.1 + title: One or more validation errors occurred. + status: 400 + traceId: 00-c6bf8291d14e90ddd363d057cc837f39-897c1324fd309af2-00 + errors: + ZipCode: + - The ZipCode field is required. + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + examples: + InvalidToken: + value: + errorCode: "401" + 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" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + + schemas: + AddressRequestBody: + type: object + properties: + street: + type: string + description: >- + Indicates street address and unit number (if applicable) required + for lookup + city: + type: string + description: Indicates city required for lookup + state: + type: string + description: Indicates state required for lookup + zipCode: + type: string + pattern: ^[0-9]{5}(?:-[0-9]{4})?$ + description: Indicates zipcode required for lookup + required: + - street + - city + - state + - zipCode + additionalProperties: false + Error: + type: object + properties: + errorCode: + type: string + description: An error code representing the type of error. + errorMessage: + type: string + description: | + * Invalid Authentication Information. + required: + - errorCode + - errorMessage + + Error400: + type: object + properties: + type: + type: string + format: uri + description: url + title: + type: string + description: One or more validation errors occurred + status: + type: integer + description: | + * 400 + traceId: + type: string + description: auto generated Id + errors: + type: object + additionalProperties: true + description: | + * The Street field is required. + * The City field is required. + * The State field is required. + * The ZipCode field is required. + * Invalid Address. + * Please enter address in appropriate format. + * Invalid ZipCode. + success: + type: object + properties: + status: + type: object + properties: + message: + type: string + description: Indicates request information was accepted and processed + data: + type: object + properties: + address: + type: string + description: Indicates address used for search + street: + type: string + description: Street name in address + city: + type: string + description: City name in address + state: + type: string + description: State code in address + zipCode: + type: string + description: Zipcode in address + country: + type: string + description: Country code in address + score: + type: integer + description: > + * If range is between 900-1000 then there is a low likelihood of + loss. + + * If range is between 700-899 then likelihood of loss is 4x + higher than a score of 900-1000. + + * If range is between 500-699 then likelihood of loss is 16x + higher than a score of 900-1000. + + * If range is between 300-499 then likelihood of loss is 18x + higher than a score of 900-1000. + + * If range between 100-299 then likelihood of loss is 21x higher + than a score of 900-1000. + resiComFlag: + type: string + description: >- + Indicates if the address used for lookup is residential or + commercial diff --git a/DeliveryIntercept.yaml b/DeliveryIntercept.yaml index e53d695..43fef22 100644 --- a/DeliveryIntercept.yaml +++ b/DeliveryIntercept.yaml @@ -1,2235 +1,2235 @@ -openapi: 3.1.0 -info: - title: Delivery Intercept® API v2 - description: | - With the UPS Delivery Intercept® API, a shipper can cancel or reroute a shipment they have sent, prior to delivery. - - ## Key Business Values - - Elimination of manually processing customer requests - - Acceptance of requests later in the delivery process - - For more information on the Delivery Intercept® API, please visit the Product Info page. - - ## Reference - - Errors - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - - ## 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 - | /eligibility/intercept | SUPER14 | 1Z6568YY1200043419 - | /willcall | SIIWillcall | 1Z4096YY0316914058 - | /return | SIIReturn | 1Z4096YY0316914058 - | /reschedule | SIIReschedule | 1Z4096YY0316914058 - | /redirect/address | SIIRedirect | 1Z4096YY0316914058 - | /cancel | SIICancel | 1Z4096YY0316914058 - version: "1.0" -servers: - - url: https://onlinetools.ups.com/api/deliveryintercept/{version} - description: Production - variables: - version: - default: v2 - enum: - - v2 - - url: https://wwwcie.ups.com/api/deliveryintercept/{version} - description: Customer Integration Environment - variables: - version: - default: v2 - enum: - - v2 -paths: - /charges/{tracking_number}: - post: - summary: Get charges by inquiry type - description: Obtains intercept charges specified by the inquiry type and tracking number passed in the interface. - operationId: getCharges - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptChargesRequestV2' - example: - clientIP: 10.9.100.220 - ratingRequest: - - redirectAddress: - addressNickName: John's work address - addressInfo: - addressLine1: "1899" - city: Baltimore - state: MD - postalCode: 21230-3410 - countryCode: US - buildingFloor: "2" - publicLocationId: "62200" - firstName: Robert - lastName: Willams - fullName: Trk 7702 Paramus Ward - phoneNumber: "+1987654324" - nameOrCompanyName: ACME Inc. - contactName: Robert - phoneNumber: "+1987654324" - phoneExt: "+123" - emailAddress: aups@ups.com - fromAddress: - addressLine1: "1899" - city: Baltimore - state: MD - postalCode: 21230-3410 - countryCode: US - buildingFloor: "2" - publicLocationId: "62200" - firstName: Robert - lastName: Willams - fullName: Trk 7702 Paramus Ward - phoneNumber: "+1987654324" - toAddress: - addressLine1: "12911 FORK RD" - city: BALDWIN - state: MD - postalCode: "21013" - countryCode: US - buildingFloor: "2" - publicLocationId: "7002" - firstName: Sam - lastName: carren - fullName: RICA80 CDW80 - phoneNumber: "+1987654324" - trackInfo: - interceptOption: AL - responses: - '200': - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptChargesResponseV2' - examples: - ALL INTERCEPT: - summary: ALL Intercept Response - value: - response: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - addrToken: "2" - errors: null - warnings: null - chargeInfo: - - trackingNumber: 1ZA2F8810719086435 - accessorialCharge: "0.00" - interceptCharge: "0.00" - transportationCharge: "0.00" - totalCharge: "0.00" - chargeCurrency: USD - estDeliveryDate: "20250220" - residentialIndicator: false - additionalHandlingIndicator: false - downgradeServiceCode: null - oversizeCode: null - serviceCode: "012" - serviceDesc: UPS 3 Day Select - packageWeight: "5" - packageWeightUOM: LBS - packagingType: "03" - interceptChargeDetail: - - accessorialCharge: "21.00" - interceptCharge: "21.00" - transportationCharge: "0.00" - totalCharge: "21.00" - interceptOption: AA - displayShipperPaidInterceptCharges: false - shipperPaidInterceptCharges: false - successful: true - currencyCode: USD - - accessorialCharge: "21.00" - interceptCharge: "21.00" - transportationCharge: "0.00" - totalCharge: "21.00" - interceptOption: FD - displayShipperPaidInterceptCharges: false - shipperPaidInterceptCharges: false - successful: true - currencyCode: USD - - accessorialCharge: "21.00" - interceptCharge: "21.00" - transportationCharge: "0.00" - totalCharge: "21.00" - interceptOption: RS - displayShipperPaidInterceptCharges: false - shipperPaidInterceptCharges: false - successful: true - currencyCode: USD - shipperName: ACME Inc. - preTaxTotalCharge: "25.00" - taxDisclaimerIndicator: NTA - displayShipperPaidInterceptCharges: false - shipperPaidInterceptCharges: false - shipperPaidTransportationCharges: false - displayShipperPaidTransportationCharges: false - chargesPaidByThirdPartyShipper: false - taxes: - - tax: City - taxAmount: "5.00" - - tax: State - taxAmount: "2.00" - totalTax: "7.00" - accessorialGrandTotal: "" - interceptGrandTotal: "" - transportationGrandTotal: "" - grandTotalCharge: "" - taxesGrandTotal: "" - preTaxGrandTotal: "" - SINGLE INTERCEPT: - summary: Single Intercept Response - value: - response: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - addrToken: "2" - errors: null - warnings: null - chargeInfo: - - trackingNumber: 1ZA2F8810719086435 - accessorialCharge: "10.00" - interceptCharge: "5.00" - transportationCharge: "25.00" - totalCharge: "40.00" - chargeCurrency: USD - estDeliveryDate: "20250220" - residentialIndicator: false - additionalHandlingIndicator: false - downgradeServiceCode: null - oversizeCode: null - serviceCode: "012" - serviceDesc: UPS 3 Day Select - packageWeight: "5" - packageWeightUOM: LBS - packagingType: "03" - shipperName: ACME Inc. - preTaxTotalCharge: "25.00" - taxDisclaimerIndicator: NTA - displayShipperPaidInterceptCharges: false - shipperPaidInterceptCharges: false - shipperPaidTransportationCharges: false - displayShipperPaidTransportationCharges: false - chargesPaidByThirdPartyShipper: false - taxes: - - tax: City - taxAmount: "5.00" - - tax: State - taxAmount: "2.00" - totalTax: "7.00" - accessorialGrandTotal: "" - interceptGrandTotal: "" - transportationGrandTotal: "" - grandTotalCharge: "" - taxesGrandTotal: "" - preTaxGrandTotal: "" - '400': - description: Bad Request - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Unauthorized - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. - /eligibility/intercept/{tracking_number}: - get: - summary: Get eligibility options - description: Retrieves the delivery change eligibility information for the tracking number passed in the interface. - operationId: getEligibilityOptions - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - responses: - '200': - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: "#/components/schemas/DeliveryInterceptEligibilityOptionsResponseV2" - examples: - SUCCESS: - summary: Success Response - value: - response: - transactionId: b2e514fc8a2 - statusCode: "000" - statusMsg: SUCCESS - success: true - errors: null - warnings: null - commonEligibilityMap: - - interceptFeature: FD - eligibilityValue: - createEligibility: ELIGIBLE - modifyEligibility: NOT_ELIGIBLE - cancelEligibility: NOT_ELIGIBLE - dateOptionsforFutureDelivery: - - date: 20250110 - dayOfWeekText: Friday - dayOfWeekNumber: 06 - - date: 20250115 - dayOfWeekText: Wednesday - dayOfWeekNumber: 04 - - interceptFeature: WC - eligibilityValue: - createEligibility: ELIGIBLE - modifyEligibility: NOT_ELIGIBLE - cancelEligibility: NOT_ELIGIBLE - - interceptFeature: SDWC - eligibilityValue: - createEligibility: ELIGIBLE - modifyEligibility: NOT_ELIGIBLE - cancelEligibility: NOT_ELIGIBLE - - interceptFeature: RD - eligibilityValue: - createEligibility: ELIGIBLE - modifyEligibility: NOT_ELIGIBLE - cancelEligibility: NOT_ELIGIBLE - - interceptFeature: RTS - eligibilityValue: - createEligibility: ELIGIBLE - modifyEligibility: NOT_ELIGIBLE - cancelEligibility: NOT_ELIGIBLE - reasonOptionsForRTS: - - id: AN - value: Duplicate Order - - id: AS - ERROR: - summary: Error Response - value: - response: - transactionId: b2e514fc8a2 - statusCode: "500" - statusMsg: ERROR - success: false - errors: - - errorCode: "500" - errorMessage: System Error - commonEligibilityMap: null - '400': - description: Bad Request - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: b2e514fc8a2 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Unauthorized - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. - /redirect/address/{tracking_number}: - post: - summary: Submit a non access point redirect request - description: Submits a deliver to another address delivery change for the tracking number passed in the interface. - operationId: getRedirectInterceptOptions - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptRequestV2' - example: - requestType: AA - specialInstructions: Handle With Care - requesterContactInfo: - name: andreas - telephone: "+12010000000" - phoneExt: "+123" - emailAddress: aups@ups.com - altTelephone: "+12345678" - altPhoneExt: "+1" - displayPhoneNumber: false - newDeliveryAddress: - addressNickName: John's new address - addressInfo: - addressLine1: 12911 FORK RD - addressLine2: Washington - addressLine3: Washington - city: BALDWIN - state: MD - postalCode: "21013" - countryCode: US - buildingFloor: "2" - publicLocationId: "800" - firstName: "sam" - lastName: "curren" - fullName: "sam curren" - phoneNumber: "+1988676185" - nameOrCompanyName: KRISTINA LEO - contactName: Andrea - phoneNumber: "+2019909098" - phoneExt: "+2" - emailAddress: aups@ups.com - responses: - '200': - description: Successful response - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptResponseV2' - examples: - SUCCESS: - summary: Success Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - errors: null - subStatusCode: "" - ERROR: - summary: Error Response - value: - transactionId: ASR1212 - statusCode: "500" - statusMsg: System Error - success: false - errors: - - errorCode: "500" - errorMessage: System Error - subStatusCode: "" - '400': - description: Validation error occurred - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Authentication required - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. - /willcall/{tracking_number}: - post: - summary: Request to hold the package at a UPS facility 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: willcallInterceptOption - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptRequestV2' - example: - requestType: WC - specialInstructions: Handle With Care - requesterContactInfo: - name: John - telephone: "+3522098238" - phoneExt: "+123" - emailAddress: aups@ups.com - altTelephone: "+3522098238" - altPhoneExt: "+3" - displayPhoneNumber: false - responses: - '200': - description: Successful response - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptResponseV2' - examples: - SUCCESS: - summary: Success Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - errors: null - subStatusCode: "" - ERROR: - summary: Error Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: false - errors: - - errorCode: "500" - errorMessage: System Error - subStatusCode: "" - '400': - description: Validation error occurred - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Authentication required - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. - /return/{tracking_number}: - post: - summary: Submit a return to sender request - description: Return a package to the original shipper prior to delivery. - operationId: returnInterceptOption - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptRequestV2' - example: - requestType: RS - specialInstructions: Handle With Care - requesterContactInfo: - name: andreas - telephone: "+112010000000" - phoneExt: "+123" - emailAddress: aups@ups.com - altTelephone: "+19887654321" - altPhoneExt: "+12" - displayPhoneNumber: false - reasonForReturn: AM - responses: - '200': - description: Successful response - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptResponseV2' - examples: - SUCCESS: - summary: Success Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - errors: null - subStatusCode: "" - ERROR: - summary: Error Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: false - errors: - - errorCode: "500" - errorMessage: System Error - subStatusCode: "" - '400': - description: Validation error occurred - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Authentication required - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. - /reschedule/{tracking_number}: - post: - summary: Request for a new delivery date - description: Have the package delivered to the original address but on a different day in the future. - operationId: rescheduleInterceptOption - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptRequestV2' - example: - requestType: FD - specialInstructions: - requesterContactInfo: - name: andreas - telephone: "+112010000000" - phoneExt: "+1" - emailAddress: aups@ups.com - altTelephone: "+19887654321" - altPhoneExt: "+12" - displayPhoneNumber: false - deliveryDate: "20240904" - responses: - '200': - description: Successful response - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptResponseV2' - examples: - SUCCESS: - summary: Success Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - errors: null - subStatusCode: "" - ERROR: - summary: Error Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: false - errors: - - errorCode: "500" - errorMessage: System Error - subStatusCode: "" - '400': - description: Validation error occurred - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Authentication required - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. - /cancel/{tracking_number}: - post: - summary: Request cancellation of a prior intercept request - description: Cancel a previously applied intercept on the package. - operationId: cancelInterceptOption - tags: - - Delivery Intercept - security: - - OAuth2: [] - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/PlatformType" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/InquiryType" - - $ref: "#/components/parameters/tracking_number" - - $ref: "#/components/parameters/Loc" - - name: version - in: path - description: version - required: true - schema: - type: string - default: v2 - enum: - - v2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptRequestV2' - example: - requestType: FD - specialInstructions: - requesterContactInfo: - name: John A - telephone: "+19881234567" - phoneExt: "+1" - emailAddress: aups@ups.com - altTelephone: "+19881234567" - altPhoneExt: "+12" - displayPhoneNumber: true - responses: - '200': - description: Successful response - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptResponseV2' - examples: - SUCCESS: - summary: Success Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: true - errors: null - subStatusCode: "" - ERROR: - summary: Error Response - value: - transactionId: ASR1212 - statusCode: "000" - statusMsg: Success - success: false - errors: - - errorCode: "500" - errorMessage: System Error - subStatusCode: "" - '400': - description: Validation error occurred - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "400" - errors: - - code: "710" - message: Failure due to input validation error - '401': - description: Authentication required - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' - example: - response: - transactionId: ASR1212 - statusCode: "401" - errors: - - code: "605" - message: Package address token does not match any tokens in the user's profile. -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token - scopes: {} - parameters: - transId: - name: transId - in: header - description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes - required: true - schema: - type: string - pattern: ^[a-zA-Z0-9-.]{3,14}$ - minLength: 3 - maxLength: 14 - example: 0a1b9c2d8e3f43 - PlatformType: - name: platformType - in: header - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - enum: - - XOLT - Content-Type: - name: Content-Type - description: describes the content type to expect - in: header - required: true - schema: - type: string - example: application/json - InquiryType: - name: inquiryType - description: describes the content type to expect - in: header - required: true - schema: - type: string - description: indicator for UPS Shipper Initiated Intercepts - enum: - - U - tracking_number: - name: tracking_number - description: The number being tracked. Each method defines if required. - in: path - required: true - style: simple - explode: false - schema: - type: string - minLength: 18 - maxLength: 18 - pattern: '^(1Z)[A-Z0-9]{16}$' - example: 1ZA2F8810719086435 - Loc: - name: loc - in: query - required: false - description: >- - The locale of the client application to ensure that translations on - the response are in the proper language. - style: form - explode: true - schema: - type: string - maxLength: 5 - pattern: '^[a-z]+[_]+[A-Z]+$' - example: en_US - headers: - BkndTransId: - description: The backend transaction id. - schema: - type: string - example: 383f7d397a48 - transId: - description: An identifier unique to the request. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]{3,36}$ - minLength: 3 - maxLength: 36 - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - description: Identifies the client/source application that is calling. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]{1,36}$ - minLength: 1 - maxLength: 36 - example: UPS.com - Content-Type: - description: The Content-Type header provides the client with the actual content/media type of the returned content. - schema: - type: string - example: application/json - APIErrorCode: - description: The API error code. - schema: - type: string - example: UJ0001 - APIErrorMsg: - description: The API error message. - schema: - type: string - example: Invalid token or token is not present. - schemas: - DeliveryInterceptChargesRequestV2: - type: object - description: Request schema for Delivery Change Charges retrieval - properties: - clientIP: - type: string - description: IP address of the requesting device - example: 10.9.100.220 - ratingRequest: - type: array - 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. - items: - type: object - description: Container for each rating request object - properties: - redirectAddress: - type: object - properties: - addressNickName: - type: string - description: The nickname string assigned to the address entry. - minLength: 2 - maxLength: 20 - example: John's woek address - addressInfo: - description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present. - $ref: '#/components/schemas/DeliveryInterceptAddressV2' - nameOrCompanyName: - type: string - description: The name of the company or person customer address.(Required When calling submitAddress() API Empty String can be passed) - example: ACME Inc. - contactName: - type: string - description: The contact name at the customer address. - example: Robert - phoneNumber: - type: string - description: The contact phone number at the customer address.(Required When calling submitAddress() API Empty String can be passed) - maxLength: 14 - pattern: '^(\+)[0-9]{1,13}$' - example: "+19886222523" - phoneExt: - type: string - description: The phone extension number at the customer address.(Required When calling submitAddress() API Empty String can be passed) - pattern: '^(\+)[0-9]{1,3}$' - example: "+244" - emailAddress: - type: string - description: Email Address at the customer address. - pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$' - example: aups@ups.com - additionalProperties: false - required: - - addressNickName - - addressInfo - - nameOrCompanyName - - contactName - - phoneNumber - fromAddress: - allOf: - - $ref: '#/components/schemas/DeliveryInterceptAddressV2' - - $ref: '#/components/schemas/DeliveryInterceptAdditionalAddressV2' - toAddress: - allOf: - - $ref: '#/components/schemas/DeliveryInterceptAddressV2' - - $ref: '#/components/schemas/DeliveryInterceptAdditionalAddressV2' - trackInfo: - type: object - properties: - interceptOption: - type: string - description: Intercept option to be mentioned to find the charges - minLength: 2 - maxLength: 2 - oneOf: - - const: WC - title: WILL CALL - - const: SC - title: SAME DAY WILL CALL - - const: FD - title: FUTURE DELIVERY - - const: AA - title: ALTERNATE ADDRES - - const: RS - title: RETURN TO SENDER - - const: AL - title: ALL INTERCEPT - additionalProperties: false - required: - - interceptOption - additionalProperties: false - required: - - fromAddress - - toAddress - - trackInfo - additionalProperties: true - required: - - ratingRequest - DeliveryInterceptChargesResponseV2: - type: object - description: Response schema for Delivery Change Charge request - properties: - response: - allOf: - - $ref: "#/components/schemas/DeliveryInterceptCommonResponseV2" - - type: object - properties: - chargeInfo: - type: array - description: For each 1z there will exist a ChargeInfo object. These are the charges that were applied. This array is unbounded. - minItems: 1 - items: - type: object - properties: - trackingNumber: - $ref: "#/components/schemas/DeliveryInterceptTrackingNumberV2" - accessorialCharge: - description: The sum of all accessorial charges (i.e. including addition handling, intercept) - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - interceptCharge: - description: The flat rate charge specific for the intercept - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - transportationCharge: - description: The sum of all AlternateAddress transportation Charges (Redirect,deliver to another address) - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - totalCharge: - description: Total of all accessorial, intercept and transportation charges - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - chargeCurrency: - type: string - description: The ISO 4217 currency code - maxLength: 3 - minLength: 3 - pattern: ^[A-Z]{3}$ - example: USD - estDeliveryDate: - description: Estimate Delivery Date (YYYYMMDD). - $ref: "#/components/schemas/DeliveryInterceptDateV2" - residentialIndicator: - description: Ship to residential indicator. - type: boolean - default: false - additionalHandlingIndicator: - description: Additional handling indicator. May be set by NRF during rating. - type: boolean - default: false - downgradeServiceCode: - type: - - string - - "null" - description: Downgraded service code. - minLength: 3 - maxLength: 3 - example: "003" - oversizeCode: - type: - - string - - "null" - description: Oversize indicator. May be set by NRF during rating LPK. - minLength: 3 - maxLength: 3 - serviceCode: - type: string - description: Original service code. Refer to the Service Codes document for more details. - minLength: 3 - maxLength: 3 - example: "012" - serviceDesc: - type: string - description: Original service description. Refer to the Service Codes document for more details. - example: "UPS 3 DAY SELECT" - packageWeight: - type: string - description: Package weight. May also be changed by NRF during rating to billable weight. - maxLength: 10 - example: "4.0" - packageWeightUOM: - type: string - description: Package weight unit of measure - maxLength: 3 - minLength: 3 - anyOf: - - const: LBS - title: Pounds - - const: KGS - - title: Kilograms - packagingType: - description: Packaging Type code. Refer to the Packaging Types document for more details. - type: string - maxLength: 3 - example: "03" - shipperName: - type: string - description: Name of the shipper Applicable for Intercept options FD,AA,UR etc. - example: ACME Inc. - displayShipperPaidInterceptCharges: - type: boolean - description: Indicates if a message should be displayed that the shipper has paid for the charges related to the intercept - default: false - shipperPaidInterceptCharges: - type: boolean - description: Indicates if charges related to the intercept are paid by the shipper. - default: false - shipperPaidTransportationCharges: - type: boolean - description: Indicates if charges related to transportation are paid by the shipper. Applicable only for Redirect to Another Address. - default: false - displayShipperPaidTransportationCharges: - type: boolean - description: | - Indicates if a message should be displayed that the shipper has paid for the charges related to transportation. - Applicable only for Redirect to Another Address and Redirect to UPS Location intercepts. TRUE - display a message - that the shipper has paid the transportation charges. - default: false - chargesPaidByThirdPartyShipper: - type: boolean - description: | - Indicates if the charges were paid by a third-party shipper and must be supplied by trusted end clients only. - - | CODE | DESCRIPTION | - | :--: | :-- | - | TRUE | the charges were paid by a third-party shipper. | - | FALSE | the charges were paid by the original shipper. | - default: false - taxes: - type: array - minItems: 1 - description: Taxes for EU/Mexico/Canada country movement. This array is unbounded. - items: - type: object - properties: - tax: - type: string - description: Identifies the tax type - taxAmount: - description: Identifies the tax amount for a particular tax type - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - totalTax: - description: Taxes for EU/Mexico/Canada country movement . sum of tax amounts present in the taxes field. - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - preTaxTotalCharge: - description: Pre-tax total Charge. Sum of accessorial charges and transportation charges excluding taxes. - $ref: "#/components/schemas/DeliveryInterceptChargeV2" - taxDisclaimerIndicator: - type: string - description: Indicates if a tax disclaimer message should be displayed. - oneOf: - - const: NTC - title: NO Tax calculation - - const: NTA - title: NO Tax applicable - - const: TA - title: Taxes applicable - - const: TE - title: Taxes Exempt - - const: TU - title: Taxes Undetermined - interceptChargeDetail: - type: array - description: Unbounded array of intercept charges details, available only for intercept option AL - items: - $ref: "#/components/schemas/DeliveryInterceptChargeDetailV2" - additionalProperties: false - required: - - trackingNumber - - accessorialCharge - - interceptCharge - - transportationCharge - - totalCharge - - chargeCurrency - - estDeliveryDate - - serviceCode - - serviceDesc - - packageWeight - - packageWeightUOM - - packagingType - - shipperName - - preTaxTotalCharge - - taxDisclaimerIndicator - additionalProperties: true - required: - - chargeInfo - additionalProperties: false - required: - - response - DeliveryInterceptChargeDetailV2: - type: object - properties: - accessorialCharge: - type: string - description: Includes sum of all accessorial charges (i.e. including addition handling, intercept) - minLength: 4 - maxLength: 20 - example: "20.00" - interceptCharge: - type: string - description: The flat rate charge specific for the intercept - minLength: 4 - maxLength: 20 - example: "20.00" - transportationCharge: - type: string - description: Transportation Charge Only for Alternate Address (Redirect, Deliver to Another Address) - minLength: 4 - maxLength: 20 - example: "20.00" - totalCharge: - type: string - description: totalCharge - minLength: 4 - maxLength: 20 - example: "20.00" - interceptOption: - type: string - description: Intercept name of the charges - example: AA - displayShipperPaidInterceptCharges: - type: boolean - description: Indicates if a message should be displayed that the shipper has paid for the charges related to the intercept. - default: false - shipperPaidInterceptCharges: - type: boolean - description: Indicates if charges related to the intercept are paid by the shipper. - default: false - example: false - successful: - type: boolean - currencyCode: - type: string - description: This will be used when authorizing credit cards or PayPal accounts - minLength: 3 - maxLength: 3 - example: USD - required: - - currencyCode - DeliveryInterceptEligibilityOptionsResponseV2: - type: object - description: Response schema for Delivery Change Eligibility request - properties: - response: - allOf: - - $ref: "#/components/schemas/DeliveryInterceptCommonResponseV2" - - type: object - properties: - commonEligibilityMap: - description: Object that contains eligibility values for each intercept feature - properties: - interceptFeature: - type: string - description: The specific delivery change options eligibilty is being returned for - oneOf: - - const: SDWC - title: Same Day Will Call - - const: RTS - title: Return To Sender - - const: WC - title: Will Call - - const: FD - title: Future Delivery - - const: RD - title: Reschedule Delivery - eligibilityValue: - type: object - description: Object that holds the eligibility values for a particular delivery change - properties: - createEligibility: - $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2' - modifyEligibility: - $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2' - cancelEligibility: - $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2' - dateOptionsforFutureDelivery: - type: array - description: Unbounded array of future delivery dates. Available only for future delivery intercept option - minItems: 1 - items: - type: object - description: Object that holds the future delivery dates user is eligible for - properties: - date: - $ref: "#/components/schemas/DeliveryInterceptDateV2" - dayOfWeekText: - type: string - description: Provides the day of the week - enum: - - Sunday - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - dayOfWeekNumber: - type: string - description: Provides the number of the day of the week - oneOf: - - const: "01" - title: Sunday - - const: "02" - title: Monday - - const: "03" - title: Tuesday - - const: "04" - title: Wednesday - - const: "05" - title: Thursday - - const: "06" - title: Friday - - const: "07" - title: Saturday - reasonOptionsForRTS: - type: array - description: Array of reasons why the item is being returned. Available only for RTS intercept option - minItems: 1 - maxItems: 9 - items: - type: object - description: Object that holds the return to sender reasons the user is eligible for - properties: - id: - type: string - description: Provides the reason code for RTS - oneOf: - - const: AM - title: CANCELLED - description: RECEIVER REFUSED, CANCELLED ORDER - - const: AN - title: DUPLICATE - description: RECEIVER REFUSED, DUPLICATE ORDER - - const: AQ - title: NO C.O.D.'S - description: RECEIVER REFUSED, NO C.O.D.'S ACCEPTED - - const: AR - title: EXPENSIVE - description: RECEIVER REFUSED, TOO EXPENSIVE - - const: AS - title: LATE - description: RECEIVER REFUSED, SHIPPED TOO LATE - - const: FA - title: BAD ADDRESS - description: UNABLE TO RESOLVE INCORRECT ADDRESS - - const: KR - title: REFUSED - description: RECEIVER DID NOT WANT, REFUSED DELIVERY - - const: KS - title: NOT ORDERED - description: RECEIVER DID NOT ORDER, REFUSED - - const: KV - title: OTHER - description: OTHER NON-DELIVERY - value: - type: string - description: Provides the reason text for RTS - example: COD Will Not Be Accepted - additionalProperties: false - required: - - id - - value - additionalProperties: false - required: - - createEligibility - - modifyEligibility - - cancelEligibility - additionalProperties: true - required: - - commonEligibilityMap - additionalProperties: false - required: - - response - DeliveryInterceptRequestV2: - type: object - properties: - requestType: - description: The request type of the intercept being performed - type: string - minLength: 2 - maxLength: 3 - oneOf: - - const: WC - title: WILL CALL - - const: SC - title: SAME DAY WILL CALL - - const: FD - title: FUTURE DELIVERY - - const: AA - title: ALTERNATE ADDRES - - const: RS - title: RETURN TO SENDER - requesterContactInfo: - type: object - properties: - name: - type: string - description: Contact Name - minLength: 1 - maxLength: 30 - example: The UPS Store - telephone: - type: string - description: Contact phone number - minLength: 1 - maxLength: 14 - pattern: ^(\+)[0-9]{1,13}$ - example: "+14107495070" - phoneExt: - type: string - description: Contact phone extension - minLength: 2 - maxLength: 4 - pattern: ^(\+)[0-9]{1,3}$ - example: "+12" - emailAddress: - type: string - description: Contact email address - minLength: 1 - maxLength: 50 - pattern: ^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$ - example: aups@ups.com - altTelephone: - type: string - description: Alternate Contact phone number - minLength: 1 - maxLength: 14 - pattern: ^(\+)[0-9]{1,13}$ - example: "+19886432748" - altPhoneExt: - type: string - description: Alternate Contact phone extension - minLength: 2 - maxLength: 4 - pattern: ^(\+)[0-9]{1,3}$ - example: "+12" - displayPhoneNumber: - type: boolean - description: Indicates if the phone number of a UAP can be displayed to external clients. - default: false - additionalProperties: true - required: - - name - - telephone - reasonForReturn: - type: string - description: Reason for return code. Required only for RS intercept type. - oneOf: - - const: AM - title: CANCELLED - description: RECEIVER REFUSED, CANCELLED ORDER - - const: AN - title: DUPLICATE - description: RECEIVER REFUSED, DUPLICATE ORDER - - const: AQ - title: NO C.O.D.'S - description: RECEIVER REFUSED, NO C.O.D.'S ACCEPTED - - const: AR - title: EXPENSIVE - description: RECEIVER REFUSED, TOO EXPENSIVE - - const: AS - title: LATE - description: RECEIVER REFUSED, SHIPPED TOO LATE - - const: FA - title: BAD ADDRESS - description: UNABLE TO RESOLVE INCORRECT ADDRESS - - const: KR - title: REFUSED - description: RECEIVER DID NOT WANT, REFUSED DELIVERY - - const: KS - title: NOT ORDERED - description: RECEIVER DID NOT ORDER, REFUSED - - const: KV - title: OTHER - description: OTHER NON-DELIVERY - deliveryDate: - type: string - description: Original scheduled date of delivery. Required olny for FD intercept type. - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20190223" - specialInstructions: - type: - - string - - "null" - description: Special Instructions sent to the driver. Available only to AA intercept type - minLength: 1 - maxLength: 254 - example: Handle With Care - newDeliveryAddress: - type: object - description: New delivery address. Required olny for AA intercept type. - properties: - addressNickName: - type: string - description: The nickname string assigned to the address entry. Required only for AA intercept type. - minLength: 2 - maxLength: 20 - example: John's woek address - addressInfo: - type: object - description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present. - properties: - addressLine1: - type: string - description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address. - minLength: 1 - maxLength: 50 - example: 12911 FORK RD - addressLine2: - type: string - description: Line 2 of the street address - minLength: 1 - maxLength: 35 - example: Ste 8 - addressLine3: - description: Line 3 of the street - minLength: 1 - maxLength: 35 - type: string - city: - type: string - description: The city name of the address - minLength: 1 - maxLength: 30 - example: Baldwin - state: - type: string - description: The state code of the address - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: MD - postalCode: - type: string - description: The postal code of the address (should be provided for postal countries) - minLength: 5 - maxLength: 16 - pattern: ^\d{5}(?:[-\s]\d{4})?$ - examples: - - "21013" - - "21093-1234" - countryCode: - type: string - description: The ISO country code of the address - maxLength: 2 - minLength: 2 - pattern: ^[A-Z]{2}$ - example: US - additionalProperties: true - required: - - addressLine1 - - city - - state - - postalCode - - countryCode - nameOrCompanyName: - type: string - description: The name of the company or person customer address.(Required When calling submitAddress() API Empty String can be passed) - example: ACME Inc. - contactName: - type: string - description: The contact name at the customer address. - example: Robert - phoneNumber: - type: string - description: The contact phone number at the customer address.(Required When calling submitAddress() API Empty String can be passed) - maxLength: 14 - pattern: '^(\+)[0-9]{1,13}$' - example: "+19886222523" - phoneExt: - type: string - description: The phone extension number at the customer address.(Required When calling submitAddress() API Empty String can be passed) - pattern: '^(\+)[0-9]{1,3}$' - example: "+244" - emailAddress: - type: string - description: Email Address at the customer address. - pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$' - example: aups@ups.com - additionalProperties: false - required: - - requesterContactInfo - - specialInstructions - DeliveryInterceptResponseV2: - type: object - description: "" - properties: - transactionId: - type: string - description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes. - minLength: 1 - maxLength: 14 - example: "ASR1212" - statusCode: - type: string - description: API response status code, Internal code regarding the success or failure of the operation - minLength: 3 - maxLength: 3 - example: "000" - statusMsg: - type: string - description: API response status message, Internal message regarding the success or failure of the operation - minLength: 1 - maxLength: 80 - example: "Success" - subStatusCode: - type: string - description: A new status code for adding granularity to the existing status code structure - example: "7103" - success: - type: boolean - description: Indicates if the transaction is considered successful. - default: false - errors: - type: - - array - - "null" - description: Unbounded array of error objects - items: - $ref: "#/components/schemas/DeliveryInterceptSuccessErrorV2" - warnings: - type: object - description: A map containing warning codes and descriptions as key/value pairs. - additionalProperties: - type: string - additionalProperties: false - required: - - transactionId - - statusCode - - success - DeliveryInterceptCommonResponseV2: - type: object - description: Object to contain properties common to all responses - properties: - transactionId: - type: string - description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes - minLength: 1 - maxLength: 14 - example: ASR1212 - statusCode: - description: API response status code, Internal code regarding the success or failure of the operation - maxLength: 3 - minLength: 3 - example: "000" - type: string - statusMsg: - type: string - description: API response status message, Internal message regarding the success or failure of the operation - minLength: 1 - maxLength: 80 - example: Success - subStatusCode: - type: string - description: A new status code for adding granularity to the existing status code structure - example: "7103" - success: - type: boolean - description: Indicates if the transaction is considered successful. - default: false - warnings: - type: - - object - - "null" - description: A map containing warning codes and descriptions as key/value pairs - errors: - type: - - array - - "null" - description: Unbounded array of error objects - items: - $ref: "#/components/schemas/DeliveryInterceptSuccessErrorV2" - additionalProperties: true - required: - - transactionId - - statusCode - DeliveryInterceptAddressV2: - type: object - properties: - addressLine1: - type: string - description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address. - minLength: 1 - maxLength: 50 - example: 12911 FORK RD - addressLine2: - type: string - description: Line 2 of the street address - minLength: 1 - maxLength: 35 - example: Ste 8 - addressLine3: - description: Line 3 of the street - minLength: 1 - maxLength: 35 - type: string - city: - type: string - description: The city name of the address - minLength: 1 - maxLength: 30 - example: Baldwin - state: - type: string - description: The state code of the address - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: MD - postalCode: - type: string - description: The postal code of the address (should be provided for postal countries) - minLength: 5 - maxLength: 16 - pattern: ^\d{5}(?:[-\s]\d{4})?$ - examples: - - "21013" - - "21093-1234" - countryCode: - type: string - description: The ISO country code of the address - maxLength: 2 - minLength: 2 - pattern: ^[A-Z]{2}$ - example: US - additionalProperties: true - required: - - addressLine1 - - city - - state - - postalCode - - countryCode - DeliveryInterceptAdditionalAddressV2: - type: object - properties: - buildingFloor: - type: string - example: "2" - publicLocationId: - type: string - example: U88498244 - firstName: - type: string - description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation . - example: HUNTLY - lastName: - type: string - description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation object. - example: OAK - fullName: - type: string - description: Full person name - example: HUNTLY OAK - phoneNumber: - type: string - maxLength: 17 - pattern: '^(\+)[0-9]{1,16}$' - example: "+19886222564" - additionalProperties: true - required: - - firstName - - phoneNumber - DeliveryInterceptChargeV2: - type: string - maxLength: 20 - pattern: ^\d{1,17}?\.\d{2}?$ - format: currency - example: "5.00" - DeliveryInterceptDateV2: - type: string - description: Provides the future dates available for delivery - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20250110" - DeliveryInterceptEligibilityValueV2: - type: string - enum: - - ELIGIBLE - - NOT_ELIGIBLE - - UNKNOWN - DeliveryInterceptTrackingNumberV2: - type: string - minLength: 18 - maxLength: 18 - pattern: ^(1Z)[A-Z0-9]{16}$ - example: 1ZA2F8810719086435 - DeliveryInterceptErrorResponseV2: - type: object - required: - - response - properties: - response: - type: object - required: - - statusCode - - errors - properties: - transactionId: - 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 - maxLength: 4 - minLength: 1 - example: "0006" - type: string - subStatusCode: - 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 - 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: - type: object - properties: - code: - description: |- - the code of the error - maxLength: 4 - minLength: 1 - example: "0006" - type: string - message: - description: |- - the message of the error - maxLength: 120 - minLength: 1 - example: "Failure to check eligibility through Tracking service" - type: string - DeliveryInterceptSuccessErrorV2: - type: object - description: | - Container to hold details related to an individual error. Will only be returned if the HTTP statusCode isn't '200'(success). - On the API version v3 the first element of the errors array contains the statusCode and scoring statusMessage field. - properties: - errorCode: - type: string - description: The code of the error - minLength: 1 - maxLength: 4 - example: "1201" - errorMessage: - type: string - description: The message of the error - minLength: 1 - maxLength: 120 - example: TransactionSrc - errorSource: - type: string - description: The source of the error - additionalProperties: false - required: - - errorCode - - errorMessage \ No newline at end of file +openapi: 3.1.0 +info: + title: Delivery Intercept® API v2 + description: | + With the UPS Delivery Intercept® API, a shipper can cancel or reroute a shipment they have sent, prior to delivery. + + ## Key Business Values + - Elimination of manually processing customer requests + - Acceptance of requests later in the delivery process + + For more information on the Delivery Intercept® API, please visit the Product Info page. + + ## Reference + - Errors + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + + ## 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 + | /eligibility/intercept | SUPER14 | 1Z6568YY1200043419 + | /willcall | SIIWillcall | 1Z4096YY0316914058 + | /return | SIIReturn | 1Z4096YY0316914058 + | /reschedule | SIIReschedule | 1Z4096YY0316914058 + | /redirect/address | SIIRedirect | 1Z4096YY0316914058 + | /cancel | SIICancel | 1Z4096YY0316914058 + version: "1.0" +servers: + - url: https://onlinetools.ups.com/api/deliveryintercept/{version} + description: Production + variables: + version: + default: v2 + enum: + - v2 + - url: https://wwwcie.ups.com/api/deliveryintercept/{version} + description: Customer Integration Environment + variables: + version: + default: v2 + enum: + - v2 +paths: + /charges/{tracking_number}: + post: + summary: Get charges by inquiry type + description: Obtains intercept charges specified by the inquiry type and tracking number passed in the interface. + operationId: getCharges + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptChargesRequestV2' + example: + clientIP: 10.9.100.220 + ratingRequest: + - redirectAddress: + addressNickName: John's work address + addressInfo: + addressLine1: "1899" + city: Baltimore + state: MD + postalCode: 21230-3410 + countryCode: US + buildingFloor: "2" + publicLocationId: "62200" + firstName: Robert + lastName: Willams + fullName: Trk 7702 Paramus Ward + phoneNumber: "+1987654324" + nameOrCompanyName: ACME Inc. + contactName: Robert + phoneNumber: "+1987654324" + phoneExt: "+123" + emailAddress: aups@ups.com + fromAddress: + addressLine1: "1899" + city: Baltimore + state: MD + postalCode: 21230-3410 + countryCode: US + buildingFloor: "2" + publicLocationId: "62200" + firstName: Robert + lastName: Willams + fullName: Trk 7702 Paramus Ward + phoneNumber: "+1987654324" + toAddress: + addressLine1: "12911 FORK RD" + city: BALDWIN + state: MD + postalCode: "21013" + countryCode: US + buildingFloor: "2" + publicLocationId: "7002" + firstName: Sam + lastName: carren + fullName: RICA80 CDW80 + phoneNumber: "+1987654324" + trackInfo: + interceptOption: AL + responses: + '200': + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptChargesResponseV2' + examples: + ALL INTERCEPT: + summary: ALL Intercept Response + value: + response: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + addrToken: "2" + errors: null + warnings: null + chargeInfo: + - trackingNumber: 1ZA2F8810719086435 + accessorialCharge: "0.00" + interceptCharge: "0.00" + transportationCharge: "0.00" + totalCharge: "0.00" + chargeCurrency: USD + estDeliveryDate: "20250220" + residentialIndicator: false + additionalHandlingIndicator: false + downgradeServiceCode: null + oversizeCode: null + serviceCode: "012" + serviceDesc: UPS 3 Day Select + packageWeight: "5" + packageWeightUOM: LBS + packagingType: "03" + interceptChargeDetail: + - accessorialCharge: "21.00" + interceptCharge: "21.00" + transportationCharge: "0.00" + totalCharge: "21.00" + interceptOption: AA + displayShipperPaidInterceptCharges: false + shipperPaidInterceptCharges: false + successful: true + currencyCode: USD + - accessorialCharge: "21.00" + interceptCharge: "21.00" + transportationCharge: "0.00" + totalCharge: "21.00" + interceptOption: FD + displayShipperPaidInterceptCharges: false + shipperPaidInterceptCharges: false + successful: true + currencyCode: USD + - accessorialCharge: "21.00" + interceptCharge: "21.00" + transportationCharge: "0.00" + totalCharge: "21.00" + interceptOption: RS + displayShipperPaidInterceptCharges: false + shipperPaidInterceptCharges: false + successful: true + currencyCode: USD + shipperName: ACME Inc. + preTaxTotalCharge: "25.00" + taxDisclaimerIndicator: NTA + displayShipperPaidInterceptCharges: false + shipperPaidInterceptCharges: false + shipperPaidTransportationCharges: false + displayShipperPaidTransportationCharges: false + chargesPaidByThirdPartyShipper: false + taxes: + - tax: City + taxAmount: "5.00" + - tax: State + taxAmount: "2.00" + totalTax: "7.00" + accessorialGrandTotal: "" + interceptGrandTotal: "" + transportationGrandTotal: "" + grandTotalCharge: "" + taxesGrandTotal: "" + preTaxGrandTotal: "" + SINGLE INTERCEPT: + summary: Single Intercept Response + value: + response: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + addrToken: "2" + errors: null + warnings: null + chargeInfo: + - trackingNumber: 1ZA2F8810719086435 + accessorialCharge: "10.00" + interceptCharge: "5.00" + transportationCharge: "25.00" + totalCharge: "40.00" + chargeCurrency: USD + estDeliveryDate: "20250220" + residentialIndicator: false + additionalHandlingIndicator: false + downgradeServiceCode: null + oversizeCode: null + serviceCode: "012" + serviceDesc: UPS 3 Day Select + packageWeight: "5" + packageWeightUOM: LBS + packagingType: "03" + shipperName: ACME Inc. + preTaxTotalCharge: "25.00" + taxDisclaimerIndicator: NTA + displayShipperPaidInterceptCharges: false + shipperPaidInterceptCharges: false + shipperPaidTransportationCharges: false + displayShipperPaidTransportationCharges: false + chargesPaidByThirdPartyShipper: false + taxes: + - tax: City + taxAmount: "5.00" + - tax: State + taxAmount: "2.00" + totalTax: "7.00" + accessorialGrandTotal: "" + interceptGrandTotal: "" + transportationGrandTotal: "" + grandTotalCharge: "" + taxesGrandTotal: "" + preTaxGrandTotal: "" + '400': + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Unauthorized + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. + /eligibility/intercept/{tracking_number}: + get: + summary: Get eligibility options + description: Retrieves the delivery change eligibility information for the tracking number passed in the interface. + operationId: getEligibilityOptions + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + responses: + '200': + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: "#/components/schemas/DeliveryInterceptEligibilityOptionsResponseV2" + examples: + SUCCESS: + summary: Success Response + value: + response: + transactionId: b2e514fc8a2 + statusCode: "000" + statusMsg: SUCCESS + success: true + errors: null + warnings: null + commonEligibilityMap: + - interceptFeature: FD + eligibilityValue: + createEligibility: ELIGIBLE + modifyEligibility: NOT_ELIGIBLE + cancelEligibility: NOT_ELIGIBLE + dateOptionsforFutureDelivery: + - date: 20250110 + dayOfWeekText: Friday + dayOfWeekNumber: 06 + - date: 20250115 + dayOfWeekText: Wednesday + dayOfWeekNumber: 04 + - interceptFeature: WC + eligibilityValue: + createEligibility: ELIGIBLE + modifyEligibility: NOT_ELIGIBLE + cancelEligibility: NOT_ELIGIBLE + - interceptFeature: SDWC + eligibilityValue: + createEligibility: ELIGIBLE + modifyEligibility: NOT_ELIGIBLE + cancelEligibility: NOT_ELIGIBLE + - interceptFeature: RD + eligibilityValue: + createEligibility: ELIGIBLE + modifyEligibility: NOT_ELIGIBLE + cancelEligibility: NOT_ELIGIBLE + - interceptFeature: RTS + eligibilityValue: + createEligibility: ELIGIBLE + modifyEligibility: NOT_ELIGIBLE + cancelEligibility: NOT_ELIGIBLE + reasonOptionsForRTS: + - id: AN + value: Duplicate Order + - id: AS + ERROR: + summary: Error Response + value: + response: + transactionId: b2e514fc8a2 + statusCode: "500" + statusMsg: ERROR + success: false + errors: + - errorCode: "500" + errorMessage: System Error + commonEligibilityMap: null + '400': + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: b2e514fc8a2 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Unauthorized + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. + /redirect/address/{tracking_number}: + post: + summary: Submit a non access point redirect request + description: Submits a deliver to another address delivery change for the tracking number passed in the interface. + operationId: getRedirectInterceptOptions + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptRequestV2' + example: + requestType: AA + specialInstructions: Handle With Care + requesterContactInfo: + name: andreas + telephone: "+12010000000" + phoneExt: "+123" + emailAddress: aups@ups.com + altTelephone: "+12345678" + altPhoneExt: "+1" + displayPhoneNumber: false + newDeliveryAddress: + addressNickName: John's new address + addressInfo: + addressLine1: 12911 FORK RD + addressLine2: Washington + addressLine3: Washington + city: BALDWIN + state: MD + postalCode: "21013" + countryCode: US + buildingFloor: "2" + publicLocationId: "800" + firstName: "sam" + lastName: "curren" + fullName: "sam curren" + phoneNumber: "+1988676185" + nameOrCompanyName: KRISTINA LEO + contactName: Andrea + phoneNumber: "+2019909098" + phoneExt: "+2" + emailAddress: aups@ups.com + responses: + '200': + description: Successful response + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptResponseV2' + examples: + SUCCESS: + summary: Success Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + errors: null + subStatusCode: "" + ERROR: + summary: Error Response + value: + transactionId: ASR1212 + statusCode: "500" + statusMsg: System Error + success: false + errors: + - errorCode: "500" + errorMessage: System Error + subStatusCode: "" + '400': + description: Validation error occurred + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Authentication required + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. + /willcall/{tracking_number}: + post: + summary: Request to hold the package at a UPS facility 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: willcallInterceptOption + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptRequestV2' + example: + requestType: WC + specialInstructions: Handle With Care + requesterContactInfo: + name: John + telephone: "+3522098238" + phoneExt: "+123" + emailAddress: aups@ups.com + altTelephone: "+3522098238" + altPhoneExt: "+3" + displayPhoneNumber: false + responses: + '200': + description: Successful response + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptResponseV2' + examples: + SUCCESS: + summary: Success Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + errors: null + subStatusCode: "" + ERROR: + summary: Error Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: false + errors: + - errorCode: "500" + errorMessage: System Error + subStatusCode: "" + '400': + description: Validation error occurred + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Authentication required + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. + /return/{tracking_number}: + post: + summary: Submit a return to sender request + description: Return a package to the original shipper prior to delivery. + operationId: returnInterceptOption + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptRequestV2' + example: + requestType: RS + specialInstructions: Handle With Care + requesterContactInfo: + name: andreas + telephone: "+112010000000" + phoneExt: "+123" + emailAddress: aups@ups.com + altTelephone: "+19887654321" + altPhoneExt: "+12" + displayPhoneNumber: false + reasonForReturn: AM + responses: + '200': + description: Successful response + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptResponseV2' + examples: + SUCCESS: + summary: Success Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + errors: null + subStatusCode: "" + ERROR: + summary: Error Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: false + errors: + - errorCode: "500" + errorMessage: System Error + subStatusCode: "" + '400': + description: Validation error occurred + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Authentication required + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. + /reschedule/{tracking_number}: + post: + summary: Request for a new delivery date + description: Have the package delivered to the original address but on a different day in the future. + operationId: rescheduleInterceptOption + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptRequestV2' + example: + requestType: FD + specialInstructions: + requesterContactInfo: + name: andreas + telephone: "+112010000000" + phoneExt: "+1" + emailAddress: aups@ups.com + altTelephone: "+19887654321" + altPhoneExt: "+12" + displayPhoneNumber: false + deliveryDate: "20240904" + responses: + '200': + description: Successful response + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptResponseV2' + examples: + SUCCESS: + summary: Success Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + errors: null + subStatusCode: "" + ERROR: + summary: Error Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: false + errors: + - errorCode: "500" + errorMessage: System Error + subStatusCode: "" + '400': + description: Validation error occurred + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Authentication required + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. + /cancel/{tracking_number}: + post: + summary: Request cancellation of a prior intercept request + description: Cancel a previously applied intercept on the package. + operationId: cancelInterceptOption + tags: + - Delivery Intercept + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/PlatformType" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/InquiryType" + - $ref: "#/components/parameters/tracking_number" + - $ref: "#/components/parameters/Loc" + - name: version + in: path + description: version + required: true + schema: + type: string + default: v2 + enum: + - v2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptRequestV2' + example: + requestType: FD + specialInstructions: + requesterContactInfo: + name: John A + telephone: "+19881234567" + phoneExt: "+1" + emailAddress: aups@ups.com + altTelephone: "+19881234567" + altPhoneExt: "+12" + displayPhoneNumber: true + responses: + '200': + description: Successful response + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptResponseV2' + examples: + SUCCESS: + summary: Success Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: true + errors: null + subStatusCode: "" + ERROR: + summary: Error Response + value: + transactionId: ASR1212 + statusCode: "000" + statusMsg: Success + success: false + errors: + - errorCode: "500" + errorMessage: System Error + subStatusCode: "" + '400': + description: Validation error occurred + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "400" + errors: + - code: "710" + message: Failure due to input validation error + '401': + description: Authentication required + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2' + example: + response: + transactionId: ASR1212 + statusCode: "401" + errors: + - code: "605" + message: Package address token does not match any tokens in the user's profile. +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token + scopes: {} + parameters: + transId: + name: transId + in: header + description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes + required: true + schema: + type: string + pattern: ^[a-zA-Z0-9-.]{3,14}$ + minLength: 3 + maxLength: 14 + example: 0a1b9c2d8e3f43 + PlatformType: + name: platformType + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + enum: + - XOLT + Content-Type: + name: Content-Type + description: describes the content type to expect + in: header + required: true + schema: + type: string + example: application/json + InquiryType: + name: inquiryType + description: describes the content type to expect + in: header + required: true + schema: + type: string + description: indicator for UPS Shipper Initiated Intercepts + enum: + - U + tracking_number: + name: tracking_number + description: The number being tracked. Each method defines if required. + in: path + required: true + style: simple + explode: false + schema: + type: string + minLength: 18 + maxLength: 18 + pattern: '^(1Z)[A-Z0-9]{16}$' + example: 1ZA2F8810719086435 + Loc: + name: loc + in: query + required: false + description: >- + The locale of the client application to ensure that translations on + the response are in the proper language. + style: form + explode: true + schema: + type: string + maxLength: 5 + pattern: '^[a-z]+[_]+[A-Z]+$' + example: en_US + headers: + BkndTransId: + description: The backend transaction id. + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]{3,36}$ + minLength: 3 + maxLength: 36 + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]{1,36}$ + minLength: 1 + maxLength: 36 + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + schema: + type: string + example: Invalid token or token is not present. + schemas: + DeliveryInterceptChargesRequestV2: + type: object + description: Request schema for Delivery Change Charges retrieval + properties: + clientIP: + type: string + description: IP address of the requesting device + example: 10.9.100.220 + ratingRequest: + type: array + 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. + items: + type: object + description: Container for each rating request object + properties: + redirectAddress: + type: object + properties: + addressNickName: + type: string + description: The nickname string assigned to the address entry. + minLength: 2 + maxLength: 20 + example: John's woek address + addressInfo: + description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present. + $ref: '#/components/schemas/DeliveryInterceptAddressV2' + nameOrCompanyName: + type: string + description: The name of the company or person customer address.(Required When calling submitAddress() API Empty String can be passed) + example: ACME Inc. + contactName: + type: string + description: The contact name at the customer address. + example: Robert + phoneNumber: + type: string + description: The contact phone number at the customer address.(Required When calling submitAddress() API Empty String can be passed) + maxLength: 14 + pattern: '^(\+)[0-9]{1,13}$' + example: "+19886222523" + phoneExt: + type: string + description: The phone extension number at the customer address.(Required When calling submitAddress() API Empty String can be passed) + pattern: '^(\+)[0-9]{1,3}$' + example: "+244" + emailAddress: + type: string + description: Email Address at the customer address. + pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$' + example: aups@ups.com + additionalProperties: false + required: + - addressNickName + - addressInfo + - nameOrCompanyName + - contactName + - phoneNumber + fromAddress: + allOf: + - $ref: '#/components/schemas/DeliveryInterceptAddressV2' + - $ref: '#/components/schemas/DeliveryInterceptAdditionalAddressV2' + toAddress: + allOf: + - $ref: '#/components/schemas/DeliveryInterceptAddressV2' + - $ref: '#/components/schemas/DeliveryInterceptAdditionalAddressV2' + trackInfo: + type: object + properties: + interceptOption: + type: string + description: Intercept option to be mentioned to find the charges + minLength: 2 + maxLength: 2 + oneOf: + - const: WC + title: WILL CALL + - const: SC + title: SAME DAY WILL CALL + - const: FD + title: FUTURE DELIVERY + - const: AA + title: ALTERNATE ADDRES + - const: RS + title: RETURN TO SENDER + - const: AL + title: ALL INTERCEPT + additionalProperties: false + required: + - interceptOption + additionalProperties: false + required: + - fromAddress + - toAddress + - trackInfo + additionalProperties: true + required: + - ratingRequest + DeliveryInterceptChargesResponseV2: + type: object + description: Response schema for Delivery Change Charge request + properties: + response: + allOf: + - $ref: "#/components/schemas/DeliveryInterceptCommonResponseV2" + - type: object + properties: + chargeInfo: + type: array + description: For each 1z there will exist a ChargeInfo object. These are the charges that were applied. This array is unbounded. + minItems: 1 + items: + type: object + properties: + trackingNumber: + $ref: "#/components/schemas/DeliveryInterceptTrackingNumberV2" + accessorialCharge: + description: The sum of all accessorial charges (i.e. including addition handling, intercept) + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + interceptCharge: + description: The flat rate charge specific for the intercept + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + transportationCharge: + description: The sum of all AlternateAddress transportation Charges (Redirect,deliver to another address) + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + totalCharge: + description: Total of all accessorial, intercept and transportation charges + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + chargeCurrency: + type: string + description: The ISO 4217 currency code + maxLength: 3 + minLength: 3 + pattern: ^[A-Z]{3}$ + example: USD + estDeliveryDate: + description: Estimate Delivery Date (YYYYMMDD). + $ref: "#/components/schemas/DeliveryInterceptDateV2" + residentialIndicator: + description: Ship to residential indicator. + type: boolean + default: false + additionalHandlingIndicator: + description: Additional handling indicator. May be set by NRF during rating. + type: boolean + default: false + downgradeServiceCode: + type: + - string + - "null" + description: Downgraded service code. + minLength: 3 + maxLength: 3 + example: "003" + oversizeCode: + type: + - string + - "null" + description: Oversize indicator. May be set by NRF during rating LPK. + minLength: 3 + maxLength: 3 + serviceCode: + type: string + description: Original service code. Refer to the Service Codes document for more details. + minLength: 3 + maxLength: 3 + example: "012" + serviceDesc: + type: string + description: Original service description. Refer to the Service Codes document for more details. + example: "UPS 3 DAY SELECT" + packageWeight: + type: string + description: Package weight. May also be changed by NRF during rating to billable weight. + maxLength: 10 + example: "4.0" + packageWeightUOM: + type: string + description: Package weight unit of measure + maxLength: 3 + minLength: 3 + anyOf: + - const: LBS + title: Pounds + - const: KGS + - title: Kilograms + packagingType: + description: Packaging Type code. Refer to the Packaging Types document for more details. + type: string + maxLength: 3 + example: "03" + shipperName: + type: string + description: Name of the shipper Applicable for Intercept options FD,AA,UR etc. + example: ACME Inc. + displayShipperPaidInterceptCharges: + type: boolean + description: Indicates if a message should be displayed that the shipper has paid for the charges related to the intercept + default: false + shipperPaidInterceptCharges: + type: boolean + description: Indicates if charges related to the intercept are paid by the shipper. + default: false + shipperPaidTransportationCharges: + type: boolean + description: Indicates if charges related to transportation are paid by the shipper. Applicable only for Redirect to Another Address. + default: false + displayShipperPaidTransportationCharges: + type: boolean + description: | + Indicates if a message should be displayed that the shipper has paid for the charges related to transportation. + Applicable only for Redirect to Another Address and Redirect to UPS Location intercepts. TRUE - display a message + that the shipper has paid the transportation charges. + default: false + chargesPaidByThirdPartyShipper: + type: boolean + description: | + Indicates if the charges were paid by a third-party shipper and must be supplied by trusted end clients only. + + | CODE | DESCRIPTION | + | :--: | :-- | + | TRUE | the charges were paid by a third-party shipper. | + | FALSE | the charges were paid by the original shipper. | + default: false + taxes: + type: array + minItems: 1 + description: Taxes for EU/Mexico/Canada country movement. This array is unbounded. + items: + type: object + properties: + tax: + type: string + description: Identifies the tax type + taxAmount: + description: Identifies the tax amount for a particular tax type + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + totalTax: + description: Taxes for EU/Mexico/Canada country movement . sum of tax amounts present in the taxes field. + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + preTaxTotalCharge: + description: Pre-tax total Charge. Sum of accessorial charges and transportation charges excluding taxes. + $ref: "#/components/schemas/DeliveryInterceptChargeV2" + taxDisclaimerIndicator: + type: string + description: Indicates if a tax disclaimer message should be displayed. + oneOf: + - const: NTC + title: NO Tax calculation + - const: NTA + title: NO Tax applicable + - const: TA + title: Taxes applicable + - const: TE + title: Taxes Exempt + - const: TU + title: Taxes Undetermined + interceptChargeDetail: + type: array + description: Unbounded array of intercept charges details, available only for intercept option AL + items: + $ref: "#/components/schemas/DeliveryInterceptChargeDetailV2" + additionalProperties: false + required: + - trackingNumber + - accessorialCharge + - interceptCharge + - transportationCharge + - totalCharge + - chargeCurrency + - estDeliveryDate + - serviceCode + - serviceDesc + - packageWeight + - packageWeightUOM + - packagingType + - shipperName + - preTaxTotalCharge + - taxDisclaimerIndicator + additionalProperties: true + required: + - chargeInfo + additionalProperties: false + required: + - response + DeliveryInterceptChargeDetailV2: + type: object + properties: + accessorialCharge: + type: string + description: Includes sum of all accessorial charges (i.e. including addition handling, intercept) + minLength: 4 + maxLength: 20 + example: "20.00" + interceptCharge: + type: string + description: The flat rate charge specific for the intercept + minLength: 4 + maxLength: 20 + example: "20.00" + transportationCharge: + type: string + description: Transportation Charge Only for Alternate Address (Redirect, Deliver to Another Address) + minLength: 4 + maxLength: 20 + example: "20.00" + totalCharge: + type: string + description: totalCharge + minLength: 4 + maxLength: 20 + example: "20.00" + interceptOption: + type: string + description: Intercept name of the charges + example: AA + displayShipperPaidInterceptCharges: + type: boolean + description: Indicates if a message should be displayed that the shipper has paid for the charges related to the intercept. + default: false + shipperPaidInterceptCharges: + type: boolean + description: Indicates if charges related to the intercept are paid by the shipper. + default: false + example: false + successful: + type: boolean + currencyCode: + type: string + description: This will be used when authorizing credit cards or PayPal accounts + minLength: 3 + maxLength: 3 + example: USD + required: + - currencyCode + DeliveryInterceptEligibilityOptionsResponseV2: + type: object + description: Response schema for Delivery Change Eligibility request + properties: + response: + allOf: + - $ref: "#/components/schemas/DeliveryInterceptCommonResponseV2" + - type: object + properties: + commonEligibilityMap: + description: Object that contains eligibility values for each intercept feature + properties: + interceptFeature: + type: string + description: The specific delivery change options eligibilty is being returned for + oneOf: + - const: SDWC + title: Same Day Will Call + - const: RTS + title: Return To Sender + - const: WC + title: Will Call + - const: FD + title: Future Delivery + - const: RD + title: Reschedule Delivery + eligibilityValue: + type: object + description: Object that holds the eligibility values for a particular delivery change + properties: + createEligibility: + $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2' + modifyEligibility: + $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2' + cancelEligibility: + $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2' + dateOptionsforFutureDelivery: + type: array + description: Unbounded array of future delivery dates. Available only for future delivery intercept option + minItems: 1 + items: + type: object + description: Object that holds the future delivery dates user is eligible for + properties: + date: + $ref: "#/components/schemas/DeliveryInterceptDateV2" + dayOfWeekText: + type: string + description: Provides the day of the week + enum: + - Sunday + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + dayOfWeekNumber: + type: string + description: Provides the number of the day of the week + oneOf: + - const: "01" + title: Sunday + - const: "02" + title: Monday + - const: "03" + title: Tuesday + - const: "04" + title: Wednesday + - const: "05" + title: Thursday + - const: "06" + title: Friday + - const: "07" + title: Saturday + reasonOptionsForRTS: + type: array + description: Array of reasons why the item is being returned. Available only for RTS intercept option + minItems: 1 + maxItems: 9 + items: + type: object + description: Object that holds the return to sender reasons the user is eligible for + properties: + id: + type: string + description: Provides the reason code for RTS + oneOf: + - const: AM + title: CANCELLED + description: RECEIVER REFUSED, CANCELLED ORDER + - const: AN + title: DUPLICATE + description: RECEIVER REFUSED, DUPLICATE ORDER + - const: AQ + title: NO C.O.D.'S + description: RECEIVER REFUSED, NO C.O.D.'S ACCEPTED + - const: AR + title: EXPENSIVE + description: RECEIVER REFUSED, TOO EXPENSIVE + - const: AS + title: LATE + description: RECEIVER REFUSED, SHIPPED TOO LATE + - const: FA + title: BAD ADDRESS + description: UNABLE TO RESOLVE INCORRECT ADDRESS + - const: KR + title: REFUSED + description: RECEIVER DID NOT WANT, REFUSED DELIVERY + - const: KS + title: NOT ORDERED + description: RECEIVER DID NOT ORDER, REFUSED + - const: KV + title: OTHER + description: OTHER NON-DELIVERY + value: + type: string + description: Provides the reason text for RTS + example: COD Will Not Be Accepted + additionalProperties: false + required: + - id + - value + additionalProperties: false + required: + - createEligibility + - modifyEligibility + - cancelEligibility + additionalProperties: true + required: + - commonEligibilityMap + additionalProperties: false + required: + - response + DeliveryInterceptRequestV2: + type: object + properties: + requestType: + description: The request type of the intercept being performed + type: string + minLength: 2 + maxLength: 3 + oneOf: + - const: WC + title: WILL CALL + - const: SC + title: SAME DAY WILL CALL + - const: FD + title: FUTURE DELIVERY + - const: AA + title: ALTERNATE ADDRES + - const: RS + title: RETURN TO SENDER + requesterContactInfo: + type: object + properties: + name: + type: string + description: Contact Name + minLength: 1 + maxLength: 30 + example: The UPS Store + telephone: + type: string + description: Contact phone number + minLength: 1 + maxLength: 14 + pattern: ^(\+)[0-9]{1,13}$ + example: "+14107495070" + phoneExt: + type: string + description: Contact phone extension + minLength: 2 + maxLength: 4 + pattern: ^(\+)[0-9]{1,3}$ + example: "+12" + emailAddress: + type: string + description: Contact email address + minLength: 1 + maxLength: 50 + pattern: ^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$ + example: aups@ups.com + altTelephone: + type: string + description: Alternate Contact phone number + minLength: 1 + maxLength: 14 + pattern: ^(\+)[0-9]{1,13}$ + example: "+19886432748" + altPhoneExt: + type: string + description: Alternate Contact phone extension + minLength: 2 + maxLength: 4 + pattern: ^(\+)[0-9]{1,3}$ + example: "+12" + displayPhoneNumber: + type: boolean + description: Indicates if the phone number of a UAP can be displayed to external clients. + default: false + additionalProperties: true + required: + - name + - telephone + reasonForReturn: + type: string + description: Reason for return code. Required only for RS intercept type. + oneOf: + - const: AM + title: CANCELLED + description: RECEIVER REFUSED, CANCELLED ORDER + - const: AN + title: DUPLICATE + description: RECEIVER REFUSED, DUPLICATE ORDER + - const: AQ + title: NO C.O.D.'S + description: RECEIVER REFUSED, NO C.O.D.'S ACCEPTED + - const: AR + title: EXPENSIVE + description: RECEIVER REFUSED, TOO EXPENSIVE + - const: AS + title: LATE + description: RECEIVER REFUSED, SHIPPED TOO LATE + - const: FA + title: BAD ADDRESS + description: UNABLE TO RESOLVE INCORRECT ADDRESS + - const: KR + title: REFUSED + description: RECEIVER DID NOT WANT, REFUSED DELIVERY + - const: KS + title: NOT ORDERED + description: RECEIVER DID NOT ORDER, REFUSED + - const: KV + title: OTHER + description: OTHER NON-DELIVERY + deliveryDate: + type: string + description: Original scheduled date of delivery. Required olny for FD intercept type. + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20190223" + specialInstructions: + type: + - string + - "null" + description: Special Instructions sent to the driver. Available only to AA intercept type + minLength: 1 + maxLength: 254 + example: Handle With Care + newDeliveryAddress: + type: object + description: New delivery address. Required olny for AA intercept type. + properties: + addressNickName: + type: string + description: The nickname string assigned to the address entry. Required only for AA intercept type. + minLength: 2 + maxLength: 20 + example: John's woek address + addressInfo: + type: object + description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present. + properties: + addressLine1: + type: string + description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address. + minLength: 1 + maxLength: 50 + example: 12911 FORK RD + addressLine2: + type: string + description: Line 2 of the street address + minLength: 1 + maxLength: 35 + example: Ste 8 + addressLine3: + description: Line 3 of the street + minLength: 1 + maxLength: 35 + type: string + city: + type: string + description: The city name of the address + minLength: 1 + maxLength: 30 + example: Baldwin + state: + type: string + description: The state code of the address + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: MD + postalCode: + type: string + description: The postal code of the address (should be provided for postal countries) + minLength: 5 + maxLength: 16 + pattern: ^\d{5}(?:[-\s]\d{4})?$ + examples: + - "21013" + - "21093-1234" + countryCode: + type: string + description: The ISO country code of the address + maxLength: 2 + minLength: 2 + pattern: ^[A-Z]{2}$ + example: US + additionalProperties: true + required: + - addressLine1 + - city + - state + - postalCode + - countryCode + nameOrCompanyName: + type: string + description: The name of the company or person customer address.(Required When calling submitAddress() API Empty String can be passed) + example: ACME Inc. + contactName: + type: string + description: The contact name at the customer address. + example: Robert + phoneNumber: + type: string + description: The contact phone number at the customer address.(Required When calling submitAddress() API Empty String can be passed) + maxLength: 14 + pattern: '^(\+)[0-9]{1,13}$' + example: "+19886222523" + phoneExt: + type: string + description: The phone extension number at the customer address.(Required When calling submitAddress() API Empty String can be passed) + pattern: '^(\+)[0-9]{1,3}$' + example: "+244" + emailAddress: + type: string + description: Email Address at the customer address. + pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$' + example: aups@ups.com + additionalProperties: false + required: + - requesterContactInfo + - specialInstructions + DeliveryInterceptResponseV2: + type: object + description: "" + properties: + transactionId: + type: string + description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes. + minLength: 1 + maxLength: 14 + example: "ASR1212" + statusCode: + type: string + description: API response status code, Internal code regarding the success or failure of the operation + minLength: 3 + maxLength: 3 + example: "000" + statusMsg: + type: string + description: API response status message, Internal message regarding the success or failure of the operation + minLength: 1 + maxLength: 80 + example: "Success" + subStatusCode: + type: string + description: A new status code for adding granularity to the existing status code structure + example: "7103" + success: + type: boolean + description: Indicates if the transaction is considered successful. + default: false + errors: + type: + - array + - "null" + description: Unbounded array of error objects + items: + $ref: "#/components/schemas/DeliveryInterceptSuccessErrorV2" + warnings: + type: object + description: A map containing warning codes and descriptions as key/value pairs. + additionalProperties: + type: string + additionalProperties: false + required: + - transactionId + - statusCode + - success + DeliveryInterceptCommonResponseV2: + type: object + description: Object to contain properties common to all responses + properties: + transactionId: + type: string + description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes + minLength: 1 + maxLength: 14 + example: ASR1212 + statusCode: + description: API response status code, Internal code regarding the success or failure of the operation + maxLength: 3 + minLength: 3 + example: "000" + type: string + statusMsg: + type: string + description: API response status message, Internal message regarding the success or failure of the operation + minLength: 1 + maxLength: 80 + example: Success + subStatusCode: + type: string + description: A new status code for adding granularity to the existing status code structure + example: "7103" + success: + type: boolean + description: Indicates if the transaction is considered successful. + default: false + warnings: + type: + - object + - "null" + description: A map containing warning codes and descriptions as key/value pairs + errors: + type: + - array + - "null" + description: Unbounded array of error objects + items: + $ref: "#/components/schemas/DeliveryInterceptSuccessErrorV2" + additionalProperties: true + required: + - transactionId + - statusCode + DeliveryInterceptAddressV2: + type: object + properties: + addressLine1: + type: string + description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address. + minLength: 1 + maxLength: 50 + example: 12911 FORK RD + addressLine2: + type: string + description: Line 2 of the street address + minLength: 1 + maxLength: 35 + example: Ste 8 + addressLine3: + description: Line 3 of the street + minLength: 1 + maxLength: 35 + type: string + city: + type: string + description: The city name of the address + minLength: 1 + maxLength: 30 + example: Baldwin + state: + type: string + description: The state code of the address + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: MD + postalCode: + type: string + description: The postal code of the address (should be provided for postal countries) + minLength: 5 + maxLength: 16 + pattern: ^\d{5}(?:[-\s]\d{4})?$ + examples: + - "21013" + - "21093-1234" + countryCode: + type: string + description: The ISO country code of the address + maxLength: 2 + minLength: 2 + pattern: ^[A-Z]{2}$ + example: US + additionalProperties: true + required: + - addressLine1 + - city + - state + - postalCode + - countryCode + DeliveryInterceptAdditionalAddressV2: + type: object + properties: + buildingFloor: + type: string + example: "2" + publicLocationId: + type: string + example: U88498244 + firstName: + type: string + description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation . + example: HUNTLY + lastName: + type: string + description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation object. + example: OAK + fullName: + type: string + description: Full person name + example: HUNTLY OAK + phoneNumber: + type: string + maxLength: 17 + pattern: '^(\+)[0-9]{1,16}$' + example: "+19886222564" + additionalProperties: true + required: + - firstName + - phoneNumber + DeliveryInterceptChargeV2: + type: string + maxLength: 20 + pattern: ^\d{1,17}?\.\d{2}?$ + format: currency + example: "5.00" + DeliveryInterceptDateV2: + type: string + description: Provides the future dates available for delivery + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20250110" + DeliveryInterceptEligibilityValueV2: + type: string + enum: + - ELIGIBLE + - NOT_ELIGIBLE + - UNKNOWN + DeliveryInterceptTrackingNumberV2: + type: string + minLength: 18 + maxLength: 18 + pattern: ^(1Z)[A-Z0-9]{16}$ + example: 1ZA2F8810719086435 + DeliveryInterceptErrorResponseV2: + type: object + required: + - response + properties: + response: + type: object + required: + - statusCode + - errors + properties: + transactionId: + 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 + maxLength: 4 + minLength: 1 + example: "0006" + type: string + subStatusCode: + 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 + 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: + type: object + properties: + code: + description: |- + the code of the error + maxLength: 4 + minLength: 1 + example: "0006" + type: string + message: + description: |- + the message of the error + maxLength: 120 + minLength: 1 + example: "Failure to check eligibility through Tracking service" + type: string + DeliveryInterceptSuccessErrorV2: + type: object + description: | + Container to hold details related to an individual error. Will only be returned if the HTTP statusCode isn't '200'(success). + On the API version v3 the first element of the errors array contains the statusCode and scoring statusMessage field. + properties: + errorCode: + type: string + description: The code of the error + minLength: 1 + maxLength: 4 + example: "1201" + errorMessage: + type: string + description: The message of the error + minLength: 1 + maxLength: 120 + example: TransactionSrc + errorSource: + type: string + description: The source of the error + additionalProperties: false + required: + - errorCode + - errorMessage diff --git a/GlobalCheckout.yaml b/GlobalCheckout.yaml index effbdaa..ba56427 100644 --- a/GlobalCheckout.yaml +++ b/GlobalCheckout.yaml @@ -1,725 +1,724 @@ -openapi: 3.1.0 - -info: - title: Guaranteed Quote API v1 - version: "1.0" - termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html - description: | - This API provides a Global Landed Cost (GLC) duty and tax rate quote for shippers. - - ## 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.

- - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api/brokerage/{version} - description: UPS Customer Integration Environment - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/brokerage/{version} - description: UPS Production - variables: - version: - default: v1 - enum: - - v1 -tags: - - name: Global Checkout - description: Operations related to guaranteed rate quotes -security: - - OAuth2: [] -paths: - /content/glc/request-quote: - post: - operationId: createGuaranteedQuote - summary: returns a guaranteed landed cost quote - description: This endpoint requests guaranteed quotes for landed cost duties and taxes. - security: - - OAuth2: [] - tags: - - Global Checkout - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/transactionSrc" - - $ref: "#/components/parameters/Accept" - - $ref: "#/components/parameters/Content-Type" - - $ref: "#/components/parameters/registration-id" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BSIS_v1_QuoteRequest' - example: - buyerCurrencyCode: USD - shipperCurrencyCode: CAD - serviceLevelCode: "01" - referenceNumber: mar20240502 - shipperAccountNumber: " " - shipment: - importCountryCode: US - importProvince: AB - shipDate: 2024-04-01 - exportCountryCode: CA - transModes: INT_AIR - transportCost: - value: 999 - currencyCode: USD - insuranceCost: - value: 3000 - currencyCode: USD - shipmentType: Sale - shipperAddress: - name: IKEA Edmonton - addressLine1: 311 102 St - addressLine2: NW - postalCode: AB T6N 1M - city: Edmonton - countryCode: AB - stateProvinceCode: ON - shipToAddress: - name: UPS - addressLine1: 55 Glenlake Pkwy - addressLine2: NE - postalCode: "30328" - city: Sandy Springs - countryCode: US - stateProvinceCode: GA - residentialAddressIndicator: false - shipmentItems: - - partNumber: 40093ADA2 - quantity: - value: 12 - unitOfMeasure: pallets - grossWeight: - value: 1250 - unitOfMeasure: kg - unitPrice: - value: 1999 - currencyCode: USD - originCountryCode: GB - description: Surcoil Hose - Flush End - Long - dimension: - length: 48 - width: 48 - height: 60 - unitOfMeasure: IN - - partNumber: AF4535635 - originCountryCode: GB - quantity: - value: 10 - unitOfMeasure: barrels - grossWeight: - value: 1500 - unitOfMeasure: lb - unitPrice: - value: 1000 - currencyCode: USD - description: Cord 5mm PK50 Yellow/Red - dimension: - length: 24 - width: 24 - height: 36 - unitOfMeasure: IN - responses: - '200': - description: Request successful - headers: - application/json: - schema: - $ref: '#/components/schemas/BSIS_v1_SuccessResponseHeaders' - content: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_QuoteResponse" - example: - quoteId: QUOTE1233445 - quoteCreationTimestamp: 2024-05-08T17:02:43+0000 - referenceNumber: aaaaaaaaaaaaaaa33 - quoteExpirationDate: 2024-05-08 - gcTotal: - - type: Shipper - value: 89.2 - currencyCode: USD - - type: Buyer - value: 100.2 - currencyCode: CAD - "400": - description: Bad Request - headers: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_ErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_ErrorResponse" - example: - response: - errors: - - code: "0061" - message: Required parameter registration-id is invalid. - "401": - description: Unauthorized - headers: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_ErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_ErrorResponse" - example: - response: - errors: - - code: UJ0001 - message: The token was invalid/expired or could not be verified - "422": - description: Unprocessable Entity - headers: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_ErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/BSIS_v1_ErrorResponse" - example: - response: - errors: - - code: "105.350" - description: INVALID_PART_NUMBER - field: partNumber - message: PART_NUMBER is not valid - value: '' -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - "Find your Client ID and Secret on your app info page.
- 1. Select \\\"Try It\\\"
- 2. In the Security section enter your Client ID and Secret.
- 3. Select \\\"Request Token\\\"
- 4. Enter any additional information in the Body and Parameters sections.
- 5. Select \\\"Send\\\" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token (Opens in new window or tab) - scopes: {} - JWTAuth: - type: "http" - scheme: bearer - bearerFormat: JWT - parameters: - transId: - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - name: transactionSrc - in: header - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - example: EWS - Accept: - name: Accept - in: header - description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. - required: true - schema: - type: string - example: application/json - Content-Type: - name: Content-Type - in: header - description: The Content-Type header provides the client with the actual content/media type of the returned content. - required: true - schema: - type: string - example: application/json - registration-id: - name: registration-id - in: header - description: The Customer Registration Identifier used to validate the shipper account. If not passed then it will be obtained with the OAuth token's UUID. - required: false - schema: - type: string - pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' - example: "643F7EAC-DC06-19E3-84C9-0274164A04E9" - schemas: - BSIS_v1_QuoteRequest: - type: object - required: - - shipperAccountNumber - - shipperCurrencyCode - - shipment - properties: - buyerCurrencyCode: - type: string - description: | - Buyer's currency code adhering to ISO 4217 standard. - Click here for more information. - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3}$ - example: USD - shipperCurrencyCode: - type: string - description: | - Shipper's currency code adhering to ISO 4217 standard. - Click here for more information. - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3}$ - example: USD - serviceLevelCode: - type: string - description: | - The code for the UPS Service associated with the shipment. - Click here for more information. - enum: ["01", "02", "03", "07", "08", "11", "12", "13", "17", "54", "65", "M2", "M3", "M4", "M5", "M6", "M7", "71", "72", "74", "75", "82", "83", "84", "85", "86", "96"] - example: '01' - referenceNumber: - type: string - maxLength: 512 - description: A unique identifier used by clients for internal tracking. - example: Refc123 - shipperAccountNumber: - type: string - description: The Shipper's UPS Account Number. - minLength: 6 - maxLength: 6 - example: Acc123 - shipment: - $ref: "#/components/schemas/BSIS_v1_Shipment" - additionalProperties: false - BSIS_v1_Shipment: - type: object - required: - - importCountryCode - - exportCountryCode - - shipperAddress - - shipToAddress - - shipmentItems - minItems: 1 - maxItems: 1 - properties: - importCountryCode: - type: string - description: | - The ISO 3166 code of the country imported from. - Click here for more information. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: US - importProvince: - type: string - description: | - Specifies the Province taken from. - Click here for more information. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z0-9]{2}$ - example: A0 - shipDate: - type: string - description: ShipDate of the Request (YYYY-MM-DD). - format: date - minLength: 10 - maxLength: 10 - pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$ - example: 2024-05-08 - exportCountryCode: - type: string - description: The ISO 3166 code of the country exported to. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: AU - transModes: - type: string - description: | - The shipment mode of transportation. If not one of the listed values then it will default to the first one from the import country. - - | Mode | Description | - | :--: | :-- | - | DOM_AIR | Domestic Air transportation | - | DOM_OCEAN | Domestic Ocean transportation | - | DOM_RAIL | Domestic Rail transportation | - | DOM_TRUCK | Domestic Truck transportation | - | INT_AIR | International Air transportation | - | INT_OCEAN | International Ocean transportation | - | INT_RAIL | International Rail transportation | - | INT_TRUCK | International/Interstate Truck transportation | - enum: [DOM_AIR, DOM_OCEAN, DOM_RAIL, DOM_TRUCK, INT_AIR, INT_OCEAN, INT_RAIL, INT_TRUCK] - example: INT_AIR - transportCost: - description: | - Specifies the Transport Costs, which are used for tariff calculations in some governments. - If needed and not provided then internal Rate call will be made to retrieve it. - $ref: "#/components/schemas/BSIS_v1_ChargeDetail" - insuranceCost: - description: | - Specifies the fee charged by UPS for insuring the package, which could be used for tariff calculations in some governments. - This will be defaulted to 0 if needed and not provided. - $ref: "#/components/schemas/BSIS_v1_ChargeDetail" - shipmentType: - type: string - description: | - Specifies the shipment type. - - | Type | Description | - | :--: | :-- | - | GIFT | GIFT | - | COMM | Sale, Sample, Repair | - | OTHR | Return, Other, and Intercompany Data, Anything else not supported | - | PERS | Personal | - example: COMM - shipperAddress: - description: Shipper Address of request. Needed for internal rate call to calculate transportCost if that is needed and not provided. - $ref: "#/components/schemas/BSIS_v1_Address" - shipToAddress: - description: ShipTo Address of request. Needed for internal rate call to calculate transportCost if that is needed and not provided. - allOf: - - $ref: "#/components/schemas/BSIS_v1_Address" - - properties: - residentialAddressIndicator: - type: boolean - description: | - Indicate as true if the shipTo address is classified as residential (vs. commercial). Valid only for US50 addresses. - Needed for internal rate call to calculate transportCost if that is needed and not provided. - enum: [true,false] - example: true - shipmentItems: - type: array - minItems: 1 - maxItems: 99 - description: array of request ShipmentItems. - items: - $ref: "#/components/schemas/BSIS_v1_ShipmentItemRequest" - additionalProperties: false - BSIS_v1_ShipmentItemRequest: - type: object - description: Object containing the details of each item in the shipment. - required: - - unitPrice - - quantity - - partNumber - - originCountryCode - properties: - grossWeight: - description: | - Specifies the gross weight of the entire ShipmentItem, that is, the weight of all contained Products plus the Packaging weight, if any. Specifying this value overrides - any weight value in Product and/or Packaging objects. - properties: - value: - type: integer - description: | - The weight value. If this field is specified, the unitOfMeasure field must also be specified. If this field is not specified, - unitOfMeasure must be not be set to anything but null. - example: 4 - unitOfMeasure: - type: string - description: Unit Of Measure for the package weight. - enum: [kg, lb, oz, KG, LB, OZ] - example: lb - unitPrice: - $ref: "#/components/schemas/BSIS_v1_ChargeDetail" - quantity: - description: Container to quantity information on items within the shipmentItem. - required: - - value - - unitOfMeasure - properties: - value: - type: integer - description: Item count. - example: 4 - unitOfMeasure: - type: string - description: | - Item count Unit Of Measure - Click here for more information. - examples: - - Case - - Pallet - partNumber: - type: string - description: Part number or SKU, pre-approved for Garanteed Landed Cost service to identifier the item being shipped. - maxLength: 35 - example: ABDAD23455 - description: - type: string - description: This field is populated with the hscode description. - maxLength: 150 - example: FABRIC FOR UPHOLSTERY - originCountryCode: - type: string - description: The ISO 3166 code of the shipment item country. - minLength: 2 - maxLength: 2 - pattern: ^[a-zA-Z0-9]{2}$ - dimension: - type: object - required: - - length - - width - - height - - unitOfMeasure - properties: - length: - type: number - description: package length (no limit). - format: decimal - example: 1 - width: - type: number - description: package width (no limit). - format: decimal - example: 2 - height: - type: number - description: package height (no limit). - format: decimal - example: 3 - unitOfMeasure: - type: string - description: Specifies the units of measure. - enum: [in, cm, IN, CM] - example: IN - additionalProperties: false - BSIS_v1_QuoteResponse: - type: object - required: - - quoteId - - quoteCreationTimestamp - - quoteExpirationDate - - gcTotal - properties: - quoteId: - type: string - description: unique quote id. - maxLength: 32 - example: 1d2523754bde48bc95b738224de49d7b - quoteCreationTimestamp: - type: string - description: Timestamp for quote generation(UTC). - format: datetime - minLength: 24 - maxLength: 24 - pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)\+\d{4}$ - example: 2024-05-08T17:02:43+0000 - referenceNumber: - type: string - description: A reference for customer internal tracking from the request . - maxLength: 512 - example: "1234567890" - quoteExpirationDate: - type: string - description: Date after which the quote is no longer valid. yyyy-mm-dd format. - format: date - minLength: 10 - maxLength: 10 - pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$ - example: 2024-05-08 - gcTotal: - type: array - description: array for buyer and billing Global checkout total items. - minItems: 1 - maxItems: 2 - items: - $ref: "#/components/schemas/BSIS_v1_TotalResponse" - additionalProperties: false - BSIS_v1_TotalResponse: - description: buyer or billing Global checkout details. - allOf: - - $ref: "#/components/schemas/BSIS_v1_ChargeDetail" - - type: object - required: - - type - properties: - type: - type: string - description: Shipper is mandatory and the Buyer will be conditionally returned if Buyer currency is porvided. - enum: [Shipper, Buyer] - example: Shipper - BSIS_v1_ChargeDetail: - type: object - required: - - value - - currencyCode - properties: - value: - type: number - description: The value of a particular item in the shipment . - maxLength: 15 - format: double - pattern: ^-?\d+(,\d{3})*(\.\d{1,2})?$ - examples: - - 100.99 - - 999999999999.99 - currencyCode: - type: string - description: | - Currency Code of the unit total value adhering to ISO 4217 standard. - Click here for more information. - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3}$ - BSIS_v1_Address: - type: object - description: Common address fields - required: - - addressLine1 - - countryCode - properties: - name: - type: string - description: Shipper or or Consignee's name. - maxLength: 35 - example: John Lee - addressLine1: - type: string - description: Shipper or or Consignee's street addres line 1. - maxLength: 35 - example: 100 main street - addressLine2: - type: string - description: Shipper or or Consignee's street addres line 2. - maxLength: 35 - example: Suite 101 - postalCode: - type: string - description: Shipper's or Consignee's postal code. - minLength: 5 - maxLength: 9 - pattern: ^[a-zA-Z0-9\-\s]{5,9}$ - examples: - - '29003' - - '300054616' - city: - type: string - description: Shipper or Consignee's city. - maxLength: 30 - example: Columbia - countryCode: - type: string - description: The ISO 3166 code of the Shipper or Consignee's country or territory. - maxLength: 2 - example: US - stateProvinceCode: - type: string - description: Shipper or Consignee's state or province code. - maxLength: 2 - example: SC - BSIS_v1_SuccessResponseHeaders: - description: The headers that are returned for all error responses. - type: object - required: - - BkndTransId - - transId - - transactionSrc - - Accept - - Content-Type - properties: - BkndTransId: - type: string - description: The backend transaction id. - example: UJ0001 - transId: - type: string - description: An identifier unique to the request. - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - type: string - description: Identifies the client/source application that is calling. - example: CPC - Accept: - type: string - description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. - example: application/json - Content-Type: - type: string - description: The Content-Type header provides the client with the actual content/media type of the returned content. - example: application/json - BSIS_v1_ErrorResponseHeaders: - description: The headers that are returned in error conditions - allOf: - - $ref: "#/components/schemas/BSIS_v1_SuccessResponseHeaders" - - type: object - required: - - APIErrorCode - - APIErrorMsg - properties: - APIErrorCode: - type: string - description: The API error code. - example: UJ0001 - APIErrorMsg: - type: string - description: The API error message. - example: Invalid token or token is not present. - BSIS_v1_ErrorResponse: - type: object - description: response container. - required: - - response - properties: - response: - type: object - description: errors container. - required: - - errors - properties: - errors: - type: array - description: error payload - array containing one or more Errors. - items: - $ref: '#/components/schemas/BSIS_v1_Error' - additionalProperties: false - BSIS_v1_Error: - type: object - description: container for error and warning messages - required: - - code - - message - properties: - code: - description: code for the given message - type: string - example: "105.300" - description: - type: string - description: Internal description of the error - example: VALUE_REQUIRED - message: - description: the warning or error message to be conveyed - type: string - maxLength: 200 - example: Required field 'ImportCountryCode' is null. - value: - type: string - description: The value that caused the error - example: '' - field: - type: string - description: The path to the field causing the error as returned from the backend services. - example: shipment.importCountryCode - \ No newline at end of file +openapi: 3.1.0 + +info: + title: Guaranteed Quote API v1 + version: "1.0" + termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html + description: | + This API provides a Global Landed Cost (GLC) duty and tax rate quote for shippers. + + ## 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.

+ + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api/brokerage/{version} + description: UPS Customer Integration Environment + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/brokerage/{version} + description: UPS Production + variables: + version: + default: v1 + enum: + - v1 +tags: + - name: Global Checkout + description: Operations related to guaranteed rate quotes +security: + - OAuth2: [] +paths: + /content/glc/request-quote: + post: + operationId: createGuaranteedQuote + summary: returns a guaranteed landed cost quote + description: This endpoint requests guaranteed quotes for landed cost duties and taxes. + security: + - OAuth2: [] + tags: + - Global Checkout + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Accept" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/registration-id" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BSIS_v1_QuoteRequest' + example: + buyerCurrencyCode: USD + shipperCurrencyCode: CAD + serviceLevelCode: "01" + referenceNumber: mar20240502 + shipperAccountNumber: " " + shipment: + importCountryCode: US + importProvince: AB + shipDate: 2024-04-01 + exportCountryCode: CA + transModes: INT_AIR + transportCost: + value: 999 + currencyCode: USD + insuranceCost: + value: 3000 + currencyCode: USD + shipmentType: Sale + shipperAddress: + name: IKEA Edmonton + addressLine1: 311 102 St + addressLine2: NW + postalCode: AB T6N 1M + city: Edmonton + countryCode: AB + stateProvinceCode: ON + shipToAddress: + name: UPS + addressLine1: 55 Glenlake Pkwy + addressLine2: NE + postalCode: "30328" + city: Sandy Springs + countryCode: US + stateProvinceCode: GA + residentialAddressIndicator: false + shipmentItems: + - partNumber: 40093ADA2 + quantity: + value: 12 + unitOfMeasure: pallets + grossWeight: + value: 1250 + unitOfMeasure: kg + unitPrice: + value: 1999 + currencyCode: USD + originCountryCode: GB + description: Surcoil Hose - Flush End - Long + dimension: + length: 48 + width: 48 + height: 60 + unitOfMeasure: IN + - partNumber: AF4535635 + originCountryCode: GB + quantity: + value: 10 + unitOfMeasure: barrels + grossWeight: + value: 1500 + unitOfMeasure: lb + unitPrice: + value: 1000 + currencyCode: USD + description: Cord 5mm PK50 Yellow/Red + dimension: + length: 24 + width: 24 + height: 36 + unitOfMeasure: IN + responses: + '200': + description: Request successful + headers: + application/json: + schema: + $ref: '#/components/schemas/BSIS_v1_SuccessResponseHeaders' + content: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_QuoteResponse" + example: + quoteId: QUOTE1233445 + quoteCreationTimestamp: 2024-05-08T17:02:43+0000 + referenceNumber: aaaaaaaaaaaaaaa33 + quoteExpirationDate: 2024-05-08 + gcTotal: + - type: Shipper + value: 89.2 + currencyCode: USD + - type: Buyer + value: 100.2 + currencyCode: CAD + "400": + description: Bad Request + headers: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_ErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_ErrorResponse" + example: + response: + errors: + - code: "0061" + message: Required parameter registration-id is invalid. + "401": + description: Unauthorized + headers: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_ErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_ErrorResponse" + example: + response: + errors: + - code: UJ0001 + message: The token was invalid/expired or could not be verified + "422": + description: Unprocessable Entity + headers: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_ErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/BSIS_v1_ErrorResponse" + example: + response: + errors: + - code: "105.350" + description: INVALID_PART_NUMBER + field: partNumber + message: PART_NUMBER is not valid + value: '' +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + "Find your Client ID and Secret on your app info page.
+ 1. Select \\\"Try It\\\"
+ 2. In the Security section enter your Client ID and Secret.
+ 3. Select \\\"Request Token\\\"
+ 4. Enter any additional information in the Body and Parameters sections.
+ 5. Select \\\"Send\\\" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token (Opens in new window or tab) + scopes: {} + JWTAuth: + type: "http" + scheme: bearer + bearerFormat: JWT + parameters: + transId: + name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + name: transactionSrc + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + example: EWS + Accept: + name: Accept + in: header + description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. + required: true + schema: + type: string + example: application/json + Content-Type: + name: Content-Type + in: header + description: The Content-Type header provides the client with the actual content/media type of the returned content. + required: true + schema: + type: string + example: application/json + registration-id: + name: registration-id + in: header + description: The Customer Registration Identifier used to validate the shipper account. If not passed then it will be obtained with the OAuth token's UUID. + required: false + schema: + type: string + pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' + example: "643F7EAC-DC06-19E3-84C9-0274164A04E9" + schemas: + BSIS_v1_QuoteRequest: + type: object + required: + - shipperAccountNumber + - shipperCurrencyCode + - shipment + properties: + buyerCurrencyCode: + type: string + description: | + Buyer's currency code adhering to ISO 4217 standard. + Click here for more information. + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3}$ + example: USD + shipperCurrencyCode: + type: string + description: | + Shipper's currency code adhering to ISO 4217 standard. + Click here for more information. + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3}$ + example: USD + serviceLevelCode: + type: string + description: | + The code for the UPS Service associated with the shipment. + Click here for more information. + enum: ["01", "02", "03", "07", "08", "11", "12", "13", "17", "54", "65", "M2", "M3", "M4", "M5", "M6", "M7", "71", "72", "74", "75", "82", "83", "84", "85", "86", "96"] + example: '01' + referenceNumber: + type: string + maxLength: 512 + description: A unique identifier used by clients for internal tracking. + example: Refc123 + shipperAccountNumber: + type: string + description: The Shipper's UPS Account Number. + minLength: 6 + maxLength: 6 + example: Acc123 + shipment: + $ref: "#/components/schemas/BSIS_v1_Shipment" + additionalProperties: false + BSIS_v1_Shipment: + type: object + required: + - importCountryCode + - exportCountryCode + - shipperAddress + - shipToAddress + - shipmentItems + minItems: 1 + maxItems: 1 + properties: + importCountryCode: + type: string + description: | + The ISO 3166 code of the country imported from. + Click here for more information. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + importProvince: + type: string + description: | + Specifies the Province taken from. + Click here for more information. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z0-9]{2}$ + example: A0 + shipDate: + type: string + description: ShipDate of the Request (YYYY-MM-DD). + format: date + minLength: 10 + maxLength: 10 + pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$ + example: 2024-05-08 + exportCountryCode: + type: string + description: The ISO 3166 code of the country exported to. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: AU + transModes: + type: string + description: | + The shipment mode of transportation. If not one of the listed values then it will default to the first one from the import country. + + | Mode | Description | + | :--: | :-- | + | DOM_AIR | Domestic Air transportation | + | DOM_OCEAN | Domestic Ocean transportation | + | DOM_RAIL | Domestic Rail transportation | + | DOM_TRUCK | Domestic Truck transportation | + | INT_AIR | International Air transportation | + | INT_OCEAN | International Ocean transportation | + | INT_RAIL | International Rail transportation | + | INT_TRUCK | International/Interstate Truck transportation | + enum: [DOM_AIR, DOM_OCEAN, DOM_RAIL, DOM_TRUCK, INT_AIR, INT_OCEAN, INT_RAIL, INT_TRUCK] + example: INT_AIR + transportCost: + description: | + Specifies the Transport Costs, which are used for tariff calculations in some governments. + If needed and not provided then internal Rate call will be made to retrieve it. + $ref: "#/components/schemas/BSIS_v1_ChargeDetail" + insuranceCost: + description: | + Specifies the fee charged by UPS for insuring the package, which could be used for tariff calculations in some governments. + This will be defaulted to 0 if needed and not provided. + $ref: "#/components/schemas/BSIS_v1_ChargeDetail" + shipmentType: + type: string + description: | + Specifies the shipment type. + + | Type | Description | + | :--: | :-- | + | GIFT | GIFT | + | COMM | Sale, Sample, Repair | + | OTHR | Return, Other, and Intercompany Data, Anything else not supported | + | PERS | Personal | + example: COMM + shipperAddress: + description: Shipper Address of request. Needed for internal rate call to calculate transportCost if that is needed and not provided. + $ref: "#/components/schemas/BSIS_v1_Address" + shipToAddress: + description: ShipTo Address of request. Needed for internal rate call to calculate transportCost if that is needed and not provided. + allOf: + - $ref: "#/components/schemas/BSIS_v1_Address" + - properties: + residentialAddressIndicator: + type: boolean + description: | + Indicate as true if the shipTo address is classified as residential (vs. commercial). Valid only for US50 addresses. + Needed for internal rate call to calculate transportCost if that is needed and not provided. + enum: [true,false] + example: true + shipmentItems: + type: array + minItems: 1 + maxItems: 99 + description: array of request ShipmentItems. + items: + $ref: "#/components/schemas/BSIS_v1_ShipmentItemRequest" + additionalProperties: false + BSIS_v1_ShipmentItemRequest: + type: object + description: Object containing the details of each item in the shipment. + required: + - unitPrice + - quantity + - partNumber + - originCountryCode + properties: + grossWeight: + description: | + Specifies the gross weight of the entire ShipmentItem, that is, the weight of all contained Products plus the Packaging weight, if any. Specifying this value overrides + any weight value in Product and/or Packaging objects. + properties: + value: + type: integer + description: | + The weight value. If this field is specified, the unitOfMeasure field must also be specified. If this field is not specified, + unitOfMeasure must be not be set to anything but null. + example: 4 + unitOfMeasure: + type: string + description: Unit Of Measure for the package weight. + enum: [kg, lb, oz, KG, LB, OZ] + example: lb + unitPrice: + $ref: "#/components/schemas/BSIS_v1_ChargeDetail" + quantity: + description: Container to quantity information on items within the shipmentItem. + required: + - value + - unitOfMeasure + properties: + value: + type: integer + description: Item count. + example: 4 + unitOfMeasure: + type: string + description: | + Item count Unit Of Measure + Click here for more information. + examples: + - Case + - Pallet + partNumber: + type: string + description: Part number or SKU, pre-approved for Garanteed Landed Cost service to identifier the item being shipped. + maxLength: 35 + example: ABDAD23455 + description: + type: string + description: This field is populated with the hscode description. + maxLength: 150 + example: FABRIC FOR UPHOLSTERY + originCountryCode: + type: string + description: The ISO 3166 code of the shipment item country. + minLength: 2 + maxLength: 2 + pattern: ^[a-zA-Z0-9]{2}$ + dimension: + type: object + required: + - length + - width + - height + - unitOfMeasure + properties: + length: + type: number + description: package length (no limit). + format: decimal + example: 1 + width: + type: number + description: package width (no limit). + format: decimal + example: 2 + height: + type: number + description: package height (no limit). + format: decimal + example: 3 + unitOfMeasure: + type: string + description: Specifies the units of measure. + enum: [in, cm, IN, CM] + example: IN + additionalProperties: false + BSIS_v1_QuoteResponse: + type: object + required: + - quoteId + - quoteCreationTimestamp + - quoteExpirationDate + - gcTotal + properties: + quoteId: + type: string + description: unique quote id. + maxLength: 32 + example: 1d2523754bde48bc95b738224de49d7b + quoteCreationTimestamp: + type: string + description: Timestamp for quote generation(UTC). + format: datetime + minLength: 24 + maxLength: 24 + pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)\+\d{4}$ + example: 2024-05-08T17:02:43+0000 + referenceNumber: + type: string + description: A reference for customer internal tracking from the request . + maxLength: 512 + example: "1234567890" + quoteExpirationDate: + type: string + description: Date after which the quote is no longer valid. yyyy-mm-dd format. + format: date + minLength: 10 + maxLength: 10 + pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$ + example: 2024-05-08 + gcTotal: + type: array + description: array for buyer and billing Global checkout total items. + minItems: 1 + maxItems: 2 + items: + $ref: "#/components/schemas/BSIS_v1_TotalResponse" + additionalProperties: false + BSIS_v1_TotalResponse: + description: buyer or billing Global checkout details. + allOf: + - $ref: "#/components/schemas/BSIS_v1_ChargeDetail" + - type: object + required: + - type + properties: + type: + type: string + description: Shipper is mandatory and the Buyer will be conditionally returned if Buyer currency is porvided. + enum: [Shipper, Buyer] + example: Shipper + BSIS_v1_ChargeDetail: + type: object + required: + - value + - currencyCode + properties: + value: + type: number + description: The value of a particular item in the shipment . + maxLength: 15 + format: double + pattern: ^-?\d+(,\d{3})*(\.\d{1,2})?$ + examples: + - 100.99 + - 999999999999.99 + currencyCode: + type: string + description: | + Currency Code of the unit total value adhering to ISO 4217 standard. + Click here for more information. + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3}$ + BSIS_v1_Address: + type: object + description: Common address fields + required: + - addressLine1 + - countryCode + properties: + name: + type: string + description: Shipper or or Consignee's name. + maxLength: 35 + example: John Lee + addressLine1: + type: string + description: Shipper or or Consignee's street addres line 1. + maxLength: 35 + example: 100 main street + addressLine2: + type: string + description: Shipper or or Consignee's street addres line 2. + maxLength: 35 + example: Suite 101 + postalCode: + type: string + description: Shipper's or Consignee's postal code. + minLength: 5 + maxLength: 9 + pattern: ^[a-zA-Z0-9\-\s]{5,9}$ + examples: + - '29003' + - '300054616' + city: + type: string + description: Shipper or Consignee's city. + maxLength: 30 + example: Columbia + countryCode: + type: string + description: The ISO 3166 code of the Shipper or Consignee's country or territory. + maxLength: 2 + example: US + stateProvinceCode: + type: string + description: Shipper or Consignee's state or province code. + maxLength: 2 + example: SC + BSIS_v1_SuccessResponseHeaders: + description: The headers that are returned for all error responses. + type: object + required: + - BkndTransId + - transId + - transactionSrc + - Accept + - Content-Type + properties: + BkndTransId: + type: string + description: The backend transaction id. + example: UJ0001 + transId: + type: string + description: An identifier unique to the request. + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + type: string + description: Identifies the client/source application that is calling. + example: CPC + Accept: + type: string + description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. + example: application/json + Content-Type: + type: string + description: The Content-Type header provides the client with the actual content/media type of the returned content. + example: application/json + BSIS_v1_ErrorResponseHeaders: + description: The headers that are returned in error conditions + allOf: + - $ref: "#/components/schemas/BSIS_v1_SuccessResponseHeaders" + - type: object + required: + - APIErrorCode + - APIErrorMsg + properties: + APIErrorCode: + type: string + description: The API error code. + example: UJ0001 + APIErrorMsg: + type: string + description: The API error message. + example: Invalid token or token is not present. + BSIS_v1_ErrorResponse: + type: object + description: response container. + required: + - response + properties: + response: + type: object + description: errors container. + required: + - errors + properties: + errors: + type: array + description: error payload - array containing one or more Errors. + items: + $ref: '#/components/schemas/BSIS_v1_Error' + additionalProperties: false + BSIS_v1_Error: + type: object + description: container for error and warning messages + required: + - code + - message + properties: + code: + description: code for the given message + type: string + example: "105.300" + description: + type: string + description: Internal description of the error + example: VALUE_REQUIRED + message: + description: the warning or error message to be conveyed + type: string + maxLength: 200 + example: Required field 'ImportCountryCode' is null. + value: + type: string + description: The value that caused the error + example: '' + field: + type: string + description: The path to the field causing the error as returned from the backend services. + example: shipment.importCountryCode diff --git a/InteractiveDescriptionGuidance.yaml b/InteractiveDescriptionGuidance.yaml index f633581..3021ec4 100644 --- a/InteractiveDescriptionGuidance.yaml +++ b/InteractiveDescriptionGuidance.yaml @@ -1,895 +1,895 @@ -openapi: 3.1.0 -info: - title: Interactive Description Guidance - description: | - The Interactive Commodity Description API will guide an International shipper through a series of - multiple-choice questions in order to improve the commodity description such that it can be tied to a full, - destination country specific Harmonized Tariff Schedule code (HTS). The tariff code is used for expediting customs - clearance, avoiding customs holds, and ensuring accurate assessing of duties and taxes. Both an updated, natural - language description and tariff code will be returned. The chargeable event is the return of the full tariff code. - - For more information on the Interactive Description API, please visit the Product Info page. - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - version: "1.0" -servers: - - url: https://wwwcie.ups.com/api/export-assure/{version} - description: Customer Integration Environment URL - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/export-assure/{version} - description: Production URL - variables: - version: - default: v1 - enum: - - v1 -security: - - OAuth2: [] -tags: - - name: Interactive Description - description: Operations for interactively generating detailed product descriptions and HTC codes. - - name: Feedback - description: Operations for providing feedback using the 'id' of a question. -paths: - /interactive: - post: - tags: - - Interactive Description - summary: Initiates an interactive description session for a product. - description: Initiates an interactive description session for a product. - security: - - OAuth2: [] - operationId: start_interactive_post - parameters: - - name: transId - in: header - required: true - description: A 128 bit GUID. - schema: - type: string - maxLength: 32 - - name: transactionSrc - in: header - required: true - description: The consuming application or user name. - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/StartRequest" - responses: - "200": - description: Successful Response - headers: - x-api-success-count: - 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: - type: integer - example: 1 - content: - application/json: - schema: - $ref: "#/components/schemas/InteractiveResponse" - "400": - description: Bad Request - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Invalid input provided" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4000" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4000: - value: - response: - errors: - - code: "4000" - message: "Invalid input provided" - E7001: - value: - response: - errors: - - code: "7001" - message: "Unsupported Country" - E7002: - value: - response: - errors: - - code: "7002" - message: "Unsupported Language" - E7004: - value: - response: - errors: - - code: "7004" - message: "Session Expired or Does Not Exist" - E7008: - value: - response: - errors: - - code: "7008" - message: "Invalid Commodity HTS Code" - E7011: - value: - response: - errors: - - code: "7011" - message: "Insufficient Description" - E7015: - value: - response: - errors: - - code: "7015" - message: "Selected Locale Does Not Match Description Language" - "401": - description: Unauthorized - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Invalid token or token is not present" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "UJ0001" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - UJ0001: - value: - response: - errors: - - code: "UJ0001" - message: "Invalid token or token is not present" - "415": - description: Unsupported Media Type - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Unsupported Media Type" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4015" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4015: - value: - response: - errors: - - code: "4015" - message: "Unsupported Media Type" - "422": - description: Unprocessable Entity - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Unprocessable Entity" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4022" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4022: - value: - response: - errors: - - code: "4022" - message: "Unprocessable Entity" - "500": - description: Internal Server Error - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Internal Server Error" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "5000" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E5000: - value: - response: - errors: - - code: "5000" - message: "Internal Server Error" - /interactive/{sessionId}: - post: - tags: - - 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. - - 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: [] - operationId: iterate_interactive__sessionId__post - parameters: - - name: sessionId - in: path - required: true - schema: - type: string - - name: transId - in: header - required: true - description: A 128 bit GUID. - schema: - type: string - maxLength: 32 - - name: transactionSrc - in: header - required: true - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/IterateRequest" - responses: - "200": - description: Successful Response - headers: - x-api-success-count: - 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: - type: integer - example: 1 - content: - application/json: - schema: - $ref: "#/components/schemas/InteractiveResponse" - "400": - description: Bad Request - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Invalid input provided" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4000" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4000: - value: - response: - errors: - - code: "4000" - message: "Invalid input provided" - E7005: - value: - response: - errors: - - code: "7005" - message: "Unknown Question" - E7006: - value: - response: - errors: - - code: "7006" - message: "Invalid Sequence" - E7007: - value: - response: - errors: - - code: "7007" - message: "Option Index Out of Range" - "401": - description: Unauthorized - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Invalid token or token is not present" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "UJ0001" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - UJ0001: - value: - response: - errors: - - code: "UJ0001" - message: "Invalid token or token is not present" - "415": - description: Unsupported Media Type - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Unsupported Media Type" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4015" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4015: - value: - response: - errors: - - code: "4015" - message: "Unsupported Media Type" - "422": - description: Unprocessable Entity - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Unprocessable Entity" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4022" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4022: - value: - response: - errors: - - code: "4022" - message: "Unprocessable Entity" - "500": - description: Internal Server Error - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Internal Server Error" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "5000" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E5000: - value: - response: - errors: - - code: "5000" - message: "Internal Server Error" - /interactive/feedback/{sessionId}: - post: - tags: - - Interactive Description - summary: Allows the user to provide feedback on a specific question of the - overall session. - description: Allows the user to provide feedback on a specific question of the - overall session. - security: - - OAuth2: [] - operationId: submit_feedback_interactive_feedback__sessionId__post - parameters: - - name: sessionId - in: path - required: true - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Feedback" - responses: - "204": - description: Successful Response - "400": - description: Bad Request - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Invalid input provided" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4000" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4000: - value: - response: - errors: - - code: "4000" - message: "Invalid input provided" - E7004: - value: - response: - errors: - - code: "7004" - message: "Session Expired or Does Not Exist" - E7005: - value: - response: - errors: - - code: "7005" - message: "Unknown Question" - "401": - description: Unauthorized - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Invalid token or token is not present" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "UJ0001" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - UJ0001: - value: - response: - errors: - - code: "UJ0001" - message: "Invalid token or token is not present" - "415": - description: Unsupported Media Type - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Unsupported Media Type" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4015" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4015: - value: - response: - errors: - - code: "4015" - message: "Unsupported Media Type" - "422": - description: Unprocessable Entity - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Unprocessable Entity" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "4022" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E4022: - value: - response: - errors: - - code: "4022" - message: "Unprocessable Entity" - "500": - description: Internal Server Error - headers: - APIErrorMsg: - description: Error message describing the error - schema: - type: string - example: "Internal Server Error" - APIErrorCode: - description: Error code indicating the type of error - schema: - type: string - example: "5000" - content: - application/json: - schema: - $ref: "#/components/schemas/CustomErrorResponse" - examples: - E5000: - value: - response: - errors: - - code: "5000" - message: "Internal Server Error" -components: - schemas: - Answer: - type: object - properties: - id: - type: string - 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. - 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: - - id - - selected - Countries: - type: string - enum: - - "US" - - "CA" - - "CN" - - "UK" - - "DE" - - "HK" - - "NL" - - "IT" - - "ES" - - "FR" - - "GB" - - "IE" - CustomErrorResponse: - type: object - properties: - response: - $ref: "#/components/schemas/ErrorObjList" - required: - - response - ErrorObj: - type: object - properties: - code: - type: string - message: - type: string - required: - - code - - message - ErrorObjList: - type: object - properties: - errors: - type: array - items: - $ref: "#/components/schemas/ErrorObj" - required: - - errors - Feedback: - type: object - properties: - id: - type: string - description: The id field represents the unique identifier of the specific question for which the user is submitting feedback. This identifier ensures that the feedback is accurately associated with the correct question within the session. - sentiment: - type: boolean - description: The "sentiment" field is a boolean that indicates the user's sentiment towards the specific question. A value of true represents a positive sentiment, while a value of false represents negative sentiment. - feedback: - type: string - description: An optional field for user input to describe the reason for their - sentiment. - required: - - id - - sentiment - History: - type: object - properties: - id: - type: string - 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. - 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: - type: boolean - description: Identifies whether the API selected an answer to the corresponding question without having to explicitly ask it to the user. The value true means that the answer was assumed by the API, while false means that the answer was selected by the user. - example: true - required: - - id - - selected - - assumed - InteractiveResponse: - type: object - properties: - newProductDescription: - type: string - description: An enhanced description generated for the product after processing product details. - actualHts: - type: string - description: The Harmonized Tariff Schedule (HTS) code representing the currently provided "newProductDescription" - example: "010121" - suggestedHts: - type: string - description: The API's prediction for what the final Harmonized Tariff Schedule (HTS) code might be based on the current point of the session. - example: "01012100" - confidence: - type: number - description: A value between 0.00 and 1.00 representing the APIs likeliness for a suggestedHts to be the final HTS code. A value of 1.00 can also be interpreted as 100% confidence. - minimum: 0.0 - maximum: 1.0 - noMoreQuestions: - type: boolean - description: This field will be marked as true when the API doesn't have any more questions to ask the user. In this case, the questions list will be empty and the most complete "actualHts" is provided. - default: false - questions: - type: array - items: - $ref: "#/components/schemas/Question" - session: - $ref: "#/components/schemas/Session" - required: - - newProductDescription - - session - IterateRequest: - type: object - properties: - questions: - type: array - items: - $ref: "#/components/schemas/Answer" - required: - - questions - Languages: - type: string - description: The language code following the ISO 639-1 standard. - enum: - - "EN" - QuestionType: - type: string - enum: - - multiple_choice - Question: - type: object - properties: - id: - type: string - description: The unique identifier of a question. - type: - description: The formatting of the question and how it should be presented to the user. - $ref: "#/components/schemas/QuestionType" - question: - type: string - description: A question asked by the API to help clarify and improve product description. - maxLength: 2048 - example: "What is the intended use of your water bottle?" - options: - type: array - description: A list representing the most common possible answers to a question. - items: - type: string - 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. - 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 - example: ["PET", "PPT"] - selected: - type: integer - description: |- - 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: - type: boolean - description: Identifies whether the API selected an answer to the corresponding question without having to explicitly ask it to the user. - default: false - required: - - id - - question - - options - Session: - type: object - description: An object representing the user's session, a series of questions and selected answers. - properties: - id: - type: string - description: A unique identifier for representing the session belonging a user. - historyDesc: - type: array - items: - $ref: "#/components/schemas/History" - required: - - id - StartRequest: - type: object - properties: - importCountryCode: - type: string - description: The two-letter ISO 3166-1 alpha-2 country code representing the import country. - $ref: "#/components/schemas/Countries" - example: "US" - exportCountryCode: - type: string - description: The two-letter ISO 3166-1 alpha-2 country code representing the export country. - example: "US" - commodityValue: - type: string - description: The declared value of the commodity for customs and trade purposes. - example: "100.00" - commodityCurrencyCode: - type: string - description: The three-letter currency code representing the currency in which the commodity value is expressed, according to the ISO 4217 standard. - example: "USD" - commodityQuantity: - type: string - description: The quantity of the commodity. - example: "100" - commodityUnitOfMeasure: - type: string - description: The unit of measure used for the commodity quantity. - example: "ml" - commodityDescription: - type: string - description: A brief description of the commodity, detailing its type and key characteristics. - example: "Water Bottles" - commodityHtsCode: - type: string - description: The commodityHtsCode is an optional field that allows the user to submit their known HTS classification. This will be used as a starting point for the interactive description guidance process. - example: "0101" - commodityCountryOfOrigin: - type: string - description: The two-letter ISO 3166-1 alpha-2 country code representing the country of origin of the commodity. - example: "US" - shipperName: - type: string - description: The name of the company or individual responsible for shipping the commodity. - example: "Hardwood Floors LLC" - shipperAccountNumber: - type: string - description: The account number representing the company or individual responsible for shipping the commodity. - example: "10003KER50" - locale: - type: string - description: The language the user uses to submit their initial product description. If the actual language used differs from this field, the application will throw an error as a "7015". - allOf: - - $ref: "#/components/schemas/Languages" - default: "EN" - required: - - importCountryCode - - commodityDescription - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} \ No newline at end of file +openapi: 3.1.0 +info: + title: Interactive Description Guidance + description: | + The Interactive Commodity Description API will guide an International shipper through a series of + multiple-choice questions in order to improve the commodity description such that it can be tied to a full, + destination country specific Harmonized Tariff Schedule code (HTS). The tariff code is used for expediting customs + clearance, avoiding customs holds, and ensuring accurate assessing of duties and taxes. Both an updated, natural + language description and tariff code will be returned. The chargeable event is the return of the full tariff code. + + For more information on the Interactive Description API, please visit the Product Info page. + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + version: "1.0" +servers: + - url: https://wwwcie.ups.com/api/export-assure/{version} + description: Customer Integration Environment URL + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/export-assure/{version} + description: Production URL + variables: + version: + default: v1 + enum: + - v1 +security: + - OAuth2: [] +tags: + - name: Interactive Description + description: Operations for interactively generating detailed product descriptions and HTC codes. + - name: Feedback + description: Operations for providing feedback using the 'id' of a question. +paths: + /interactive: + post: + tags: + - Interactive Description + summary: Initiates an interactive description session for a product. + description: Initiates an interactive description session for a product. + security: + - OAuth2: [] + operationId: start_interactive_post + parameters: + - name: transId + in: header + required: true + description: A 128 bit GUID. + schema: + type: string + maxLength: 32 + - name: transactionSrc + in: header + required: true + description: The consuming application or user name. + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/StartRequest" + responses: + "200": + description: Successful Response + headers: + x-api-success-count: + 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: + type: integer + example: 1 + content: + application/json: + schema: + $ref: "#/components/schemas/InteractiveResponse" + "400": + description: Bad Request + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Invalid input provided" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4000" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4000: + value: + response: + errors: + - code: "4000" + message: "Invalid input provided" + E7001: + value: + response: + errors: + - code: "7001" + message: "Unsupported Country" + E7002: + value: + response: + errors: + - code: "7002" + message: "Unsupported Language" + E7004: + value: + response: + errors: + - code: "7004" + message: "Session Expired or Does Not Exist" + E7008: + value: + response: + errors: + - code: "7008" + message: "Invalid Commodity HTS Code" + E7011: + value: + response: + errors: + - code: "7011" + message: "Insufficient Description" + E7015: + value: + response: + errors: + - code: "7015" + message: "Selected Locale Does Not Match Description Language" + "401": + description: Unauthorized + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Invalid token or token is not present" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "UJ0001" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + UJ0001: + value: + response: + errors: + - code: "UJ0001" + message: "Invalid token or token is not present" + "415": + description: Unsupported Media Type + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Unsupported Media Type" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4015" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4015: + value: + response: + errors: + - code: "4015" + message: "Unsupported Media Type" + "422": + description: Unprocessable Entity + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Unprocessable Entity" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4022" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4022: + value: + response: + errors: + - code: "4022" + message: "Unprocessable Entity" + "500": + description: Internal Server Error + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Internal Server Error" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "5000" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E5000: + value: + response: + errors: + - code: "5000" + message: "Internal Server Error" + /interactive/{sessionId}: + post: + tags: + - 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. + + 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: [] + operationId: iterate_interactive__sessionId__post + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + - name: transId + in: header + required: true + description: A 128 bit GUID. + schema: + type: string + maxLength: 32 + - name: transactionSrc + in: header + required: true + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/IterateRequest" + responses: + "200": + description: Successful Response + headers: + x-api-success-count: + 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: + type: integer + example: 1 + content: + application/json: + schema: + $ref: "#/components/schemas/InteractiveResponse" + "400": + description: Bad Request + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Invalid input provided" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4000" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4000: + value: + response: + errors: + - code: "4000" + message: "Invalid input provided" + E7005: + value: + response: + errors: + - code: "7005" + message: "Unknown Question" + E7006: + value: + response: + errors: + - code: "7006" + message: "Invalid Sequence" + E7007: + value: + response: + errors: + - code: "7007" + message: "Option Index Out of Range" + "401": + description: Unauthorized + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Invalid token or token is not present" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "UJ0001" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + UJ0001: + value: + response: + errors: + - code: "UJ0001" + message: "Invalid token or token is not present" + "415": + description: Unsupported Media Type + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Unsupported Media Type" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4015" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4015: + value: + response: + errors: + - code: "4015" + message: "Unsupported Media Type" + "422": + description: Unprocessable Entity + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Unprocessable Entity" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4022" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4022: + value: + response: + errors: + - code: "4022" + message: "Unprocessable Entity" + "500": + description: Internal Server Error + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Internal Server Error" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "5000" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E5000: + value: + response: + errors: + - code: "5000" + message: "Internal Server Error" + /interactive/feedback/{sessionId}: + post: + tags: + - Interactive Description + summary: Allows the user to provide feedback on a specific question of the + overall session. + description: Allows the user to provide feedback on a specific question of the + overall session. + security: + - OAuth2: [] + operationId: submit_feedback_interactive_feedback__sessionId__post + parameters: + - name: sessionId + in: path + required: true + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Feedback" + responses: + "204": + description: Successful Response + "400": + description: Bad Request + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Invalid input provided" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4000" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4000: + value: + response: + errors: + - code: "4000" + message: "Invalid input provided" + E7004: + value: + response: + errors: + - code: "7004" + message: "Session Expired or Does Not Exist" + E7005: + value: + response: + errors: + - code: "7005" + message: "Unknown Question" + "401": + description: Unauthorized + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Invalid token or token is not present" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "UJ0001" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + UJ0001: + value: + response: + errors: + - code: "UJ0001" + message: "Invalid token or token is not present" + "415": + description: Unsupported Media Type + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Unsupported Media Type" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4015" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4015: + value: + response: + errors: + - code: "4015" + message: "Unsupported Media Type" + "422": + description: Unprocessable Entity + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Unprocessable Entity" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "4022" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E4022: + value: + response: + errors: + - code: "4022" + message: "Unprocessable Entity" + "500": + description: Internal Server Error + headers: + APIErrorMsg: + description: Error message describing the error + schema: + type: string + example: "Internal Server Error" + APIErrorCode: + description: Error code indicating the type of error + schema: + type: string + example: "5000" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomErrorResponse" + examples: + E5000: + value: + response: + errors: + - code: "5000" + message: "Internal Server Error" +components: + schemas: + Answer: + type: object + properties: + id: + type: string + 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. + 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: + - id + - selected + Countries: + type: string + enum: + - "US" + - "CA" + - "CN" + - "UK" + - "DE" + - "HK" + - "NL" + - "IT" + - "ES" + - "FR" + - "GB" + - "IE" + CustomErrorResponse: + type: object + properties: + response: + $ref: "#/components/schemas/ErrorObjList" + required: + - response + ErrorObj: + type: object + properties: + code: + type: string + message: + type: string + required: + - code + - message + ErrorObjList: + type: object + properties: + errors: + type: array + items: + $ref: "#/components/schemas/ErrorObj" + required: + - errors + Feedback: + type: object + properties: + id: + type: string + description: The id field represents the unique identifier of the specific question for which the user is submitting feedback. This identifier ensures that the feedback is accurately associated with the correct question within the session. + sentiment: + type: boolean + description: The "sentiment" field is a boolean that indicates the user's sentiment towards the specific question. A value of true represents a positive sentiment, while a value of false represents negative sentiment. + feedback: + type: string + description: An optional field for user input to describe the reason for their + sentiment. + required: + - id + - sentiment + History: + type: object + properties: + id: + type: string + 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. + 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: + type: boolean + description: Identifies whether the API selected an answer to the corresponding question without having to explicitly ask it to the user. The value true means that the answer was assumed by the API, while false means that the answer was selected by the user. + example: true + required: + - id + - selected + - assumed + InteractiveResponse: + type: object + properties: + newProductDescription: + type: string + description: An enhanced description generated for the product after processing product details. + actualHts: + type: string + description: The Harmonized Tariff Schedule (HTS) code representing the currently provided "newProductDescription" + example: "010121" + suggestedHts: + type: string + description: The API's prediction for what the final Harmonized Tariff Schedule (HTS) code might be based on the current point of the session. + example: "01012100" + confidence: + type: number + description: A value between 0.00 and 1.00 representing the APIs likeliness for a suggestedHts to be the final HTS code. A value of 1.00 can also be interpreted as 100% confidence. + minimum: 0.0 + maximum: 1.0 + noMoreQuestions: + type: boolean + description: This field will be marked as true when the API doesn't have any more questions to ask the user. In this case, the questions list will be empty and the most complete "actualHts" is provided. + default: false + questions: + type: array + items: + $ref: "#/components/schemas/Question" + session: + $ref: "#/components/schemas/Session" + required: + - newProductDescription + - session + IterateRequest: + type: object + properties: + questions: + type: array + items: + $ref: "#/components/schemas/Answer" + required: + - questions + Languages: + type: string + description: The language code following the ISO 639-1 standard. + enum: + - "EN" + QuestionType: + type: string + enum: + - multiple_choice + Question: + type: object + properties: + id: + type: string + description: The unique identifier of a question. + type: + description: The formatting of the question and how it should be presented to the user. + $ref: "#/components/schemas/QuestionType" + question: + type: string + description: A question asked by the API to help clarify and improve product description. + maxLength: 2048 + example: "What is the intended use of your water bottle?" + options: + type: array + description: A list representing the most common possible answers to a question. + items: + type: string + 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. + 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 + example: ["PET", "PPT"] + selected: + type: integer + description: |- + 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: + type: boolean + description: Identifies whether the API selected an answer to the corresponding question without having to explicitly ask it to the user. + default: false + required: + - id + - question + - options + Session: + type: object + description: An object representing the user's session, a series of questions and selected answers. + properties: + id: + type: string + description: A unique identifier for representing the session belonging a user. + historyDesc: + type: array + items: + $ref: "#/components/schemas/History" + required: + - id + StartRequest: + type: object + properties: + importCountryCode: + type: string + description: The two-letter ISO 3166-1 alpha-2 country code representing the import country. + $ref: "#/components/schemas/Countries" + example: "US" + exportCountryCode: + type: string + description: The two-letter ISO 3166-1 alpha-2 country code representing the export country. + example: "US" + commodityValue: + type: string + description: The declared value of the commodity for customs and trade purposes. + example: "100.00" + commodityCurrencyCode: + type: string + description: The three-letter currency code representing the currency in which the commodity value is expressed, according to the ISO 4217 standard. + example: "USD" + commodityQuantity: + type: string + description: The quantity of the commodity. + example: "100" + commodityUnitOfMeasure: + type: string + description: The unit of measure used for the commodity quantity. + example: "ml" + commodityDescription: + type: string + description: A brief description of the commodity, detailing its type and key characteristics. + example: "Water Bottles" + commodityHtsCode: + type: string + description: The commodityHtsCode is an optional field that allows the user to submit their known HTS classification. This will be used as a starting point for the interactive description guidance process. + example: "0101" + commodityCountryOfOrigin: + type: string + description: The two-letter ISO 3166-1 alpha-2 country code representing the country of origin of the commodity. + example: "US" + shipperName: + type: string + description: The name of the company or individual responsible for shipping the commodity. + example: "Hardwood Floors LLC" + shipperAccountNumber: + type: string + description: The account number representing the company or individual responsible for shipping the commodity. + example: "10003KER50" + locale: + type: string + description: The language the user uses to submit their initial product description. If the actual language used differs from this field, the application will throw an error as a "7015". + allOf: + - $ref: "#/components/schemas/Languages" + default: "EN" + required: + - importCountryCode + - commodityDescription + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} diff --git a/LandedCost-Ready.yaml b/LandedCost-Ready.yaml index 56a9838..16e82a9 100644 --- a/LandedCost-Ready.yaml +++ b/LandedCost-Ready.yaml @@ -1,670 +1,670 @@ -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: - - **Enhanced Customer Experience**: Get a quick and accurate quote on the landed cost of a shipment, including the cost of goods, transportation, and any other fees associated with getting the goods to their destination. - - **Operational Efficiency**: Simplify the process of calculating landed costs by eliminating the need to manually research and calculate all of the different fees involved. - - **Data-Driven Decision Making**: Improve decision-making by having a clear understanding of the total cost of shipping goods before you commit to a purchase.. - - **Optimizing Cash Flow**: Streamline your shipping process by integrating the Landed Cost Quote API into your existing systems. - - # Reference - - Business Rules - - Appendix - - Errors - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/landedcost/{version}/quotes": - post: - summary: Landed Cost Quote API - tags: - - Landed Cost - security: - - OAuth2: [] - 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. - operationId: LandedCost - parameters: - - in: header - name: transId - schema: - type: string - description: 'An identifier unique to the request. Length: 32' - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: 'An identifier of the client/source application that is making - the request. Length: 512' - required: true - - in: path - name: version - schema: - type: string - default: v1 - description: Version of the API. - required: true - - in: header - name: AccountNumber - schema: - type: string - description: The UPS account number. - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/LandedCostRequest" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - currencyCode: GBP - transID: '325467165' - allowPartialLandedCostResult: false - shipment: - id: ShipmentID83 - importCountryCode: GB - importProvince: '' - shipDate: '' - exportCountryCode: US - incoterms: '' - shipmentItems: - - commodityId: '1' - grossWeight: '' - grossWeightUnit: '' - priceEach: '125' - hsCode: '400932' - quantity: 24 - UOM: Each - originCountryCode: GB - commodityCurrencyCode: GBP - description: '' - - commodityId: '4' - grossWeight: '' - grossWeightUnit: '' - priceEach: '0.5' - hsCode: '' - quantity: 900 - UOM: Each - originCountryCode: GB - commodityCurrencyCode: GBP - description: Cord5mm{PK50Yellow/Red - transModes: '' - transportCost: '' - shipmentType: Sale - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/LandedCostResponse" - examples: - json: - summary: A sample JSON response - value: - shipment: - currencyCode: GBP - id: ShipmentID83 - brokerageFeeItems: - - chargeName: DisbursementFee - chargeAmount: 19.05 - - chargeName: EntryPreparationFee - chargeAmount: 5.6 - totalBrokerageFees: 24.65 - totalDuties: 60 - totalCommodityLevelTaxesAndFees: 0 - totalShipmentLevelTaxesAndFees: 0 - totalVAT: 702 - totalDutyandTax: 762 - grandTotal: 786.65 - importCountryCode: GB - shipmentItems: - - commodityId: '1' - commodityDuty: 60 - totalCommodityTaxesAndFees: 0 - commodityVAT: 612 - totalCommodityDutyandTax: 672 - commodityCurrencyCode: GBP - isCalculable: true - hsCode: '4009320090' - - commodityId: '4' - commodityDuty: 0 - totalCommodityTaxesAndFees: 0 - commodityVAT: 90 - totalCommodityDutyandTax: 90 - commodityCurrencyCode: GBP - isCalculable: true - hsCode: '8546901000' - alversion: 0 - dpversion: - transID: '325467165' - error: - perfStats: - absLayerTime: '139' - fulfillTime: ThuFeb027:56:53.231-05:002023 - receiptTime: ThuFeb027:56:53.091-05:002023 - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - LandedCostRequest: - type: object - required: - - currencyCode - - transID - - alversion - - shipment - properties: - currencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the currency of transaction or purchase. - example: USD, CAD, EUR - transID: - type: string - maximum: 1 - maxLength: 50 - description: Unique transaction ID for the request. - example: LCUAT20220208053048_197985278292494 - allowPartialLandedCostResult: - type: boolean - maximum: 1 - description: |- - An optional flag to indicate that partial landed cost calculations are acceptable to be used by upstream systems. - When set to *false*, the system will return an error when at least one commodity in the shipment is invalid (all or none), and no results will be sent back for that request. When set to *true*, the system will return partial calculations when applicable. - - Valid values: true = Partial Landed Cost result will return. false = All or No result will return (default). - alversion: - type: integer - maximum: 1 - description: Version number of the instance that processed this request. - This must match the major number of the corresponding ICD version. - example: 1, 2, 3 - shipment: - "$ref": "#/components/schemas/LandedCostRequest_Shipment" - xml: - name: LandedCostRequest - maximum: 1 - description: The root element for the Landed Cost document. - LandedCostRequest_Shipment: - type: object - maximum: 1 - description: Every Landed Cost request must be based on a shipment. - required: - - id - - importCountryCode - - exportCountryCode - - shipmentItems - properties: - id: - maximum: 1 - maxLength: 100 - type: string - description: Specifies the Shipment ID in the Landed Cost quote. It is an - arbitrary string provided by the user of the API and will be returned - with the Landed Cost Quote to indicate which shipment the tariffs apply - to. There are similar IDs associated with the Product and Order objects. - importCountryCode: - maximum: 1 - maxLength: 2 - type: string - description: Specifies the Import/Ship-To/Destination/Final country of the - shipment. Please check country list in the Appendix. - example: US, MX, CA - importProvince: - maximum: 1 - type: string - maxLength: 100 - description: Province/State is supported only for a few countries such as - Mexico, Canada, etc. Please check Province list in the Appendix - example: Alberta, Ontario, North Frontier Zone - shipDate: - type: string - maximum: 1 - maxLength: 10 - description: 'Defaults to current date if not provided. Date format: YYYY-MM-DD.' - example: '2022-02-28' - incoterms: - type: string - maximum: 1 - maxLength: 3 - description: "Supported Incoterm Values:\n1. CFR - Cost & Freight \n2. CIF - - Cost, Insurance & Freight \n3. CIP - Carriage and Insurance Paid-To - \n4. CPT - Carriage Paid-To \n5. DAP - Delivered At Place \n6. DAT - Delivered - At Terminal \n7. DDP - Delivered Duty Paid \n8. DPU - Delivered at Place - Unloaded \n9. EXW - Ex Works \n10. FAS - Free Alongside Ship \n11. FCA - - Free Carrier \n12. FOB - Free On Board (Default)" - default: FOB - example: FOB, CFR - exportCountryCode: - type: string - maximum: 1 - maxLength: 2 - description: |- - Specifies the export/ship-from/origin country of the shipment. Please check country List in the Appendix section. - - **Note:** Export country code must be different from the import country code. - example: DE, CN, JP - transModes: - type: string - maximum: 1 - maxLength: 9 - description: "The modes of transportation (in upper case).\nSupported Values: - \n1. INT_AIR 2. \nINT_OCEAN \n3. INT_RAIL \n4. INT_TRUCK \n5. DOM_AIR - \n6. DOM_OCEAN \n7. DOM_RAIL \n8. DOM_TRUCK \n\nDefault value will vary - based on the import country." - transportCost: - maximum: 1 - type: number - description: "Specifies the Freight charge or transport costs, which are - used for tariff calculations. Landed cost result might have some dependency - on the freight charges in some countries. Therefore, freight amount should - be always provided for accurate Landed Cost result. \n\nAllowed values:\n - 1. Any non-negative floating-point number. \n2. Numeric value with optional - decimal value." - example: 100.6 - shipmentType: - type: string - maximum: 1 - maxLength: 35 - description: "Specifies the shipment type such as Gift, Document, Commercial - (Sale), etc.\n\nSupported Shipment Types: \n1. GIFT \n2. COMMERCIAL \n3. - SALE \n4. SAMPLE \n5. REPAIR \n6. RETURN \n7. OTHER \n\nDefault value - will vary and based on import country." - shipmentItems: - type: array - maximum: 99 - items: - "$ref": "#/components/schemas/Request_ShipmentItems" - description: Array of shipment item objects (commodities), that are in a - shipment. - Request_ShipmentItems: - type: object - required: - - commodityId - - priceEach - - commodityCurrencyCode - - quantity - - UOM - - originCountryCode - properties: - commodityId: - type: string - maximum: 1 - maxLength: 100 - description: Commodity ID is used to associate tariffs with product in the - output. Should be unique for each commodity in a request. It is an arbitrary - string provided by the user of the API that will be returned with the - Landed Cost Quote to indicate which commodity the tariffs apply to. - grossWeight: - type: number - maximum: 1 - description: Specifies the gross weight of the commodity as any non-negative - value. - example: 10.34 - grossWeightUnit: - type: string - maximum: 1 - maxLength: 2 - description: 'Specifies the units of the gross weight. Required if GrossWeight - is used. If GrossWeight is not specified, this value must not be set to - anything but null. Supported values: LB, KG' - example: KG - priceEach: - type: number - maximum: 1 - description: Specifies the price for each commodity unit in the settlement - currency. The total price of the entire number of shipmentItems may not - exceed 999999999999.99 - example: 346.32 - commodityCurrencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the Currency Code used for commodity price. All commodities - must have the same currency code. - example: USD, CAD, EUR - quantity: - type: integer - maximum: 1 - description: Specifies the number of product units to be shipped. The total - price of the entire number of shipmentItems may not exceed 999999999999.99, - 1 or greater than 1 - UOM: - type: string - maximum: 1 - description: Specifies unit of measure. Check UOM List in the Appendices - section. - example: KILOGRAM, BAG - hsCode: - type: string - maximum: 1 - maxLength: 40 - description: Specifies a valid HS or HTS code for the shipment's destination - or import country. This field is required if description is not provided. - example: '0901.90.00.10' - description: - type: string - maximum: 1 - maxLength: 150 - description: This field is populated with description of the commodity. - This field is required if hsCode is not provided. - originCountryCode: - type: string - maximum: 1 - maxLength: 2 - description: Country of Manufacture or origin. - example: US, CA, JP, MX - LandedCostResponse: - type: object - required: - - shipment - - alVersion - - perfStats - - transID - properties: - shipment: - type: object - required: - - currencyCode - - importCountryCode - - id - - brokerageFeeItems - - totalBrokerageFees - - totalDuties - - totalCommodityLevelTaxesAndFees - - totalShipmentLevelTaxesAndFees - - totalVAT - - totalDutyAndTax - - grandTotal - - shipmentItems - description: Every Landed Cost response must be based on a shipment. - properties: - currencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the Currency Code set at the commodity level. - This currency is applicable for all duty, tax, VAT, and fee at the - shipment and commodity level. - example: USD, CAD, EUR - importCountryCode: - type: string - maximum: 1 - maxLength: 2 - description: Specifies the Import/Ship-To/Destination/Final country - of the shipment. Please check country list in the Appendices section. - example: US, CA, MX - id: - type: string - maximum: 1 - maxLength: 100 - description: Specifies the Shipment ID in the Landed Cost quote. - brokerageFeeItems: - type: array - maximum: 1 - items: - "$ref": "#/components/schemas/brokerageFeeItems" - description: An array of Brokerage fees. - totalBrokerageFees: - type: number - maximum: 1 - description: Grand total of all applicable Brokerage fees. - totalDuties: - type: number - maximum: 1 - description: Total duty amount of this shipment. - totalCommodityLevelTaxesAndFees: - type: number - maximum: 1 - description: Total tax and other fees at commodity level. - totalShipmentLevelTaxesAndFees: - type: number - maximum: 1 - description: Total tax and other fees at shipment level. - totalVAT: - type: number - maximum: 1 - description: Total VAT of the shipment. - totalDutyAndTax: - type: number - maximum: 1 - description: Grand total of the combined duty, VAT, tax, and other fees - of all commodities in this shipment including shipment level taxes - and fees. - grandTotal: - type: number - maximum: 1 - description: Sum of totalDutyAndTax + totalBrokerageFees - shipmentItems: - type: array - items: - "$ref": "#/components/schemas/Response_ShipmentItems" - maximum: 99 - description: An array of Landed Cost for all valid commodities. - transID: - type: string - maxLength: 50 - description: An identifier unique to the request. - perfStats: - type: object - maximum: 1 - required: - - absLayerTime - - fulfillTime - - receiptTime - description: See ALPerfStats - properties: - absLayerTime: - type: string - maximum: 1 - maxLength: 20 - description: Time taken through the abstraction layer in milliseconds. - fulfillTime: - type: string - maximum: 1 - maxLength: 32 - description: Time taken to complete the request. - receiptTime: - type: string - maximum: 1 - maxLength: 32 - description: Time taken to receive the request. - alVersion: - type: integer - maximum: 1 - maxLength: 10 - description: Version number of the instance that processed this request. - Default is 1. - errors: - "$ref": "#/components/schemas/Errors" - xml: - name: LandedCostResponse - maximum: 1 - brokerageFeeItems: - properties: - chargeName: - type: string - maximum: 1 - maxLength: 50 - description: "Brokerage charge name for this shipment. Possible Values:\n1. - Entry Preparation Fee \n2. Disbursement Fee \n3. Additional Line Fee" - chargeAmount: - type: number - maximum: 1 - description: Fee amount for the brokerage charges. - example: 10.56 - Response_ShipmentItems: - required: - - commodityID - - hsCode - - commodityDuty - - commodityVAT - - totalCommodityDutyAndTax - - commodityCurrencyCode - - isCalculable - properties: - commodityID: - type: string - maximum: 1 - description: Specifies the commodity ID. - hsCode: - type: string - maxLength: 40 - maximum: 1 - description: Specifies the HTS code of the commodity. - commodityDuty: - type: number - maximum: 1 - description: Duty amount for this commodity. - totalCommodityTaxAndFee: - type: number - maximum: 1 - description: Total tax and other fees for this commodity (excluding commodity - duty and VAT). - commodityVAT: - type: number - maximum: 1 - description: VAT amount for this commodity. - totalCommodityDutyAndTax: - type: number - maximum: 1 - description: Sum of commodity duty, VAT, tax, and other fees for this commodity. - commodityCurrencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the currency code used for commodity's price. - isCalculable: - type: boolean - maximum: 1 - description: True/False. Indicates if Landed Cost can successful calculated - for this commodity. - example: true, false - Errors: - type: object - maximum: 99 - description: Error code and description - properties: - code: - type: string - maximum: 1 - maxLength: 20 - description: Error Code - description: - type: string - maximum: 1 - maxLength: 128 - description: Description of the error. - message: - type: string - maximum: 1 - maxLength: 128 - description: Consumer tailored error message. - value: - type: string - maximum: 1 - maxLength: 128 - description: The value that caused the error. - field: - type: string - maximum: 1 - maxLength: 256 - description: The path to the field causing the error, as returned from the - backend services. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +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: + - **Enhanced Customer Experience**: Get a quick and accurate quote on the landed cost of a shipment, including the cost of goods, transportation, and any other fees associated with getting the goods to their destination. + - **Operational Efficiency**: Simplify the process of calculating landed costs by eliminating the need to manually research and calculate all of the different fees involved. + - **Data-Driven Decision Making**: Improve decision-making by having a clear understanding of the total cost of shipping goods before you commit to a purchase.. + - **Optimizing Cash Flow**: Streamline your shipping process by integrating the Landed Cost Quote API into your existing systems. + + # Reference + - Business Rules + - Appendix + - Errors + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/landedcost/{version}/quotes": + post: + summary: Landed Cost Quote API + tags: + - Landed Cost + security: + - OAuth2: [] + 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. + operationId: LandedCost + parameters: + - in: header + name: transId + schema: + type: string + description: 'An identifier unique to the request. Length: 32' + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: 'An identifier of the client/source application that is making + the request. Length: 512' + required: true + - in: path + name: version + schema: + type: string + default: v1 + description: Version of the API. + required: true + - in: header + name: AccountNumber + schema: + type: string + description: The UPS account number. + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/LandedCostRequest" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + currencyCode: GBP + transID: '325467165' + allowPartialLandedCostResult: false + shipment: + id: ShipmentID83 + importCountryCode: GB + importProvince: '' + shipDate: '' + exportCountryCode: US + incoterms: '' + shipmentItems: + - commodityId: '1' + grossWeight: '' + grossWeightUnit: '' + priceEach: '125' + hsCode: '400932' + quantity: 24 + UOM: Each + originCountryCode: GB + commodityCurrencyCode: GBP + description: '' + - commodityId: '4' + grossWeight: '' + grossWeightUnit: '' + priceEach: '0.5' + hsCode: '' + quantity: 900 + UOM: Each + originCountryCode: GB + commodityCurrencyCode: GBP + description: Cord5mm{PK50Yellow/Red + transModes: '' + transportCost: '' + shipmentType: Sale + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/LandedCostResponse" + examples: + json: + summary: A sample JSON response + value: + shipment: + currencyCode: GBP + id: ShipmentID83 + brokerageFeeItems: + - chargeName: DisbursementFee + chargeAmount: 19.05 + - chargeName: EntryPreparationFee + chargeAmount: 5.6 + totalBrokerageFees: 24.65 + totalDuties: 60 + totalCommodityLevelTaxesAndFees: 0 + totalShipmentLevelTaxesAndFees: 0 + totalVAT: 702 + totalDutyandTax: 762 + grandTotal: 786.65 + importCountryCode: GB + shipmentItems: + - commodityId: '1' + commodityDuty: 60 + totalCommodityTaxesAndFees: 0 + commodityVAT: 612 + totalCommodityDutyandTax: 672 + commodityCurrencyCode: GBP + isCalculable: true + hsCode: '4009320090' + - commodityId: '4' + commodityDuty: 0 + totalCommodityTaxesAndFees: 0 + commodityVAT: 90 + totalCommodityDutyandTax: 90 + commodityCurrencyCode: GBP + isCalculable: true + hsCode: '8546901000' + alversion: 0 + dpversion: + transID: '325467165' + error: + perfStats: + absLayerTime: '139' + fulfillTime: ThuFeb027:56:53.231-05:002023 + receiptTime: ThuFeb027:56:53.091-05:002023 + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + LandedCostRequest: + type: object + required: + - currencyCode + - transID + - alversion + - shipment + properties: + currencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the currency of transaction or purchase. + example: USD, CAD, EUR + transID: + type: string + maximum: 1 + maxLength: 50 + description: Unique transaction ID for the request. + example: LCUAT20220208053048_197985278292494 + allowPartialLandedCostResult: + type: boolean + maximum: 1 + description: |- + An optional flag to indicate that partial landed cost calculations are acceptable to be used by upstream systems. + When set to *false*, the system will return an error when at least one commodity in the shipment is invalid (all or none), and no results will be sent back for that request. When set to *true*, the system will return partial calculations when applicable. + + Valid values: true = Partial Landed Cost result will return. false = All or No result will return (default). + alversion: + type: integer + maximum: 1 + description: Version number of the instance that processed this request. + This must match the major number of the corresponding ICD version. + example: 1, 2, 3 + shipment: + "$ref": "#/components/schemas/LandedCostRequest_Shipment" + xml: + name: LandedCostRequest + maximum: 1 + description: The root element for the Landed Cost document. + LandedCostRequest_Shipment: + type: object + maximum: 1 + description: Every Landed Cost request must be based on a shipment. + required: + - id + - importCountryCode + - exportCountryCode + - shipmentItems + properties: + id: + maximum: 1 + maxLength: 100 + type: string + description: Specifies the Shipment ID in the Landed Cost quote. It is an + arbitrary string provided by the user of the API and will be returned + with the Landed Cost Quote to indicate which shipment the tariffs apply + to. There are similar IDs associated with the Product and Order objects. + importCountryCode: + maximum: 1 + maxLength: 2 + type: string + description: Specifies the Import/Ship-To/Destination/Final country of the + shipment. Please check country list in the Appendix. + example: US, MX, CA + importProvince: + maximum: 1 + type: string + maxLength: 100 + description: Province/State is supported only for a few countries such as + Mexico, Canada, etc. Please check Province list in the Appendix + example: Alberta, Ontario, North Frontier Zone + shipDate: + type: string + maximum: 1 + maxLength: 10 + description: 'Defaults to current date if not provided. Date format: YYYY-MM-DD.' + example: '2022-02-28' + incoterms: + type: string + maximum: 1 + maxLength: 3 + description: "Supported Incoterm Values:\n1. CFR - Cost & Freight \n2. CIF + - Cost, Insurance & Freight \n3. CIP - Carriage and Insurance Paid-To + \n4. CPT - Carriage Paid-To \n5. DAP - Delivered At Place \n6. DAT - Delivered + At Terminal \n7. DDP - Delivered Duty Paid \n8. DPU - Delivered at Place + Unloaded \n9. EXW - Ex Works \n10. FAS - Free Alongside Ship \n11. FCA + - Free Carrier \n12. FOB - Free On Board (Default)" + default: FOB + example: FOB, CFR + exportCountryCode: + type: string + maximum: 1 + maxLength: 2 + description: |- + Specifies the export/ship-from/origin country of the shipment. Please check country List in the Appendix section. + + **Note:** Export country code must be different from the import country code. + example: DE, CN, JP + transModes: + type: string + maximum: 1 + maxLength: 9 + description: "The modes of transportation (in upper case).\nSupported Values: + \n1. INT_AIR 2. \nINT_OCEAN \n3. INT_RAIL \n4. INT_TRUCK \n5. DOM_AIR + \n6. DOM_OCEAN \n7. DOM_RAIL \n8. DOM_TRUCK \n\nDefault value will vary + based on the import country." + transportCost: + maximum: 1 + type: number + description: "Specifies the Freight charge or transport costs, which are + used for tariff calculations. Landed cost result might have some dependency + on the freight charges in some countries. Therefore, freight amount should + be always provided for accurate Landed Cost result. \n\nAllowed values:\n + 1. Any non-negative floating-point number. \n2. Numeric value with optional + decimal value." + example: 100.6 + shipmentType: + type: string + maximum: 1 + maxLength: 35 + description: "Specifies the shipment type such as Gift, Document, Commercial + (Sale), etc.\n\nSupported Shipment Types: \n1. GIFT \n2. COMMERCIAL \n3. + SALE \n4. SAMPLE \n5. REPAIR \n6. RETURN \n7. OTHER \n\nDefault value + will vary and based on import country." + shipmentItems: + type: array + maximum: 99 + items: + "$ref": "#/components/schemas/Request_ShipmentItems" + description: Array of shipment item objects (commodities), that are in a + shipment. + Request_ShipmentItems: + type: object + required: + - commodityId + - priceEach + - commodityCurrencyCode + - quantity + - UOM + - originCountryCode + properties: + commodityId: + type: string + maximum: 1 + maxLength: 100 + description: Commodity ID is used to associate tariffs with product in the + output. Should be unique for each commodity in a request. It is an arbitrary + string provided by the user of the API that will be returned with the + Landed Cost Quote to indicate which commodity the tariffs apply to. + grossWeight: + type: number + maximum: 1 + description: Specifies the gross weight of the commodity as any non-negative + value. + example: 10.34 + grossWeightUnit: + type: string + maximum: 1 + maxLength: 2 + description: 'Specifies the units of the gross weight. Required if GrossWeight + is used. If GrossWeight is not specified, this value must not be set to + anything but null. Supported values: LB, KG' + example: KG + priceEach: + type: number + maximum: 1 + description: Specifies the price for each commodity unit in the settlement + currency. The total price of the entire number of shipmentItems may not + exceed 999999999999.99 + example: 346.32 + commodityCurrencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the Currency Code used for commodity price. All commodities + must have the same currency code. + example: USD, CAD, EUR + quantity: + type: integer + maximum: 1 + description: Specifies the number of product units to be shipped. The total + price of the entire number of shipmentItems may not exceed 999999999999.99, + 1 or greater than 1 + UOM: + type: string + maximum: 1 + description: Specifies unit of measure. Check UOM List in the Appendices + section. + example: KILOGRAM, BAG + hsCode: + type: string + maximum: 1 + maxLength: 40 + description: Specifies a valid HS or HTS code for the shipment's destination + or import country. This field is required if description is not provided. + example: '0901.90.00.10' + description: + type: string + maximum: 1 + maxLength: 150 + description: This field is populated with description of the commodity. + This field is required if hsCode is not provided. + originCountryCode: + type: string + maximum: 1 + maxLength: 2 + description: Country of Manufacture or origin. + example: US, CA, JP, MX + LandedCostResponse: + type: object + required: + - shipment + - alVersion + - perfStats + - transID + properties: + shipment: + type: object + required: + - currencyCode + - importCountryCode + - id + - brokerageFeeItems + - totalBrokerageFees + - totalDuties + - totalCommodityLevelTaxesAndFees + - totalShipmentLevelTaxesAndFees + - totalVAT + - totalDutyAndTax + - grandTotal + - shipmentItems + description: Every Landed Cost response must be based on a shipment. + properties: + currencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the Currency Code set at the commodity level. + This currency is applicable for all duty, tax, VAT, and fee at the + shipment and commodity level. + example: USD, CAD, EUR + importCountryCode: + type: string + maximum: 1 + maxLength: 2 + description: Specifies the Import/Ship-To/Destination/Final country + of the shipment. Please check country list in the Appendices section. + example: US, CA, MX + id: + type: string + maximum: 1 + maxLength: 100 + description: Specifies the Shipment ID in the Landed Cost quote. + brokerageFeeItems: + type: array + maximum: 1 + items: + "$ref": "#/components/schemas/brokerageFeeItems" + description: An array of Brokerage fees. + totalBrokerageFees: + type: number + maximum: 1 + description: Grand total of all applicable Brokerage fees. + totalDuties: + type: number + maximum: 1 + description: Total duty amount of this shipment. + totalCommodityLevelTaxesAndFees: + type: number + maximum: 1 + description: Total tax and other fees at commodity level. + totalShipmentLevelTaxesAndFees: + type: number + maximum: 1 + description: Total tax and other fees at shipment level. + totalVAT: + type: number + maximum: 1 + description: Total VAT of the shipment. + totalDutyAndTax: + type: number + maximum: 1 + description: Grand total of the combined duty, VAT, tax, and other fees + of all commodities in this shipment including shipment level taxes + and fees. + grandTotal: + type: number + maximum: 1 + description: Sum of totalDutyAndTax + totalBrokerageFees + shipmentItems: + type: array + items: + "$ref": "#/components/schemas/Response_ShipmentItems" + maximum: 99 + description: An array of Landed Cost for all valid commodities. + transID: + type: string + maxLength: 50 + description: An identifier unique to the request. + perfStats: + type: object + maximum: 1 + required: + - absLayerTime + - fulfillTime + - receiptTime + description: See ALPerfStats + properties: + absLayerTime: + type: string + maximum: 1 + maxLength: 20 + description: Time taken through the abstraction layer in milliseconds. + fulfillTime: + type: string + maximum: 1 + maxLength: 32 + description: Time taken to complete the request. + receiptTime: + type: string + maximum: 1 + maxLength: 32 + description: Time taken to receive the request. + alVersion: + type: integer + maximum: 1 + maxLength: 10 + description: Version number of the instance that processed this request. + Default is 1. + errors: + "$ref": "#/components/schemas/Errors" + xml: + name: LandedCostResponse + maximum: 1 + brokerageFeeItems: + properties: + chargeName: + type: string + maximum: 1 + maxLength: 50 + description: "Brokerage charge name for this shipment. Possible Values:\n1. + Entry Preparation Fee \n2. Disbursement Fee \n3. Additional Line Fee" + chargeAmount: + type: number + maximum: 1 + description: Fee amount for the brokerage charges. + example: 10.56 + Response_ShipmentItems: + required: + - commodityID + - hsCode + - commodityDuty + - commodityVAT + - totalCommodityDutyAndTax + - commodityCurrencyCode + - isCalculable + properties: + commodityID: + type: string + maximum: 1 + description: Specifies the commodity ID. + hsCode: + type: string + maxLength: 40 + maximum: 1 + description: Specifies the HTS code of the commodity. + commodityDuty: + type: number + maximum: 1 + description: Duty amount for this commodity. + totalCommodityTaxAndFee: + type: number + maximum: 1 + description: Total tax and other fees for this commodity (excluding commodity + duty and VAT). + commodityVAT: + type: number + maximum: 1 + description: VAT amount for this commodity. + totalCommodityDutyAndTax: + type: number + maximum: 1 + description: Sum of commodity duty, VAT, tax, and other fees for this commodity. + commodityCurrencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the currency code used for commodity's price. + isCalculable: + type: boolean + maximum: 1 + description: True/False. Indicates if Landed Cost can successful calculated + for this commodity. + example: true, false + Errors: + type: object + maximum: 99 + description: Error code and description + properties: + code: + type: string + maximum: 1 + maxLength: 20 + description: Error Code + description: + type: string + maximum: 1 + maxLength: 128 + description: Description of the error. + message: + type: string + maximum: 1 + maxLength: 128 + description: Consumer tailored error message. + value: + type: string + maximum: 1 + maxLength: 128 + description: The value that caused the error. + field: + type: string + maximum: 1 + maxLength: 256 + description: The path to the field causing the error, as returned from the + backend services. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/LandedCost.yaml b/LandedCost.yaml index ee04f16..f1d990c 100644 --- a/LandedCost.yaml +++ b/LandedCost.yaml @@ -1,664 +1,664 @@ -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: - - **Enhanced Customer Experience**: Get a quick and accurate quote on the landed cost of a shipment, including the cost of goods, transportation, and any other fees associated with getting the goods to their destination. - - **Operational Efficiency**: Simplify the process of calculating landed costs by eliminating the need to manually research and calculate all of the different fees involved. - - **Data-Driven Decision Making**: Improve decision-making by having a clear understanding of the total cost of shipping goods before you commit to a purchase.. - - **Optimizing Cash Flow**: Streamline your shipping process by integrating the Landed Cost Quote API into your existing systems. - - # Reference - - Business Rules - - Appendix - - Errors - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/landedcost/{version}/quotes": - post: - summary: Landed Cost Quote API - tags: - - Landed Cost - security: - - OAuth2: [] - 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. - operationId: LandedCost - parameters: - - in: header - name: transId - schema: - type: string - description: 'An identifier unique to the request. Length: 32' - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: 'An identifier of the client/source application that is making - the request. Length: 512' - required: true - - in: path - name: version - schema: - type: string - default: v1 - description: Version of the API. - required: true - - in: header - name: AccountNumber - schema: - type: string - description: The UPS account number. - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/LandedCostRequest" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - currencyCode: GBP - transID: '325467165' - allowPartialLandedCostResult: false - shipment: - id: ShipmentID83 - importCountryCode: GB - importProvince: '' - shipDate: '' - exportCountryCode: US - incoterms: '' - shipmentItems: - - commodityId: '1' - grossWeight: '' - grossWeightUnit: '' - priceEach: '125' - hsCode: '400932' - quantity: 24 - UOM: Each - originCountryCode: GB - commodityCurrencyCode: GBP - description: '' - - commodityId: '4' - grossWeight: '' - grossWeightUnit: '' - priceEach: '0.5' - hsCode: '' - quantity: 900 - UOM: Each - originCountryCode: GB - commodityCurrencyCode: GBP - description: Cord5mm{PK50Yellow/Red - transModes: '' - transportCost: '' - shipmentType: Sale - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/LandedCostResponse" - examples: - json: - summary: A sample JSON response - value: - shipment: - currencyCode: GBP - id: ShipmentID83 - brokerageFeeItems: - - chargeName: DisbursementFee - chargeAmount: 19.05 - - chargeName: EntryPreparationFee - chargeAmount: 5.6 - totalBrokerageFees: 24.65 - totalDuties: 60 - totalCommodityLevelTaxesAndFees: 0 - totalShipmentLevelTaxesAndFees: 0 - totalVAT: 702 - totalDutyandTax: 762 - grandTotal: 786.65 - importCountryCode: GB - shipmentItems: - - commodityId: '1' - commodityDuty: 60 - totalCommodityTaxesAndFees: 0 - commodityVAT: 612 - totalCommodityDutyandTax: 672 - commodityCurrencyCode: GBP - isCalculable: true - hsCode: '4009320090' - - commodityId: '4' - commodityDuty: 0 - totalCommodityTaxesAndFees: 0 - commodityVAT: 90 - totalCommodityDutyandTax: 90 - commodityCurrencyCode: GBP - isCalculable: true - hsCode: '8546901000' - alversion: 0 - dpversion: - transID: '325467165' - error: - perfStats: - absLayerTime: '139' - fulfillTime: ThuFeb027:56:53.231-05:002023 - receiptTime: ThuFeb027:56:53.091-05:002023 - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - LandedCostRequest: - type: object - required: - - currencyCode - - transID - - alversion - - shipment - properties: - currencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the currency of transaction or purchase. - example: USD, CAD, EUR - transID: - type: string - maximum: 1 - maxLength: 50 - description: Unique transaction ID for the request. - example: LCUAT20220208053048_197985278292494 - allowPartialLandedCostResult: - type: boolean - maximum: 1 - description: |- - An optional flag to indicate that partial landed cost calculations are acceptable to be used by upstream systems. - When set to *false*, the system will return an error when at least one commodity in the shipment is invalid (all or none), and no results will be sent back for that request. When set to *true*, the system will return partial calculations when applicable. - - Valid values: true = Partial Landed Cost result will return. false = All or No result will return (default). - alversion: - type: integer - maximum: 1 - description: Version number of the instance that processed this request. - This must match the major number of the corresponding ICD version. - example: 1, 2, 3 - shipment: - "$ref": "#/components/schemas/LandedCostRequest_Shipment" - xml: - name: LandedCostRequest - maximum: 1 - description: The root element for the Landed Cost document. - LandedCostRequest_Shipment: - type: object - maximum: 1 - description: Every Landed Cost request must be based on a shipment. - required: - - id - - importCountryCode - - exportCountryCode - - shipmentItems - properties: - id: - maximum: 1 - maxLength: 100 - type: string - description: Specifies the Shipment ID in the Landed Cost quote. It is an - arbitrary string provided by the user of the API and will be returned - with the Landed Cost Quote to indicate which shipment the tariffs apply - to. There are similar IDs associated with the Product and Order objects. - importCountryCode: - maximum: 1 - maxLength: 2 - type: string - description: Specifies the Import/Ship-To/Destination/Final country of the - shipment. Please check country list in the Appendix. - example: US, MX, CA - importProvince: - maximum: 1 - type: string - maxLength: 100 - description: Province/State is supported only for a few countries such as - Mexico, Canada, etc. Please check Province list in the Appendix - example: Alberta, Ontario, North Frontier Zone - shipDate: - type: string - maximum: 1 - maxLength: 10 - description: 'Defaults to current date if not provided. Date format: YYYY-MM-DD.' - example: '2022-02-28' - incoterms: - type: string - maximum: 1 - maxLength: 3 - description: "Supported Incoterm Values:\n1. CFR - Cost & Freight \n2. CIF - - Cost, Insurance & Freight \n3. CIP - Carriage and Insurance Paid-To - \n4. CPT - Carriage Paid-To \n5. DAP - Delivered At Place \n6. DAT - Delivered - At Terminal \n7. DDP - Delivered Duty Paid \n8. DPU - Delivered at Place - Unloaded \n9. EXW - Ex Works \n10. FAS - Free Alongside Ship \n11. FCA - - Free Carrier \n12. FOB - Free On Board (Default)" - default: FOB - example: FOB, CFR - exportCountryCode: - type: string - maximum: 1 - maxLength: 2 - description: |- - Specifies the export/ship-from/origin country of the shipment. Please check country List in the Appendix section. - - **Note:** Export country code must be different from the import country code. - example: DE, CN, JP - transModes: - type: string - maximum: 1 - maxLength: 9 - description: "The modes of transportation (in upper case).\nSupported Values: - \n1. INT_AIR 2. \nINT_OCEAN \n3. INT_RAIL \n4. INT_TRUCK \n5. DOM_AIR - \n6. DOM_OCEAN \n7. DOM_RAIL \n8. DOM_TRUCK \n\nDefault value will vary - based on the import country." - transportCost: - maximum: 1 - type: number - description: "Specifies the Freight charge or transport costs, which are - used for tariff calculations. Landed cost result might have some dependency - on the freight charges in some countries. Therefore, freight amount should - be always provided for accurate Landed Cost result. \n\nAllowed values:\n - 1. Any non-negative floating-point number. \n2. Numeric value with optional - decimal value." - example: 100.6 - shipmentType: - type: string - maximum: 1 - maxLength: 35 - description: "Specifies the shipment type such as Gift, Document, Commercial - (Sale), etc.\n\nSupported Shipment Types: \n1. GIFT \n2. COMMERCIAL \n3. - SALE \n4. SAMPLE \n5. REPAIR \n6. RETURN \n7. OTHER \n\nDefault value - will vary and based on import country." - shipmentItems: - type: array - maximum: 99 - items: - "$ref": "#/components/schemas/Request_ShipmentItems" - description: Array of shipment item objects (commodities), that are in a - shipment. - Request_ShipmentItems: - type: object - required: - - commodityId - - priceEach - - commodityCurrencyCode - - quantity - - UOM - - originCountryCode - properties: - commodityId: - type: string - maximum: 1 - maxLength: 100 - description: Commodity ID is used to associate tariffs with product in the - output. Should be unique for each commodity in a request. It is an arbitrary - string provided by the user of the API that will be returned with the - Landed Cost Quote to indicate which commodity the tariffs apply to. - grossWeight: - type: number - maximum: 1 - description: Specifies the gross weight of the commodity as any non-negative - value. - example: 10.34 - grossWeightUnit: - type: string - maximum: 1 - maxLength: 2 - description: 'Specifies the units of the gross weight. Required if GrossWeight - is used. If GrossWeight is not specified, this value must not be set to - anything but null. Supported values: LB, KG' - example: KG - priceEach: - type: number - maximum: 1 - description: Specifies the price for each commodity unit in the settlement - currency. The total price of the entire number of shipmentItems may not - exceed 999999999999.99 - example: 346.32 - commodityCurrencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the Currency Code used for commodity price. All commodities - must have the same currency code. - example: USD, CAD, EUR - quantity: - type: integer - maximum: 1 - description: Specifies the number of product units to be shipped. The total - price of the entire number of shipmentItems may not exceed 999999999999.99, - 1 or greater than 1 - UOM: - type: string - maximum: 1 - description: Specifies unit of measure. Check UOM List in the Appendices - section. - example: KILOGRAM, BAG - hsCode: - type: string - maximum: 1 - maxLength: 40 - description: Specifies a valid HS or HTS code for the shipment's destination - or import country. This field is required if description is not provided. - example: '0901.90.00.10' - description: - type: string - maximum: 1 - maxLength: 150 - description: This field is populated with description of the commodity. - This field is required if hsCode is not provided. - originCountryCode: - type: string - maximum: 1 - maxLength: 2 - description: Country of Manufacture or origin. - example: US, CA, JP, MX - LandedCostResponse: - type: object - required: - - shipment - - alVersion - - perfStats - - transID - properties: - shipment: - type: object - required: - - currencyCode - - importCountryCode - - id - - brokerageFeeItems - - totalBrokerageFees - - totalDuties - - totalCommodityLevelTaxesAndFees - - totalShipmentLevelTaxesAndFees - - totalVAT - - totalDutyAndTax - - grandTotal - - shipmentItems - description: Every Landed Cost response must be based on a shipment. - properties: - currencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the Currency Code set at the commodity level. - This currency is applicable for all duty, tax, VAT, and fee at the - shipment and commodity level. - example: USD, CAD, EUR - importCountryCode: - type: string - maximum: 1 - maxLength: 2 - description: Specifies the Import/Ship-To/Destination/Final country - of the shipment. Please check country list in the Appendices section. - example: US, CA, MX - id: - type: string - maximum: 1 - maxLength: 100 - description: Specifies the Shipment ID in the Landed Cost quote. - brokerageFeeItems: - type: array - maximum: 1 - items: - "$ref": "#/components/schemas/brokerageFeeItems" - description: An array of Brokerage fees. - totalBrokerageFees: - type: number - maximum: 1 - description: Grand total of all applicable Brokerage fees. - totalDuties: - type: number - maximum: 1 - description: Total duty amount of this shipment. - totalCommodityLevelTaxesAndFees: - type: number - maximum: 1 - description: Total tax and other fees at commodity level. - totalShipmentLevelTaxesAndFees: - type: number - maximum: 1 - description: Total tax and other fees at shipment level. - totalVAT: - type: number - maximum: 1 - description: Total VAT of the shipment. - totalDutyAndTax: - type: number - maximum: 1 - description: Grand total of the combined duty, VAT, tax, and other fees - of all commodities in this shipment including shipment level taxes - and fees. - grandTotal: - type: number - maximum: 1 - description: Sum of totalDutyAndTax + totalBrokerageFees - shipmentItems: - type: array - items: - "$ref": "#/components/schemas/Response_ShipmentItems" - maximum: 99 - description: An array of Landed Cost for all valid commodities. - transID: - type: string - maxLength: 50 - description: An identifier unique to the request. - perfStats: - type: object - maximum: 1 - required: - - absLayerTime - - fulfillTime - - receiptTime - description: See ALPerfStats - properties: - absLayerTime: - type: string - maximum: 1 - maxLength: 20 - description: Time taken through the abstraction layer in milliseconds. - fulfillTime: - type: string - maximum: 1 - maxLength: 32 - description: Time taken to complete the request. - receiptTime: - type: string - maximum: 1 - maxLength: 32 - description: Time taken to receive the request. - alVersion: - type: integer - maximum: 1 - maxLength: 10 - description: Version number of the instance that processed this request. - Default is 1. - errors: - "$ref": "#/components/schemas/Errors" - xml: - name: LandedCostResponse - maximum: 1 - brokerageFeeItems: - properties: - chargeName: - type: string - maximum: 1 - maxLength: 50 - description: "Brokerage charge name for this shipment. Possible Values:\n1. - Entry Preparation Fee \n2. Disbursement Fee \n3. Additional Line Fee" - chargeAmount: - type: number - maximum: 1 - description: Fee amount for the brokerage charges. - example: 10.56 - Response_ShipmentItems: - required: - - commodityID - - hsCode - - commodityDuty - - commodityVAT - - totalCommodityDutyAndTax - - commodityCurrencyCode - - isCalculable - properties: - commodityID: - type: string - maximum: 1 - description: Specifies the commodity ID. - hsCode: - type: string - maxLength: 40 - maximum: 1 - description: Specifies the HTS code of the commodity. - commodityDuty: - type: number - maximum: 1 - description: Duty amount for this commodity. - totalCommodityTaxAndFee: - type: number - maximum: 1 - description: Total tax and other fees for this commodity (excluding commodity - duty and VAT). - commodityVAT: - type: number - maximum: 1 - description: VAT amount for this commodity. - totalCommodityDutyAndTax: - type: number - maximum: 1 - description: Sum of commodity duty, VAT, tax, and other fees for this commodity. - commodityCurrencyCode: - type: string - maximum: 1 - maxLength: 3 - description: Specifies the currency code used for commodity's price. - isCalculable: - type: boolean - maximum: 1 - description: True/False. Indicates if Landed Cost can successful calculated - for this commodity. - example: true, false - Errors: - type: object - maximum: 99 - description: Error code and description - properties: - code: - type: string - maximum: 1 - maxLength: 20 - description: Error Code - description: - type: string - maximum: 1 - maxLength: 128 - description: Description of the error. - message: - type: string - maximum: 1 - maxLength: 128 - description: Consumer tailored error message. - value: - type: string - maximum: 1 - maxLength: 128 - description: The value that caused the error. - field: - type: string - maximum: 1 - maxLength: 256 - description: The path to the field causing the error, as returned from the - backend services. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +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: + - **Enhanced Customer Experience**: Get a quick and accurate quote on the landed cost of a shipment, including the cost of goods, transportation, and any other fees associated with getting the goods to their destination. + - **Operational Efficiency**: Simplify the process of calculating landed costs by eliminating the need to manually research and calculate all of the different fees involved. + - **Data-Driven Decision Making**: Improve decision-making by having a clear understanding of the total cost of shipping goods before you commit to a purchase.. + - **Optimizing Cash Flow**: Streamline your shipping process by integrating the Landed Cost Quote API into your existing systems. + + # Reference + - Business Rules + - Appendix + - Errors + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/landedcost/{version}/quotes": + post: + summary: Landed Cost Quote API + tags: + - Landed Cost + security: + - OAuth2: [] + 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. + operationId: LandedCost + parameters: + - in: header + name: transId + schema: + type: string + description: 'An identifier unique to the request. Length: 32' + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: 'An identifier of the client/source application that is making + the request. Length: 512' + required: true + - in: path + name: version + schema: + type: string + default: v1 + description: Version of the API. + required: true + - in: header + name: AccountNumber + schema: + type: string + description: The UPS account number. + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/LandedCostRequest" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + currencyCode: GBP + transID: '325467165' + allowPartialLandedCostResult: false + shipment: + id: ShipmentID83 + importCountryCode: GB + importProvince: '' + shipDate: '' + exportCountryCode: US + incoterms: '' + shipmentItems: + - commodityId: '1' + grossWeight: '' + grossWeightUnit: '' + priceEach: '125' + hsCode: '400932' + quantity: 24 + UOM: Each + originCountryCode: GB + commodityCurrencyCode: GBP + description: '' + - commodityId: '4' + grossWeight: '' + grossWeightUnit: '' + priceEach: '0.5' + hsCode: '' + quantity: 900 + UOM: Each + originCountryCode: GB + commodityCurrencyCode: GBP + description: Cord5mm{PK50Yellow/Red + transModes: '' + transportCost: '' + shipmentType: Sale + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/LandedCostResponse" + examples: + json: + summary: A sample JSON response + value: + shipment: + currencyCode: GBP + id: ShipmentID83 + brokerageFeeItems: + - chargeName: DisbursementFee + chargeAmount: 19.05 + - chargeName: EntryPreparationFee + chargeAmount: 5.6 + totalBrokerageFees: 24.65 + totalDuties: 60 + totalCommodityLevelTaxesAndFees: 0 + totalShipmentLevelTaxesAndFees: 0 + totalVAT: 702 + totalDutyandTax: 762 + grandTotal: 786.65 + importCountryCode: GB + shipmentItems: + - commodityId: '1' + commodityDuty: 60 + totalCommodityTaxesAndFees: 0 + commodityVAT: 612 + totalCommodityDutyandTax: 672 + commodityCurrencyCode: GBP + isCalculable: true + hsCode: '4009320090' + - commodityId: '4' + commodityDuty: 0 + totalCommodityTaxesAndFees: 0 + commodityVAT: 90 + totalCommodityDutyandTax: 90 + commodityCurrencyCode: GBP + isCalculable: true + hsCode: '8546901000' + alversion: 0 + dpversion: + transID: '325467165' + error: + perfStats: + absLayerTime: '139' + fulfillTime: ThuFeb027:56:53.231-05:002023 + receiptTime: ThuFeb027:56:53.091-05:002023 + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + LandedCostRequest: + type: object + required: + - currencyCode + - transID + - alversion + - shipment + properties: + currencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the currency of transaction or purchase. + example: USD, CAD, EUR + transID: + type: string + maximum: 1 + maxLength: 50 + description: Unique transaction ID for the request. + example: LCUAT20220208053048_197985278292494 + allowPartialLandedCostResult: + type: boolean + maximum: 1 + description: |- + An optional flag to indicate that partial landed cost calculations are acceptable to be used by upstream systems. + When set to *false*, the system will return an error when at least one commodity in the shipment is invalid (all or none), and no results will be sent back for that request. When set to *true*, the system will return partial calculations when applicable. + + Valid values: true = Partial Landed Cost result will return. false = All or No result will return (default). + alversion: + type: integer + maximum: 1 + description: Version number of the instance that processed this request. + This must match the major number of the corresponding ICD version. + example: 1, 2, 3 + shipment: + "$ref": "#/components/schemas/LandedCostRequest_Shipment" + xml: + name: LandedCostRequest + maximum: 1 + description: The root element for the Landed Cost document. + LandedCostRequest_Shipment: + type: object + maximum: 1 + description: Every Landed Cost request must be based on a shipment. + required: + - id + - importCountryCode + - exportCountryCode + - shipmentItems + properties: + id: + maximum: 1 + maxLength: 100 + type: string + description: Specifies the Shipment ID in the Landed Cost quote. It is an + arbitrary string provided by the user of the API and will be returned + with the Landed Cost Quote to indicate which shipment the tariffs apply + to. There are similar IDs associated with the Product and Order objects. + importCountryCode: + maximum: 1 + maxLength: 2 + type: string + description: Specifies the Import/Ship-To/Destination/Final country of the + shipment. Please check country list in the Appendix. + example: US, MX, CA + importProvince: + maximum: 1 + type: string + maxLength: 100 + description: Province/State is supported only for a few countries such as + Mexico, Canada, etc. Please check Province list in the Appendix + example: Alberta, Ontario, North Frontier Zone + shipDate: + type: string + maximum: 1 + maxLength: 10 + description: 'Defaults to current date if not provided. Date format: YYYY-MM-DD.' + example: '2022-02-28' + incoterms: + type: string + maximum: 1 + maxLength: 3 + description: "Supported Incoterm Values:\n1. CFR - Cost & Freight \n2. CIF + - Cost, Insurance & Freight \n3. CIP - Carriage and Insurance Paid-To + \n4. CPT - Carriage Paid-To \n5. DAP - Delivered At Place \n6. DAT - Delivered + At Terminal \n7. DDP - Delivered Duty Paid \n8. DPU - Delivered at Place + Unloaded \n9. EXW - Ex Works \n10. FAS - Free Alongside Ship \n11. FCA + - Free Carrier \n12. FOB - Free On Board (Default)" + default: FOB + example: FOB, CFR + exportCountryCode: + type: string + maximum: 1 + maxLength: 2 + description: |- + Specifies the export/ship-from/origin country of the shipment. Please check country List in the Appendix section. + + **Note:** Export country code must be different from the import country code. + example: DE, CN, JP + transModes: + type: string + maximum: 1 + maxLength: 9 + description: "The modes of transportation (in upper case).\nSupported Values: + \n1. INT_AIR 2. \nINT_OCEAN \n3. INT_RAIL \n4. INT_TRUCK \n5. DOM_AIR + \n6. DOM_OCEAN \n7. DOM_RAIL \n8. DOM_TRUCK \n\nDefault value will vary + based on the import country." + transportCost: + maximum: 1 + type: number + description: "Specifies the Freight charge or transport costs, which are + used for tariff calculations. Landed cost result might have some dependency + on the freight charges in some countries. Therefore, freight amount should + be always provided for accurate Landed Cost result. \n\nAllowed values:\n + 1. Any non-negative floating-point number. \n2. Numeric value with optional + decimal value." + example: 100.6 + shipmentType: + type: string + maximum: 1 + maxLength: 35 + description: "Specifies the shipment type such as Gift, Document, Commercial + (Sale), etc.\n\nSupported Shipment Types: \n1. GIFT \n2. COMMERCIAL \n3. + SALE \n4. SAMPLE \n5. REPAIR \n6. RETURN \n7. OTHER \n\nDefault value + will vary and based on import country." + shipmentItems: + type: array + maximum: 99 + items: + "$ref": "#/components/schemas/Request_ShipmentItems" + description: Array of shipment item objects (commodities), that are in a + shipment. + Request_ShipmentItems: + type: object + required: + - commodityId + - priceEach + - commodityCurrencyCode + - quantity + - UOM + - originCountryCode + properties: + commodityId: + type: string + maximum: 1 + maxLength: 100 + description: Commodity ID is used to associate tariffs with product in the + output. Should be unique for each commodity in a request. It is an arbitrary + string provided by the user of the API that will be returned with the + Landed Cost Quote to indicate which commodity the tariffs apply to. + grossWeight: + type: number + maximum: 1 + description: Specifies the gross weight of the commodity as any non-negative + value. + example: 10.34 + grossWeightUnit: + type: string + maximum: 1 + maxLength: 2 + description: 'Specifies the units of the gross weight. Required if GrossWeight + is used. If GrossWeight is not specified, this value must not be set to + anything but null. Supported values: LB, KG' + example: KG + priceEach: + type: number + maximum: 1 + description: Specifies the price for each commodity unit in the settlement + currency. The total price of the entire number of shipmentItems may not + exceed 999999999999.99 + example: 346.32 + commodityCurrencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the Currency Code used for commodity price. All commodities + must have the same currency code. + example: USD, CAD, EUR + quantity: + type: integer + maximum: 1 + description: Specifies the number of product units to be shipped. The total + price of the entire number of shipmentItems may not exceed 999999999999.99, + 1 or greater than 1 + UOM: + type: string + maximum: 1 + description: Specifies unit of measure. Check UOM List in the Appendices + section. + example: KILOGRAM, BAG + hsCode: + type: string + maximum: 1 + maxLength: 40 + description: Specifies a valid HS or HTS code for the shipment's destination + or import country. This field is required if description is not provided. + example: '0901.90.00.10' + description: + type: string + maximum: 1 + maxLength: 150 + description: This field is populated with description of the commodity. + This field is required if hsCode is not provided. + originCountryCode: + type: string + maximum: 1 + maxLength: 2 + description: Country of Manufacture or origin. + example: US, CA, JP, MX + LandedCostResponse: + type: object + required: + - shipment + - alVersion + - perfStats + - transID + properties: + shipment: + type: object + required: + - currencyCode + - importCountryCode + - id + - brokerageFeeItems + - totalBrokerageFees + - totalDuties + - totalCommodityLevelTaxesAndFees + - totalShipmentLevelTaxesAndFees + - totalVAT + - totalDutyAndTax + - grandTotal + - shipmentItems + description: Every Landed Cost response must be based on a shipment. + properties: + currencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the Currency Code set at the commodity level. + This currency is applicable for all duty, tax, VAT, and fee at the + shipment and commodity level. + example: USD, CAD, EUR + importCountryCode: + type: string + maximum: 1 + maxLength: 2 + description: Specifies the Import/Ship-To/Destination/Final country + of the shipment. Please check country list in the Appendices section. + example: US, CA, MX + id: + type: string + maximum: 1 + maxLength: 100 + description: Specifies the Shipment ID in the Landed Cost quote. + brokerageFeeItems: + type: array + maximum: 1 + items: + "$ref": "#/components/schemas/brokerageFeeItems" + description: An array of Brokerage fees. + totalBrokerageFees: + type: number + maximum: 1 + description: Grand total of all applicable Brokerage fees. + totalDuties: + type: number + maximum: 1 + description: Total duty amount of this shipment. + totalCommodityLevelTaxesAndFees: + type: number + maximum: 1 + description: Total tax and other fees at commodity level. + totalShipmentLevelTaxesAndFees: + type: number + maximum: 1 + description: Total tax and other fees at shipment level. + totalVAT: + type: number + maximum: 1 + description: Total VAT of the shipment. + totalDutyAndTax: + type: number + maximum: 1 + description: Grand total of the combined duty, VAT, tax, and other fees + of all commodities in this shipment including shipment level taxes + and fees. + grandTotal: + type: number + maximum: 1 + description: Sum of totalDutyAndTax + totalBrokerageFees + shipmentItems: + type: array + items: + "$ref": "#/components/schemas/Response_ShipmentItems" + maximum: 99 + description: An array of Landed Cost for all valid commodities. + transID: + type: string + maxLength: 50 + description: An identifier unique to the request. + perfStats: + type: object + maximum: 1 + required: + - absLayerTime + - fulfillTime + - receiptTime + description: See ALPerfStats + properties: + absLayerTime: + type: string + maximum: 1 + maxLength: 20 + description: Time taken through the abstraction layer in milliseconds. + fulfillTime: + type: string + maximum: 1 + maxLength: 32 + description: Time taken to complete the request. + receiptTime: + type: string + maximum: 1 + maxLength: 32 + description: Time taken to receive the request. + alVersion: + type: integer + maximum: 1 + maxLength: 10 + description: Version number of the instance that processed this request. + Default is 1. + errors: + "$ref": "#/components/schemas/Errors" + xml: + name: LandedCostResponse + maximum: 1 + brokerageFeeItems: + properties: + chargeName: + type: string + maximum: 1 + maxLength: 50 + description: "Brokerage charge name for this shipment. Possible Values:\n1. + Entry Preparation Fee \n2. Disbursement Fee \n3. Additional Line Fee" + chargeAmount: + type: number + maximum: 1 + description: Fee amount for the brokerage charges. + example: 10.56 + Response_ShipmentItems: + required: + - commodityID + - hsCode + - commodityDuty + - commodityVAT + - totalCommodityDutyAndTax + - commodityCurrencyCode + - isCalculable + properties: + commodityID: + type: string + maximum: 1 + description: Specifies the commodity ID. + hsCode: + type: string + maxLength: 40 + maximum: 1 + description: Specifies the HTS code of the commodity. + commodityDuty: + type: number + maximum: 1 + description: Duty amount for this commodity. + totalCommodityTaxAndFee: + type: number + maximum: 1 + description: Total tax and other fees for this commodity (excluding commodity + duty and VAT). + commodityVAT: + type: number + maximum: 1 + description: VAT amount for this commodity. + totalCommodityDutyAndTax: + type: number + maximum: 1 + description: Sum of commodity duty, VAT, tax, and other fees for this commodity. + commodityCurrencyCode: + type: string + maximum: 1 + maxLength: 3 + description: Specifies the currency code used for commodity's price. + isCalculable: + type: boolean + maximum: 1 + description: True/False. Indicates if Landed Cost can successful calculated + for this commodity. + example: true, false + Errors: + type: object + maximum: 99 + description: Error code and description + properties: + code: + type: string + maximum: 1 + maxLength: 20 + description: Error Code + description: + type: string + maximum: 1 + maxLength: 128 + description: Description of the error. + message: + type: string + maximum: 1 + maxLength: 128 + description: Consumer tailored error message. + value: + type: string + maximum: 1 + maxLength: 128 + description: The value that caused the error. + field: + type: string + maximum: 1 + maxLength: 256 + description: The path to the field causing the error, as returned from the + backend services. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/Locator.yaml b/Locator.yaml index 161a20a..3664cf7 100644 --- a/Locator.yaml +++ b/Locator.yaml @@ -1,2634 +1,2634 @@ -openapi: 3.0.3 -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 - - Appendix - - Errors - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/locations/{version}/search/availabilities/{reqOption}": - post: - summary: Locator - tags: - - Locator - security: - - OAuth2: [] - 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. - operationId: Locator - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v3 - description: | - Version of API - - Valid values: - - v3 - required: true - - in: path - name: reqOption - schema: - type: string - minLength: 1 - maxLength: 4 - description: "Indicates the type of request.\nValid values:\n1-Locations (Drop - 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. " - required: true - - in: query - name: Locale - schema: - type: string - default: en_US - description: Locale of request - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/LOCATORRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - LocatorRequest: - Request: - TransactionReference: - CustomerContext: '' - RequestAction: Locator - OriginAddress: - AddressKeyFormat: - AddressLine: 123 Fork rd - PoliticalDivision2: Atlanta - PoliticalDivision1: PE - PostcodePrimaryLow: '30005' - PostcodeExtendedLow: '30005' - CountryCode: US - MaximumListSize: '10' - Translate: - LanguageCode: ENG - Locale: en_US - UnitOfMeasurement: - Code: MI - LocationSearchCriteria: - SearchOption: - - OptionType: - Code: '01' - OptionCode: - Code: '001' - Relation: - Code: '01' - - OptionType: - Code: '01' - OptionCode: - - Code: '001' - - Code: '001' - Relation: - Code: '01' - MaximumListSize: '10' - SearchRadius: '75' - ServiceSearch: - Time: '1030' - ServiceCode: - Code: '01' - SortCriteria: - SortType: '01' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/LOCATORResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - post: - deprecated: true - summary: Locator - tags: - - Locator - security: - - OAuth2: [] - 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. - operationId: Deprecated Locator - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: path - name: reqOption - schema: - type: string - minLength: 1 - maxLength: 4 - description: "Indicates the type of request.\nValid values:\n1-Locations (Drop - 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. " - required: true - - in: query - name: Locale - schema: - type: string - default: en_US - description: Locale of request - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/LOCATORRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - LocatorRequest: - Request: - TransactionReference: - CustomerContext: '' - RequestAction: Locator - OriginAddress: - AddressKeyFormat: - AddressLine: 123 Fork rd - PoliticalDivision2: Atlanta - PoliticalDivision1: PE - PostcodePrimaryLow: '30005' - PostcodeExtendedLow: '30005' - CountryCode: US - MaximumListSize: '10' - Translate: - LanguageCode: ENG - Locale: en_US - UnitOfMeasurement: - Code: MI - LocationSearchCriteria: - SearchOption: - - OptionType: - Code: '01' - OptionCode: - Code: '001' - Relation: - Code: '01' - - OptionType: - Code: '01' - OptionCode: - - Code: '001' - - Code: '001' - Relation: - Code: '01' - MaximumListSize: '10' - SearchRadius: '75' - ServiceSearch: - Time: '1030' - ServiceCode: - Code: '01' - SortCriteria: - SortType: '01' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/LOCATORResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - LOCATORRequestWrapper: - xml: - name: LocatorRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - LocatorRequest - properties: - LocatorRequest: - "$ref": "#/components/schemas/LocatorRequest" - LOCATORResponseWrapper: - xml: - name: LocatorResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - LocatorResponse - properties: - LocatorResponse: - "$ref": "#/components/schemas/LocatorResponse" - LocatorRequest: - type: object - required: - - Request - - OriginAddress - - Translate - properties: - Request: - "$ref": "#/components/schemas/LocatorRequest_Request" - OriginAddress: - "$ref": "#/components/schemas/LocatorRequest_OriginAddress" - Translate: - "$ref": "#/components/schemas/LocatorRequest_Translate" - UnitOfMeasurement: - "$ref": "#/components/schemas/LocatorRequest_UnitOfMeasurement" - LocationID: - description: Location ID is the identification number of the UPS affiliated - location. - type: array - items: - type: string - minLength: 1 - maxLength: 10 - LocationSearchCriteria: - "$ref": "#/components/schemas/LocatorRequest_LocationSearchCriteria" - 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 - Details\n03-Proximity Search Summary\n04-Address Search Summary\n05-Freight - Will Call Search. \nEither OptionType 03 or 04 is required." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ServiceGeoUnit: - "$ref": "#/components/schemas/LocatorRequest_ServiceGeoUnit" - FreightIndicator: - description: FreightIndicator. Required for Freight Location Search. - type: string - maximum: 1 - xml: - name: LocatorRequest - maximum: 1 - description: N/A - LocatorRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - RequestAction: - description: "Indicates the action to be taken by the XML service. \nThe - only valid value is 'Locator'." - maximum: 1 - type: string - minLength: 13 - maxLength: 13 - xml: - name: Request - maximum: 1 - required: - - RequestAction - description: N/A - Request_TransactionReference: - type: object - maximum: 1 - minLength: 1 - maxLength: 512 - properties: - CustomerContext: - description: The client uses CustomerContext to synchronize request/response - pairs. The client establishes CustomerContext, which can contain any information - client want, as long as it is valid XML; it is echoed back by the server - type: string - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - LocatorRequest_OriginAddress: - type: object - properties: - Geocode: - "$ref": "#/components/schemas/OriginAddress_Geocode" - 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 - values: 1-50, default 10" - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - xml: - name: OriginAddress - required: - - AddressKeyFormat - maximum: 1 - description: Container for origin address information. - OriginAddress_Geocode: - type: object - maximum: 1 - required: - - Latitude - - Longitude - properties: - Latitude: - description: The latitude of the origin address or the center point of the area code. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - Longitude: - description: The longitude of the origin address or the center point of the area code. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - xml: - name: Geocode - description: Geocode is the latitude and longitude of the origin address. - OriginAddress_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name. Not relevant for this tool - type: string - minLength: 1 - maxLength: 40 - maximum: 1 - AddressLine: - description: Address Line Information. The user may submit street level address information or provide Intersection information. - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - AddressLine2: - description: Additional Address Line Information. - maximum: 1 - type: string - minLength: 1 - maxLength: 64 - AddressLine3: - description: Additional Address Line Information. - maximum: 1 - type: string - minLength: 1 - maxLength: 64 - PoliticalDivision3: - description: Barrio or other sub-division of City - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - PoliticalDivision2: - description: City or Town. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PoliticalDivision1: - description: State or province - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostcodePrimaryLow: - description: Main postal code. Required if the user does not submit the City, State/Province address combination. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PostcodeExtendedLow: - description: 4 Digit postal code extension. Valid for US only. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - CountryCode: - description: Two-character country or territory abbreviation - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - SingleLineAddress: - description: | - Single line search information. Can contain values of origin address in a single line. Will override other origin address information. - - Conditionally Required for Non-Postal Code Countries. Applicable Country Ireland (IE) - - SingleLineAddress used for the lookup - - SingleLineAddress (Format - CSV) (\"Values:\" + postalCode + city + state + address + landmark + phoneNumber) - type: string - maximum: 1 - xml: - name: AddressKeyFormat - required: - - PoliticalDivision1 - - AddressLine - - PostcodePrimaryLow - - PoliticalDivision2 - - 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." - LocatorRequest_Translate: - type: object - maximum: 1 - properties: - Locale: - 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." - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - xml: - name: Translate - description: Contains the locale information for the request. - LocatorRequest_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - Valid values are: - - - MI-Miles - - KM-Kilometers - type: string - xml: - name: UnitOfMeasurement - description: Distance unit of measurement. This is required for location requests - (request option 1). - LocatorRequest_LocationSearchCriteria: - type: object - properties: - SearchOption: - type: array - items: - "$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 - of 5. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - 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 - for UnitOfMesaure KM" - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - ServiceSearch: - "$ref": "#/components/schemas/LocationSearchCriteria_ServiceSearch" - FreightWillCallSearch: - "$ref": "#/components/schemas/LocationSearchCriteria_FreightWillCallSearch" - AccessPointSearch: - "$ref": "#/components/schemas/LocationSearchCriteria_AccessPointSearch" - 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. - UAPs with postal code starts with BT returned when brexit filter starts - with BT, else UAPs returned with non BT postal code. Applicable for UAP - and Proximal building search. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - 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 - when the user requests a Location search (request option 1)." - LocationSearchCriteria_SearchOption: - type: object - required: - - OptionCode - - OptionType - properties: - OptionType: - "$ref": "#/components/schemas/SearchOption_OptionType" - OptionCode: - type: array - items: - "$ref": "#/components/schemas/SearchOption_OptionCode" - Relation: - "$ref": "#/components/schemas/SearchOption_Relation" - xml: - name: SearchOption - description: | - SearchOption contains the information that forms the basis of the location search, It contains the criteria for search by Locations, Retail Locations, Additional Services, or Program Types. - - There should be one container for each type of search the user may wish to do. The user can specify either search by Locations or Retail Locations, but not both. - - If this container is missing, the default search would be for The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping Outlet location types. - SearchOption_OptionType: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - Code for Option type valid values are: - - - 01-Location - - 02-Retail Location - - 03-Additional Services - - 04-Program Type - - 05-Service Level Option. - - 06-End Point Service Offering - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - 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 - 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." - SearchOption_OptionCode: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - These codes vary by country. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country or territory. - - Refer to Location Search Option Codes in the Appendix for additional information. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - 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 - OptionCodes which forms the criteria for the location search." - SearchOption_Relation: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - Applicable for Additional Services and Program Types. - - Valid values: - - - 01 - And (Default) - - 02 - Or - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - 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 - 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." - LocationSearchCriteria_ServiceSearch: - type: object - maximum: 1 - properties: - Time: - description: 'Scheduled Local Drop-off Time. Format: HHMM' - maximum: 1 - type: string - minLength: 4 - maxLength: 6 - ServiceCode: - type: array - items: - "$ref": "#/components/schemas/ServiceSearch_ServiceCode" - ServiceOptionCode: - type: array - items: - "$ref": "#/components/schemas/ServiceSearch_ServiceOptionCode" - xml: - name: ServiceSearch - description: Allows for users to further define the search criteria. Refer to - the rules specified in Service Search section. - ServiceSearch_ServiceCode: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - Code indicating the different services. Valid values are: - 01-Ground. - 02-Air. - 03-Express - 04-Standard - 05-International (Only avialable July 17) - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ServiceCode - description: |- - Container that contains the service information such as Ground/Air. - Required if the customer provides ServiceSearch Time. - ServiceSearch_ServiceOptionCode: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - Code that defines the optional service. - - Valid values: - - 01 - Saturday pickup. - - Only valid for air service. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ServiceOptionCode - description: Container for the optional service information such as Saturday - Pick up. - LocationSearchCriteria_FreightWillCallSearch: - type: object - maximum: 1 - required: - - FreightWillCallRequestType - - OriginOrDestination - - FormatPostalCode - - FacilityAddress - properties: - FreightWillCallRequestType: - 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. - This Search is valid for non-postal code Countries" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - FacilityAddress: - type: array - items: - "$ref": "#/components/schemas/FreightWillCallSearch_FacilityAddress" - OriginOrDestination: - description: |- - OriginOrDestination is required for FreightWillCallRequestType 1 and type 3 . Valid values: - 01-Origin facilities - 02-Destination facilities. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - FormatPostalCode: - description: |- - FormatPostalCode would be required in the request when FreightWillCallRequestType is 1. Valid values are: - NFR-No format requested - FR-format requested - FS-format and search - NVR-No validation requested. - maximum: 1 - type: string - 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." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: FreightWillCallSearch - description: Freight Will Call Search Container. Required if SearchOption is - '05-Freight Will Call Search' - FreightWillCallSearch_FacilityAddress: - type: object - maximum: 1 - properties: - SLIC: - description: Facility SLIC. Required for Freight Will call search if FreightWillCallRequestType - is 2. - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - AddressLine: - description: Address line - type: array - items: - type: string - maxItems: 2 - minLength: 1 - maxLength: 64 - City: - description: City. Required for Freight Will call search if FreightWillCallRequestType - is 3. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCodePrimaryLow: - description: Postal code. Required for Freight Will call search if FreightWillCallRequestType - is 1. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - PostalCodeExtendedLow: - description: 4 Digit postal code extension. Valid for US only. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - State: - description: State. Required if FrieghtWillCallRequestType is 3 if State - is available. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - CountryCode: - description: Country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: FacilityAddress - required: - - CountryCode - description: Facility Address Container - LocationSearchCriteria_AccessPointSearch: - type: object - maximum: 1 - properties: - PublicAccessPointID: - description: The Public Access Point ID to use for UPS Access Point Search. - Once this parameter is present , address or geocode search is ignored. - It cannot be combined with AccountNumber search parameter. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - AccessPointStatus: - description: "Status of UPS Access Point. Valid values are: \n01-Active-available\n07-Active-unavailable." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - AccountNumber: - description: The account number to use for UPS Access Point Search in the - country or territory. Used to locate a private network for the account. - Once this parameter is present any access point address or geocode search - is ignored. It cannot be combined with PublicAccessPointID search parameter. - maximum: 1 - type: string - minLength: 6 - maxLength: 10 - IncludeCriteria: - "$ref": "#/components/schemas/AccessPointSearch_IncludeCriteria" - 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. - type: string - maximum: 1 - ExistIndicator: - description: Presence of this tag represents that "AccessPointAvailability" - service is requested. The value of this tag is ignored. - type: string - maximum: 1 - xml: - name: AccessPointSearch - description: Applicable for request option 64 only. This contains inclusion - and exclusion criteria for address search. It also contains Account Number - and Access Point Public ID search elements. - AccessPointSearch_IncludeCriteria: - type: object - properties: - MerchantAccountNumberList: - "$ref": "#/components/schemas/IncludeCriteria_MerchantAccountNumberList" - SearchFilter: - "$ref": "#/components/schemas/IncludeCriteria_SearchFilter" - ServiceOfferingList: - "$ref": "#/components/schemas/IncludeCriteria_ServiceOfferingList" - xml: - name: IncludeCriteria - description: This contains elements to refine (include) UPS Access point address - or geocode Search. - maximum: 1 - IncludeCriteria_MerchantAccountNumberList: - type: object - required: - - MerchantAccountNumber - properties: - MerchantAccountNumber: - description: Account number to be used for a private network access point - search where a UPS access point candidate list is obtained in search by - address or geocode search. - type: array - items: - type: string - minLength: 6 - maxLength: 10 - xml: - name: MerchantAccountNumberList - description: This contains the list of Merchant Account numbers to be used for - finding private network access points. - maximum: 1 - IncludeCriteria_SearchFilter: - type: object - maximum: 1 - properties: - DCRIndicator: - description: DCR/DCO Availability indicator for UPS Access Point. Either - this indicator is present or not present. Presence indicates a search - for access points with DCR. Any data in the element is ignored. - type: string - maximum: 1 - ShippingAvailabilityIndicator: - description: Shipping Availability indicator for UPS Access Point. Either - this indicator is present or not present. Presence indicates a search - of access points with shipping availability. Any data in it is ignored. - type: string - maximum: 1 - ShipperPreparationDelay: - description: Value for the number of days to check for shipping availability from the current day. When this value is present, ShippingAvailabilityIndicator is implied implicitly. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ClickAndCollectSortWithDistance: - description: This contains the distance (in given UnitOfMeasurement) wherin to sort the click and collect access point locations above other access point locations when a UPS Access Point candidate list is obtained in search by address or geocode search. - maximum: 1 - type: string - maxLength: 3 - xml: - name: SearchFilter - description: Container to hold one or more search criteria for UPS Access Points - that allow DCR, Shipping and ClickAndCollect access. Only applicable when - the UPS access point candidate list is obtained in search by address or geocode - search. - IncludeCriteria_ServiceOfferingList: - type: object - required: - - ServiceOffering - properties: - ServiceOffering: - type: array - items: - "$ref": "#/components/schemas/ServiceOfferingList_ServiceOffering" - xml: - name: ServiceOfferingList - description: Container to hold end point service offering List for UPS Access - point. Applicable only when a UPS Access Point candidate list is obtained - in search by address or geocode search. - maximum: 1 - ServiceOfferingList_ServiceOffering: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - 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 - At Store\n013-Accepts Restricted Articles" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the service offering. Text will be displayed - in the locale requested. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ServiceOffering - AccessPointSearch_ExcludeFromResult: - type: object - maximum: 1 - properties: - BusinessClassificationCode: - description: This contains the business classification code to exclude from - UPS Access Point Search by address or geocode. Multiple codes can are - possible in separate elements. Please refer to Appendix D for detailed - business codes. - type: array - items: - type: string - minLength: 3 - maxLength: 3 - maximum: 1 - BusinessName: - description: This contains the business name to exclude from UPS Access - Point Search by address or geocode. Partial names are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - Radius: - description: Public Access points within Radius (in specified Unit of Measure) - of any included private access points will be excluded from the results. - Valid only if at least one IncludeCriteria/MerchantAccountNumber is provided. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - PostalCodeList: - "$ref": "#/components/schemas/ExcludeFromResult_PostalCodeList" - xml: - name: ExcludeFromResult - description: This contains elements to exclude from UPS Access Point address - or geocode search. - ExcludeFromResult_PostalCodeList: - type: object - required: - - PostalCode - properties: - PostalCode: - type: array - items: - "$ref": "#/components/schemas/PostalCodeList_PostalCode" - xml: - name: PostalCodeList - description: Container to hold a list of postal codes to exclude from the access - point address or geocode search. - maximum: 1 - PostalCodeList_PostalCode: - type: object - maximum: 1 - required: - - PrimaryPostalCode - properties: - PrimaryPostalCode: - description: Primary postal code. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - SecondaryPostalCode: - description: Secondary postal code. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: PostalCode - description: Container to hold the postal code . - LocationSearchCriteria_OpenTimeCriteria: - type: object - maximum: 1 - properties: - DayOfWeekCode: - description: |- - Day Of week Code. - Valid values: - 1-Sunday - 2-Monday - 3-Tuesday - 4-Wednesday - 5-Thursday - 6-Friday - 7-Saturday - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - FromTime: - description: From time. Time Format HHMM. - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - ToTime: - description: To Time. Time Format HHMM - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - xml: - name: OpenTimeCriteria - description: Container to hold open times of the Location. - LocatorRequest_SortCriteria: - type: object - maximum: 1 - properties: - SortType: - description: |- - For different sort type. Valid values: - 01-Closest Location - 02-Deadline for Drop-off by Air/Express - 03-Deadline for Drop-off by Ground/Standard - 04-Latest Close Time - 05-Earliest Open Time. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - xml: - name: SortCriteria - description: Container for Sort Criteria - LocatorRequest_ServiceGeoUnit: - type: object - maximum: 1 - required: - - ServiceCode - - GeoPoliticalUnit - properties: - ServiceCode: - description: "Service Code. Required if ServiceGeoUnit Container present. - \nValid value is '096' ." - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - GeoPoliticalUnit: - description: |- - GeoPoliticalUnit. Required if ServiceGeoUnit container present. - Valid value is '002' . - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: ServiceGeoUnit - description: ServiceGeoUnit Container. Required to search for the freight facility - information - LocatorResponse: - type: object - required: - - Response - - AllowAllConfidenceLevels - - SearchResults - properties: - Response: - "$ref": "#/components/schemas/LocatorResponse_Response" - Geocode: - "$ref": "#/components/schemas/LocatorResponse_Geocode" - SearchResults: - "$ref": "#/components/schemas/LocatorResponse_SearchResults" - AllowAllConfidenceLevels: - description: |- - Confidence level. - Valid values: True or False - maximum: 1 - type: string - minLength: 4 - maxLength: 5 - xml: - name: LocatorResponse - maximum: 1 - description: Container for LocatorResponse. - LocatorResponse_Response: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - ResponseStatusCode: - description: "Identifies the success or failure of the interchange. \n1-Success\n0-Failure" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ResponseStatusDescription: - description: Describes the Response Status Code. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - Error: - "$ref": "#/components/schemas/Response_Error" - xml: - name: Response - maximum: 1 - required: - - ResponseStatusCode - description: Container for Response. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: Customer provided data. If this data is present in the request, it is echoed back to the customer. - maximum: 1 - type: string - maxLength: 512 - XpciVersion: - description: "Identifies the version of the message. \nCurrent version is - 1.0014" - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: TransactionReference - description: Container for customer provided data and the XPCI Version. - Response_Error: - type: object - maximum: 1 - required: - - ErrorSeverity - - ErrorCode - properties: - ErrorSeverity: - description: "Describes the severity of the error. \nFor additional information, - refer to Locator Error Codes in the Appendix." - maximum: 1 - type: string - minLength: 1 - 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 - Error Codes in the Appendix." - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ErrorDescription: - description: Describes the error code. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - MinimumRetrySeconds: - 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 - type: string - minLength: 1 - maxLength: 5 - ErrorLocation: - description: | - Identifies the element in error. - - **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" - ErrorDigest: - description: | - The contents of the element in error. - - **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: - type: string - xml: - name: Error - description: If an error is encountered during the interchange, the Response - contains an error. If the error is present, then the ErrorSeverity and ErrorCode - are required. - Error_ErrorLocation: - type: object - maximum: 1 - properties: - ErrorLocationElementName: - description: The Xpath name of the element in error. This is a valid Xpath - pointing to an element in the request document. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - ErrorLocationAttributeName: - description: The name of the attribute in error. This is the name of the - attribute contained by the Error Location element. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: ErrorLocation - LocatorResponse_Geocode: - type: object - maximum: 1 - required: - - Latitude - - Longitude - properties: - Latitude: - description: The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. - type: string - Longitude: - description: The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. - type: string - xml: - name: Geocode - description: Geocode is the latitude and longitude of the origin address. The - Geocode is provided in the first successful response. Required to be returned - when the origin address or phone number is submitted in the request.Will not - be returned when the requestoption =64 - LocatorResponse_SearchResults: - type: object - properties: - GeocodeCandidate: - description: | - If the origin address provided in the location request document does not have a match, a list of candidate addresses, geocodes and optionally a landmark will be returned. - - **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" - 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 - 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 - origin." - DropLocation: - description: | - When a location request is submitted with a valid origin address, UPS locations will be returned. - - **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" - AvailableLocationAttributes: - description: | - This container contains the information about the currently existing Retail Locations or Additional Services or Program types. - - **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" - ActiveAvailableAccessPointIndicator: - description: "Indicates whether the country or territory has AccessPoints - or not. \n\nThis tag is populated in the Response only if tag \"ExistIndicator\" - was present in the Locator request." - type: string - maximum: 1 - xml: - name: SearchResults - maximum: 1 - description: Container for search results. - SearchResults_GeocodeCandidate: - type: object - required: - - Geocode - - AddressKeyFormat - properties: - AddressKeyFormat: - "$ref": "#/components/schemas/GeocodeCandidate_AddressKeyFormat" - 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 - and Geocode. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: GeocodeCandidate - maximum: 1 - GeocodeCandidate_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name. Not relevant for candidate list. - type: string - AddressLine: - description: Address Line Information. The address level or Intersection information must be returned if provided in the request. The AddressLine will be a combination of up to 3 separate address lines, each separated by a new line character. - type: string - PoliticalDivision3: - description: Subdivision within a City. e.g., a Barrio. - type: string - PoliticalDivision2: - description: City. - type: string - PoliticalDivision1: - description: State/Province. - type: string - PostcodePrimaryLow: - description: Postal Code. - type: string - PostcodeExtendedLow: - description: 4 Digit postal code extension. Valid for US only. - type: string - CountryCode: - description: "A country or territory code. Valid values for candidates to be returned are: US-United States (meaning US 50)" - type: string - xml: - name: AddressKeyFormat - required: - - PoliticalDivision1 - - AddressLine - - PostcodePrimaryLow - - PoliticalDivision2 - - CountryCode - description: Contains all of the basic information about candidate address. - GeocodeCandidate_Geocode: - type: object - maximum: 1 - required: - - Latitude - - Longitude - properties: - Latitude: - description: The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. - type: string - Longitude: - description: The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. - type: string - xml: - name: Geocode - description: Geocode is the latitude and longitude of the origin candidate. - SearchResults_DropLocation: - type: object - maximum: 1 - required: - - Geocode - - Timezone - - IVR - - AddressKeyFormat - - LocationID - - OriginOrDestination - - PhoneNumber - - LocationAttribute - - Distance - properties: - LocationID: - description: The location ID that corresponds to the UPS location. Do not - expose the Location ID. - type: string - minLength: 1 - maxLength: 10 - OriginOrDestination: - description: "OriginOrDestination will returned for FreightWillCallRequestType - 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" - Geocode: - "$ref": "#/components/schemas/DropLocation_Geocode" - AddressKeyFormat: - "$ref": "#/components/schemas/DropLocation_AddressKeyFormat" - PhoneNumber: - description: | - The UPS locations Phone number. A phone number of the location will be returned. - - 10 digits allowed for US, otherwise 1..15 digits allowed. - - The phone number will be returned as a string. - - **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: - type: string - minLength: 1 - 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 - 1..15 digits allowed.\nThe fax number will be returned as string." - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - EMailAddress: - description: Email address of the UPS location. Returned when available. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - LocationAttribute: - description: | - OptionType is a container that indicates the type of the location attribute. - - There are 4 types of attributes. - - They are: Location, Retail Location, Additional Services and Program Type. - - **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" - Distance: - "$ref": "#/components/schemas/DropLocation_Distance" - SpecialInstructions: - description: | - Walking directions. - - **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" - 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. - - When a user specifies a Drop-off Time and Ground as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned. - - **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: - minLength: 4 - maxLength: 6 - type: string - LatestAirDropOffTime: - description: | - The latest airtime 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. - - When a user specifies a Drop-off Time and Air as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned. - - **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: - minLength: 4 - maxLength: 6 - type: string - AdditionalChargeIndicator: - description: Presence or Absence Indicator. If present, Indicates if the - UPS location would have an additional charge. ASO locations will require - an additional charge. - type: string - maximum: 1 - StandardHoursOfOperation: - description: The standard hours of operation of the drop location will be - returned when available. The location's time may differ because of holidays. - type: string - maximum: 1 - NonStandardHoursOfOperation: - description: The non-standard hours of operation of the drop location. The - location's time may differ because of holidays, weekends, or other factors - that are beyond the locations control. Seven days preceding a given holiday - the Non Standard Hours Of Operation will be returned along with the standard - hours of operation if available. - type: string - maximum: 1 - WillCallHoursOfOperation: - description: The will call hours of operation of the drop location will - be returned when available. The location's time may differ because of - holidays. - type: string - maximum: 1 - Number: - description: The center number of the drop location if it is The UPS store. - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - HomePageURL: - description: The home page URL of the drop location if it is The UPS store. - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - Comments: - description: "Comments returned about the location. Text will be displayed in English or the locale given in the request. If Country Code is FR, and locale passed in the request is \"fr_FR\" then text will be displayed in French language, else comment will be displayed in English language." - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - AdditionalComments: - "$ref": "#/components/schemas/DropLocation_AdditionalComments" - Disclaimer: - description: | - Textual disclaimer about the drop location. - - **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: - type: string - SLIC: - description: SLIC. - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - Timezone: - description: TimeZone. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - FacilityType: - description: PKG/FRT. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - OperatingHours: - "$ref": "#/components/schemas/DropLocation_OperatingHours" - LocalizedInstruction: - description: | - LocalizedInstruction container. Applicable for SearchOptionCode 01, 02, 03. - - **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" - PromotionInformation: - description: | - Container to hold any promotion text for the location. Text will be displayed in English or the locale given in the request. - - **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" - SortCode: - "$ref": "#/components/schemas/DropLocation_SortCode" - 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 - number. This indicator is used by the clients to determine whether to - display the telephone number to the end user." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - AccessPointInformation: - "$ref": "#/components/schemas/DropLocation_AccessPointInformation" - LocationImage: - "$ref": "#/components/schemas/DropLocation_LocationImage" - LocationNewIndicator: - description: Indicator for new location. - type: string - maximum: 1 - PromotionalLinkURL: - description: Promotional link URL for specific location. - type: string - maximum: 1 - FeaturedRank: - description: "Feature Ranking values:\nNull or blank - Location is not featured. - \n1 - Featured Location ranked number 1.\n2 - Featured Location ranked - number 2." - maximum: 1 - type: string - maxLength: 1 - WillCallLocationIndicator: - description: | - Will Call Location Indicator values: - - Y – Signifies a Will Call location that serves the customers address. - - N - Signifies it is not a Will Call location. - - Will Call locations are only returned with a \"Y\" indicator if the request included EnhancedSearchOption code 10. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: DropLocation - DropLocation_IVR: - type: object - maximum: 1 - required: - - PhraseID - properties: - PhraseID: - description: |- - Contains the name of the IVR file that relates to this drop location. The file is an audio recording of information related to the location. - ONLY FOR IVR. - maximum: 1 - type: string - minLength: 1 - 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." - type: string - maximum: 1 - xml: - name: IVR - description: "Integrated Voice Response information. \nONLY FOR IVR." - DropLocation_Geocode: - type: object - maximum: 1 - required: - - Latitude - - Longitude - properties: - Latitude: - description: The latitude of the location address or the center point of - the area code. - type: string - Longitude: - description: The longitude of the location address or the center point of - the area code. - type: string - xml: - name: Geocode - description: Geocode is the latitude and longitude of the location address. - The Geocode for the location address will be returned when Location is requested - in the Request Option. - DropLocation_AddressKeyFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Name. (Also includes the building name)Return if available. - type: string - AddressLine: - description: Address Line Information of the UPS location The address level - or Intersection information. Only two address lines will be returned. - The second line may contain such information as the building name, the - suite, and room. - type: string - PoliticalDivision3: - description: Subdivision within a City. e.g., a Barrio. - type: string - PoliticalDivision2: - description: City. - type: string - PoliticalDivision1: - description: State/Province. - type: string - PostcodePrimaryLow: - description: Postal Code. - type: string - PostcodeExtendedLow: - description: 4 Digit postal code extension. Valid for US only. - type: string - CountryCode: - description: 'A country or territory code. Valid values to be returned are: - US-United States (meaning US 50).' - type: string - xml: - name: AddressKeyFormat - required: - - PoliticalDivision1 - - AddressLine - - PostcodePrimaryLow - - PoliticalDivision2 - - CountryCode - description: Contains all of the basic information about a location, Consignee - Name, Building Name, Address Lines, City, State/Province, Postal Code and - Country or Terriotry Code. - DropLocation_LocationAttribute: - type: object - required: - - OptionCode - - OptionType - properties: - 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. - - 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. - - **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 - about the location's Location Type, Retail Location Type, Additional Services, - or Program Type. - maximum: 1 - LocationAttribute_OptionType: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Code for Option type. Valid values: - - 01 - Location - - 02 - Retail Location - - 03 - Additional Services - - 04 - Program Type - type: string - Description: - description: Description for Option type such as Location, RetailLocation, AdditionalServices and ProgramType. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: OptionType - LocationAttribute_OptionCode: - type: object - properties: - Category: - description: | - Only applicabe for OptionType = 03 (Additional Services). Valid values: - - 06 - Non transportation - - 07 - Transportation - type: string - Code: - description: These codes vary by country or territory. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country. Refer to Location Search Option Codes in the Appendix for additional information. - type: string - Description: - description: | - Description is only applicable for Location and Retail Location. The description for Program types and additional service is not provided with Location detail. - - It is only provided when the request is for 8, 24, 40, 56-All available additional services or 16, 24, 48, 56-all available Program types. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Name: - description: Name will indicate the name of any Additional Services/ Program Types depending on the option code. Text will be displayed in the locale selected. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - TransportationPickUpSchedule: - "$ref": "#/components/schemas/OptionCode_TransportationPickUpSchedule" - xml: - name: OptionCode - maximum: 1 - required: - - Description - - Code - OptionCode_TransportationPickUpSchedule: - type: object - required: - - PickUp - properties: - PickUp: - description: | - PickUp container contains details of day of week and corresponding pickup times for that service. - - **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" - 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. - maximum: 1 - TransportationPickUpSchedule_PickUp: - type: object - required: - - DayOfWeek - - PickUpDetails - properties: - DayOfWeek: - description: | - Day of week. - - 1 - Sunday - - 2 - Monday - - 3 - Tuesday - - 4 - Wednesday - - 5 - Thursday - - 6 - Friday - - 7 - Saturday. - type: string - minLength: 1 - maxLength: 1 - PickUpDetails: - "$ref": "#/components/schemas/PickUp_PickUpDetails" - xml: - name: PickUp - PickUp_PickUpDetails: - type: object - properties: - PickUpTime: - description: Pickup time of transportation service for a location in military format (HHMM) e.g. 0930, 1700, 1845 etc. with exception for midnight. For midnight the time will be returned as 0. - type: string - minLength: 4 - maxLength: 4 - NoPickUpIndicator: - description: Presence or Absence Indicator. If present, Indicates that there is no pickup time for the day. - type: string - xml: - name: PickUpDetails - required: - - NoPickUpIndicator - description: PickUpDetails container contains either pickup time or NoPickupIndicator. Either PickUpTime or NoPickupIndicator - maximum: 1 - DropLocation_Distance: - type: object - maximum: 1 - required: - - UnitOfMeasurement - - Value - properties: - Value: - description: The straight line distance from the origin to the UPS location. - Distance value may include one decimal and followed by one decimal place. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - UnitOfMeasurement: - "$ref": "#/components/schemas/Distance_UnitOfMeasurement" - xml: - name: Distance - description: Container for the straight line distance from the origin to the - UPS location. - Distance_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - 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 - KM-Kilometers" - type: string - Description: - description: May return the description of the unit of measure specified - in the request. - maximum: 1 - type: string - minLength: 5 - maxLength: 10 - xml: - name: UnitOfMeasurement - description: The unit of measurement the user will see for the distance is based - on the user input provided in the search request. - DropLocation_SpecialInstructions: - type: object - maximum: 1 - required: - - Segment - properties: - Segment: - 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: - type: string - xml: - name: SpecialInstructions - DropLocation_AdditionalComments: - type: object - required: - - CommentType - properties: - CommentType: - description: | - Container for CommentType Code and Text. - - **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" - xml: - name: AdditionalComments - description: Container for Additional Comments about Location.Text will be displayed - in the Locale requested. - maximum: 1 - AdditionalComments_CommentType: - type: object - maximum: 1 - required: - - Text - - Code - properties: - Code: - description: Comment code is 01 for AccessPoint LCO pickup time comment. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Text: - description: Access point LCO pickup time comment - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - xml: - name: CommentType - DropLocation_OperatingHours: - type: object - properties: - StandardHours: - description: | - StandardHours Container. - - **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" - xml: - name: OperatingHours - description: Operating Hours. - maximum: 1 - OperatingHours_StandardHours: - type: object - maximum: 1 - required: - - DayOfWeek - - HoursType - properties: - HoursType: - 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" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - DayOfWeek: - description: | - Container for the Day of Week. - - **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" - xml: - name: StandardHours - StandardHours_DayOfWeek: - type: object - maximum: 1 - required: - - Day - properties: - Day: - 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 - maxLength: 1 - OpenHours: - description: Open time of a location in military format (HHMM) e.g. 930, - 1700, 1845 etc. with exception for midnight. For midnight the time will - be returned as 0. - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - CloseHours: - description: Close time of a location in military format (HHMM) e.g. 930, - 1700, 1845 etc. with exception for midnight. For midnight the time will - be returned as 0. - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - LatestDropOffHours: - description: LatestDropOffHours for Hour Type 50. Latest Drop Off time of - a location in military format (HHMM) e.g. 930, 1700, 1845 etc. with exception - for midnight. For midnight the time will be returned as 0. - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - PrepHours: - description: PrepHours for Hour Type 51. Prep Hours of a location in military - format (HHMM) e.g. 930, 1700, 1845 etc. with exception for midnight. For - midnight the time will be returned as 0. - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - ClosedIndicator: - description: Presence absence Indicator. Indicator present means location - is closed. - maximum: 1 - type: string - Open24HoursIndicator: - description: Presence/ Absence Indicator. Presence denotes for the given - day, if the location is open 24 hours. Absence denotes the location is - not open for 24 hours on the given day. - maximum: 1 - type: string - minLength: 4 - maxLength: 5 - xml: - name: DayOfWeek - DropLocation_LocalizedInstruction: - type: object - maximum: 1 - required: - - Locale - - Last50ftInstruction - properties: - Locale: - description: Locale - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - Last50ftInstruction: - description: Holds the additional instructions. Text will be displayed in - English or the locale given in the request. The max length of the additional - instruction text is 750 characters. - maximum: 1 - type: string - minLength: 1 - maxLength: 750 - xml: - name: LocalizedInstruction - DropLocation_PromotionInformation: - type: object - maximum: 1 - required: - - Locale - - Promotion - properties: - Locale: - description: Locale (language/ dialect) for the promotion code. - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - Promotion: - description: Promotion text for the given location. - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - xml: - name: PromotionInformation - DropLocation_SortCode: - type: object - maximum: 1 - properties: - HubSortCode: - description: Holds the value of the hub sort code or airport code - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - FreightSortFacilityCode: - description: Holds the value of the facility location code. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: SortCode - description: This container is only for Freight Will call Search. - DropLocation_ServiceOfferingList: - type: object - required: - - ServiceOffering - properties: - ServiceOffering: - description: | - Container for Service offering code. - - **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" - xml: - name: ServiceOfferingList - description: Container to hold the list of service offerings at the end point. - maximum: 1 - DropLocation_AccessPointInformation: - type: object - maximum: 1 - properties: - PublicAccessPointID: - description: The Public Access Point ID associated with UPS access point. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ImageURL: - description: Image URL associated with UPS access point. - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - BusinessClassificationList: - "$ref": "#/components/schemas/AccessPointInformation_BusinessClassificationList" - AccessPointStatus: - "$ref": "#/components/schemas/AccessPointInformation_AccessPointStatus" - FacilitySLIC: - description: Holds the value of facility SLIC of Access Point Location. - Not implemented currently. For future use. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PrivateNetworkList: - "$ref": "#/components/schemas/AccessPointInformation_PrivateNetworkList" - Availability: - "$ref": "#/components/schemas/AccessPointInformation_Availability" - xml: - name: AccessPointInformation - description: Container for UPS Access Point specific parameters. - AccessPointInformation_BusinessClassificationList: - type: object - required: - - BusinessClassification - properties: - BusinessClassification: - description: | - Container to hold Business classification of UPS access point. - - **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" - xml: - name: BusinessClassificationList - description: Container to hold list for business classification. - maximum: 1 - BusinessClassificationList_BusinessClassification: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Business Classification code of UPS Access Point. Please refer - to appendix D for a list of business classification. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - Description: - description: Description of business classification. - maximum: 1 - type: string - maxLength: 35 - xml: - name: BusinessClassification - AccessPointInformation_AccessPointStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: "Valid status values are: \n01-Active-available\n06-Suspended\n07-Active-unavailable\n08-Terminated" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Description of status code. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: AccessPointStatus - description: Container for UPS AccessPoint status. - AccessPointInformation_PrivateNetworkList: - type: object - required: - - PrivateNetwork - properties: - PrivateNetwork: - description: | - Container to hold the private network details. - - **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" - xml: - name: PrivateNetworkList - description: Container to hold the list of private networks. - maximum: 1 - PrivateNetworkList_PrivateNetwork: - type: object - maximum: 1 - required: - - NetworkID - - NetworkDescription - properties: - NetworkID: - description: Value of networkID. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - NetworkDescription: - description: Description of the Network. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: PrivateNetwork - AccessPointInformation_Availability: - type: object - properties: - ShippingAvailability: - "$ref": "#/components/schemas/Availability_ShippingAvailability" - DCRAvailability: - "$ref": "#/components/schemas/Availability_DCRAvailability" - xml: - name: Availability - description: Container to hold the status of shipping or DRC/DCO availability - of a UPS Access Point. - maximum: 1 - Availability_ShippingAvailability: - type: object - maximum: 1 - properties: - AvailableIndicator: - description: Presence or absence indicator. Presence means the location - is available for shipping. - type: string - maximum: 1 - UnavailableReason: - "$ref": "#/components/schemas/ShippingAvailability_UnavailableReason" - xml: - name: ShippingAvailability - description: Holds status of shipping availability. - ShippingAvailability_UnavailableReason: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Code for shipping unavailability. Code for DCR/DCO unavailability. - - Valid values: - - 01 - Temporarily Unavailable - - 02 - Location Full - - 03 - Unavailable - - 04 - Weather - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Description for shipping unavailability. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnavailableReason - description: Container to hold shipping unavailable reason. - Availability_DCRAvailability: - type: object - maximum: 1 - properties: - AvailableIndicator: - description: Presence or absence indicator. Presence means the location - is available for DCR/DCO. - type: string - maximum: 1 - UnavailableReason: - "$ref": "#/components/schemas/DCRAvailability_UnavailableReason" - xml: - name: DCRAvailability - description: Holds status of DCR/DCO availability. - DCRAvailability_UnavailableReason: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - 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. - type: string - xml: - name: UnavailableReason - description: Container to hold shipping unavailable reason. - DropLocation_LocationImage: - type: object - maximum: 1 - properties: - SecureURL: - description: Secure URL for Location Image. - type: string - maximum: 1 - NonSecureURL: - description: Non Secure URL for Location Image. - type: string - maximum: 1 - xml: - name: LocationImage - description: Location Image container. - SearchResults_AvailableLocationAttributes: - type: object - required: - - OptionCode - - OptionType - properties: - OptionType: - "$ref": "#/components/schemas/AvailableLocationAttributes_OptionType" - OptionCode: - "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCode" - xml: - name: AvailableLocationAttributes - AvailableLocationAttributes_OptionType: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Code for Option type. - type: string - Description: - description: Description for Option type such as RetailLocation, AdditionalServices - and ProgramType. - type: string - xml: - name: OptionType - description: OptionType is a container that indicates the type of the location - attribute that are available. For example if the Option Type is RetailLocation - 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. - type: array - items: - "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCodeElement" - AvailableLocationAttributes_OptionCodeElement: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: The valid list of codes and description for Retail Locations - or Additional Services or Pro-gram Types that are currently available - in the database. This can be obtained by a separate type of request (Request - Option 8, 16, 24, 32, 40, 48 and 56). - type: string - Description: - description: Description is only applicable for Program types and Additional - Services. It is not provided with Location detail. It is only provided - when the request is for All available additional ser-vices or all available - Program types. Text will be displayed in the locale requested. - type: string - Name: - description: Name will indicate the name of Location/Retail Location or - Additional Services or Program Types depending on the option code. Text - will be displayed in the locale requested. - type: string - Category: - description: N/A - type: string - TransportationPickUpSchedule: - "$ref": "#/components/schemas/AvailableLocationAttributesOptionCode_TransportationPickUpSchedule" - xml: - name: OptionCode - description: Option code is a container that contains the information of a particular - retail location type or additional service or program type that is available - currently. One or more of this container will be returned to give all the - available codes for Retail Type or Additional Services or Program Type. - AvailableLocationAttributesOptionCode_TransportationPickUpSchedule: - type: object - required: - - PickUp - properties: - PickUp: - description: | - Container to hold information regarding pickup day of the week and details. - - **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" - xml: - name: TransportationPickUpSchedule - description: Container to hold information regarding pickup details for each day of the week. - maximum: 1 - AvailableLocationAttributes_TransportationPickUpSchedule_PickUp: - type: object - required: - - DayOfWeek - - PickUpDetails - properties: - DayOfWeek: - description: | - Day of the week for scheduled pickup. Valid values are: - - 1 - Sunday - - 2 - Monday - - 3 - Tuesday - - 4 - Wednesday - - 5 - Thursday - - 6 - Friday - - 7 - Saturday. - type: string - minLength: 1 - maxLength: 1 - PickUpDetails: - "$ref": "#/components/schemas/AvailableLocationAttributes_PickUp_PickUpDetails" - xml: - name: PickUp - AvailableLocationAttributes_PickUp_PickUpDetails: - type: object - properties: - PickUpTime: - description: Time of pickup in military format (HHMM) e.g. 0930, 1700, 1845 etc. with exception for midnight. For midnight the time will be returned as 0. - type: string - minLength: 4 - maxLength: 4 - NoPickUpIndicator: - description: | - Indicates whether or not there is a pickup time for the specified day of the week. Valid values: - - True-there is a pickup time - - False-there is not a pickup time. - type: string - xml: - name: PickUpDetails - required: - - NoPickUpIndicator - description: Container to hold information regarding pickup time and pickup availability indicator. - maximum: 1 - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +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 + - Appendix + - Errors + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/locations/{version}/search/availabilities/{reqOption}": + post: + summary: Locator + tags: + - Locator + security: + - OAuth2: [] + 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. + operationId: Locator + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v3 + description: | + Version of API + + Valid values: + - v3 + required: true + - in: path + name: reqOption + schema: + type: string + minLength: 1 + maxLength: 4 + description: "Indicates the type of request.\nValid values:\n1-Locations (Drop + 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. " + required: true + - in: query + name: Locale + schema: + type: string + default: en_US + description: Locale of request + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/LOCATORRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + LocatorRequest: + Request: + TransactionReference: + CustomerContext: '' + RequestAction: Locator + OriginAddress: + AddressKeyFormat: + AddressLine: 123 Fork rd + PoliticalDivision2: Atlanta + PoliticalDivision1: PE + PostcodePrimaryLow: '30005' + PostcodeExtendedLow: '30005' + CountryCode: US + MaximumListSize: '10' + Translate: + LanguageCode: ENG + Locale: en_US + UnitOfMeasurement: + Code: MI + LocationSearchCriteria: + SearchOption: + - OptionType: + Code: '01' + OptionCode: + Code: '001' + Relation: + Code: '01' + - OptionType: + Code: '01' + OptionCode: + - Code: '001' + - Code: '001' + Relation: + Code: '01' + MaximumListSize: '10' + SearchRadius: '75' + ServiceSearch: + Time: '1030' + ServiceCode: + Code: '01' + SortCriteria: + SortType: '01' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/LOCATORResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + post: + deprecated: true + summary: Locator + tags: + - Locator + security: + - OAuth2: [] + 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. + operationId: Deprecated Locator + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: path + name: reqOption + schema: + type: string + minLength: 1 + maxLength: 4 + description: "Indicates the type of request.\nValid values:\n1-Locations (Drop + 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. " + required: true + - in: query + name: Locale + schema: + type: string + default: en_US + description: Locale of request + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/LOCATORRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + LocatorRequest: + Request: + TransactionReference: + CustomerContext: '' + RequestAction: Locator + OriginAddress: + AddressKeyFormat: + AddressLine: 123 Fork rd + PoliticalDivision2: Atlanta + PoliticalDivision1: PE + PostcodePrimaryLow: '30005' + PostcodeExtendedLow: '30005' + CountryCode: US + MaximumListSize: '10' + Translate: + LanguageCode: ENG + Locale: en_US + UnitOfMeasurement: + Code: MI + LocationSearchCriteria: + SearchOption: + - OptionType: + Code: '01' + OptionCode: + Code: '001' + Relation: + Code: '01' + - OptionType: + Code: '01' + OptionCode: + - Code: '001' + - Code: '001' + Relation: + Code: '01' + MaximumListSize: '10' + SearchRadius: '75' + ServiceSearch: + Time: '1030' + ServiceCode: + Code: '01' + SortCriteria: + SortType: '01' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/LOCATORResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + LOCATORRequestWrapper: + xml: + name: LocatorRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - LocatorRequest + properties: + LocatorRequest: + "$ref": "#/components/schemas/LocatorRequest" + LOCATORResponseWrapper: + xml: + name: LocatorResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - LocatorResponse + properties: + LocatorResponse: + "$ref": "#/components/schemas/LocatorResponse" + LocatorRequest: + type: object + required: + - Request + - OriginAddress + - Translate + properties: + Request: + "$ref": "#/components/schemas/LocatorRequest_Request" + OriginAddress: + "$ref": "#/components/schemas/LocatorRequest_OriginAddress" + Translate: + "$ref": "#/components/schemas/LocatorRequest_Translate" + UnitOfMeasurement: + "$ref": "#/components/schemas/LocatorRequest_UnitOfMeasurement" + LocationID: + description: Location ID is the identification number of the UPS affiliated + location. + type: array + items: + type: string + minLength: 1 + maxLength: 10 + LocationSearchCriteria: + "$ref": "#/components/schemas/LocatorRequest_LocationSearchCriteria" + 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 + Details\n03-Proximity Search Summary\n04-Address Search Summary\n05-Freight + Will Call Search. \nEither OptionType 03 or 04 is required." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ServiceGeoUnit: + "$ref": "#/components/schemas/LocatorRequest_ServiceGeoUnit" + FreightIndicator: + description: FreightIndicator. Required for Freight Location Search. + type: string + maximum: 1 + xml: + name: LocatorRequest + maximum: 1 + description: N/A + LocatorRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + RequestAction: + description: "Indicates the action to be taken by the XML service. \nThe + only valid value is 'Locator'." + maximum: 1 + type: string + minLength: 13 + maxLength: 13 + xml: + name: Request + maximum: 1 + required: + - RequestAction + description: N/A + Request_TransactionReference: + type: object + maximum: 1 + minLength: 1 + maxLength: 512 + properties: + CustomerContext: + description: The client uses CustomerContext to synchronize request/response + pairs. The client establishes CustomerContext, which can contain any information + client want, as long as it is valid XML; it is echoed back by the server + type: string + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + LocatorRequest_OriginAddress: + type: object + properties: + Geocode: + "$ref": "#/components/schemas/OriginAddress_Geocode" + 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 + values: 1-50, default 10" + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + xml: + name: OriginAddress + required: + - AddressKeyFormat + maximum: 1 + description: Container for origin address information. + OriginAddress_Geocode: + type: object + maximum: 1 + required: + - Latitude + - Longitude + properties: + Latitude: + description: The latitude of the origin address or the center point of the area code. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + Longitude: + description: The longitude of the origin address or the center point of the area code. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + xml: + name: Geocode + description: Geocode is the latitude and longitude of the origin address. + OriginAddress_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name. Not relevant for this tool + type: string + minLength: 1 + maxLength: 40 + maximum: 1 + AddressLine: + description: Address Line Information. The user may submit street level address information or provide Intersection information. + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + AddressLine2: + description: Additional Address Line Information. + maximum: 1 + type: string + minLength: 1 + maxLength: 64 + AddressLine3: + description: Additional Address Line Information. + maximum: 1 + type: string + minLength: 1 + maxLength: 64 + PoliticalDivision3: + description: Barrio or other sub-division of City + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + PoliticalDivision2: + description: City or Town. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PoliticalDivision1: + description: State or province + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostcodePrimaryLow: + description: Main postal code. Required if the user does not submit the City, State/Province address combination. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PostcodeExtendedLow: + description: 4 Digit postal code extension. Valid for US only. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + CountryCode: + description: Two-character country or territory abbreviation + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + SingleLineAddress: + description: | + Single line search information. Can contain values of origin address in a single line. Will override other origin address information. + + Conditionally Required for Non-Postal Code Countries. Applicable Country Ireland (IE) + + SingleLineAddress used for the lookup + + SingleLineAddress (Format - CSV) (\"Values:\" + postalCode + city + state + address + landmark + phoneNumber) + type: string + maximum: 1 + xml: + name: AddressKeyFormat + required: + - PoliticalDivision1 + - AddressLine + - PostcodePrimaryLow + - PoliticalDivision2 + - 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." + LocatorRequest_Translate: + type: object + maximum: 1 + properties: + Locale: + 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." + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + xml: + name: Translate + description: Contains the locale information for the request. + LocatorRequest_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + Valid values are: + + - MI-Miles + - KM-Kilometers + type: string + xml: + name: UnitOfMeasurement + description: Distance unit of measurement. This is required for location requests + (request option 1). + LocatorRequest_LocationSearchCriteria: + type: object + properties: + SearchOption: + type: array + items: + "$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 + of 5. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + 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 + for UnitOfMesaure KM" + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + ServiceSearch: + "$ref": "#/components/schemas/LocationSearchCriteria_ServiceSearch" + FreightWillCallSearch: + "$ref": "#/components/schemas/LocationSearchCriteria_FreightWillCallSearch" + AccessPointSearch: + "$ref": "#/components/schemas/LocationSearchCriteria_AccessPointSearch" + 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. + UAPs with postal code starts with BT returned when brexit filter starts + with BT, else UAPs returned with non BT postal code. Applicable for UAP + and Proximal building search. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + 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 + when the user requests a Location search (request option 1)." + LocationSearchCriteria_SearchOption: + type: object + required: + - OptionCode + - OptionType + properties: + OptionType: + "$ref": "#/components/schemas/SearchOption_OptionType" + OptionCode: + type: array + items: + "$ref": "#/components/schemas/SearchOption_OptionCode" + Relation: + "$ref": "#/components/schemas/SearchOption_Relation" + xml: + name: SearchOption + description: | + SearchOption contains the information that forms the basis of the location search, It contains the criteria for search by Locations, Retail Locations, Additional Services, or Program Types. + + There should be one container for each type of search the user may wish to do. The user can specify either search by Locations or Retail Locations, but not both. + + If this container is missing, the default search would be for The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping Outlet location types. + SearchOption_OptionType: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + Code for Option type valid values are: + + - 01-Location + - 02-Retail Location + - 03-Additional Services + - 04-Program Type + - 05-Service Level Option. + - 06-End Point Service Offering + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + 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 + 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." + SearchOption_OptionCode: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + These codes vary by country. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country or territory. + + Refer to Location Search Option Codes in the Appendix for additional information. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + 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 + OptionCodes which forms the criteria for the location search." + SearchOption_Relation: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + Applicable for Additional Services and Program Types. + + Valid values: + + - 01 - And (Default) + - 02 - Or + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + 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 + 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." + LocationSearchCriteria_ServiceSearch: + type: object + maximum: 1 + properties: + Time: + description: 'Scheduled Local Drop-off Time. Format: HHMM' + maximum: 1 + type: string + minLength: 4 + maxLength: 6 + ServiceCode: + type: array + items: + "$ref": "#/components/schemas/ServiceSearch_ServiceCode" + ServiceOptionCode: + type: array + items: + "$ref": "#/components/schemas/ServiceSearch_ServiceOptionCode" + xml: + name: ServiceSearch + description: Allows for users to further define the search criteria. Refer to + the rules specified in Service Search section. + ServiceSearch_ServiceCode: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + Code indicating the different services. Valid values are: + 01-Ground. + 02-Air. + 03-Express + 04-Standard + 05-International (Only avialable July 17) + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ServiceCode + description: |- + Container that contains the service information such as Ground/Air. + Required if the customer provides ServiceSearch Time. + ServiceSearch_ServiceOptionCode: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + Code that defines the optional service. + + Valid values: + - 01 - Saturday pickup. + + Only valid for air service. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ServiceOptionCode + description: Container for the optional service information such as Saturday + Pick up. + LocationSearchCriteria_FreightWillCallSearch: + type: object + maximum: 1 + required: + - FreightWillCallRequestType + - OriginOrDestination + - FormatPostalCode + - FacilityAddress + properties: + FreightWillCallRequestType: + 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. + This Search is valid for non-postal code Countries" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + FacilityAddress: + type: array + items: + "$ref": "#/components/schemas/FreightWillCallSearch_FacilityAddress" + OriginOrDestination: + description: |- + OriginOrDestination is required for FreightWillCallRequestType 1 and type 3 . Valid values: + 01-Origin facilities + 02-Destination facilities. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + FormatPostalCode: + description: |- + FormatPostalCode would be required in the request when FreightWillCallRequestType is 1. Valid values are: + NFR-No format requested + FR-format requested + FS-format and search + NVR-No validation requested. + maximum: 1 + type: string + 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." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: FreightWillCallSearch + description: Freight Will Call Search Container. Required if SearchOption is + '05-Freight Will Call Search' + FreightWillCallSearch_FacilityAddress: + type: object + maximum: 1 + properties: + SLIC: + description: Facility SLIC. Required for Freight Will call search if FreightWillCallRequestType + is 2. + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + AddressLine: + description: Address line + type: array + items: + type: string + maxItems: 2 + minLength: 1 + maxLength: 64 + City: + description: City. Required for Freight Will call search if FreightWillCallRequestType + is 3. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCodePrimaryLow: + description: Postal code. Required for Freight Will call search if FreightWillCallRequestType + is 1. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + PostalCodeExtendedLow: + description: 4 Digit postal code extension. Valid for US only. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + State: + description: State. Required if FrieghtWillCallRequestType is 3 if State + is available. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + CountryCode: + description: Country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: FacilityAddress + required: + - CountryCode + description: Facility Address Container + LocationSearchCriteria_AccessPointSearch: + type: object + maximum: 1 + properties: + PublicAccessPointID: + description: The Public Access Point ID to use for UPS Access Point Search. + Once this parameter is present , address or geocode search is ignored. + It cannot be combined with AccountNumber search parameter. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + AccessPointStatus: + description: "Status of UPS Access Point. Valid values are: \n01-Active-available\n07-Active-unavailable." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + AccountNumber: + description: The account number to use for UPS Access Point Search in the + country or territory. Used to locate a private network for the account. + Once this parameter is present any access point address or geocode search + is ignored. It cannot be combined with PublicAccessPointID search parameter. + maximum: 1 + type: string + minLength: 6 + maxLength: 10 + IncludeCriteria: + "$ref": "#/components/schemas/AccessPointSearch_IncludeCriteria" + 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. + type: string + maximum: 1 + ExistIndicator: + description: Presence of this tag represents that "AccessPointAvailability" + service is requested. The value of this tag is ignored. + type: string + maximum: 1 + xml: + name: AccessPointSearch + description: Applicable for request option 64 only. This contains inclusion + and exclusion criteria for address search. It also contains Account Number + and Access Point Public ID search elements. + AccessPointSearch_IncludeCriteria: + type: object + properties: + MerchantAccountNumberList: + "$ref": "#/components/schemas/IncludeCriteria_MerchantAccountNumberList" + SearchFilter: + "$ref": "#/components/schemas/IncludeCriteria_SearchFilter" + ServiceOfferingList: + "$ref": "#/components/schemas/IncludeCriteria_ServiceOfferingList" + xml: + name: IncludeCriteria + description: This contains elements to refine (include) UPS Access point address + or geocode Search. + maximum: 1 + IncludeCriteria_MerchantAccountNumberList: + type: object + required: + - MerchantAccountNumber + properties: + MerchantAccountNumber: + description: Account number to be used for a private network access point + search where a UPS access point candidate list is obtained in search by + address or geocode search. + type: array + items: + type: string + minLength: 6 + maxLength: 10 + xml: + name: MerchantAccountNumberList + description: This contains the list of Merchant Account numbers to be used for + finding private network access points. + maximum: 1 + IncludeCriteria_SearchFilter: + type: object + maximum: 1 + properties: + DCRIndicator: + description: DCR/DCO Availability indicator for UPS Access Point. Either + this indicator is present or not present. Presence indicates a search + for access points with DCR. Any data in the element is ignored. + type: string + maximum: 1 + ShippingAvailabilityIndicator: + description: Shipping Availability indicator for UPS Access Point. Either + this indicator is present or not present. Presence indicates a search + of access points with shipping availability. Any data in it is ignored. + type: string + maximum: 1 + ShipperPreparationDelay: + description: Value for the number of days to check for shipping availability from the current day. When this value is present, ShippingAvailabilityIndicator is implied implicitly. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ClickAndCollectSortWithDistance: + description: This contains the distance (in given UnitOfMeasurement) wherin to sort the click and collect access point locations above other access point locations when a UPS Access Point candidate list is obtained in search by address or geocode search. + maximum: 1 + type: string + maxLength: 3 + xml: + name: SearchFilter + description: Container to hold one or more search criteria for UPS Access Points + that allow DCR, Shipping and ClickAndCollect access. Only applicable when + the UPS access point candidate list is obtained in search by address or geocode + search. + IncludeCriteria_ServiceOfferingList: + type: object + required: + - ServiceOffering + properties: + ServiceOffering: + type: array + items: + "$ref": "#/components/schemas/ServiceOfferingList_ServiceOffering" + xml: + name: ServiceOfferingList + description: Container to hold end point service offering List for UPS Access + point. Applicable only when a UPS Access Point candidate list is obtained + in search by address or geocode search. + maximum: 1 + ServiceOfferingList_ServiceOffering: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + 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 + At Store\n013-Accepts Restricted Articles" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the service offering. Text will be displayed + in the locale requested. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ServiceOffering + AccessPointSearch_ExcludeFromResult: + type: object + maximum: 1 + properties: + BusinessClassificationCode: + description: This contains the business classification code to exclude from + UPS Access Point Search by address or geocode. Multiple codes can are + possible in separate elements. Please refer to Appendix D for detailed + business codes. + type: array + items: + type: string + minLength: 3 + maxLength: 3 + maximum: 1 + BusinessName: + description: This contains the business name to exclude from UPS Access + Point Search by address or geocode. Partial names are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + Radius: + description: Public Access points within Radius (in specified Unit of Measure) + of any included private access points will be excluded from the results. + Valid only if at least one IncludeCriteria/MerchantAccountNumber is provided. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + PostalCodeList: + "$ref": "#/components/schemas/ExcludeFromResult_PostalCodeList" + xml: + name: ExcludeFromResult + description: This contains elements to exclude from UPS Access Point address + or geocode search. + ExcludeFromResult_PostalCodeList: + type: object + required: + - PostalCode + properties: + PostalCode: + type: array + items: + "$ref": "#/components/schemas/PostalCodeList_PostalCode" + xml: + name: PostalCodeList + description: Container to hold a list of postal codes to exclude from the access + point address or geocode search. + maximum: 1 + PostalCodeList_PostalCode: + type: object + maximum: 1 + required: + - PrimaryPostalCode + properties: + PrimaryPostalCode: + description: Primary postal code. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + SecondaryPostalCode: + description: Secondary postal code. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: PostalCode + description: Container to hold the postal code . + LocationSearchCriteria_OpenTimeCriteria: + type: object + maximum: 1 + properties: + DayOfWeekCode: + description: |- + Day Of week Code. + Valid values: + 1-Sunday + 2-Monday + 3-Tuesday + 4-Wednesday + 5-Thursday + 6-Friday + 7-Saturday + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + FromTime: + description: From time. Time Format HHMM. + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + ToTime: + description: To Time. Time Format HHMM + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + xml: + name: OpenTimeCriteria + description: Container to hold open times of the Location. + LocatorRequest_SortCriteria: + type: object + maximum: 1 + properties: + SortType: + description: |- + For different sort type. Valid values: + 01-Closest Location + 02-Deadline for Drop-off by Air/Express + 03-Deadline for Drop-off by Ground/Standard + 04-Latest Close Time + 05-Earliest Open Time. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + xml: + name: SortCriteria + description: Container for Sort Criteria + LocatorRequest_ServiceGeoUnit: + type: object + maximum: 1 + required: + - ServiceCode + - GeoPoliticalUnit + properties: + ServiceCode: + description: "Service Code. Required if ServiceGeoUnit Container present. + \nValid value is '096' ." + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + GeoPoliticalUnit: + description: |- + GeoPoliticalUnit. Required if ServiceGeoUnit container present. + Valid value is '002' . + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: ServiceGeoUnit + description: ServiceGeoUnit Container. Required to search for the freight facility + information + LocatorResponse: + type: object + required: + - Response + - AllowAllConfidenceLevels + - SearchResults + properties: + Response: + "$ref": "#/components/schemas/LocatorResponse_Response" + Geocode: + "$ref": "#/components/schemas/LocatorResponse_Geocode" + SearchResults: + "$ref": "#/components/schemas/LocatorResponse_SearchResults" + AllowAllConfidenceLevels: + description: |- + Confidence level. + Valid values: True or False + maximum: 1 + type: string + minLength: 4 + maxLength: 5 + xml: + name: LocatorResponse + maximum: 1 + description: Container for LocatorResponse. + LocatorResponse_Response: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + ResponseStatusCode: + description: "Identifies the success or failure of the interchange. \n1-Success\n0-Failure" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ResponseStatusDescription: + description: Describes the Response Status Code. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + Error: + "$ref": "#/components/schemas/Response_Error" + xml: + name: Response + maximum: 1 + required: + - ResponseStatusCode + description: Container for Response. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: Customer provided data. If this data is present in the request, it is echoed back to the customer. + maximum: 1 + type: string + maxLength: 512 + XpciVersion: + description: "Identifies the version of the message. \nCurrent version is + 1.0014" + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: TransactionReference + description: Container for customer provided data and the XPCI Version. + Response_Error: + type: object + maximum: 1 + required: + - ErrorSeverity + - ErrorCode + properties: + ErrorSeverity: + description: "Describes the severity of the error. \nFor additional information, + refer to Locator Error Codes in the Appendix." + maximum: 1 + type: string + minLength: 1 + 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 + Error Codes in the Appendix." + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ErrorDescription: + description: Describes the error code. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + MinimumRetrySeconds: + 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 + type: string + minLength: 1 + maxLength: 5 + ErrorLocation: + description: | + Identifies the element in error. + + **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" + ErrorDigest: + description: | + The contents of the element in error. + + **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: + type: string + xml: + name: Error + description: If an error is encountered during the interchange, the Response + contains an error. If the error is present, then the ErrorSeverity and ErrorCode + are required. + Error_ErrorLocation: + type: object + maximum: 1 + properties: + ErrorLocationElementName: + description: The Xpath name of the element in error. This is a valid Xpath + pointing to an element in the request document. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + ErrorLocationAttributeName: + description: The name of the attribute in error. This is the name of the + attribute contained by the Error Location element. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: ErrorLocation + LocatorResponse_Geocode: + type: object + maximum: 1 + required: + - Latitude + - Longitude + properties: + Latitude: + description: The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. + type: string + Longitude: + description: The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. + type: string + xml: + name: Geocode + description: Geocode is the latitude and longitude of the origin address. The + Geocode is provided in the first successful response. Required to be returned + when the origin address or phone number is submitted in the request.Will not + be returned when the requestoption =64 + LocatorResponse_SearchResults: + type: object + properties: + GeocodeCandidate: + description: | + If the origin address provided in the location request document does not have a match, a list of candidate addresses, geocodes and optionally a landmark will be returned. + + **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" + 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 + 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 + origin." + DropLocation: + description: | + When a location request is submitted with a valid origin address, UPS locations will be returned. + + **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" + AvailableLocationAttributes: + description: | + This container contains the information about the currently existing Retail Locations or Additional Services or Program types. + + **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" + ActiveAvailableAccessPointIndicator: + description: "Indicates whether the country or territory has AccessPoints + or not. \n\nThis tag is populated in the Response only if tag \"ExistIndicator\" + was present in the Locator request." + type: string + maximum: 1 + xml: + name: SearchResults + maximum: 1 + description: Container for search results. + SearchResults_GeocodeCandidate: + type: object + required: + - Geocode + - AddressKeyFormat + properties: + AddressKeyFormat: + "$ref": "#/components/schemas/GeocodeCandidate_AddressKeyFormat" + 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 + and Geocode. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: GeocodeCandidate + maximum: 1 + GeocodeCandidate_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name. Not relevant for candidate list. + type: string + AddressLine: + description: Address Line Information. The address level or Intersection information must be returned if provided in the request. The AddressLine will be a combination of up to 3 separate address lines, each separated by a new line character. + type: string + PoliticalDivision3: + description: Subdivision within a City. e.g., a Barrio. + type: string + PoliticalDivision2: + description: City. + type: string + PoliticalDivision1: + description: State/Province. + type: string + PostcodePrimaryLow: + description: Postal Code. + type: string + PostcodeExtendedLow: + description: 4 Digit postal code extension. Valid for US only. + type: string + CountryCode: + description: "A country or territory code. Valid values for candidates to be returned are: US-United States (meaning US 50)" + type: string + xml: + name: AddressKeyFormat + required: + - PoliticalDivision1 + - AddressLine + - PostcodePrimaryLow + - PoliticalDivision2 + - CountryCode + description: Contains all of the basic information about candidate address. + GeocodeCandidate_Geocode: + type: object + maximum: 1 + required: + - Latitude + - Longitude + properties: + Latitude: + description: The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. + type: string + Longitude: + description: The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. + type: string + xml: + name: Geocode + description: Geocode is the latitude and longitude of the origin candidate. + SearchResults_DropLocation: + type: object + maximum: 1 + required: + - Geocode + - Timezone + - IVR + - AddressKeyFormat + - LocationID + - OriginOrDestination + - PhoneNumber + - LocationAttribute + - Distance + properties: + LocationID: + description: The location ID that corresponds to the UPS location. Do not + expose the Location ID. + type: string + minLength: 1 + maxLength: 10 + OriginOrDestination: + description: "OriginOrDestination will returned for FreightWillCallRequestType + 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" + Geocode: + "$ref": "#/components/schemas/DropLocation_Geocode" + AddressKeyFormat: + "$ref": "#/components/schemas/DropLocation_AddressKeyFormat" + PhoneNumber: + description: | + The UPS locations Phone number. A phone number of the location will be returned. + + 10 digits allowed for US, otherwise 1..15 digits allowed. + + The phone number will be returned as a string. + + **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: + type: string + minLength: 1 + 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 + 1..15 digits allowed.\nThe fax number will be returned as string." + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + EMailAddress: + description: Email address of the UPS location. Returned when available. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + LocationAttribute: + description: | + OptionType is a container that indicates the type of the location attribute. + + There are 4 types of attributes. + + They are: Location, Retail Location, Additional Services and Program Type. + + **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" + Distance: + "$ref": "#/components/schemas/DropLocation_Distance" + SpecialInstructions: + description: | + Walking directions. + + **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" + 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. + + When a user specifies a Drop-off Time and Ground as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned. + + **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: + minLength: 4 + maxLength: 6 + type: string + LatestAirDropOffTime: + description: | + The latest airtime 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. + + When a user specifies a Drop-off Time and Air as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned. + + **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: + minLength: 4 + maxLength: 6 + type: string + AdditionalChargeIndicator: + description: Presence or Absence Indicator. If present, Indicates if the + UPS location would have an additional charge. ASO locations will require + an additional charge. + type: string + maximum: 1 + StandardHoursOfOperation: + description: The standard hours of operation of the drop location will be + returned when available. The location's time may differ because of holidays. + type: string + maximum: 1 + NonStandardHoursOfOperation: + description: The non-standard hours of operation of the drop location. The + location's time may differ because of holidays, weekends, or other factors + that are beyond the locations control. Seven days preceding a given holiday + the Non Standard Hours Of Operation will be returned along with the standard + hours of operation if available. + type: string + maximum: 1 + WillCallHoursOfOperation: + description: The will call hours of operation of the drop location will + be returned when available. The location's time may differ because of + holidays. + type: string + maximum: 1 + Number: + description: The center number of the drop location if it is The UPS store. + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + HomePageURL: + description: The home page URL of the drop location if it is The UPS store. + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + Comments: + description: "Comments returned about the location. Text will be displayed in English or the locale given in the request. If Country Code is FR, and locale passed in the request is \"fr_FR\" then text will be displayed in French language, else comment will be displayed in English language." + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + AdditionalComments: + "$ref": "#/components/schemas/DropLocation_AdditionalComments" + Disclaimer: + description: | + Textual disclaimer about the drop location. + + **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: + type: string + SLIC: + description: SLIC. + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + Timezone: + description: TimeZone. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + FacilityType: + description: PKG/FRT. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + OperatingHours: + "$ref": "#/components/schemas/DropLocation_OperatingHours" + LocalizedInstruction: + description: | + LocalizedInstruction container. Applicable for SearchOptionCode 01, 02, 03. + + **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" + PromotionInformation: + description: | + Container to hold any promotion text for the location. Text will be displayed in English or the locale given in the request. + + **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" + SortCode: + "$ref": "#/components/schemas/DropLocation_SortCode" + 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 + number. This indicator is used by the clients to determine whether to + display the telephone number to the end user." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + AccessPointInformation: + "$ref": "#/components/schemas/DropLocation_AccessPointInformation" + LocationImage: + "$ref": "#/components/schemas/DropLocation_LocationImage" + LocationNewIndicator: + description: Indicator for new location. + type: string + maximum: 1 + PromotionalLinkURL: + description: Promotional link URL for specific location. + type: string + maximum: 1 + FeaturedRank: + description: "Feature Ranking values:\nNull or blank - Location is not featured. + \n1 - Featured Location ranked number 1.\n2 - Featured Location ranked + number 2." + maximum: 1 + type: string + maxLength: 1 + WillCallLocationIndicator: + description: | + Will Call Location Indicator values: + - Y – Signifies a Will Call location that serves the customers address. + - N - Signifies it is not a Will Call location. + + Will Call locations are only returned with a \"Y\" indicator if the request included EnhancedSearchOption code 10. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: DropLocation + DropLocation_IVR: + type: object + maximum: 1 + required: + - PhraseID + properties: + PhraseID: + description: |- + Contains the name of the IVR file that relates to this drop location. The file is an audio recording of information related to the location. + ONLY FOR IVR. + maximum: 1 + type: string + minLength: 1 + 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." + type: string + maximum: 1 + xml: + name: IVR + description: "Integrated Voice Response information. \nONLY FOR IVR." + DropLocation_Geocode: + type: object + maximum: 1 + required: + - Latitude + - Longitude + properties: + Latitude: + description: The latitude of the location address or the center point of + the area code. + type: string + Longitude: + description: The longitude of the location address or the center point of + the area code. + type: string + xml: + name: Geocode + description: Geocode is the latitude and longitude of the location address. + The Geocode for the location address will be returned when Location is requested + in the Request Option. + DropLocation_AddressKeyFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Name. (Also includes the building name)Return if available. + type: string + AddressLine: + description: Address Line Information of the UPS location The address level + or Intersection information. Only two address lines will be returned. + The second line may contain such information as the building name, the + suite, and room. + type: string + PoliticalDivision3: + description: Subdivision within a City. e.g., a Barrio. + type: string + PoliticalDivision2: + description: City. + type: string + PoliticalDivision1: + description: State/Province. + type: string + PostcodePrimaryLow: + description: Postal Code. + type: string + PostcodeExtendedLow: + description: 4 Digit postal code extension. Valid for US only. + type: string + CountryCode: + description: 'A country or territory code. Valid values to be returned are: + US-United States (meaning US 50).' + type: string + xml: + name: AddressKeyFormat + required: + - PoliticalDivision1 + - AddressLine + - PostcodePrimaryLow + - PoliticalDivision2 + - CountryCode + description: Contains all of the basic information about a location, Consignee + Name, Building Name, Address Lines, City, State/Province, Postal Code and + Country or Terriotry Code. + DropLocation_LocationAttribute: + type: object + required: + - OptionCode + - OptionType + properties: + 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. + + 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. + + **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 + about the location's Location Type, Retail Location Type, Additional Services, + or Program Type. + maximum: 1 + LocationAttribute_OptionType: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Code for Option type. Valid values: + - 01 - Location + - 02 - Retail Location + - 03 - Additional Services + - 04 - Program Type + type: string + Description: + description: Description for Option type such as Location, RetailLocation, AdditionalServices and ProgramType. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: OptionType + LocationAttribute_OptionCode: + type: object + properties: + Category: + description: | + Only applicabe for OptionType = 03 (Additional Services). Valid values: + - 06 - Non transportation + - 07 - Transportation + type: string + Code: + description: These codes vary by country or territory. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country. Refer to Location Search Option Codes in the Appendix for additional information. + type: string + Description: + description: | + Description is only applicable for Location and Retail Location. The description for Program types and additional service is not provided with Location detail. + + It is only provided when the request is for 8, 24, 40, 56-All available additional services or 16, 24, 48, 56-all available Program types. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Name: + description: Name will indicate the name of any Additional Services/ Program Types depending on the option code. Text will be displayed in the locale selected. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + TransportationPickUpSchedule: + "$ref": "#/components/schemas/OptionCode_TransportationPickUpSchedule" + xml: + name: OptionCode + maximum: 1 + required: + - Description + - Code + OptionCode_TransportationPickUpSchedule: + type: object + required: + - PickUp + properties: + PickUp: + description: | + PickUp container contains details of day of week and corresponding pickup times for that service. + + **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" + 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. + maximum: 1 + TransportationPickUpSchedule_PickUp: + type: object + required: + - DayOfWeek + - PickUpDetails + properties: + DayOfWeek: + description: | + Day of week. + - 1 - Sunday + - 2 - Monday + - 3 - Tuesday + - 4 - Wednesday + - 5 - Thursday + - 6 - Friday + - 7 - Saturday. + type: string + minLength: 1 + maxLength: 1 + PickUpDetails: + "$ref": "#/components/schemas/PickUp_PickUpDetails" + xml: + name: PickUp + PickUp_PickUpDetails: + type: object + properties: + PickUpTime: + description: Pickup time of transportation service for a location in military format (HHMM) e.g. 0930, 1700, 1845 etc. with exception for midnight. For midnight the time will be returned as 0. + type: string + minLength: 4 + maxLength: 4 + NoPickUpIndicator: + description: Presence or Absence Indicator. If present, Indicates that there is no pickup time for the day. + type: string + xml: + name: PickUpDetails + required: + - NoPickUpIndicator + description: PickUpDetails container contains either pickup time or NoPickupIndicator. Either PickUpTime or NoPickupIndicator + maximum: 1 + DropLocation_Distance: + type: object + maximum: 1 + required: + - UnitOfMeasurement + - Value + properties: + Value: + description: The straight line distance from the origin to the UPS location. + Distance value may include one decimal and followed by one decimal place. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + UnitOfMeasurement: + "$ref": "#/components/schemas/Distance_UnitOfMeasurement" + xml: + name: Distance + description: Container for the straight line distance from the origin to the + UPS location. + Distance_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + 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 + KM-Kilometers" + type: string + Description: + description: May return the description of the unit of measure specified + in the request. + maximum: 1 + type: string + minLength: 5 + maxLength: 10 + xml: + name: UnitOfMeasurement + description: The unit of measurement the user will see for the distance is based + on the user input provided in the search request. + DropLocation_SpecialInstructions: + type: object + maximum: 1 + required: + - Segment + properties: + Segment: + 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: + type: string + xml: + name: SpecialInstructions + DropLocation_AdditionalComments: + type: object + required: + - CommentType + properties: + CommentType: + description: | + Container for CommentType Code and Text. + + **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" + xml: + name: AdditionalComments + description: Container for Additional Comments about Location.Text will be displayed + in the Locale requested. + maximum: 1 + AdditionalComments_CommentType: + type: object + maximum: 1 + required: + - Text + - Code + properties: + Code: + description: Comment code is 01 for AccessPoint LCO pickup time comment. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Text: + description: Access point LCO pickup time comment + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + xml: + name: CommentType + DropLocation_OperatingHours: + type: object + properties: + StandardHours: + description: | + StandardHours Container. + + **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" + xml: + name: OperatingHours + description: Operating Hours. + maximum: 1 + OperatingHours_StandardHours: + type: object + maximum: 1 + required: + - DayOfWeek + - HoursType + properties: + HoursType: + 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" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + DayOfWeek: + description: | + Container for the Day of Week. + + **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" + xml: + name: StandardHours + StandardHours_DayOfWeek: + type: object + maximum: 1 + required: + - Day + properties: + Day: + 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 + maxLength: 1 + OpenHours: + description: Open time of a location in military format (HHMM) e.g. 930, + 1700, 1845 etc. with exception for midnight. For midnight the time will + be returned as 0. + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + CloseHours: + description: Close time of a location in military format (HHMM) e.g. 930, + 1700, 1845 etc. with exception for midnight. For midnight the time will + be returned as 0. + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + LatestDropOffHours: + description: LatestDropOffHours for Hour Type 50. Latest Drop Off time of + a location in military format (HHMM) e.g. 930, 1700, 1845 etc. with exception + for midnight. For midnight the time will be returned as 0. + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + PrepHours: + description: PrepHours for Hour Type 51. Prep Hours of a location in military + format (HHMM) e.g. 930, 1700, 1845 etc. with exception for midnight. For + midnight the time will be returned as 0. + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + ClosedIndicator: + description: Presence absence Indicator. Indicator present means location + is closed. + maximum: 1 + type: string + Open24HoursIndicator: + description: Presence/ Absence Indicator. Presence denotes for the given + day, if the location is open 24 hours. Absence denotes the location is + not open for 24 hours on the given day. + maximum: 1 + type: string + minLength: 4 + maxLength: 5 + xml: + name: DayOfWeek + DropLocation_LocalizedInstruction: + type: object + maximum: 1 + required: + - Locale + - Last50ftInstruction + properties: + Locale: + description: Locale + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + Last50ftInstruction: + description: Holds the additional instructions. Text will be displayed in + English or the locale given in the request. The max length of the additional + instruction text is 750 characters. + maximum: 1 + type: string + minLength: 1 + maxLength: 750 + xml: + name: LocalizedInstruction + DropLocation_PromotionInformation: + type: object + maximum: 1 + required: + - Locale + - Promotion + properties: + Locale: + description: Locale (language/ dialect) for the promotion code. + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + Promotion: + description: Promotion text for the given location. + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + xml: + name: PromotionInformation + DropLocation_SortCode: + type: object + maximum: 1 + properties: + HubSortCode: + description: Holds the value of the hub sort code or airport code + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + FreightSortFacilityCode: + description: Holds the value of the facility location code. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: SortCode + description: This container is only for Freight Will call Search. + DropLocation_ServiceOfferingList: + type: object + required: + - ServiceOffering + properties: + ServiceOffering: + description: | + Container for Service offering code. + + **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" + xml: + name: ServiceOfferingList + description: Container to hold the list of service offerings at the end point. + maximum: 1 + DropLocation_AccessPointInformation: + type: object + maximum: 1 + properties: + PublicAccessPointID: + description: The Public Access Point ID associated with UPS access point. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ImageURL: + description: Image URL associated with UPS access point. + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + BusinessClassificationList: + "$ref": "#/components/schemas/AccessPointInformation_BusinessClassificationList" + AccessPointStatus: + "$ref": "#/components/schemas/AccessPointInformation_AccessPointStatus" + FacilitySLIC: + description: Holds the value of facility SLIC of Access Point Location. + Not implemented currently. For future use. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PrivateNetworkList: + "$ref": "#/components/schemas/AccessPointInformation_PrivateNetworkList" + Availability: + "$ref": "#/components/schemas/AccessPointInformation_Availability" + xml: + name: AccessPointInformation + description: Container for UPS Access Point specific parameters. + AccessPointInformation_BusinessClassificationList: + type: object + required: + - BusinessClassification + properties: + BusinessClassification: + description: | + Container to hold Business classification of UPS access point. + + **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" + xml: + name: BusinessClassificationList + description: Container to hold list for business classification. + maximum: 1 + BusinessClassificationList_BusinessClassification: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Business Classification code of UPS Access Point. Please refer + to appendix D for a list of business classification. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + Description: + description: Description of business classification. + maximum: 1 + type: string + maxLength: 35 + xml: + name: BusinessClassification + AccessPointInformation_AccessPointStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: "Valid status values are: \n01-Active-available\n06-Suspended\n07-Active-unavailable\n08-Terminated" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Description of status code. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: AccessPointStatus + description: Container for UPS AccessPoint status. + AccessPointInformation_PrivateNetworkList: + type: object + required: + - PrivateNetwork + properties: + PrivateNetwork: + description: | + Container to hold the private network details. + + **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" + xml: + name: PrivateNetworkList + description: Container to hold the list of private networks. + maximum: 1 + PrivateNetworkList_PrivateNetwork: + type: object + maximum: 1 + required: + - NetworkID + - NetworkDescription + properties: + NetworkID: + description: Value of networkID. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + NetworkDescription: + description: Description of the Network. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: PrivateNetwork + AccessPointInformation_Availability: + type: object + properties: + ShippingAvailability: + "$ref": "#/components/schemas/Availability_ShippingAvailability" + DCRAvailability: + "$ref": "#/components/schemas/Availability_DCRAvailability" + xml: + name: Availability + description: Container to hold the status of shipping or DRC/DCO availability + of a UPS Access Point. + maximum: 1 + Availability_ShippingAvailability: + type: object + maximum: 1 + properties: + AvailableIndicator: + description: Presence or absence indicator. Presence means the location + is available for shipping. + type: string + maximum: 1 + UnavailableReason: + "$ref": "#/components/schemas/ShippingAvailability_UnavailableReason" + xml: + name: ShippingAvailability + description: Holds status of shipping availability. + ShippingAvailability_UnavailableReason: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Code for shipping unavailability. Code for DCR/DCO unavailability. + + Valid values: + - 01 - Temporarily Unavailable + - 02 - Location Full + - 03 - Unavailable + - 04 - Weather + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Description for shipping unavailability. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnavailableReason + description: Container to hold shipping unavailable reason. + Availability_DCRAvailability: + type: object + maximum: 1 + properties: + AvailableIndicator: + description: Presence or absence indicator. Presence means the location + is available for DCR/DCO. + type: string + maximum: 1 + UnavailableReason: + "$ref": "#/components/schemas/DCRAvailability_UnavailableReason" + xml: + name: DCRAvailability + description: Holds status of DCR/DCO availability. + DCRAvailability_UnavailableReason: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + 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. + type: string + xml: + name: UnavailableReason + description: Container to hold shipping unavailable reason. + DropLocation_LocationImage: + type: object + maximum: 1 + properties: + SecureURL: + description: Secure URL for Location Image. + type: string + maximum: 1 + NonSecureURL: + description: Non Secure URL for Location Image. + type: string + maximum: 1 + xml: + name: LocationImage + description: Location Image container. + SearchResults_AvailableLocationAttributes: + type: object + required: + - OptionCode + - OptionType + properties: + OptionType: + "$ref": "#/components/schemas/AvailableLocationAttributes_OptionType" + OptionCode: + "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCode" + xml: + name: AvailableLocationAttributes + AvailableLocationAttributes_OptionType: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Code for Option type. + type: string + Description: + description: Description for Option type such as RetailLocation, AdditionalServices + and ProgramType. + type: string + xml: + name: OptionType + description: OptionType is a container that indicates the type of the location + attribute that are available. For example if the Option Type is RetailLocation + 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. + type: array + items: + "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCodeElement" + AvailableLocationAttributes_OptionCodeElement: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: The valid list of codes and description for Retail Locations + or Additional Services or Pro-gram Types that are currently available + in the database. This can be obtained by a separate type of request (Request + Option 8, 16, 24, 32, 40, 48 and 56). + type: string + Description: + description: Description is only applicable for Program types and Additional + Services. It is not provided with Location detail. It is only provided + when the request is for All available additional ser-vices or all available + Program types. Text will be displayed in the locale requested. + type: string + Name: + description: Name will indicate the name of Location/Retail Location or + Additional Services or Program Types depending on the option code. Text + will be displayed in the locale requested. + type: string + Category: + description: N/A + type: string + TransportationPickUpSchedule: + "$ref": "#/components/schemas/AvailableLocationAttributesOptionCode_TransportationPickUpSchedule" + xml: + name: OptionCode + description: Option code is a container that contains the information of a particular + retail location type or additional service or program type that is available + currently. One or more of this container will be returned to give all the + available codes for Retail Type or Additional Services or Program Type. + AvailableLocationAttributesOptionCode_TransportationPickUpSchedule: + type: object + required: + - PickUp + properties: + PickUp: + description: | + Container to hold information regarding pickup day of the week and details. + + **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" + xml: + name: TransportationPickUpSchedule + description: Container to hold information regarding pickup details for each day of the week. + maximum: 1 + AvailableLocationAttributes_TransportationPickUpSchedule_PickUp: + type: object + required: + - DayOfWeek + - PickUpDetails + properties: + DayOfWeek: + description: | + Day of the week for scheduled pickup. Valid values are: + - 1 - Sunday + - 2 - Monday + - 3 - Tuesday + - 4 - Wednesday + - 5 - Thursday + - 6 - Friday + - 7 - Saturday. + type: string + minLength: 1 + maxLength: 1 + PickUpDetails: + "$ref": "#/components/schemas/AvailableLocationAttributes_PickUp_PickUpDetails" + xml: + name: PickUp + AvailableLocationAttributes_PickUp_PickUpDetails: + type: object + properties: + PickUpTime: + description: Time of pickup in military format (HHMM) e.g. 0930, 1700, 1845 etc. with exception for midnight. For midnight the time will be returned as 0. + type: string + minLength: 4 + maxLength: 4 + NoPickUpIndicator: + description: | + Indicates whether or not there is a pickup time for the specified day of the week. Valid values: + - True-there is a pickup time + - False-there is not a pickup time. + type: string + xml: + name: PickUpDetails + required: + - NoPickUpIndicator + description: Container to hold information regarding pickup time and pickup availability indicator. + maximum: 1 + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/OAuthAuthCode-Ready.yaml b/OAuthAuthCode-Ready.yaml index 5ef0bbf..0c7e965 100644 --- a/OAuthAuthCode-Ready.yaml +++ b/OAuthAuthCode-Ready.yaml @@ -1,422 +1,422 @@ -openapi: 3.0.3 -info: - title: OAuth Authorization Code API - 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 - 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. - - Overview of steps in OAuth Authorization Code flow: - - 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint. - 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. - 3. The application then sends the authorization code and the redirection URI to the authorization server's /oauth/token endpoint. - 4. The authorization server's /token endpoint verifies the authorization code and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. - 5. The Client application uses the access token to request information from an UPS API. - - Overview of steps in OAuth Authorization Code PKCE flow: - 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint with Code Challenge - - **Note:** Prior to redirecting to the authorization server, the application generates and **code_challenge** and **code_verifier** that are related in this way: code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) - 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. - 4. The application then sends the authorization code , code_verifer and the redirection URI to the authorization server's /oauth/token endpoint. - - **Note:** When utlizing the PKCE flow, the BASIC Authorization header should **not** be included, just the **client_id** parameter in the body. - 5. The authorization server's /token endpoint verifies the authorization code, code_verifier and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. - 6. The Client application uses the access token to request information from an UPS API. - - - Setting-up OAuth Authorization Code flow - - Accelerate API Integration with UPS SDKs
- - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - version: '1.0' -paths: - "/v1/oauth/authorize": - get: - servers: - - url: https://wwwcie.ups.com/security - description: Customer Integration Environment - - url: https://onlinetools.ups.com/security - description: Production - 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. - operationId: AuthorizeClient - parameters: - - in: query - name: client_id - schema: - type: string - description: The public identifier for your application, obtained when you, - the developer first registered the application. - required: true - - in: query - name: redirect_uri - schema: - type: string - description: URL that tells the authorization server where to send the user - back to after they approve the request. - required: true - - in: query - name: response_type - schema: - type: string - description: 'Valid Values: code' - required: true - - in: query - name: state - schema: - type: string - description: A random string generated by the application and included in - the request to prevent CSRF attacks. The application checks that the same - value is returned after the user authorizes the app. - required: false - - in: query - name: scope - schema: - type: string - description: One or more space-separated strings indicating which permissions - the application is requesting. - required: false - - in: query - name: code_challenge - schema: - type: string - 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: - '302': - description: successful operation - headers: - location: - description: |- - The UPS login redirection URI in the following format: https://www.ups.com/lasso/signin?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api - - The value of 'state' will be the same value that the application initially set in the request. - The 'code' is the authorization code generated by the authorization server. - schema: - type: string - appname: - description: Name of the application requesting the authorization code. - schema: - type: string - displayname: - description: Display name of the application requesting the Authorization - code. - schema: - type: string - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - "/v1/oauth/token": - post: - servers: - - url: https://wwwcie.ups.com/security - description: Customer Integration Environment - - url: https://onlinetools.ups.com/security - description: Production - tags: - - OAuth Auth Code - security: - - BasicAuthGenerate: [] - description: The Generate Token endpoint exchanges the authorization code received - from the client application for an access token and a refresh token. The client - uses the access token to make API requests on behalf of the user by including - it in the authorization header. The access token will expire after a certain - period and can be refreshed by using the /refresh endpoint. - operationId: GenerateToken - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - grant_type: - type: string - description: 'Valid values: authorization_code' - default: authorization_code - code: - type: string - description: Authorization code from the UPS login system. - redirect_uri: - type: string - 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. - 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. - required: - - grant_type - - code - - redirect_uri - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/generateTokenSuccessResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - "/v1/oauth/refresh": - post: - servers: - - url: https://wwwcie.ups.com/security - description: Customer Integration Environment - - url: https://onlinetools.ups.com/security - description: Production - security: - - BasicAuthRefresh: [] - summary: Refresh Token - tags: - - OAuth Auth Code - operationId: RefreshToken - description: The /refresh endpoint is used to refresh an expired access token - in order to continue accessing a UPS API on behalf of a user. The endpoint - generates a new access/refresh token pair by exchanging a valid refresh token. - A successful response returns new access and refresh tokens for ongoing API - access without re-prompting the user. - parameters: [] - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - grant_type: - type: string - description: 'Valid values: refresh_token' - default: refresh_token - refresh_token: - type: string - description: Refresh token from GenerateToken operation - required: - - grant_type - - refresh_token - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/refreshTokenSuccessResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$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\" - 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 - - - **Flow 2: Auth-Code with PKCE [no http Authorization header required]** - 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 - BasicAuthRefresh: - type: http - scheme: basic - 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 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 - schemas: - generateTokenSuccessResponse: - type: object - properties: - refresh_token_expires_in: - description: Expiration time for requested refresh token in seconds. - type: string - refresh_token_status: - description: Status for requested refresh token. - type: string - token_type: - description: Type of requested access token - type: string - issued_at: - description: Issue time of requested token in milliseconds. - type: string - client_id: - description: Client id for requested token. - type: string - access_token: - description: Token to be used in API requests. - type: string - refresh_token: - description: Refresh token to be used in refresh requests when obtaining - new access token. - type: string - scope: - description: Scope for requested token. - type: string - refresh_token_issued_at: - description: Time that refresh token was issued in milliseconds. - type: string - expires_in: - description: Expire time for requested token in seconds. - type: string - refresh_count: - description: Number of refreshes for requested token. - type: string - status: - description: Status for requested token. - type: string - refreshTokenSuccessResponse: - type: object - properties: - refresh_token_expires_in: - description: Expiration time for requested refresh token in seconds. - type: string - refresh_token_status: - description: Status for requested refresh token. - type: string - token_type: - description: Type for requested token. - type: string - issued_at: - description: Issue time for requested token in milliseconds. - type: string - client_id: - description: Client id for requested token. - type: string - access_token: - description: Token to be used in API requests. - type: string - refresh_token: - description: Token to be used in refresh requests. - type: string - scope: - description: Scope for requested token. - type: string - refresh_token_issued_at: - description: Issue time for requested refresh token in milliseconds. - type: string - expires_in: - description: Expiration time for requested access token in seconds. - type: string - refresh_count: - description: Number of refreshes for requested token. - type: string - status: - description: Status for requested token. - type: string - tokenErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/errorResponseWrapper" - errorResponseWrapper: - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/errors" - errors: - type: object - properties: - code: - description: Error code - type: string - message: - description: Error message - type: string \ No newline at end of file +openapi: 3.0.3 +info: + title: OAuth Authorization Code API + 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 + 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. + + Overview of steps in OAuth Authorization Code flow: + + 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint. + 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. + 3. The application then sends the authorization code and the redirection URI to the authorization server's /oauth/token endpoint. + 4. The authorization server's /token endpoint verifies the authorization code and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. + 5. The Client application uses the access token to request information from an UPS API. + + Overview of steps in OAuth Authorization Code PKCE flow: + 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint with Code Challenge + - **Note:** Prior to redirecting to the authorization server, the application generates and **code_challenge** and **code_verifier** that are related in this way: code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) + 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. + 4. The application then sends the authorization code , code_verifer and the redirection URI to the authorization server's /oauth/token endpoint. + - **Note:** When utlizing the PKCE flow, the BASIC Authorization header should **not** be included, just the **client_id** parameter in the body. + 5. The authorization server's /token endpoint verifies the authorization code, code_verifier and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. + 6. The Client application uses the access token to request information from an UPS API. + + - Setting-up OAuth Authorization Code flow + - Accelerate API Integration with UPS SDKs
+ + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + +
+

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + version: '1.0' +paths: + "/v1/oauth/authorize": + get: + servers: + - url: https://wwwcie.ups.com/security + description: Customer Integration Environment + - url: https://onlinetools.ups.com/security + description: Production + 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. + operationId: AuthorizeClient + parameters: + - in: query + name: client_id + schema: + type: string + description: The public identifier for your application, obtained when you, + the developer first registered the application. + required: true + - in: query + name: redirect_uri + schema: + type: string + description: URL that tells the authorization server where to send the user + back to after they approve the request. + required: true + - in: query + name: response_type + schema: + type: string + description: 'Valid Values: code' + required: true + - in: query + name: state + schema: + type: string + description: A random string generated by the application and included in + the request to prevent CSRF attacks. The application checks that the same + value is returned after the user authorizes the app. + required: false + - in: query + name: scope + schema: + type: string + description: One or more space-separated strings indicating which permissions + the application is requesting. + required: false + - in: query + name: code_challenge + schema: + type: string + 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: + '302': + description: successful operation + headers: + location: + description: |- + The UPS login redirection URI in the following format: https://www.ups.com/lasso/signin?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api + + The value of 'state' will be the same value that the application initially set in the request. + The 'code' is the authorization code generated by the authorization server. + schema: + type: string + appname: + description: Name of the application requesting the authorization code. + schema: + type: string + displayname: + description: Display name of the application requesting the Authorization + code. + schema: + type: string + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + "/v1/oauth/token": + post: + servers: + - url: https://wwwcie.ups.com/security + description: Customer Integration Environment + - url: https://onlinetools.ups.com/security + description: Production + tags: + - OAuth Auth Code + security: + - BasicAuthGenerate: [] + description: The Generate Token endpoint exchanges the authorization code received + from the client application for an access token and a refresh token. The client + uses the access token to make API requests on behalf of the user by including + it in the authorization header. The access token will expire after a certain + period and can be refreshed by using the /refresh endpoint. + operationId: GenerateToken + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + grant_type: + type: string + description: 'Valid values: authorization_code' + default: authorization_code + code: + type: string + description: Authorization code from the UPS login system. + redirect_uri: + type: string + 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. + 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. + required: + - grant_type + - code + - redirect_uri + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/generateTokenSuccessResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + "/v1/oauth/refresh": + post: + servers: + - url: https://wwwcie.ups.com/security + description: Customer Integration Environment + - url: https://onlinetools.ups.com/security + description: Production + security: + - BasicAuthRefresh: [] + summary: Refresh Token + tags: + - OAuth Auth Code + operationId: RefreshToken + description: The /refresh endpoint is used to refresh an expired access token + in order to continue accessing a UPS API on behalf of a user. The endpoint + generates a new access/refresh token pair by exchanging a valid refresh token. + A successful response returns new access and refresh tokens for ongoing API + access without re-prompting the user. + parameters: [] + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + grant_type: + type: string + description: 'Valid values: refresh_token' + default: refresh_token + refresh_token: + type: string + description: Refresh token from GenerateToken operation + required: + - grant_type + - refresh_token + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/refreshTokenSuccessResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$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\" + 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 + + - **Flow 2: Auth-Code with PKCE [no http Authorization header required]** + 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 + BasicAuthRefresh: + type: http + scheme: basic + 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 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 + schemas: + generateTokenSuccessResponse: + type: object + properties: + refresh_token_expires_in: + description: Expiration time for requested refresh token in seconds. + type: string + refresh_token_status: + description: Status for requested refresh token. + type: string + token_type: + description: Type of requested access token + type: string + issued_at: + description: Issue time of requested token in milliseconds. + type: string + client_id: + description: Client id for requested token. + type: string + access_token: + description: Token to be used in API requests. + type: string + refresh_token: + description: Refresh token to be used in refresh requests when obtaining + new access token. + type: string + scope: + description: Scope for requested token. + type: string + refresh_token_issued_at: + description: Time that refresh token was issued in milliseconds. + type: string + expires_in: + description: Expire time for requested token in seconds. + type: string + refresh_count: + description: Number of refreshes for requested token. + type: string + status: + description: Status for requested token. + type: string + refreshTokenSuccessResponse: + type: object + properties: + refresh_token_expires_in: + description: Expiration time for requested refresh token in seconds. + type: string + refresh_token_status: + description: Status for requested refresh token. + type: string + token_type: + description: Type for requested token. + type: string + issued_at: + description: Issue time for requested token in milliseconds. + type: string + client_id: + description: Client id for requested token. + type: string + access_token: + description: Token to be used in API requests. + type: string + refresh_token: + description: Token to be used in refresh requests. + type: string + scope: + description: Scope for requested token. + type: string + refresh_token_issued_at: + description: Issue time for requested refresh token in milliseconds. + type: string + expires_in: + description: Expiration time for requested access token in seconds. + type: string + refresh_count: + description: Number of refreshes for requested token. + type: string + status: + description: Status for requested token. + type: string + tokenErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/errorResponseWrapper" + errorResponseWrapper: + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/errors" + errors: + type: object + properties: + code: + description: Error code + type: string + message: + description: Error message + type: string diff --git a/OAuthAuthCode.yaml b/OAuthAuthCode.yaml index f1f8f12..469bba8 100644 --- a/OAuthAuthCode.yaml +++ b/OAuthAuthCode.yaml @@ -1,415 +1,415 @@ -openapi: 3.0.3 -info: - title: OAuth Authorization Code API - 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 - 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. - - Overview of steps in OAuth Authorization Code flow: - - 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint. - 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. - 3. The application then sends the authorization code and the redirection URI to the authorization server's /oauth/token endpoint. - 4. The authorization server's /token endpoint verifies the authorization code and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. - 5. The Client application uses the access token to request information from an UPS API. - - Overview of steps in OAuth Authorization Code PKCE flow: - 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint with Code Challenge - - **Note:** Prior to redirecting to the authorization server, the application generates and **code_challenge** and **code_verifier** that are related in this way: code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) - 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. - 4. The application then sends the authorization code , code_verifer and the redirection URI to the authorization server's /oauth/token endpoint. - - **Note:** When utlizing the PKCE flow, the BASIC Authorization header should **not** be included, just the **client_id** parameter in the body. - 5. The authorization server's /token endpoint verifies the authorization code, code_verifier and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. - 6. The Client application uses the access token to request information from an UPS API. - - - Setting-up OAuth Authorization Code flow - - Accelerate API Integration with UPS SDKs
- -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - Run In Postman - - Open in GitHub - - version: '1.0' -paths: - "/v1/oauth/authorize": - get: - servers: - - url: https://wwwcie.ups.com/security - description: Customer Integration Environment - - url: https://onlinetools.ups.com/security - description: Production - 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. - operationId: AuthorizeClient - parameters: - - in: query - name: client_id - schema: - type: string - description: The public identifier for your application, obtained when you, - the developer first registered the application. - required: true - - in: query - name: redirect_uri - schema: - type: string - description: URL that tells the authorization server where to send the user - back to after they approve the request. - required: true - - in: query - name: response_type - schema: - type: string - description: 'Valid Values: code' - required: true - - in: query - name: state - schema: - type: string - description: A random string generated by the application and included in - the request to prevent CSRF attacks. The application checks that the same - value is returned after the user authorizes the app. - required: false - - in: query - name: scope - schema: - type: string - description: One or more space-separated strings indicating which permissions - the application is requesting. - required: false - - in: query - name: code_challenge - schema: - type: string - 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: - '302': - description: successful operation - headers: - location: - description: |- - The UPS login redirection URI in the following format: https://www.ups.com/lasso/signin?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api - - The value of 'state' will be the same value that the application initially set in the request. - The 'code' is the authorization code generated by the authorization server. - schema: - type: string - appname: - description: Name of the application requesting the authorization code. - schema: - type: string - displayname: - description: Display name of the application requesting the Authorization - code. - schema: - type: string - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - "/v1/oauth/token": - post: - servers: - - url: https://wwwcie.ups.com/security - description: Customer Integration Environment - - url: https://onlinetools.ups.com/security - description: Production - tags: - - OAuth Auth Code - security: - - BasicAuthGenerate: [] - description: The Generate Token endpoint exchanges the authorization code received - from the client application for an access token and a refresh token. The client - uses the access token to make API requests on behalf of the user by including - it in the authorization header. The access token will expire after a certain - period and can be refreshed by using the /refresh endpoint. - operationId: GenerateToken - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - grant_type: - type: string - description: 'Valid values: authorization_code' - default: authorization_code - code: - type: string - description: Authorization code from the UPS login system. - redirect_uri: - type: string - 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. - 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. - required: - - grant_type - - code - - redirect_uri - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/generateTokenSuccessResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - "/v1/oauth/refresh": - post: - servers: - - url: https://wwwcie.ups.com/security - description: Customer Integration Environment - - url: https://onlinetools.ups.com/security - description: Production - security: - - BasicAuthRefresh: [] - summary: Refresh Token - tags: - - OAuth Auth Code - operationId: RefreshToken - description: The /refresh endpoint is used to refresh an expired access token - in order to continue accessing a UPS API on behalf of a user. The endpoint - generates a new access/refresh token pair by exchanging a valid refresh token. - A successful response returns new access and refresh tokens for ongoing API - access without re-prompting the user. - parameters: [] - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - grant_type: - type: string - description: 'Valid values: refresh_token' - default: refresh_token - refresh_token: - type: string - description: Refresh token from GenerateToken operation - required: - - grant_type - - refresh_token - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/refreshTokenSuccessResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$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\" - 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 - - - **Flow 2: Auth-Code with PKCE [no http Authorization header required]** - 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 - BasicAuthRefresh: - type: http - scheme: basic - 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 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 - schemas: - generateTokenSuccessResponse: - type: object - properties: - refresh_token_expires_in: - description: Expiration time for requested refresh token in seconds. - type: string - refresh_token_status: - description: Status for requested refresh token. - type: string - token_type: - description: Type of requested access token - type: string - issued_at: - description: Issue time of requested token in milliseconds. - type: string - client_id: - description: Client id for requested token. - type: string - access_token: - description: Token to be used in API requests. - type: string - refresh_token: - description: Refresh token to be used in refresh requests when obtaining - new access token. - type: string - scope: - description: Scope for requested token. - type: string - refresh_token_issued_at: - description: Time that refresh token was issued in milliseconds. - type: string - expires_in: - description: Expire time for requested token in seconds. - type: string - refresh_count: - description: Number of refreshes for requested token. - type: string - status: - description: Status for requested token. - type: string - refreshTokenSuccessResponse: - type: object - properties: - refresh_token_expires_in: - description: Expiration time for requested refresh token in seconds. - type: string - refresh_token_status: - description: Status for requested refresh token. - type: string - token_type: - description: Type for requested token. - type: string - issued_at: - description: Issue time for requested token in milliseconds. - type: string - client_id: - description: Client id for requested token. - type: string - access_token: - description: Token to be used in API requests. - type: string - refresh_token: - description: Token to be used in refresh requests. - type: string - scope: - description: Scope for requested token. - type: string - refresh_token_issued_at: - description: Issue time for requested refresh token in milliseconds. - type: string - expires_in: - description: Expiration time for requested access token in seconds. - type: string - refresh_count: - description: Number of refreshes for requested token. - type: string - status: - description: Status for requested token. - type: string - tokenErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/errorResponseWrapper" - errorResponseWrapper: - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/errors" - errors: - type: object - properties: - code: - description: Error code - type: string - message: - description: Error message - type: string \ No newline at end of file +openapi: 3.0.3 +info: + title: OAuth Authorization Code API + 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 + 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. + + Overview of steps in OAuth Authorization Code flow: + + 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint. + 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. + 3. The application then sends the authorization code and the redirection URI to the authorization server's /oauth/token endpoint. + 4. The authorization server's /token endpoint verifies the authorization code and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. + 5. The Client application uses the access token to request information from an UPS API. + + Overview of steps in OAuth Authorization Code PKCE flow: + 1. When user selects Login, the client application redirects to the authorization server's /authorize endpoint with Code Challenge + - **Note:** Prior to redirecting to the authorization server, the application generates and **code_challenge** and **code_verifier** that are related in this way: code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))) + 2. The Authorization Server authenticates the user by asking for their login credentials, and after successful login, the authorization server responds back to the application with an authorization code contained within a redirection URI. + 4. The application then sends the authorization code , code_verifer and the redirection URI to the authorization server's /oauth/token endpoint. + - **Note:** When utlizing the PKCE flow, the BASIC Authorization header should **not** be included, just the **client_id** parameter in the body. + 5. The authorization server's /token endpoint verifies the authorization code, code_verifier and the application's client ID contained in the redirect URI, and responds with a with an access token, as well as a refresh token. + 6. The Client application uses the access token to request information from an UPS API. + + - Setting-up OAuth Authorization Code flow + - Accelerate API Integration with UPS SDKs
+ +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + Run In Postman + + Open in GitHub + + version: '1.0' +paths: + "/v1/oauth/authorize": + get: + servers: + - url: https://wwwcie.ups.com/security + description: Customer Integration Environment + - url: https://onlinetools.ups.com/security + description: Production + 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. + operationId: AuthorizeClient + parameters: + - in: query + name: client_id + schema: + type: string + description: The public identifier for your application, obtained when you, + the developer first registered the application. + required: true + - in: query + name: redirect_uri + schema: + type: string + description: URL that tells the authorization server where to send the user + back to after they approve the request. + required: true + - in: query + name: response_type + schema: + type: string + description: 'Valid Values: code' + required: true + - in: query + name: state + schema: + type: string + description: A random string generated by the application and included in + the request to prevent CSRF attacks. The application checks that the same + value is returned after the user authorizes the app. + required: false + - in: query + name: scope + schema: + type: string + description: One or more space-separated strings indicating which permissions + the application is requesting. + required: false + - in: query + name: code_challenge + schema: + type: string + 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: + '302': + description: successful operation + headers: + location: + description: |- + The UPS login redirection URI in the following format: https://www.ups.com/lasso/signin?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api + + The value of 'state' will be the same value that the application initially set in the request. + The 'code' is the authorization code generated by the authorization server. + schema: + type: string + appname: + description: Name of the application requesting the authorization code. + schema: + type: string + displayname: + description: Display name of the application requesting the Authorization + code. + schema: + type: string + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + "/v1/oauth/token": + post: + servers: + - url: https://wwwcie.ups.com/security + description: Customer Integration Environment + - url: https://onlinetools.ups.com/security + description: Production + tags: + - OAuth Auth Code + security: + - BasicAuthGenerate: [] + description: The Generate Token endpoint exchanges the authorization code received + from the client application for an access token and a refresh token. The client + uses the access token to make API requests on behalf of the user by including + it in the authorization header. The access token will expire after a certain + period and can be refreshed by using the /refresh endpoint. + operationId: GenerateToken + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + grant_type: + type: string + description: 'Valid values: authorization_code' + default: authorization_code + code: + type: string + description: Authorization code from the UPS login system. + redirect_uri: + type: string + 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. + 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. + required: + - grant_type + - code + - redirect_uri + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/generateTokenSuccessResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + "/v1/oauth/refresh": + post: + servers: + - url: https://wwwcie.ups.com/security + description: Customer Integration Environment + - url: https://onlinetools.ups.com/security + description: Production + security: + - BasicAuthRefresh: [] + summary: Refresh Token + tags: + - OAuth Auth Code + operationId: RefreshToken + description: The /refresh endpoint is used to refresh an expired access token + in order to continue accessing a UPS API on behalf of a user. The endpoint + generates a new access/refresh token pair by exchanging a valid refresh token. + A successful response returns new access and refresh tokens for ongoing API + access without re-prompting the user. + parameters: [] + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + grant_type: + type: string + description: 'Valid values: refresh_token' + default: refresh_token + refresh_token: + type: string + description: Refresh token from GenerateToken operation + required: + - grant_type + - refresh_token + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/refreshTokenSuccessResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$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\" + 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 + + - **Flow 2: Auth-Code with PKCE [no http Authorization header required]** + 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 + BasicAuthRefresh: + type: http + scheme: basic + 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 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 + schemas: + generateTokenSuccessResponse: + type: object + properties: + refresh_token_expires_in: + description: Expiration time for requested refresh token in seconds. + type: string + refresh_token_status: + description: Status for requested refresh token. + type: string + token_type: + description: Type of requested access token + type: string + issued_at: + description: Issue time of requested token in milliseconds. + type: string + client_id: + description: Client id for requested token. + type: string + access_token: + description: Token to be used in API requests. + type: string + refresh_token: + description: Refresh token to be used in refresh requests when obtaining + new access token. + type: string + scope: + description: Scope for requested token. + type: string + refresh_token_issued_at: + description: Time that refresh token was issued in milliseconds. + type: string + expires_in: + description: Expire time for requested token in seconds. + type: string + refresh_count: + description: Number of refreshes for requested token. + type: string + status: + description: Status for requested token. + type: string + refreshTokenSuccessResponse: + type: object + properties: + refresh_token_expires_in: + description: Expiration time for requested refresh token in seconds. + type: string + refresh_token_status: + description: Status for requested refresh token. + type: string + token_type: + description: Type for requested token. + type: string + issued_at: + description: Issue time for requested token in milliseconds. + type: string + client_id: + description: Client id for requested token. + type: string + access_token: + description: Token to be used in API requests. + type: string + refresh_token: + description: Token to be used in refresh requests. + type: string + scope: + description: Scope for requested token. + type: string + refresh_token_issued_at: + description: Issue time for requested refresh token in milliseconds. + type: string + expires_in: + description: Expiration time for requested access token in seconds. + type: string + refresh_count: + description: Number of refreshes for requested token. + type: string + status: + description: Status for requested token. + type: string + tokenErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/errorResponseWrapper" + errorResponseWrapper: + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/errors" + errors: + type: object + properties: + code: + description: Error code + type: string + message: + description: Error message + type: string diff --git a/OAuthClientCredentials-Ready.yaml b/OAuthClientCredentials-Ready.yaml index bd708f2..b007ed7 100644 --- a/OAuthClientCredentials-Ready.yaml +++ b/OAuthClientCredentials-Ready.yaml @@ -1,148 +1,148 @@ -openapi: 3.0.3 -info: - title: OAuth Client Credentials API - version: '' - description: | - The UPS OAuth Client Credentials API helps retrieve an OAuth Bearer token when the integration owner is also the UPS shipper. The integration owner uses their UPS login credentials, and the UPS account number, to receive a token that can be used in the authorization HTTP header of subsequent API calls to UPS APIs like the Ship API, Track API, etc. - - Client Credentials - - Accelerate API Integration with UPS SDKs - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -paths: - "/security/v1/oauth/token": - post: - servers: - - url: https://wwwcie.ups.com/ - description: Customer Integration Environment for Client Credentials - - url: https://onlinetools.ups.com/ - description: Production for Client Credentials - summary: Create Token - tags: - - OAuth Client Credentials - security: - - BasicAuth: [] - operationId: CreateToken - parameters: - - in: header - name: x-merchant-id - schema: - type: string - description: 6-digit UPS account number. - required: false - requestBody: - required: true - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - grant_type: - type: string - description: 'Valid values: client_credentials' - default: client_credentials - required: - - grant_type - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenSuccessResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Quota Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" -components: - securitySchemes: - BasicAuth: - type: http - scheme: basic - 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 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 - schemas: - tokenSuccessResponse: - type: object - properties: - token_type: - description: Container for token response. - type: string - issued_at: - description: Issue time of requested token. - type: string - client_id: - description: Client id for requested token. - type: string - access_token: - description: Token to be used in API requests. - type: string - scope: - description: Scope for requested token. - type: string - expires_in: - description: Expire time for requested token in seconds. - type: string - refresh_count: - description: Number of refreshes for requested token. - type: string - status: - description: Status for requested token. - type: string - tokenErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/errorResponseWrapper" - errorResponseWrapper: - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/errors" - errors: - type: object - properties: - code: - description: Error code - type: string - message: - description: Error message - type: string +openapi: 3.0.3 +info: + title: OAuth Client Credentials API + version: '' + description: | + The UPS OAuth Client Credentials API helps retrieve an OAuth Bearer token when the integration owner is also the UPS shipper. The integration owner uses their UPS login credentials, and the UPS account number, to receive a token that can be used in the authorization HTTP header of subsequent API calls to UPS APIs like the Ship API, Track API, etc. + - Client Credentials + - Accelerate API Integration with UPS SDKs + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + +
+

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +paths: + "/security/v1/oauth/token": + post: + servers: + - url: https://wwwcie.ups.com/ + description: Customer Integration Environment for Client Credentials + - url: https://onlinetools.ups.com/ + description: Production for Client Credentials + summary: Create Token + tags: + - OAuth Client Credentials + security: + - BasicAuth: [] + operationId: CreateToken + parameters: + - in: header + name: x-merchant-id + schema: + type: string + description: 6-digit UPS account number. + required: false + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + grant_type: + type: string + description: 'Valid values: client_credentials' + default: client_credentials + required: + - grant_type + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenSuccessResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Quota Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" +components: + securitySchemes: + BasicAuth: + type: http + scheme: basic + 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 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 + schemas: + tokenSuccessResponse: + type: object + properties: + token_type: + description: Container for token response. + type: string + issued_at: + description: Issue time of requested token. + type: string + client_id: + description: Client id for requested token. + type: string + access_token: + description: Token to be used in API requests. + type: string + scope: + description: Scope for requested token. + type: string + expires_in: + description: Expire time for requested token in seconds. + type: string + refresh_count: + description: Number of refreshes for requested token. + type: string + status: + description: Status for requested token. + type: string + tokenErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/errorResponseWrapper" + errorResponseWrapper: + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/errors" + errors: + type: object + properties: + code: + description: Error code + type: string + message: + description: Error message + type: string diff --git a/OAuthClientCredentials.yaml b/OAuthClientCredentials.yaml index a132076..2bdfbc1 100644 --- a/OAuthClientCredentials.yaml +++ b/OAuthClientCredentials.yaml @@ -1,142 +1,142 @@ -openapi: 3.0.3 -info: - title: OAuth Client Credentials API - version: '' - description: | - The UPS OAuth Client Credentials API helps retrieve an OAuth Bearer token when the integration owner is also the UPS shipper. The integration owner uses their UPS login credentials, and the UPS account number, to receive a token that can be used in the authorization HTTP header of subsequent API calls to UPS APIs like the Ship API, Track API, etc. - - Client Credentials - - Accelerate API Integration with UPS SDKs - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -paths: - "/security/v1/oauth/token": - post: - servers: - - url: https://wwwcie.ups.com/ - description: Customer Integration Environment for Client Credentials - - url: https://onlinetools.ups.com/ - description: Production for Client Credentials - summary: Create Token - tags: - - OAuth Client Credentials - security: - - BasicAuth: [] - operationId: CreateToken - parameters: - - in: header - name: x-merchant-id - schema: - type: string - description: 6-digit UPS account number. - required: false - requestBody: - required: true - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - grant_type: - type: string - description: 'Valid values: client_credentials' - default: client_credentials - required: - - grant_type - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenSuccessResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" - '429': - description: Quota Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/tokenErrorResponse" -components: - securitySchemes: - BasicAuth: - type: http - scheme: basic - 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 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 - schemas: - tokenSuccessResponse: - type: object - properties: - token_type: - description: Container for token response. - type: string - issued_at: - description: Issue time of requested token. - type: string - client_id: - description: Client id for requested token. - type: string - access_token: - description: Token to be used in API requests. - type: string - scope: - description: Scope for requested token. - type: string - expires_in: - description: Expire time for requested token in seconds. - type: string - refresh_count: - description: Number of refreshes for requested token. - type: string - status: - description: Status for requested token. - type: string - tokenErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/errorResponseWrapper" - errorResponseWrapper: - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/errors" - errors: - type: object - properties: - code: - description: Error code - type: string - message: - description: Error message - type: string +openapi: 3.0.3 +info: + title: OAuth Client Credentials API + version: '' + description: | + The UPS OAuth Client Credentials API helps retrieve an OAuth Bearer token when the integration owner is also the UPS shipper. The integration owner uses their UPS login credentials, and the UPS account number, to receive a token that can be used in the authorization HTTP header of subsequent API calls to UPS APIs like the Ship API, Track API, etc. + - Client Credentials + - Accelerate API Integration with UPS SDKs + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +paths: + "/security/v1/oauth/token": + post: + servers: + - url: https://wwwcie.ups.com/ + description: Customer Integration Environment for Client Credentials + - url: https://onlinetools.ups.com/ + description: Production for Client Credentials + summary: Create Token + tags: + - OAuth Client Credentials + security: + - BasicAuth: [] + operationId: CreateToken + parameters: + - in: header + name: x-merchant-id + schema: + type: string + description: 6-digit UPS account number. + required: false + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + grant_type: + type: string + description: 'Valid values: client_credentials' + default: client_credentials + required: + - grant_type + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenSuccessResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" + '429': + description: Quota Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/tokenErrorResponse" +components: + securitySchemes: + BasicAuth: + type: http + scheme: basic + 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 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 + schemas: + tokenSuccessResponse: + type: object + properties: + token_type: + description: Container for token response. + type: string + issued_at: + description: Issue time of requested token. + type: string + client_id: + description: Client id for requested token. + type: string + access_token: + description: Token to be used in API requests. + type: string + scope: + description: Scope for requested token. + type: string + expires_in: + description: Expire time for requested token in seconds. + type: string + refresh_count: + description: Number of refreshes for requested token. + type: string + status: + description: Status for requested token. + type: string + tokenErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/errorResponseWrapper" + errorResponseWrapper: + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/errors" + errors: + type: object + properties: + code: + description: Error code + type: string + message: + description: Error message + type: string diff --git a/Paperless-Ready.yaml b/Paperless-Ready.yaml index 15c3786..abce793 100644 --- a/Paperless-Ready.yaml +++ b/Paperless-Ready.yaml @@ -1,1164 +1,1164 @@ -openapi: 3.0.3 -info: - title: Paperless Document - version: '' - description: | - - The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments.
The /upload endpoint of the API requires document details, including file name, file format, and document type (such as authorization form, commercial invoice, certificate of origin, export license, etc).
The /image endpoint helps users upload document images as support documents for shipping
The /delete endpoint of the API helps delete a specific document the user has uploaded. - # Reference - - Business Rules - - Errors - - FAQ - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/paperlessdocuments/{version}/upload": - post: - summary: Upload Paperless Document - tags: - - Paperless - security: - - 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. ' - operationId: Upload - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API - - Valid values: - - v2 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" - examples: - '1': - summary: Upload Request with document type 013 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: '' - UserCreatedForm: - UserCreatedFormFileName: TestFile.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '013' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - '2': - summary: Upload Request with document type 010 - value: - UploadRequest: - Request: - RequestOption: - TransactionReference: - CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 - ShipperNumber: '' - UserCreatedForm: - UserCreatedFormDocumentType: '010' - UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== - UserCreatedFormFileFormat: pdf - UserCreatedFormFileName: TP-0452492_PackingList.pdf - '3': - summary: Upload Request with document type 002 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: 06266e54656e4284805be4d45786ee96 - UserCreatedForm: - - UserCreatedFormFileName: iShipTestFile04.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '002' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - ShipperNumber: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{version}/image": - post: - summary: Paperless Document Push Image - tags: - - Paperless - security: - - OAuth2: [] - description: 'The Paperless Document API web service allows the users to upload - their own customized trade documents for customs clearance to Forms History. ' - operationId: PushToImageRepository - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API - - Valid values: - - v2 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PushToImageRepositoryRequest: - Request: - TransactionReference: - CustomerContext: Your Customer Context - FormsHistoryDocumentID: - DocumentID: 2016-01-18-11.01.07.589501 - ShipmentIdentifier: Your Package Shipment Identifier - ShipmentDateAndTime: 2016-01-18-11.01.07 - ShipmentType: '1' - TrackingNumber: Your Package Tracking Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - delete: - summary: Delete Paperless Document - tags: - - Paperless - security: - - OAuth2: [] - description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - operationId: Delete - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API - - Valid values: - - v2 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Your Shipper Number - required: true - - in: header - name: DocumentId - schema: - type: string - description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{deprecatedVersion}/upload": - post: - deprecated: true - summary: Upload Paperless Document - tags: - - Paperless - security: - - 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. ' - operationId: Deprecated Upload - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" - examples: - '1': - summary: Upload Request with document type 013 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: '' - UserCreatedForm: - UserCreatedFormFileName: TestFile.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '013' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - '2': - summary: Upload Request with document type 010 - value: - UploadRequest: - Request: - RequestOption: - TransactionReference: - CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 - ShipperNumber: '' - UserCreatedForm: - UserCreatedFormDocumentType: '010' - UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== - UserCreatedFormFileFormat: pdf - UserCreatedFormFileName: TP-0452492_PackingList.pdf - '3': - summary: Upload Request with document type 002 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: 06266e54656e4284805be4d45786ee96 - UserCreatedForm: - - UserCreatedFormFileName: iShipTestFile04.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '002' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - ShipperNumber: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{deprecatedVersion}/image": - post: - deprecated: true - summary: Paperless Document Push Image - tags: - - Paperless - security: - - OAuth2: [] - description: 'The Paperless Document API web service allows the users to upload - their own customized trade documents for customs clearance to Forms History. ' - operationId: Deprecated PushToImageRepository - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PushToImageRepositoryRequest: - Request: - TransactionReference: - CustomerContext: Your Customer Context - FormsHistoryDocumentID: - DocumentID: 2016-01-18-11.01.07.589501 - ShipmentIdentifier: Your Package Shipment Identifier - ShipmentDateAndTime: 2016-01-18-11.01.07 - ShipmentType: '1' - TrackingNumber: Your Package Tracking Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - delete: - deprecated: true - summary: Delete Paperless Document - tags: - - Paperless - security: - - OAuth2: [] - description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - operationId: Deprecated Delete - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Your Shipper Number - required: true - - in: header - name: DocumentId - schema: - type: string - description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - PAPERLESSDOCUMENTDeleteRequestWrapper: - xml: - name: DeleteRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - DeleteRequest - properties: - DeleteRequest: - "$ref": "#/components/schemas/DeleteRequest" - PAPERLESSDOCUMENTDeleteResponseWrapper: - xml: - name: DeleteResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - DeleteResponse - properties: - DeleteResponse: - "$ref": "#/components/schemas/DeleteResponse" - DeleteRequest: - type: object - required: - - Request - - DocumentID - - ShipperNumber - properties: - Request: - "$ref": "#/components/schemas/DeleteRequest_Request" - ShipperNumber: - 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 - one DocumentID will be accepted for delete request. - maximum: 1 - type: string - minLength: 26 - maxLength: 26 - xml: - name: DeleteRequest - maximum: 1 - description: Paperless Document API Request container for deleting user created - forms. - DeleteRequest_Request: - type: object - properties: - RequestOption: - description: Enables the user to specify optional processing. Currently, - there is no optional process in Paperless Document API. - type: string - minLength: 1 - maxLength: 1 - SubVersion: - description: Not Used. - maximum: 1 - type: string - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Paperless Document API deleted request criteria components. - DeleteResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/DeleteResponse_Response" - xml: - name: DeleteResponse - description: Paperless Document API response container for delete request. - maximum: 1 - DeleteResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response container. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Identifies the success or failure of the transaction. Valid - values are 0 = Failed and 1 = Successful. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of "Success" - or "Failure". - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response status container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - PAPERLESSDOCUMENTRequestWrapper: - xml: - name: PushToImageRepositoryRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PushToImageRepositoryRequest - properties: - PushToImageRepositoryRequest: - "$ref": "#/components/schemas/PushToImageRepositoryRequest" - PAPERLESSDOCUMENTResponseWrapper: - xml: - name: PushToImageRepositoryResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PushToImageRepositoryResponse - properties: - PushToImageRepositoryResponse: - "$ref": "#/components/schemas/PushToImageRepositoryResponse" - PushToImageRepositoryRequest: - type: object - required: - - ShipmentIdentifier - - ShipmentType - - Request - - ShipperNumber - - FormsHistoryDocumentID - properties: - Request: - "$ref": "#/components/schemas/PushToImageRepositoryRequest_Request" - ShipperNumber: - 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" - FormsGroupID: - description: FormsGroupID would be required in Push Request if user needs - to update uploaded DocumentID(s) in Forms History. - maximum: 1 - type: string - minLength: 26 - maxLength: 26 - ShipmentIdentifier: - description: Shipment Identifier is required for this request. - maximum: 1 - type: string - minLength: 1 - maxLength: 19 - ShipmentDateAndTime: - description: The date and time of the processed shipment. Required only - for small package shipments. The valid format is yyyy-MM-dd-HH.mm.ss - maximum: 1 - type: string - ShipmentType: - description: 'Valid values are: 1 = small package, 2 = freight. ' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PRQConfirmationNumber: - description: PRQ Confirmation being specified by client. Required for freight - shipments. - maximum: 1 - type: string - minLength: 9 - maxLength: 30 - TrackingNumber: - description: UPS Tracking Number associated with this shipment. Required - only for small package shipment. - type: array - minLength: 7 - maxLength: 20 - items: - type: string - xml: - name: PushToImageRepositoryRequest - maximum: 1 - description: Paperless Document API request container for push to Image Repository. - PushToImageRepositoryRequest_Request: - type: object - properties: - RequestOption: - description: Enables the user to specify optional processing. Currently, - there is no optional process in Paperless Document API. - type: string - minLength: 1 - maxLength: 1 - SubVersion: - description: Not Used. - maximum: 1 - type: string - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Paperless Document API PushToImageRepository request criteria - components. - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want; it is echoed back by the server. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and server. - PushToImageRepositoryRequest_FormsHistoryDocumentID: - type: object - maximum: 13 - required: - - DocumentID - properties: - DocumentID: - description: DocumentID represents a document uploaded to Forms History. - type: array - maximum: 13 - minLength: 26 - maxLength: 26 - items: - type: string - xml: - name: FormsHistoryDocumentID - description: The container for DocumentID(s). - PushToImageRepositoryResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/PushToImageRepositoryResponse_Response" - FormsGroupID: - description: FormsGroupID is a consolidated ID representing one or multiple - DocumentID(s). - maximum: 1 - type: string - minLength: 26 - maxLength: 26 - xml: - name: PushToImageRepositoryResponse - maximum: 1 - description: Paperless Document API response container for Push To Image Repository - request. - PushToImageRepositoryResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response container. - maximum: 1 - PAPERLESSDOCUMENTUploadRequestWrapper: - xml: - name: UploadRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - UploadRequest - properties: - UploadRequest: - "$ref": "#/components/schemas/UploadRequest" - PAPERLESSDOCUMENTUploadResponseWrapper: - xml: - name: UploadResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - UploadResponse - properties: - UploadResponse: - "$ref": "#/components/schemas/UploadResponse" - UploadRequest: - type: object - required: - - Request - - UserCreatedForm - - ShipperNumber - properties: - Request: - "$ref": "#/components/schemas/UploadRequest_Request" - ShipperNumber: - 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 - UserCreatedForm: - type: array - maximum: 13 - items: - "$ref": "#/components/schemas/UploadRequest_UserCreatedForm" - xml: - name: UploadRequest - maximum: 1 - description: Paperless Document API Request container for uploading User Created Forms. - UploadRequest_Request: - type: object - properties: - RequestOption: - description: Enables the user to specify optional processing. Currently, there is no optional process in Paperless Document API. - type: string - minLength: 1 - maxLength: 1 - SubVersion: - description: Not Used. - maximum: 1 - type: string - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Paperless Document API upload request criteria components. - UploadRequest_UserCreatedForm: - type: object - maximum: 1 - required: - - UserCreatedFormFile - - UserCreatedFormFileName - - UserCreatedFormFileFormat - - UserCreatedFormDocumentType - properties: - UserCreatedFormFileName: - description: The name of the file. - maximum: 1 - type: string - minLength: 1 - 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. - - 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 - 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. - maximum: 1 - type: string - minLength: 3 - maxLength: 4 - UserCreatedFormDocumentType: - 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 - Document, 009 - Power of Attorney, 010 - Packing List, 011 - SED Document, - 012 - Shipper's Letter of Instruction, 013 - Declaration. The total number - of documents allowed per file or per shipment is 13. Each document type - needs to be three digits. - maximum: 13 - type: string - minLength: 3 - maxLength: 3 - xml: - name: UserCreatedForm - description: The container for User Created Form. The container holds the file. Total number of allowed files per shipment is 13. - UploadResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/UploadResponse_Response" - FormsHistoryDocumentID: - "$ref": "#/components/schemas/UploadResponse_FormsHistoryDocumentID" - xml: - name: UploadResponse - description: Paperless Document API Response Container for upload request. - maximum: 1 - UploadResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response container. - maximum: 1 - UploadResponse_FormsHistoryDocumentID: - type: object - required: - - DocumentID - properties: - DocumentID: - description: | - DocumentID represents a document uploaded to Forms History. - - **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: - type: string - minLength: 26 - maxLength: 26 - xml: - name: FormsHistoryDocumentID - description: The container for DocumentID(s). - maximum: 1 - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +info: + title: Paperless Document + version: '' + description: | + + The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments.
The /upload endpoint of the API requires document details, including file name, file format, and document type (such as authorization form, commercial invoice, certificate of origin, export license, etc).
The /image endpoint helps users upload document images as support documents for shipping
The /delete endpoint of the API helps delete a specific document the user has uploaded. + # Reference + - Business Rules + - Errors + - FAQ + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/paperlessdocuments/{version}/upload": + post: + summary: Upload Paperless Document + tags: + - Paperless + security: + - 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. ' + operationId: Upload + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API + + Valid values: + - v2 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" + examples: + '1': + summary: Upload Request with document type 013 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: '' + UserCreatedForm: + UserCreatedFormFileName: TestFile.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '013' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + '2': + summary: Upload Request with document type 010 + value: + UploadRequest: + Request: + RequestOption: + TransactionReference: + CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 + ShipperNumber: '' + UserCreatedForm: + UserCreatedFormDocumentType: '010' + UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== + UserCreatedFormFileFormat: pdf + UserCreatedFormFileName: TP-0452492_PackingList.pdf + '3': + summary: Upload Request with document type 002 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: 06266e54656e4284805be4d45786ee96 + UserCreatedForm: + - UserCreatedFormFileName: iShipTestFile04.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '002' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + ShipperNumber: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{version}/image": + post: + summary: Paperless Document Push Image + tags: + - Paperless + security: + - OAuth2: [] + description: 'The Paperless Document API web service allows the users to upload + their own customized trade documents for customs clearance to Forms History. ' + operationId: PushToImageRepository + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API + + Valid values: + - v2 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PushToImageRepositoryRequest: + Request: + TransactionReference: + CustomerContext: Your Customer Context + FormsHistoryDocumentID: + DocumentID: 2016-01-18-11.01.07.589501 + ShipmentIdentifier: Your Package Shipment Identifier + ShipmentDateAndTime: 2016-01-18-11.01.07 + ShipmentType: '1' + TrackingNumber: Your Package Tracking Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + delete: + summary: Delete Paperless Document + tags: + - Paperless + security: + - OAuth2: [] + description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. + operationId: Delete + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API + + Valid values: + - v2 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Your Shipper Number + required: true + - in: header + name: DocumentId + schema: + type: string + description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{deprecatedVersion}/upload": + post: + deprecated: true + summary: Upload Paperless Document + tags: + - Paperless + security: + - 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. ' + operationId: Deprecated Upload + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" + examples: + '1': + summary: Upload Request with document type 013 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: '' + UserCreatedForm: + UserCreatedFormFileName: TestFile.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '013' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + '2': + summary: Upload Request with document type 010 + value: + UploadRequest: + Request: + RequestOption: + TransactionReference: + CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 + ShipperNumber: '' + UserCreatedForm: + UserCreatedFormDocumentType: '010' + UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== + UserCreatedFormFileFormat: pdf + UserCreatedFormFileName: TP-0452492_PackingList.pdf + '3': + summary: Upload Request with document type 002 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: 06266e54656e4284805be4d45786ee96 + UserCreatedForm: + - UserCreatedFormFileName: iShipTestFile04.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '002' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + ShipperNumber: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{deprecatedVersion}/image": + post: + deprecated: true + summary: Paperless Document Push Image + tags: + - Paperless + security: + - OAuth2: [] + description: 'The Paperless Document API web service allows the users to upload + their own customized trade documents for customs clearance to Forms History. ' + operationId: Deprecated PushToImageRepository + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PushToImageRepositoryRequest: + Request: + TransactionReference: + CustomerContext: Your Customer Context + FormsHistoryDocumentID: + DocumentID: 2016-01-18-11.01.07.589501 + ShipmentIdentifier: Your Package Shipment Identifier + ShipmentDateAndTime: 2016-01-18-11.01.07 + ShipmentType: '1' + TrackingNumber: Your Package Tracking Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + delete: + deprecated: true + summary: Delete Paperless Document + tags: + - Paperless + security: + - OAuth2: [] + description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. + operationId: Deprecated Delete + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Your Shipper Number + required: true + - in: header + name: DocumentId + schema: + type: string + description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + PAPERLESSDOCUMENTDeleteRequestWrapper: + xml: + name: DeleteRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - DeleteRequest + properties: + DeleteRequest: + "$ref": "#/components/schemas/DeleteRequest" + PAPERLESSDOCUMENTDeleteResponseWrapper: + xml: + name: DeleteResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - DeleteResponse + properties: + DeleteResponse: + "$ref": "#/components/schemas/DeleteResponse" + DeleteRequest: + type: object + required: + - Request + - DocumentID + - ShipperNumber + properties: + Request: + "$ref": "#/components/schemas/DeleteRequest_Request" + ShipperNumber: + 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 + one DocumentID will be accepted for delete request. + maximum: 1 + type: string + minLength: 26 + maxLength: 26 + xml: + name: DeleteRequest + maximum: 1 + description: Paperless Document API Request container for deleting user created + forms. + DeleteRequest_Request: + type: object + properties: + RequestOption: + description: Enables the user to specify optional processing. Currently, + there is no optional process in Paperless Document API. + type: string + minLength: 1 + maxLength: 1 + SubVersion: + description: Not Used. + maximum: 1 + type: string + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Paperless Document API deleted request criteria components. + DeleteResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/DeleteResponse_Response" + xml: + name: DeleteResponse + description: Paperless Document API response container for delete request. + maximum: 1 + DeleteResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response container. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Identifies the success or failure of the transaction. Valid + values are 0 = Failed and 1 = Successful. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of "Success" + or "Failure". + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response status container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + PAPERLESSDOCUMENTRequestWrapper: + xml: + name: PushToImageRepositoryRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PushToImageRepositoryRequest + properties: + PushToImageRepositoryRequest: + "$ref": "#/components/schemas/PushToImageRepositoryRequest" + PAPERLESSDOCUMENTResponseWrapper: + xml: + name: PushToImageRepositoryResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PushToImageRepositoryResponse + properties: + PushToImageRepositoryResponse: + "$ref": "#/components/schemas/PushToImageRepositoryResponse" + PushToImageRepositoryRequest: + type: object + required: + - ShipmentIdentifier + - ShipmentType + - Request + - ShipperNumber + - FormsHistoryDocumentID + properties: + Request: + "$ref": "#/components/schemas/PushToImageRepositoryRequest_Request" + ShipperNumber: + 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" + FormsGroupID: + description: FormsGroupID would be required in Push Request if user needs + to update uploaded DocumentID(s) in Forms History. + maximum: 1 + type: string + minLength: 26 + maxLength: 26 + ShipmentIdentifier: + description: Shipment Identifier is required for this request. + maximum: 1 + type: string + minLength: 1 + maxLength: 19 + ShipmentDateAndTime: + description: The date and time of the processed shipment. Required only + for small package shipments. The valid format is yyyy-MM-dd-HH.mm.ss + maximum: 1 + type: string + ShipmentType: + description: 'Valid values are: 1 = small package, 2 = freight. ' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PRQConfirmationNumber: + description: PRQ Confirmation being specified by client. Required for freight + shipments. + maximum: 1 + type: string + minLength: 9 + maxLength: 30 + TrackingNumber: + description: UPS Tracking Number associated with this shipment. Required + only for small package shipment. + type: array + minLength: 7 + maxLength: 20 + items: + type: string + xml: + name: PushToImageRepositoryRequest + maximum: 1 + description: Paperless Document API request container for push to Image Repository. + PushToImageRepositoryRequest_Request: + type: object + properties: + RequestOption: + description: Enables the user to specify optional processing. Currently, + there is no optional process in Paperless Document API. + type: string + minLength: 1 + maxLength: 1 + SubVersion: + description: Not Used. + maximum: 1 + type: string + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Paperless Document API PushToImageRepository request criteria + components. + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want; it is echoed back by the server. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and server. + PushToImageRepositoryRequest_FormsHistoryDocumentID: + type: object + maximum: 13 + required: + - DocumentID + properties: + DocumentID: + description: DocumentID represents a document uploaded to Forms History. + type: array + maximum: 13 + minLength: 26 + maxLength: 26 + items: + type: string + xml: + name: FormsHistoryDocumentID + description: The container for DocumentID(s). + PushToImageRepositoryResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/PushToImageRepositoryResponse_Response" + FormsGroupID: + description: FormsGroupID is a consolidated ID representing one or multiple + DocumentID(s). + maximum: 1 + type: string + minLength: 26 + maxLength: 26 + xml: + name: PushToImageRepositoryResponse + maximum: 1 + description: Paperless Document API response container for Push To Image Repository + request. + PushToImageRepositoryResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response container. + maximum: 1 + PAPERLESSDOCUMENTUploadRequestWrapper: + xml: + name: UploadRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - UploadRequest + properties: + UploadRequest: + "$ref": "#/components/schemas/UploadRequest" + PAPERLESSDOCUMENTUploadResponseWrapper: + xml: + name: UploadResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - UploadResponse + properties: + UploadResponse: + "$ref": "#/components/schemas/UploadResponse" + UploadRequest: + type: object + required: + - Request + - UserCreatedForm + - ShipperNumber + properties: + Request: + "$ref": "#/components/schemas/UploadRequest_Request" + ShipperNumber: + 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 + UserCreatedForm: + type: array + maximum: 13 + items: + "$ref": "#/components/schemas/UploadRequest_UserCreatedForm" + xml: + name: UploadRequest + maximum: 1 + description: Paperless Document API Request container for uploading User Created Forms. + UploadRequest_Request: + type: object + properties: + RequestOption: + description: Enables the user to specify optional processing. Currently, there is no optional process in Paperless Document API. + type: string + minLength: 1 + maxLength: 1 + SubVersion: + description: Not Used. + maximum: 1 + type: string + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Paperless Document API upload request criteria components. + UploadRequest_UserCreatedForm: + type: object + maximum: 1 + required: + - UserCreatedFormFile + - UserCreatedFormFileName + - UserCreatedFormFileFormat + - UserCreatedFormDocumentType + properties: + UserCreatedFormFileName: + description: The name of the file. + maximum: 1 + type: string + minLength: 1 + 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. + + 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 + 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. + maximum: 1 + type: string + minLength: 3 + maxLength: 4 + UserCreatedFormDocumentType: + 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 + Document, 009 - Power of Attorney, 010 - Packing List, 011 - SED Document, + 012 - Shipper's Letter of Instruction, 013 - Declaration. The total number + of documents allowed per file or per shipment is 13. Each document type + needs to be three digits. + maximum: 13 + type: string + minLength: 3 + maxLength: 3 + xml: + name: UserCreatedForm + description: The container for User Created Form. The container holds the file. Total number of allowed files per shipment is 13. + UploadResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/UploadResponse_Response" + FormsHistoryDocumentID: + "$ref": "#/components/schemas/UploadResponse_FormsHistoryDocumentID" + xml: + name: UploadResponse + description: Paperless Document API Response Container for upload request. + maximum: 1 + UploadResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response container. + maximum: 1 + UploadResponse_FormsHistoryDocumentID: + type: object + required: + - DocumentID + properties: + DocumentID: + description: | + DocumentID represents a document uploaded to Forms History. + + **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: + type: string + minLength: 26 + maxLength: 26 + xml: + name: FormsHistoryDocumentID + description: The container for DocumentID(s). + maximum: 1 + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/Paperless.yaml b/Paperless.yaml index 058834c..c701a7b 100644 --- a/Paperless.yaml +++ b/Paperless.yaml @@ -1,1158 +1,1158 @@ -openapi: 3.0.3 -info: - title: Paperless Document - version: '' - description: | - - The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments.
The /upload endpoint of the API requires document details, including file name, file format, and document type (such as authorization form, commercial invoice, certificate of origin, export license, etc).
The /image endpoint helps users upload document images as support documents for shipping
The /delete endpoint of the API helps delete a specific document the user has uploaded. - # Reference - - Business Rules - - Errors - - FAQ - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/paperlessdocuments/{version}/upload": - post: - summary: Upload Paperless Document - tags: - - Paperless - security: - - 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. ' - operationId: Upload - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API - - Valid values: - - v2 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" - examples: - '1': - summary: Upload Request with document type 013 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: '' - UserCreatedForm: - UserCreatedFormFileName: TestFile.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '013' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - '2': - summary: Upload Request with document type 010 - value: - UploadRequest: - Request: - RequestOption: - TransactionReference: - CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 - ShipperNumber: '' - UserCreatedForm: - UserCreatedFormDocumentType: '010' - UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== - UserCreatedFormFileFormat: pdf - UserCreatedFormFileName: TP-0452492_PackingList.pdf - '3': - summary: Upload Request with document type 002 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: 06266e54656e4284805be4d45786ee96 - UserCreatedForm: - - UserCreatedFormFileName: iShipTestFile04.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '002' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - ShipperNumber: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{version}/image": - post: - summary: Paperless Document Push Image - tags: - - Paperless - security: - - OAuth2: [] - description: 'The Paperless Document API web service allows the users to upload - their own customized trade documents for customs clearance to Forms History. ' - operationId: PushToImageRepository - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API - - Valid values: - - v2 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PushToImageRepositoryRequest: - Request: - TransactionReference: - CustomerContext: Your Customer Context - FormsHistoryDocumentID: - DocumentID: 2016-01-18-11.01.07.589501 - ShipmentIdentifier: Your Package Shipment Identifier - ShipmentDateAndTime: 2016-01-18-11.01.07 - ShipmentType: '1' - TrackingNumber: Your Package Tracking Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - delete: - summary: Delete Paperless Document - tags: - - Paperless - security: - - OAuth2: [] - description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - operationId: Delete - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API - - Valid values: - - v2 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Your Shipper Number - required: true - - in: header - name: DocumentId - schema: - type: string - description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{deprecatedVersion}/upload": - post: - deprecated: true - summary: Upload Paperless Document - tags: - - Paperless - security: - - 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. ' - operationId: Deprecated Upload - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" - examples: - '1': - summary: Upload Request with document type 013 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: '' - UserCreatedForm: - UserCreatedFormFileName: TestFile.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '013' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - '2': - summary: Upload Request with document type 010 - value: - UploadRequest: - Request: - RequestOption: - TransactionReference: - CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 - ShipperNumber: '' - UserCreatedForm: - UserCreatedFormDocumentType: '010' - UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== - UserCreatedFormFileFormat: pdf - UserCreatedFormFileName: TP-0452492_PackingList.pdf - '3': - summary: Upload Request with document type 002 - value: - UploadRequest: - Request: - TransactionReference: - CustomerContext: 06266e54656e4284805be4d45786ee96 - UserCreatedForm: - - UserCreatedFormFileName: iShipTestFile04.txt - UserCreatedFormFileFormat: txt - UserCreatedFormDocumentType: '002' - UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K - ShipperNumber: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{deprecatedVersion}/image": - post: - deprecated: true - summary: Paperless Document Push Image - tags: - - Paperless - security: - - OAuth2: [] - description: 'The Paperless Document API web service allows the users to upload - their own customized trade documents for customs clearance to Forms History. ' - operationId: Deprecated PushToImageRepository - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Shipper Number - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PushToImageRepositoryRequest: - Request: - TransactionReference: - CustomerContext: Your Customer Context - FormsHistoryDocumentID: - DocumentID: 2016-01-18-11.01.07.589501 - ShipmentIdentifier: Your Package Shipment Identifier - ShipmentDateAndTime: 2016-01-18-11.01.07 - ShipmentType: '1' - TrackingNumber: Your Package Tracking Number - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - delete: - deprecated: true - summary: Delete Paperless Document - tags: - - Paperless - security: - - OAuth2: [] - description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - operationId: Deprecated Delete - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API - - Valid values: - - v1 - required: true - - in: header - name: ShipperNumber - schema: - type: string - description: Your Shipper Number - required: true - - in: header - name: DocumentId - schema: - type: string - description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - PAPERLESSDOCUMENTDeleteRequestWrapper: - xml: - name: DeleteRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - DeleteRequest - properties: - DeleteRequest: - "$ref": "#/components/schemas/DeleteRequest" - PAPERLESSDOCUMENTDeleteResponseWrapper: - xml: - name: DeleteResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - DeleteResponse - properties: - DeleteResponse: - "$ref": "#/components/schemas/DeleteResponse" - DeleteRequest: - type: object - required: - - Request - - DocumentID - - ShipperNumber - properties: - Request: - "$ref": "#/components/schemas/DeleteRequest_Request" - ShipperNumber: - 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 - one DocumentID will be accepted for delete request. - maximum: 1 - type: string - minLength: 26 - maxLength: 26 - xml: - name: DeleteRequest - maximum: 1 - description: Paperless Document API Request container for deleting user created - forms. - DeleteRequest_Request: - type: object - properties: - RequestOption: - description: Enables the user to specify optional processing. Currently, - there is no optional process in Paperless Document API. - type: string - minLength: 1 - maxLength: 1 - SubVersion: - description: Not Used. - maximum: 1 - type: string - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Paperless Document API deleted request criteria components. - DeleteResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/DeleteResponse_Response" - xml: - name: DeleteResponse - description: Paperless Document API response container for delete request. - maximum: 1 - DeleteResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response container. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Identifies the success or failure of the transaction. Valid - values are 0 = Failed and 1 = Successful. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of "Success" - or "Failure". - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response status container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - PAPERLESSDOCUMENTRequestWrapper: - xml: - name: PushToImageRepositoryRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PushToImageRepositoryRequest - properties: - PushToImageRepositoryRequest: - "$ref": "#/components/schemas/PushToImageRepositoryRequest" - PAPERLESSDOCUMENTResponseWrapper: - xml: - name: PushToImageRepositoryResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PushToImageRepositoryResponse - properties: - PushToImageRepositoryResponse: - "$ref": "#/components/schemas/PushToImageRepositoryResponse" - PushToImageRepositoryRequest: - type: object - required: - - ShipmentIdentifier - - ShipmentType - - Request - - ShipperNumber - - FormsHistoryDocumentID - properties: - Request: - "$ref": "#/components/schemas/PushToImageRepositoryRequest_Request" - ShipperNumber: - 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" - FormsGroupID: - description: FormsGroupID would be required in Push Request if user needs - to update uploaded DocumentID(s) in Forms History. - maximum: 1 - type: string - minLength: 26 - maxLength: 26 - ShipmentIdentifier: - description: Shipment Identifier is required for this request. - maximum: 1 - type: string - minLength: 1 - maxLength: 19 - ShipmentDateAndTime: - description: The date and time of the processed shipment. Required only - for small package shipments. The valid format is yyyy-MM-dd-HH.mm.ss - maximum: 1 - type: string - ShipmentType: - description: 'Valid values are: 1 = small package, 2 = freight. ' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PRQConfirmationNumber: - description: PRQ Confirmation being specified by client. Required for freight - shipments. - maximum: 1 - type: string - minLength: 9 - maxLength: 30 - TrackingNumber: - description: UPS Tracking Number associated with this shipment. Required - only for small package shipment. - type: array - minLength: 7 - maxLength: 20 - items: - type: string - xml: - name: PushToImageRepositoryRequest - maximum: 1 - description: Paperless Document API request container for push to Image Repository. - PushToImageRepositoryRequest_Request: - type: object - properties: - RequestOption: - description: Enables the user to specify optional processing. Currently, - there is no optional process in Paperless Document API. - type: string - minLength: 1 - maxLength: 1 - SubVersion: - description: Not Used. - maximum: 1 - type: string - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Paperless Document API PushToImageRepository request criteria - components. - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want; it is echoed back by the server. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and server. - PushToImageRepositoryRequest_FormsHistoryDocumentID: - type: object - maximum: 13 - required: - - DocumentID - properties: - DocumentID: - description: DocumentID represents a document uploaded to Forms History. - type: array - maximum: 13 - minLength: 26 - maxLength: 26 - items: - type: string - xml: - name: FormsHistoryDocumentID - description: The container for DocumentID(s). - PushToImageRepositoryResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/PushToImageRepositoryResponse_Response" - FormsGroupID: - description: FormsGroupID is a consolidated ID representing one or multiple - DocumentID(s). - maximum: 1 - type: string - minLength: 26 - maxLength: 26 - xml: - name: PushToImageRepositoryResponse - maximum: 1 - description: Paperless Document API response container for Push To Image Repository - request. - PushToImageRepositoryResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response container. - maximum: 1 - PAPERLESSDOCUMENTUploadRequestWrapper: - xml: - name: UploadRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - UploadRequest - properties: - UploadRequest: - "$ref": "#/components/schemas/UploadRequest" - PAPERLESSDOCUMENTUploadResponseWrapper: - xml: - name: UploadResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - UploadResponse - properties: - UploadResponse: - "$ref": "#/components/schemas/UploadResponse" - UploadRequest: - type: object - required: - - Request - - UserCreatedForm - - ShipperNumber - properties: - Request: - "$ref": "#/components/schemas/UploadRequest_Request" - ShipperNumber: - 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 - UserCreatedForm: - type: array - maximum: 13 - items: - "$ref": "#/components/schemas/UploadRequest_UserCreatedForm" - xml: - name: UploadRequest - maximum: 1 - description: Paperless Document API Request container for uploading User Created Forms. - UploadRequest_Request: - type: object - properties: - RequestOption: - description: Enables the user to specify optional processing. Currently, there is no optional process in Paperless Document API. - type: string - minLength: 1 - maxLength: 1 - SubVersion: - description: Not Used. - maximum: 1 - type: string - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Contains Paperless Document API upload request criteria components. - UploadRequest_UserCreatedForm: - type: object - maximum: 1 - required: - - UserCreatedFormFile - - UserCreatedFormFileName - - UserCreatedFormFileFormat - - UserCreatedFormDocumentType - properties: - UserCreatedFormFileName: - description: The name of the file. - maximum: 1 - type: string - minLength: 1 - 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. - - 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 - 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. - maximum: 1 - type: string - minLength: 3 - maxLength: 4 - UserCreatedFormDocumentType: - 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 - Document, 009 - Power of Attorney, 010 - Packing List, 011 - SED Document, - 012 - Shipper's Letter of Instruction, 013 - Declaration. The total number - of documents allowed per file or per shipment is 13. Each document type - needs to be three digits. - maximum: 13 - type: string - minLength: 3 - maxLength: 3 - xml: - name: UserCreatedForm - description: The container for User Created Form. The container holds the file. Total number of allowed files per shipment is 13. - UploadResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/UploadResponse_Response" - FormsHistoryDocumentID: - "$ref": "#/components/schemas/UploadResponse_FormsHistoryDocumentID" - xml: - name: UploadResponse - description: Paperless Document API Response Container for upload request. - maximum: 1 - UploadResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response container. - maximum: 1 - UploadResponse_FormsHistoryDocumentID: - type: object - required: - - DocumentID - properties: - DocumentID: - description: | - DocumentID represents a document uploaded to Forms History. - - **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: - type: string - minLength: 26 - maxLength: 26 - xml: - name: FormsHistoryDocumentID - description: The container for DocumentID(s). - maximum: 1 - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +info: + title: Paperless Document + version: '' + description: | + + The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments.
The /upload endpoint of the API requires document details, including file name, file format, and document type (such as authorization form, commercial invoice, certificate of origin, export license, etc).
The /image endpoint helps users upload document images as support documents for shipping
The /delete endpoint of the API helps delete a specific document the user has uploaded. + # Reference + - Business Rules + - Errors + - FAQ + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/paperlessdocuments/{version}/upload": + post: + summary: Upload Paperless Document + tags: + - Paperless + security: + - 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. ' + operationId: Upload + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API + + Valid values: + - v2 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" + examples: + '1': + summary: Upload Request with document type 013 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: '' + UserCreatedForm: + UserCreatedFormFileName: TestFile.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '013' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + '2': + summary: Upload Request with document type 010 + value: + UploadRequest: + Request: + RequestOption: + TransactionReference: + CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 + ShipperNumber: '' + UserCreatedForm: + UserCreatedFormDocumentType: '010' + UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== + UserCreatedFormFileFormat: pdf + UserCreatedFormFileName: TP-0452492_PackingList.pdf + '3': + summary: Upload Request with document type 002 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: 06266e54656e4284805be4d45786ee96 + UserCreatedForm: + - UserCreatedFormFileName: iShipTestFile04.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '002' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + ShipperNumber: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{version}/image": + post: + summary: Paperless Document Push Image + tags: + - Paperless + security: + - OAuth2: [] + description: 'The Paperless Document API web service allows the users to upload + their own customized trade documents for customs clearance to Forms History. ' + operationId: PushToImageRepository + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API + + Valid values: + - v2 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PushToImageRepositoryRequest: + Request: + TransactionReference: + CustomerContext: Your Customer Context + FormsHistoryDocumentID: + DocumentID: 2016-01-18-11.01.07.589501 + ShipmentIdentifier: Your Package Shipment Identifier + ShipmentDateAndTime: 2016-01-18-11.01.07 + ShipmentType: '1' + TrackingNumber: Your Package Tracking Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + delete: + summary: Delete Paperless Document + tags: + - Paperless + security: + - OAuth2: [] + description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. + operationId: Delete + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API + + Valid values: + - v2 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Your Shipper Number + required: true + - in: header + name: DocumentId + schema: + type: string + description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{deprecatedVersion}/upload": + post: + deprecated: true + summary: Upload Paperless Document + tags: + - Paperless + security: + - 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. ' + operationId: Deprecated Upload + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadRequestWrapper" + examples: + '1': + summary: Upload Request with document type 013 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: '' + UserCreatedForm: + UserCreatedFormFileName: TestFile.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '013' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + '2': + summary: Upload Request with document type 010 + value: + UploadRequest: + Request: + RequestOption: + TransactionReference: + CustomerContext: df25efe0-899b-4c03-9534-557ae1c90b66 + ShipperNumber: '' + UserCreatedForm: + UserCreatedFormDocumentType: '010' + UserCreatedFormFile: JVBERi0xLjUKJeLjz9MKMyAwIG9iago8PC9MZW5ndGggMTI1MC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nLVXXVPjNhR9z6+4Tx2YgcSWv3lq+NpmC5SSdNud4UWxbxIvthVkGcj+nf7RXslOcJPA1ttZmAHH0T336Nwj6eqxdzrpOT6ELoNJ0ruY9H7Xbywwv/0otJwIHnqDSxtsGjHr2eYb+uRZEET0Ku8d3PL4IS3mcJWWCgYwKp5EGiP8BGOMK5mqFZxjnHHJVSqKw8kXnWZvEga29a8kjgdBYJsksPfnN5mghDucocQixhOY3B5brsfciL2XyN5K5NBkXKvvmUwXL0shFcEOk0RiWb7PONzGsaMG56NYFPAnZvGiI4IVmfgJkpzDOBZVoboh+FHYcPijSBV4RzBZIHzgCp/5qiNUGBqgUynyqZCimnecjR8EDZdrlCWuyjTBjgh+YOLPfvEZODd/dYz2/JYWmMCvZNVE5HB/cM3TIuNFcn/4vld2IB2vgZxgdgI6eJP5wLKZ43p+EEZWR1TW2C/n6Q7qF/JS/1l76WcleVHOMzHlGb4stUH7sehXD9383jb8OWbpE8rVdxm+7XjjWP2HKv2tlb4L07b994K8Ot+O4BQ5TQvGSiJ2W0Gvvr/BZ/gs5Lvq7gvfuP7mc9fQxu62ZVle19hts48VLfp3C7pjxB/k7x9t8O3l5IWOyfZpOIEbsTML+umIF7C1KPwFRuf/G5EEsdz6/JTpE5WJDs4kfUqTimcdqbn1EXkmijKdFzkWCsZVnnO52mZ5KsRDNzuA56z3iTb+J55VuI3+t2f1O+vKLAN+KTGdLxSciVLt4LpBPwwa3EdqUR57DD4S/Ie6XdnAMXBDw3WTyTQnfI5Qpl91S5KkRL+kPqSlQjs8YOtw34SPFOZgn+wf7Dv1YNYMZjT7h/kRbbb0EOfwUj8BPTav9gDZ/ltp2Vujt/M6TV62ycvWedlO3v9SFNdx+0Fd9FGuuyFOJT+G2wx5iSCRJxBzibMqy1bvQu+exy5z+81GMLw/hGGWwVyIpIRnauFgaTZ9TrCwpMLRDjZdQY5ApzQsaDeHKWIBaQH5CmIqoiG2FGVJuwQVlapMXaAJpVO+v6dqRMB2mrm1lgUxuRENkdc8PEmIgRKgqH2KW+4nUrxYgaD3suF8BIWQQKKYb2qkKeq2mJSSKeEQvSkueDYDMdsJ73dU0XLWKp4R91FNOjFtNqUiAeHi6uJscjc6G17BaHJxPdb59TwacSCjbn2/Qk7EdhQ6pyyTRVpCuUiXRoNEYElzVloYRZ2UmdKCf+UyEVVZK3AEONcTnFU5HgGf6TNdM6VnlKIUGY1YUqzqUzvWuKtEJG7Fg+YrKkm+mJZ0lhmbtUmGbK3AQqnlyWCQiZhnC719+JbjB4O0mAmZm0vHIOHFnDJW5TE56XjDcgA0BHJBVdOj241gO1Vg7+hxYVTnOfBnXXO14MoIMOOZnoM+do1KOV/Rein0LSXX8+LTDLWjljR9uh1pclCZr3VtSJ+81PbQH4ZPqSFvzH/N6SJFe9frnWoYK7CjyOroHMe317pd1s6hdUd+brxTz0Sn51PxVMvSiAhUfSWrejHGQkqMNway4bln0R4dug5s/7/70NN5rVCLyDy9BZAkvbHZv9tKe+BQT8o2SgdG6TEtOq4qiXtqQxGMtSLqO+ruzeub9Db87Mh7k5+1n+A51Xqfb94gx1y4xCltzMxpov4BS1LYBAplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwvUGFnZXMgNCAwIFIvVHlwZS9DYXRhbG9nPj4KZW5kb2JqCjggMCBvYmoKPDwvQ3JlYXRpb25EYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9Qcm9kdWNlcihpVGV4dFNoYXJwIDUuMC4wIFwoY1wpIDFUM1hUIEJWQkEpL0F1dGhvcihUcmFuc2dsb2JhbCBFeHByZXNzKS9Nb2REYXRlKEQ6MjAyMzAyMjQxMTIyMzYrMDAnMDAnKS9DcmVhdG9yKFRyYW5zZ2xvYmFsIEV4cHJlc3MpPj4KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9PYmpTdG0vTGVuZ3RoIDIyMy9GaWx0ZXIvRmxhdGVEZWNvZGUvTiA0L0ZpcnN0IDIyPj5zdHJlYW0KeJyVUNGKwjAQ/JV9vHs4N4kGFKRwVcsVOShauIPSh167SEATaVLx/t5NUZ/v8jKZnWE2GQ0CJEgtQYFSC5jBVChYLrH8PRMWzYHwkzrTpO5aCfbqhYb5TNUs9WQD+wXscOVsYOZhOtIdeTf0LXnOyViKwPGjlvG2eEkSLHrX7ilAhcU6AyzpGgDzE+9M77i6Y14nfJ7Pipm4H35CJHEiMW08jeMPOl4omLZ5S92xw41tXWfsAb+MfbfePPh/0/4SFNvymJff5YueiIl4xa3pfKXjd2vuaOC+JPtvJZNzfwplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwvV1sxIDIgMl0vSW5mbyA4IDAgUi9Sb290IDcgMCBSL1R5cGUvWFJlZi9JbmRleFswIDEwXS9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ1L1NpemUgMTAvSUQgWzw5MjMwZDQ0NmJmM2E2NDg5YmVmZGM3YTRiZWUzMmY0Zj48NzYyNGI1MDU3ODdmYTNkZDZhNzJhOGNlYThjNDU1ODc+XT4+c3RyZWFtCnicY2Bg+P+fiYGNgRFEMDEy8DMwgFjMIIKBkU0JSLCagogkBhD4/x8AcAoE/wplbmRzdHJlYW0KZW5kb2JqCnN0YXJ0eHJlZgoxODg1CiUlRU9GCg== + UserCreatedFormFileFormat: pdf + UserCreatedFormFileName: TP-0452492_PackingList.pdf + '3': + summary: Upload Request with document type 002 + value: + UploadRequest: + Request: + TransactionReference: + CustomerContext: 06266e54656e4284805be4d45786ee96 + UserCreatedForm: + - UserCreatedFormFileName: iShipTestFile04.txt + UserCreatedFormFileFormat: txt + UserCreatedFormDocumentType: '002' + UserCreatedFormFile: Tm90aWNlDQpJbiBhbGwgY29tbXVuaWNhdGlvbnMgd2l0aCBVUFMgY29uY2VybmluZyB0aGlzIGRvY3VtZW50LCBwbGVhc2UgcmVmZXIgdG8gdGhlIGRvY3VtZW50IGRhdGUgbG9jYXRlZCBvbiB0aGUgY292ZXIuDQpDb3B5cmlnaHQNClRoZSB1c2UsIGRpc2Nsb3N1cmUsIHJlcHJvZHVjdGlvbiwgbW9kaWZpY2F0aW9uLCB0cmFuc2Zlciwgb3IgdHJhbnNtaXR0YWwgb2YgdGhpcyB3b3JrIGZvciBhbnkgcHVycG9zZSBpbiBhbnkgZm9ybSBvciBieSBhbnkgbWVhbnMgd2l0aG91dCB0aGUgd3JpdHRlbiBwZXJtaXNzaW9uIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBpcyBzdHJpY3RseSBwcm9oaWJpdGVkLg0KwqkgQ29weXJpZ2h0IDIwMTYgVW5pdGVkIFBhcmNlbCBTZXJ2aWNlIG9mIEFtZXJpY2EsIEluYy4gQWxsIFJpZ2h0cyBSZXNlcnZlZC4NClRyYWRlbWFya3MNClVQUyBPbkxpbmXCriBpcyBhIHJlZ2lzdGVyZWQgdHJhZGVtYXJrIG9mIFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIEFsbCBvdGhlciB0cmFkZW1hcmtzIGFyZSB0aGUgcHJvcGVydHkgb2YgdGhlaXIgcmVzcGVjdGl2ZSBvd25lcnMuDQpTb21lIG9mIHRoZSBVUFMgY29ycG9yYXRlIGFwcGxpY2F0aW9ucyB1c2UgVS5TLiBjaXR5LCBzdGF0ZSwgYW5kIHBvc3RhbCBjb2RlIGluZm9ybWF0aW9uIG9idGFpbmVkIGJ5IFVuaXRlZCBQYXJjZWwgU2VydmljZSBvZiBBbWVyaWNhLCBJbmMuIHVuZGVyIGEgbm9uLWV4Y2x1c2l2ZSBsaWNlbnNlIGZyb20gdGhlIFVuaXRlZCBTdGF0ZXMgUG9zdGFsIFNlcnZpY2UuIA0K + ShipperNumber: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTUploadResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{deprecatedVersion}/image": + post: + deprecated: true + summary: Paperless Document Push Image + tags: + - Paperless + security: + - OAuth2: [] + description: 'The Paperless Document API web service allows the users to upload + their own customized trade documents for customs clearance to Forms History. ' + operationId: Deprecated PushToImageRepository + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Shipper Number + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PushToImageRepositoryRequest: + Request: + TransactionReference: + CustomerContext: Your Customer Context + FormsHistoryDocumentID: + DocumentID: 2016-01-18-11.01.07.589501 + ShipmentIdentifier: Your Package Shipment Identifier + ShipmentDateAndTime: 2016-01-18-11.01.07 + ShipmentType: '1' + TrackingNumber: Your Package Tracking Number + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + delete: + deprecated: true + summary: Delete Paperless Document + tags: + - Paperless + security: + - OAuth2: [] + description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. + operationId: Deprecated Delete + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API + + Valid values: + - v1 + required: true + - in: header + name: ShipperNumber + schema: + type: string + description: Your Shipper Number + required: true + - in: header + name: DocumentId + schema: + type: string + description: DocumentId representing uploaded document to Forms History. Only one DocumentID will be accepted for delete request. + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PAPERLESSDOCUMENTDeleteResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + PAPERLESSDOCUMENTDeleteRequestWrapper: + xml: + name: DeleteRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - DeleteRequest + properties: + DeleteRequest: + "$ref": "#/components/schemas/DeleteRequest" + PAPERLESSDOCUMENTDeleteResponseWrapper: + xml: + name: DeleteResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - DeleteResponse + properties: + DeleteResponse: + "$ref": "#/components/schemas/DeleteResponse" + DeleteRequest: + type: object + required: + - Request + - DocumentID + - ShipperNumber + properties: + Request: + "$ref": "#/components/schemas/DeleteRequest_Request" + ShipperNumber: + 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 + one DocumentID will be accepted for delete request. + maximum: 1 + type: string + minLength: 26 + maxLength: 26 + xml: + name: DeleteRequest + maximum: 1 + description: Paperless Document API Request container for deleting user created + forms. + DeleteRequest_Request: + type: object + properties: + RequestOption: + description: Enables the user to specify optional processing. Currently, + there is no optional process in Paperless Document API. + type: string + minLength: 1 + maxLength: 1 + SubVersion: + description: Not Used. + maximum: 1 + type: string + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Paperless Document API deleted request criteria components. + DeleteResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/DeleteResponse_Response" + xml: + name: DeleteResponse + description: Paperless Document API response container for delete request. + maximum: 1 + DeleteResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response container. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Identifies the success or failure of the transaction. Valid + values are 0 = Failed and 1 = Successful. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of "Success" + or "Failure". + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response status container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + PAPERLESSDOCUMENTRequestWrapper: + xml: + name: PushToImageRepositoryRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PushToImageRepositoryRequest + properties: + PushToImageRepositoryRequest: + "$ref": "#/components/schemas/PushToImageRepositoryRequest" + PAPERLESSDOCUMENTResponseWrapper: + xml: + name: PushToImageRepositoryResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PushToImageRepositoryResponse + properties: + PushToImageRepositoryResponse: + "$ref": "#/components/schemas/PushToImageRepositoryResponse" + PushToImageRepositoryRequest: + type: object + required: + - ShipmentIdentifier + - ShipmentType + - Request + - ShipperNumber + - FormsHistoryDocumentID + properties: + Request: + "$ref": "#/components/schemas/PushToImageRepositoryRequest_Request" + ShipperNumber: + 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" + FormsGroupID: + description: FormsGroupID would be required in Push Request if user needs + to update uploaded DocumentID(s) in Forms History. + maximum: 1 + type: string + minLength: 26 + maxLength: 26 + ShipmentIdentifier: + description: Shipment Identifier is required for this request. + maximum: 1 + type: string + minLength: 1 + maxLength: 19 + ShipmentDateAndTime: + description: The date and time of the processed shipment. Required only + for small package shipments. The valid format is yyyy-MM-dd-HH.mm.ss + maximum: 1 + type: string + ShipmentType: + description: 'Valid values are: 1 = small package, 2 = freight. ' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PRQConfirmationNumber: + description: PRQ Confirmation being specified by client. Required for freight + shipments. + maximum: 1 + type: string + minLength: 9 + maxLength: 30 + TrackingNumber: + description: UPS Tracking Number associated with this shipment. Required + only for small package shipment. + type: array + minLength: 7 + maxLength: 20 + items: + type: string + xml: + name: PushToImageRepositoryRequest + maximum: 1 + description: Paperless Document API request container for push to Image Repository. + PushToImageRepositoryRequest_Request: + type: object + properties: + RequestOption: + description: Enables the user to specify optional processing. Currently, + there is no optional process in Paperless Document API. + type: string + minLength: 1 + maxLength: 1 + SubVersion: + description: Not Used. + maximum: 1 + type: string + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Paperless Document API PushToImageRepository request criteria + components. + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The client uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information you want; it is echoed back by the server. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and server. + PushToImageRepositoryRequest_FormsHistoryDocumentID: + type: object + maximum: 13 + required: + - DocumentID + properties: + DocumentID: + description: DocumentID represents a document uploaded to Forms History. + type: array + maximum: 13 + minLength: 26 + maxLength: 26 + items: + type: string + xml: + name: FormsHistoryDocumentID + description: The container for DocumentID(s). + PushToImageRepositoryResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/PushToImageRepositoryResponse_Response" + FormsGroupID: + description: FormsGroupID is a consolidated ID representing one or multiple + DocumentID(s). + maximum: 1 + type: string + minLength: 26 + maxLength: 26 + xml: + name: PushToImageRepositoryResponse + maximum: 1 + description: Paperless Document API response container for Push To Image Repository + request. + PushToImageRepositoryResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response container. + maximum: 1 + PAPERLESSDOCUMENTUploadRequestWrapper: + xml: + name: UploadRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - UploadRequest + properties: + UploadRequest: + "$ref": "#/components/schemas/UploadRequest" + PAPERLESSDOCUMENTUploadResponseWrapper: + xml: + name: UploadResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - UploadResponse + properties: + UploadResponse: + "$ref": "#/components/schemas/UploadResponse" + UploadRequest: + type: object + required: + - Request + - UserCreatedForm + - ShipperNumber + properties: + Request: + "$ref": "#/components/schemas/UploadRequest_Request" + ShipperNumber: + 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 + UserCreatedForm: + type: array + maximum: 13 + items: + "$ref": "#/components/schemas/UploadRequest_UserCreatedForm" + xml: + name: UploadRequest + maximum: 1 + description: Paperless Document API Request container for uploading User Created Forms. + UploadRequest_Request: + type: object + properties: + RequestOption: + description: Enables the user to specify optional processing. Currently, there is no optional process in Paperless Document API. + type: string + minLength: 1 + maxLength: 1 + SubVersion: + description: Not Used. + maximum: 1 + type: string + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Contains Paperless Document API upload request criteria components. + UploadRequest_UserCreatedForm: + type: object + maximum: 1 + required: + - UserCreatedFormFile + - UserCreatedFormFileName + - UserCreatedFormFileFormat + - UserCreatedFormDocumentType + properties: + UserCreatedFormFileName: + description: The name of the file. + maximum: 1 + type: string + minLength: 1 + 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. + + 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 + 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. + maximum: 1 + type: string + minLength: 3 + maxLength: 4 + UserCreatedFormDocumentType: + 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 + Document, 009 - Power of Attorney, 010 - Packing List, 011 - SED Document, + 012 - Shipper's Letter of Instruction, 013 - Declaration. The total number + of documents allowed per file or per shipment is 13. Each document type + needs to be three digits. + maximum: 13 + type: string + minLength: 3 + maxLength: 3 + xml: + name: UserCreatedForm + description: The container for User Created Form. The container holds the file. Total number of allowed files per shipment is 13. + UploadResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/UploadResponse_Response" + FormsHistoryDocumentID: + "$ref": "#/components/schemas/UploadResponse_FormsHistoryDocumentID" + xml: + name: UploadResponse + description: Paperless Document API Response Container for upload request. + maximum: 1 + UploadResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response container. + maximum: 1 + UploadResponse_FormsHistoryDocumentID: + type: object + required: + - DocumentID + properties: + DocumentID: + description: | + DocumentID represents a document uploaded to Forms History. + + **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: + type: string + minLength: 26 + maxLength: 26 + xml: + name: FormsHistoryDocumentID + description: The container for DocumentID(s). + maximum: 1 + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/Pickup.yaml b/Pickup.yaml index 4490e74..e37eb73 100644 --- a/Pickup.yaml +++ b/Pickup.yaml @@ -1,3519 +1,3519 @@ -openapi: 3.0.3 -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 - - Appendix - - Errors - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/shipments/{version}/pickup/{pickuptype}": - post: - description: Using the POST operation of the pickuptype endpoint within the Pickup API, users can request rates for UPS on-demand package pickup. The endpoint allows users to specify pickup details like address, date/time, and other options, and returns pricing information for booking that pickup. - summary: Pickup Rate - tags: - - Pickup - security: - - OAuth2: [] - operationId: Pickup Rate - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of the API. - - Valid values: - - v2409 - required: true - - in: path - name: pickuptype - schema: - type: string - minimum: 1 - description: |- - Type of pickup. Valid values: - oncall - smart - both. Length 6 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPRequestWrapper" - examples: - json: - summary: A sample JSON request(Standard Example) - value: - PickupRateRequest: - PickupAddress: - AddressLine: 315 Saddle Bridge Drive - City: Allendale - StateProvince: NJ - PostalCode: '07401' - CountryCode: US - ResidentialIndicator: Y - AlternateAddressIndicator: N - ServiceDateOption: '02' - PickupDateInfo: - CloseTime: '2000' - ReadyTime: '900' - PickupDate: '20160405' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - 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 - tags: - - Pickup - security: - - OAuth2: [] - operationId: Pickup Pending Status - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: header - name: AccountNumber - schema: - type: string - description: "The specific account number that belongs to the \nshipper.Length - 6 or 10" - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of API - - Valid values: - - v2409 - required: true - - in: path - name: pickuptype - schema: - type: string - minimum: 1 - description: |- - Type of pickup. Valid values: - oncall - smart - both. Length 6 - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPPendingResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/shipments/{version}/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. - summary: Pickup Cancel - tags: - - Pickup - security: - - OAuth2: [] - operationId: Pickup Cancel - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: header - name: Prn - schema: - type: string - description: "The pickup equest number (PRN) generated by \nUPS pickup system.\nRequired - if CancelBy = prn.Length 26" - required: false - - in: path - name: CancelBy - schema: - type: string - description: 'Valid Values: 01 = AccountNumber, 02 = PRN' - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of API. - - Valid values: - - v2409 - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPCancelResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/pickupcreation/{version}/pickup": - post: - description: Using the Pickup API, applications can schedule pickups, manage - previously scheduled pickups, or cancel previously scheduled pickups. - summary: Pickup Creation - tags: - - Pickup - security: - - OAuth2: [] - operationId: Pickup Creation - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of the API. - - Valid values: - - v2409 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPCreationRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PickupCreationRequest: - RatePickupIndicator: N - Shipper: - Account: - AccountNumber: ShipperNumber - AccountCountryCode: US - PickupDateInfo: - CloseTime: '1400' - ReadyTime: '0500' - PickupDate: '20221214' - PickupAddress: - CompanyName: Pickup Proxy - ContactName: Pickup Manager - AddressLine: 123 Main Street - Room: R01 - Floor: '2' - City: Allendale - StateProvince: NJ - Urbanization: '' - PostalCode: '07401' - CountryCode: US - ResidentialIndicator: Y - PickupPoint: Lobby - Phone: - Number: '5555555555' - Extension: '911' - AlternateAddressIndicator: Y - PickupPiece: - - ServiceCode: '001' - Quantity: '27' - DestinationCountryCode: US - ContainerCode: '01' - - ServiceCode: '012' - Quantity: '4' - DestinationCountryCode: US - ContainerCode: '01' - TotalWeight: - Weight: '5.5' - UnitOfMeasurement: LBS - OverweightIndicator: N - PaymentMethod: '01' - SpecialInstruction: 'Test ' - ReferenceNumber: CreatePickupRef - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPCreationResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/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. - summary: Pickup Get Political Division1 List - tags: - - Pickup - security: - - OAuth2: [] - operationId: Pickup Get Political Division1 List - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: true - - in: path - name: version - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of API. - - Valid values: - - v2409 - required: true - - in: path - name: countrycode - schema: - type: string - minimum: 1 - description: "Country or terrirtory for which the list will \nrepresent.Length - 2" - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPPolDivResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/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 - summary: Pickup Get Service Center Facilities - tags: - - Pickup - security: - - OAuth2: [] - operationId: Pickup Get Service Center Facilities - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: version - schema: - type: string - default: v2409 - description: | - Version of API. - - Valid values: - - v2409 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPServCenterRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PickupGetServiceCenterFacilitiesRequest: - PickupPiece: - ServiceCode: '096' - ContainerCode: '03' - DestinationAddress: - City: Allendale - StateProvince: NJ - PostalCode: '07401' - CountryCode: US - ProximitySearchIndicator: '' - Locale: en_HK - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPServCenterResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - delete: - deprecated: true - 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. - summary: Pickup Cancel - tags: - - Pickup - security: - - OAuth2: [] - operationId: Deprecated Pickup Cancel - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: header - name: Prn - schema: - type: string - description: "The pickup equest number (PRN) generated by \nUPS pickup system.\nRequired - if CancelBy = prn.Length 26" - required: false - - in: path - name: CancelBy - schema: - type: string - description: 'Valid Values: 01 = AccountNumber, 02 = PRN' - required: true - - in: path - name: deprecatedVersion - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of API. - - Valid values: - - v2409 - required: true - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPCancelResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/pickupcreation/{deprecatedVersion}/pickup": - post: - deprecated: true - description: Using the Pickup API, applications can schedule pickups, manage - previously scheduled pickups, or cancel previously scheduled pickups. - summary: Pickup Creation - tags: - - Pickup - security: - - OAuth2: [] - operationId: Deprecated Pickup Creation - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: deprecatedVersion - schema: - type: string - minimum: 1 - default: v2409 - description: | - Version of the API. - - Valid values: - - v1 - - v1607 - - v1707 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPCreationRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PickupCreationRequest: - RatePickupIndicator: N - Shipper: - Account: - AccountNumber: ShipperNumber - AccountCountryCode: US - PickupDateInfo: - CloseTime: '1400' - ReadyTime: '0500' - PickupDate: '20221214' - PickupAddress: - CompanyName: Pickup Proxy - ContactName: Pickup Manager - AddressLine: 123 Main Street - Room: R01 - Floor: '2' - City: Allendale - StateProvince: NJ - Urbanization: '' - PostalCode: '07401' - CountryCode: US - ResidentialIndicator: Y - PickupPoint: Lobby - Phone: - Number: '5555555555' - Extension: '911' - AlternateAddressIndicator: Y - PickupPiece: - - ServiceCode: '001' - Quantity: '27' - DestinationCountryCode: US - ContainerCode: '01' - - ServiceCode: '012' - Quantity: '4' - DestinationCountryCode: US - ContainerCode: '01' - TotalWeight: - Weight: '5.5' - UnitOfMeasurement: LBS - OverweightIndicator: N - PaymentMethod: '01' - SpecialInstruction: 'Test ' - ReferenceNumber: CreatePickupRef - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PICKUPCreationResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - PICKUPRequestWrapper: - xml: - name: PickupRateRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupRateRequest - properties: - PickupRateRequest: - "$ref": "#/components/schemas/PickupRateRequest" - PICKUPResponseWrapper: - xml: - name: PickupRateResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupRateResponse - properties: - PickupRateResponse: - "$ref": "#/components/schemas/PickupRateResponse" - PickupRateRequest: - type: object - required: - - ServiceDateOption - - PickupAddress - - Request - - AlternateAddressIndicator - properties: - Request: - "$ref": "#/components/schemas/PickupRateRequest_Request" - ShipperAccount: - "$ref": "#/components/schemas/PickupRateRequest_ShipperAccount" - 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 - = Original pickup address (default)" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ServiceDateOption: - description: |- - Indicates the pickup timeframe. - - 01 = Same-Day Pickup - - 02 = Future-Day Pickup - - 03 = A Specific-Day Pickup - - If 03 is selected, then PickupDate, EarliestReadyTime, and LatestClosetime must be specified. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PickupDateInfo: - "$ref": "#/components/schemas/PickupRateRequest_PickupDateInfo" - RateChartType: - description: | - Rate Type with which pickup is rated. Possible RateChart values for different regions will be: - - US 48 origin: - 1 – Daily Rates - 3 – Standard List Rates - 4 – Retail Rates. - - Alaska/Hawaii origin: - 1 – Daily Rates - 3 – Standard List Rates - 4 – Retail Rates. - - All Other origins: - 1 – Rates - 5 - Regional Rates - 6 - General List Rates. - - 3 and 4 do not apply - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TaxInformationIndicator: - description: |- - Indicates whether to return detailed taxes for on-callpickups. - Valid values: - - Y = Rate this pickup with taxes - - N = Do not rate this pickup with taxes (default) - maximum: 1 - type: string - minLength: 1 - 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 - promo discount\nN = Do not rate this pickup with user level promo discount(default)" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: PickupRateRequest - maximum: 1 - description: This request is used to rate an on-callpickup. - PickupRateRequest_Request: - type: object - properties: - RequestOption: - description: Not used by pick up - type: string - minLength: 1 - maxLength: 15 - SubVersion: - description: "When UPS introduces new elements in the response that are - not associated with new request elements, Subversion is used. This ensures - backward compatibility.\n\nTo get such elements you need to have the right - Subversion. The value of the subversion is explained in the Response element - Description. 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: - 1601 = 2016 January" - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - maximum: 1 - description: Common element for all services - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information that is echoed back during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container - PickupRateRequest_ShipperAccount: - type: object - maximum: 1 - required: - - AccountCountryCode - - AccountNumber - properties: - AccountNumber: - description: UPS account number. Shipper's (requester of the pickup) UPS - account number - maximum: 1 - type: string - minLength: 6 - maxLength: 10 - AccountCountryCode: - description: |- - Country code as defined by ISO-3166. - Refer to Country or Territory Codes in the Appendix for valid values. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipperAccount - description: Shipper account information. - PickupRateRequest_PickupAddress: - type: object - maximum: 1 - properties: - AddressLine: - description: "Detailed street address. \nFor Jan. 2010 release, only one - AddressLine is allowed." - maximum: 1 - type: string - minLength: 1 - maxLength: 73 - City: - description: City or equivalent - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: State province code or equivalent - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Postal code for countries with postal codes. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: "Upper-case two-char long country code as defined by ISO-3166. - \nRefer to Country or Territory Codes in the Appendix for valid values." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ResidentialIndicator: - description: |- - Indicates if the pickup address is commerical or residential. - Valid values: - Y = Residential address - N = Non-residential (Commercial) address (default) - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: PickupAddress - required: - - ResidentialIndicator - - PostalCode - - City - - CountryCode - description: The address to pickup the packages - PickupRateRequest_PickupDateInfo: - type: object - maximum: 1 - required: - - ReadyTime - - CloseTime - - PickupDate - properties: - CloseTime: - description: |- - The latest local close time. Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - ReadyTime: - description: |- - The earliest local ready Time. Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - PickupDate: - description: |- - The specific local pickup date. Format: yyyyMMdd - - yyyy = Year Applicable - - MM = 01-12 - - dd = 01-31 - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: PickupDateInfo - description: "Required if the ServiceDateOption is: \n03 A Specific-Day Pickup" - PickupRateResponse: - type: object - required: - - Response - - RateResult - properties: - Response: - "$ref": "#/components/schemas/PickupRateResponse_Response" - 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: - - Y = WST - - N = Non-WST - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - WeekendServiceTerritory: - "$ref": "#/components/schemas/PickupRateResponse_WeekendServiceTerritory" - xml: - name: PickupRateResponse - maximum: 1 - description: The response of rating on-callpickup. - PickupRateResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Identifies the success of the transaction. - - 1=Success - - 0=failed - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response Status Container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information that is echoed back during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - PickupRateResponse_RateResult: - type: object - properties: - Disclaimer: - "$ref": "#/components/schemas/RateResult_Disclaimer" - RateType: - description: |- - Indicates the pickup is rated as same-day or future-day pickup. - - SD = Same-day Pickup - - FD = Future-day Pickup - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - CurrencyCode: - description: IATA currency codes for the pickup charge. Such as USD - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - ChargeDetail: - type: array - items: - "$ref": "#/components/schemas/RateResult_ChargeDetail" - TaxCharges: - type: array - items: - "$ref": "#/components/schemas/RateResult_TaxCharges" - TotalTax: - description: The sum of all taxes. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - GrandTotalOfAllCharge: - description: The grand total of each charge and applied tax. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - GrandTotalOfAllIncentedCharge: - description: The grand total of each incented charge and applied tax. Only - present if 1. UserLevelDiscountIndicator = Y and User Level Promotion - is applied to the pickup or 2 .if any incentive rate is applied to the - pickup and SubVersion on the request is greater than or equal to 1707. - maximum: 1 - type: string - minLength: 2 - maxLength: 8 - PreTaxTotalCharge: - description: Total of charges before taxes. Only present when tax details - requested in input. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - PreTaxTotalIncentedCharge: - description: Total of incented charges before taxes. Only present if 1. - UserLevelDiscountIndicator = Y and User Level Promotion is applied to - the pickup or 2 .if any incentive rate is applied to the pickup and SubVersion - on the request is greater than or equal to 1707. - maximum: 1 - type: string - minLength: 2 - maxLength: 8 - xml: - name: RateResult - maximum: 1 - required: - - CurrencyCode - description: The result of rating an on-callpickup. - RateResult_ChargeDetail: - type: object - maximum: 1 - required: - - ChargeCode - - ChargeAmount - properties: - ChargeCode: - description: |- - Indicates the general charge type - - A = ACCESSORIAL TYPE - - B = BASE CHARGE TYPE - - S = SURCHARGE TYPE - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ChargeDescription: - description: |- - Description of each charge.The possible descriptions are: - - BASE CHARGE - - EXTENDED AREA SURCHARGE - - FUEL SURCHARGE - - REMOTE AREA SURCHARGE - - RESIDENTIAL SURCHARGE - - SATURDAY ON-CALL STOP CHARGE - maximum: 1 - type: string - minLength: 1 - maxLength: 100 - ChargeAmount: - description: Monetary value of the charge. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - IncentedAmount: - description: Monetary value of the incented charge. Only present if 1. UserLevelDiscountIndicator - = Y and User Level Promotion is applied to the pickup or 2 .if any incentive - rate is applied to the pickup and SubVersion on the request is greater - than or equal to 1707. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - TaxAmount: - description: Monetary value of the tax if apply. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: ChargeDetail - description: Detailed charges. - RateResult_TaxCharges: - type: object - maximum: 1 - required: - - Type - - MonetaryValue - properties: - Type: - 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 - type: string - minLength: 3 - maxLength: 3 - MonetaryValue: - description: Monetary value of the tax. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: TaxCharges - description: Container to hold taxes when, detailed taxes are request via RateTaxIndicator. - PickupRateResponse_WeekendServiceTerritory: - type: object - maximum: 1 - required: - - SunWST - - SatWST - properties: - SatWST: - 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 2007. Valid Values: - - Y = Saturday WST - - N = Non-Saturday WST - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - SunWST: - description: | - Indicates if the pickup address qualifies for WST (Weekend Service Territory). Returned if the pickup date is Sunday and subversion greater or equal to 2007. Valid Values: - - Y = Sunday WST - - N = Non-Sunday WST - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: WeekendServiceTerritory - description: WeekendServiceTerritory Container.Returned if the subversion greater - or equal to 2007. - PICKUPCancelRequestWrapper: - xml: - name: PickupCancelRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupCancelRequest - properties: - PickupCancelRequest: - "$ref": "#/components/schemas/PickupCancelRequest" - PICKUPCancelResponseWrapper: - xml: - name: PickupCancelResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupCancelResponse - properties: - PickupCancelResponse: - "$ref": "#/components/schemas/PickupCancelResponse" - PickupCancelRequest: - type: object - required: - - CancelBy - - Request - properties: - Request: - "$ref": "#/components/schemas/PickupCancelRequest_Request" - CancelBy: - description: |- - Cancel pickup by Pickup Request Number (PRN). - - 01= Account Number - - 02 = PRN - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - PRN: - description: |- - The pickup request number (PRN) generated by UPS pickup system. - Required if CancelBy = 02 - maximum: 1 - type: string - minLength: 11 - maxLength: 11 - xml: - name: PickupCancelRequest - maximum: 1 - description: This request is to cancel an on-callpickup. - PickupCancelRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Request Container. - maximum: 1 - PickupCancelResponse: - type: object - required: - - Response - - PickupType - properties: - Response: - "$ref": "#/components/schemas/PickupCancelResponse_Response" - PickupType: - description: |- - The type of pickup that has been cancelled. - - 01 = On-Call Pickup - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - GWNStatus: - "$ref": "#/components/schemas/PickupCancelResponse_GWNStatus" - xml: - name: PickupCancelResponse - maximum: 1 - description: The response for cancelling pickup(s) - PickupCancelResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container - maximum: 1 - PickupCancelResponse_GWNStatus: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - The status code defined by operation system. - - 001 = User Triggered - - 002 = User Cancelled - - 003 = Completed - - 004 = Missed - - 005 = Not In - - 006 = Not Ready - - 007 = Closed - - 008 = Cancelled By Driver - - 999 = Unknown - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Please refer to /PickupPendingStatusResponse/PendingStatus/PickupStatusMessage - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: GWNStatus - description: The status of Smart Pickup that has been cancelled. - PICKUPCreationRequestWrapper: - xml: - name: PickupCreationRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupCreationRequest - properties: - PickupCreationRequest: - "$ref": "#/components/schemas/PickupCreationRequest" - PICKUPCreationResponseWrapper: - xml: - name: PickupCreationResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupCreationResponse - properties: - PickupCreationResponse: - "$ref": "#/components/schemas/PickupCreationResponse" - PickupCreationRequest: - type: object - required: - - PickupDateInfo - - PickupAddress - - Request - - PaymentMethod - - PickupPiece - - RatePickupIndicator - - AlternateAddressIndicator - properties: - Request: - "$ref": "#/components/schemas/PickupCreationRequest_Request" - RatePickupIndicator: - 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 - minLength: 1 - maxLength: 1 - RateChartType: - description: | - Rate Type with which pickup is rated. Possible RateChart values for different regions will be: - - US 48 origin: - - 1 – Daily Rates - - 3 – Standard List Rates - - 4 – Retail Rates. - - Alaska/Hawaii origin: - - 1 – Daily Rates - - 3 – Standard List Rates - - 4 – Retail Rates. - - All Other origins: - - 1 – Rates - - 5 - Regional Rates - - 6 - General List Rates. - - 3 and 4 do not apply - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TaxInformationIndicator: - description: "Indicates whether to return detailed taxes for the on-callpickups. - \nValid values:\nY = Rate this pickup with taxes\nN = Do not rate this - pickup with taxes (default)" - maximum: 1 - type: string - minLength: 1 - 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 - 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" - PickupDateInfo: - "$ref": "#/components/schemas/PickupCreationRequest_PickupDateInfo" - 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 - = Original pickup address (default)" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PickupPiece: - type: array - items: - "$ref": "#/components/schemas/PickupCreationRequest_PickupPiece" - 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 - required for WWEF service." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TrackingData: - type: array - items: - "$ref": "#/components/schemas/PickupCreationRequest_TrackingData" - 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 - 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 - the pickup packages.\n- If 05 is selected, then the shipper will pay for - the pickup packages with a check or money order." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - SpecialInstruction: - description: Special handling instruction from the customer - maximum: 1 - type: string - minLength: 1 - maxLength: 57 - ReferenceNumber: - description: Information entered by a customer for Privileged reference - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - 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 - - international\n03 - transborder" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - CashType: - description: "Describes the type of cash funds that the driver will collect.\nApplicable - to the following countries:\nBE,FR,DE,IT,MX,NL,PL,ES,GB\nValid values: - \n01 - Pickup only (default)\n02 - Transportation only\n03 - Pickup and - Transportation" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ShippingLabelsAvailable: - description: This element should be set to "Y" in the request to indicate that user has pre-printed shipping labels for all the packages, otherwise this will be treated as false. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Notification: - "$ref": "#/components/schemas/PickupCreationRequest_Notification" - xml: - name: PickupCreationRequest - maximum: 1 - description: This request is for scheduling an on-call pickup - PickupCreationRequest_Request: - type: object - maximum: 1 - properties: - SubVersion: - description: "When UPS introduces new elements in the response that are - not associated with new request elements, Subversion is used. This ensures - backward compatibility.\n\nTo get such elements you need to have the right - 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: - 1601 = 2016 January" - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Common element for all services - PickupCreationRequest_Shipper: - type: object - properties: - Account: - "$ref": "#/components/schemas/Shipper_Account" - ChargeCard: - "$ref": "#/components/schemas/Shipper_ChargeCard" - xml: - name: Shipper - 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 - any other payment method. However, it is highly recommended to provide if - available." - maximum: 1 - Shipper_Account: - type: object - maximum: 1 - required: - - AccountCountryCode - - AccountNumber - properties: - AccountNumber: - description: UPS account number. Shipper's (requester of the pickup) UPS - account number - maximum: 1 - type: string - minLength: 6 - maxLength: 10 - AccountCountryCode: - description: |- - Country or territory code as defined by ISO-3166. - Refer to Country or Terriotry Codes in the Appendix for valid values. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: Account - description: "Shipper account information. \nMust provide when choose to pay - the pickup by shipper account number" - Shipper_ChargeCard: - type: object - maximum: 1 - properties: - CardHolderName: - description: Charge card holder name. If the name is not provided, defaults - to "No Name Provided". - maximum: 1 - type: string - minLength: 1 - maxLength: 22 - CardType: - description: |- - Charge card type. Valid values: - - 01 = American Express - - 03 = Discover - - 04 = Mastercard - - 06 = VISA Discover card Pickup country US only. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - CardNumber: - description: Charge card number. For Privileged clients, this element must - be tokenized card number. - maximum: 1 - type: string - minLength: 9 - maxLength: 16 - ExpirationDate: - description: |- - Credit card expiration date. - Format: yyyyMM - yyyy = 4 digit year, valid value current year - 10 years. - MM = 2 digit month, valid values 01-12 - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - SecurityCode: - description: "Three or four digits that can be found either on top of credit - card number or on the back of credit card. \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" - xml: - name: ChargeCard - required: - - CardNumber - - ExpirationDate - - CardType - - CardAddress - - SecurityCode - description: Container for Charge Card payment method Required if Payment method - is 03. Credit/Charge card payment is valid for US, CA, PR and GB origin pickups. - ChargeCard_CardAddress: - type: object - maximum: 1 - properties: - AddressLine: - description: Address Lines of the credit card billing address. Max of three - address lines can be provided. - type: array - items: - type: string - maximum: 3 - minLength: 1 - maxLength: 35 - City: - description: Charge card billing city - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: Charge card billing State province code - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Charge card billing address postal code. This is a required - field for postal countries. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: |- - Charge card billing address country or territory code defined by ISO-3166. - - Upper-case two letter string. For Discover card it should be US. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: CardAddress - required: - - CountryCode - description: Container to hold the Charge card address. - PickupCreationRequest_PickupDateInfo: - type: object - maximum: 1 - required: - - ReadyTime - - CloseTime - - PickupDate - properties: - CloseTime: - description: | - Pickup location's local close time. - - User provided Close Time must be later than the Earliest Allowed Customer Close Time. - - Earliest Allowed Customer Close Time is defined by UPS pickup operation system. - - CloseTime minus ReadyTime must be greater than the LeadTime. - - LeadTime is determined by UPS pickup operation system. LeadTime is the minimum amount of time UPS requires between customer's request for a pickup and driver arriving at the location for the pickup. - - Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - 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 - 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 - than current local time, UPS uses the current local time as the ReadyTime. - \ Format: HHmm\nHour: 0-23\nMinute: 0-59" - type: string - PickupDate: - description: | - Local pickup date of the location. Format: yyyyMMdd - - yyyy = Year Appliable - - MM = 01–12 - - dd = 01–31 - maximum: 1 - type: string - minLength: 4 - maxLength: 4 - xml: - name: PickupDateInfo - description: The container of desired pickup date - PickupCreationRequest_PickupAddress: - type: object - maximum: 1 - required: - - CompanyName - - AddressLine - - ResidentialIndicator - - Phone - - City - - CountryCode - - ContactName - properties: - CompanyName: - description: Company name - maximum: 1 - type: string - minLength: 1 - maxLength: 27 - ContactName: - description: Name of contact person - maximum: 1 - type: string - minLength: 1 - maxLength: 22 - AddressLine: - description: Detailed street address. For Jan. 2010 release, only one AddressLine - is allowed - type: array - items: - maximum: 1 - type: string - minLength: 1 - maxLength: 73 - Room: - description: Room number - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - Floor: - description: Floor number - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - City: - description: City or equivalent - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: State or province for postal countries; county for Ireland - (IE) and district code for Hong Kong (HK) - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Urbanization: - description: |- - - Barrio for Mexico (MX) - - Urbanization for Puerto Rico (PR) - - Shire for United Kingdom (UK) - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Postal code or equivalent for postal countries - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: "The pickup country or territory code as defined by ISO-3166. - \nRefer to Country or Territory Codes in the Appendix for valid values." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ResidentialIndicator: - description: "Indicates if the pickup address is commercial or residential. - \nValid values:\nY = Residential address\nN = Non-residential (Commercial) - address (default)" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PickupPoint: - description: The specific spot to pickup at the address. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - Phone: - "$ref": "#/components/schemas/PickupAddress_Phone" - xml: - name: PickupAddress - description: The container of pickup address. - PickupAddress_Phone: - type: object - maximum: 1 - required: - - Number - properties: - Number: - description: Phone number - maximum: 1 - type: string - minLength: 1 - maxLength: 25 - Extension: - description: Phone extension - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: Phone - description: Contact telephone number. - PickupCreationRequest_PickupPiece: - type: object - maximum: 1 - required: - - ServiceCode - - DestinationCountryCode - - Quantity - - ContainerCode - properties: - ServiceCode: - description: Refer to Service Codes in the Appendix for valid values. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Quantity: - description: "Number of pieces to be picked up. \nMax per service: 999" - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - DestinationCountryCode: - description: |- - The destination country code as defined by ISO-3166. - Refer to Country or Territory Codes in the Appendix for valid values. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ContainerCode: - description: | - Container type. Valid values: - - 01 = PACKAGE - - 02 = UPS LETTER - - 03 = PALLET - - Note: 03 is used for only WWEF services - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - 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 - exceed 9,999." - PickupCreationRequest_TotalWeight: - type: object - maximum: 1 - required: - - UnitOfMeasurement - - Weight - properties: - Weight: - description: "The weight of the package. \nOne decimal digit is allowed. - Example: 10.9" - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - UnitOfMeasurement: - description: |- - The code representing the unit of measurement associated with the package. - LBS = Pounds - KGS = Kilograms - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: TotalWeight - description: Container for the total weight of all the items. - PickupCreationRequest_TrackingData: - type: object - maximum: 1 - properties: - TrackingNumber: - 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 - type: string - minLength: 18 - maxLength: 18 - xml: - name: TrackingData - description: |- - 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: - type: object - maximum: 3 - required: - - TrackingNumber - properties: - TrackingNumber: - description: Tracking number for shipment packages. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - ReferenceNumber: - description: The reference number associated with the tracking number. - maximum: 3 - type: array - items: - type: string - minLength: 1 - maxLength: 35 - xml: - name: TrackingDataWithReferenceNumber - 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 - container cannot be present at the same time. - PickupCreationRequest_FreightOptions: - type: object - properties: - ShipmentServiceOptions: - "$ref": "#/components/schemas/FreightOptions_ShipmentServiceOptions" - OriginServiceCenterCode: - description: Origin SLIC. This will be obtained from submitting a pickup - service center request. See PickupGetFacilitiesServiceCenterRequest. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - OriginServiceCountryCode: - description: Country or territory of Service Center SLIC chosen to drop - off. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - DestinationAddress: - "$ref": "#/components/schemas/FreightOptions_DestinationAddress" - ShipmentDetail: - "$ref": "#/components/schemas/FreightOptions_ShipmentDetail" - xml: - name: FreightOptions - maximum: 1 - required: - - ShipmentDetail - description: Container will be used to indicate Service options, add optional - Original service center, destination address and shipment details related - to the UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday. - FreightOptions_ShipmentServiceOptions: - type: object - maximum: 1 - properties: - OriginLiftGateIndicator: - description: Presence indicates OriginLiftGateRequiredIndicator is present. Conditionally - requirements. Must not be present if DropOffAtUPSFacilityIndicator is - true - maximum: 1 - type: string - DropoffAtUPSFacilityIndicator: - description: Identifies service center location information for Origin List - of UPS Facilities. - maximum: 1 - type: string - HoldForPickupIndicator: - description: Identifies service center location information for Destination - of UPS Facilities. - maximum: 1 - type: string - xml: - name: ShipmentServiceOptions - description: Supports various optional indicators - FreightOptions_DestinationAddress: - type: object - maximum: 1 - properties: - City: - description: The city of pickup address if available. It is required for - non-postal country Ireland (IE). - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: |- - 1. It means district code for Hong Kong (HK) - 2. It means county for Ireland (IE) - 3. It means state or province for all the postal countries It is required for non-postal countries including HK and IE. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Postal Code for postal countries. It does not apply to non-postal - countries such as IE and HK - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: "The pickup country or territory code as defined by ISO-3166. - \nRefer to Country or Territory Codes in the Appendix for valid values. - \ Upper-case two-letter string." - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - xml: - name: DestinationAddress - required: - - CountryCode - description: Destination Address Container. - FreightOptions_ShipmentDetail: - type: object - maximum: 1 - properties: - HazmatIndicator: - description: Indicates hazardous materials - maximum: 1 - type: string - PalletInformation: - "$ref": "#/components/schemas/ShipmentDetail_PalletInformation" - xml: - name: ShipmentDetail - description: Refers to the ShipmentDetail Container under Freight Options - PickupCreationRequest_Notification: - type: object - properties: - ConfirmationEmailAddress: - description: Email address where the pickup notification is sent. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - UndeliverableEmailAddress: - description: Email address for used exceptions. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: Notification - maximum: 1 - description: Container for pickup notification - ShipmentDetail_PalletInformation: - type: object - properties: - Dimensions: - "$ref": "#/components/schemas/PalletInformation_Dimensions" - xml: - name: PalletInformation - description: Pallet Details. - maximum: 1 - PalletInformation_Dimensions: - type: object - required: - - UnitOfMeasurement - - Length - - Height - - Width - properties: - UnitOfMeasurement: - "$ref": "#/components/schemas/Dimensions_UnitOfMeasurement" - Length: - description: Dimension length of pallet. - maximum: 1 - type: string - Width: - description: Dimension width of pallet. - maximum: 1 - type: string - Height: - description: Dimension height of pallet. - maximum: 1 - type: string - xml: - name: Dimensions - maximum: 1 - description: Dimensions of largest pallet - Dimensions_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - - IN = Inches - - CM = Centimeters - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: See Code above. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: The code representing the unit of measurement associated with the - package. - PickupCreationResponse: - type: object - required: - - Response - - RateStatus - properties: - 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 - already exists for a pickup address/ point. - maximum: 1 - type: string - minLength: 11 - maxLength: 11 - 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: - - Y = WST - - N = Non-WST - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - RateStatus: - "$ref": "#/components/schemas/PickupCreationResponse_RateStatus" - RateResult: - "$ref": "#/components/schemas/PickupCreationResponse_RateResult" - xml: - name: PickupCreationResponse - maximum: 1 - description: The response for scheduling an on-callpickup. - PickupCreationResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container. - maximum: 1 - PickupCreationResponse_WeekendServiceTerritory: - type: object - maximum: 1 - required: - - SunWST - - SatWST - properties: - SatWST: - 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 2007. Valid Values: - - Y = Saturday WST - - N = Non-Saturday WST - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - SunWST: - description: "Indicates if the pickup address qualifies for WST (Weekend Service Territory). Returned if the pickup date is Sunday and subversion greater or equal to 2007. Valid Values: - - Y = Sunday WST - - N = Non-Sunday WST" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: WeekendServiceTerritory - description: WeekendServiceTerritory Container.Returned if the subversion greater - or equal to 2007. - PickupCreationResponse_RateStatus: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - The rating status. - - 01 = Rate available - - 02 = Rate not available - - 03 = Rate not apply - - 04 = Rate not requested - - - If 01 is returned, then OnCallPickupRateResult will also be returned with rate details. - - If 02 is returned, then OnCallPickupRateResult will not be returned. - - If 03 is returned, then OnCallPickupRateResult will not be returned. The rate option is not appliable to this return pickup. The requester will not be charged. - - If 04 is returned, then OnCallPickupRateResult will not be returned. The requester did not ask for rating this on-callpickup. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: The matching description of rating status code (see above). - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: RateStatus - description: The rating result of on-callpickup - PickupCreationResponse_RateResult: - type: object - properties: - Disclaimer: - "$ref": "#/components/schemas/RateResult_Disclaimer" - RateType: - description: |- - Indicates this pickup is rated as same-day or future-day pickup. - - SD = Same-day Pickup - - FD = Future-day Pickup - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - CurrencyCode: - description: IATA currency codes for the pickup charge. Such as USD - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - ChargeDetail: - description: | - Container to hold taxes when, detailed taxes are request via RateTaxIndicator. - - **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" - TaxCharges: - description: | - Container to hold taxes when, detailed taxes are request via RateTaxIndicator. - - **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" - TotalTax: - description: The sum of all taxes. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - GrandTotalOfAllCharge: - description: The grand total of each charge and applied tax. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - GrandTotalOfAllIncentedCharge: - description: The grand total of each incented charge and applied tax. Only - present if 1. UserLevelDiscountIndicator = Y and User Level Promotion - is applied to the pickup or 2 .if any incentive rate is applied to the - pickup and SubVersion on the request is greater than or equal to 1707. - maximum: 1 - type: string - minLength: 2 - maxLength: 8 - PreTaxTotalCharge: - description: Total of charges before taxes. Only present when tax details - requested in input. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - PreTaxTotalIncentedCharge: - description: Total of incented charges before taxes. Only present if 1. - UserLevelDiscountIndicator = Y and User Level Promotion is applied to - the pickup or 2 .if any incentive rate is applied to the pickup and SubVersion - on the request is greater than or equal to 1707. - maximum: 1 - type: string - minLength: 2 - maxLength: 8 - xml: - name: RateResult - maximum: 1 - required: - - GrandTotalOfAllCharge - description: The result of rating on-callpickup. It correlates to rate status - code 01 - RateResult_Disclaimer: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Disclaimer code. Valid values: - - 01 = Taxes are included in the shipping cost and apply to the transportation charges but additional duties/taxes may apply and are not reflected in the total amount due. - - 02 = Additional duties/taxes may apply and are not reflected in the total amount due. - - 03 = Additional duties/taxes may apply and are not reflected in the total amount due. - - 04 = Taxes were unable to be determined and may apply to the shipment. - - 05 = Rate excludes VAT. Rate includes a fuel surcharge, but excludes taxes, duties and other charges that may apply to the shipment. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Description of Disclaimer. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: Disclaimer - description: Container to hold Disclaimer message applicable to taxes and charges. - Available only when tax information is requested. - PICKUPPolDivRequestWrapper: - xml: - name: PickupGetPoliticalDivision1ListRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupGetPoliticalDivision1ListRequest - properties: - PickupGetPoliticalDivision1ListRequest: - "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListRequest" - PICKUPPolDivResponseWrapper: - xml: - name: PickupGetPoliticalDivision1ListResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupGetPoliticalDivision1ListResponse - properties: - PickupGetPoliticalDivision1ListResponse: - "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListResponse" - PickupGetPoliticalDivision1ListRequest: - type: object - required: - - Request - - CountryCode - properties: - Request: - "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListRequest_Request" - CountryCode: - description: Specifies the country for which the list of Political Division - 1 will be returned if available. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: PickupGetPoliticalDivision1ListRequest - maximum: 1 - description: This request is for client to get a list of valid Political Division - 1s/State field for a specific country or territory - PickupGetPoliticalDivision1ListRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Common element for all services - maximum: 1 - PickupGetPoliticalDivision1ListResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListResponse_Response" - PoliticalDivision1: - description: The Political Division 1/State Field. - minLength: 1 - maxLength: 50 - type: array - items: - type: string - xml: - name: PickupGetPoliticalDivision1ListResponse - description: The response for getting a list of valid Political Division 1 or - State field in the specified country or territory. - maximum: 1 - PickupGetPoliticalDivision1ListResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container. - maximum: 1 - PICKUPServCenterRequestWrapper: - xml: - name: PickupGetServiceCenterFacilitiesRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupGetServiceCenterFacilitiesRequest - properties: - PickupGetServiceCenterFacilitiesRequest: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest" - PICKUPServCenterResponseWrapper: - xml: - name: PickupGetServiceCenterFacilitiesResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupGetServiceCenterFacilitiesResponse - properties: - PickupGetServiceCenterFacilitiesResponse: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse" - PickupGetServiceCenterFacilitiesRequest: - type: object - required: - - Locale - - Request - - PickupPiece - properties: - Request: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_Request" - PickupPiece: - items: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_PickupPiece" - OriginAddress: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_OriginAddress" - 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 - on this locale. Locale is required if PoximityIndicator is present for - Drop Off facilities." - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - ProximitySearchIndicator: - description: Proximity Indicator. Indicates the user requested the proximity search for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday locations for the origin address and/or the airport code, and the sort code for destination address. - maximum: 1 - type: string - xml: - name: PickupGetServiceCenterFacilitiesRequest - maximum: 1 - description: This request is to retrieve UPS Facility location information including - location address, phone number, SLIC, and hours of operation for pick-up and - drop-off requests - PickupGetServiceCenterFacilitiesRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Container for the Request. - maximum: 1 - PickupGetServiceCenterFacilitiesRequest_PickupPiece: - type: object - maximum: 1 - required: - - ServiceCode - - ContainerCode - properties: - ServiceCode: - description: |- - The service code. - 96 = WWEF Required for WWEF shipments. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - ContainerCode: - description: |- - The container type - 03 = PALLET Required for WWEF shipments. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: PickupPiece - description: Pickup Piece Container. - PickupGetServiceCenterFacilitiesRequest_OriginAddress: - type: object - maximum: 1 - properties: - StreetAddress: - description: Indicates the address of the shipper to allow for the nearest - Drop off facility Search. Conditionally required if proximitySearchIndicator - is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 73 - City: - description: Indicates the address of the shipper to allow for the nearest - Drop off facility Search Conditionally required if proximitySearchIndicator - is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: Indicates the address of the shipper to allow for the nearest - Drop off facility Search. Conditionally required if proximitySearchIndicator - is present and if country or territory is US/CA/IE/HK. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Indicates the address of the shipper to allow for the nearest - Drop off facility Search Conditionally required if proximitySearchIndicator - is present and if country or territory has postal code.It does not apply - to non-postal countries such as IE and HK. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: Indicates the address of the shipper to allow for the nearest - Drop off facility Search - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - 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. - OriginAddress_OriginSearchCriteria: - type: object - maximum: 1 - properties: - SearchRadius: - description: |- - Search Request range. Valied values: - - 1 to 200 - - Default: 200 - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - DistanceUnitOfMeasure: - description: 'Unit of Measure Required if ProximitySearchIndicator is present. - Example: MI or KM' - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - MaximumLocation: - description: |- - Maximum Number of locations. Valied values: - - 1 to 100 - - Default: 100 - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: OriginSearchCriteria - required: - - DistanceUnitOfMeasure - description: Origin Search Criteria Container Required if Proximity SearchIndicator - is present. - PickupGetServiceCenterFacilitiesRequest_DestinationAddress: - type: object - maximum: 1 - properties: - City: - description: Indicates the address of the consignee to allow for the nearest - Pickup facility Search. Required for non-postal country Ireland (IE). - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: |- - Indicates the address of the consignee to allow for the nearest Pickup facility Search. - 1 = District code for Hong Kong (HK) - 2 = County for Ireland (IE) - 3 = State or province for all the postal countries Required for non-postal countries including HK and IE. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: 'Indicates the address of the consignee to allow for the nearest - Pickup facility Search It does not apply to non-postal countries. Example: - IE and HK.' - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: The pickup country or territory code as defined by ISO-3166. - Please check check separate pickup country or territory list to find out - all the pickup eligible countries. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - xml: - name: DestinationAddress - required: - - CountryCode - description: DestinationAddress container. Conditionally required for pickup - location search. - PickupGetServiceCenterFacilitiesResponse: - type: object - required: - - Response - - ServiceCenterLocation - properties: - Response: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_Response" - ServiceCenterLocation: - "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_ServiceCenterLocation" - xml: - name: PickupGetServiceCenterFacilitiesResponse - description: Returns service center location information for Origin UPS Facilities - and Destination Facilities - maximum: 1 - PickupGetServiceCenterFacilitiesResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Container for response. - maximum: 1 - PickupGetServiceCenterFacilitiesResponse_ServiceCenterLocation: - type: object - properties: - DropOffFacilities: - type: array - items: - "$ref": "#/components/schemas/ServiceCenterLocation_DropOffFacilities" - PickupFacilities: - "$ref": "#/components/schemas/ServiceCenterLocation_PickupFacilities" - xml: - name: ServiceCenterLocation - description: Locations of the nearest Service Center for Dropoff and Pickup - maximum: 1 - ServiceCenterLocation_DropOffFacilities: - type: object - maximum: 1 - required: - - Timezone - - Type - - Address - - SLIC - - Phone - - OriginOrDestination - - Fax - - Name - properties: - Name: - description: Name of the Facility. - maximum: 1 - type: string - Address: - "$ref": "#/components/schemas/DropOffFacilities_Address" - SLIC: - description: SLIC code for the UPS Drop off facility. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - Type: - description: FRT for Freight or PKG for Package - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Timezone: - description: |- - Facility's Timezone. Format: - - America/New_York - - Asia/Hong_Kong - - Europe/London - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Phone: - description: Phone Number of the Drop off Facility - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - Fax: - description: Drop off Facilities Fax Number - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - FacilityTime: - "$ref": "#/components/schemas/DropOffFacilities_FacilityTime" - OriginOrDestination: - description: Type of Facility. - maximum: 1 - type: string - LocalizedInstruction: - type: array - items: - "$ref": "#/components/schemas/DropOffFacilities_LocalizedInstruction" - Distance: - "$ref": "#/components/schemas/DropOffFacilities_Distance" - xml: - name: DropOffFacilities - description: Returns information for DropOff Facilities. This includes name - of facility, address, business hours, and SLIC. - DropOffFacilities_Address: - type: object - maximum: 1 - required: - - AddressLine - - StateProvince - - ResidentialIndicator - - PostalCode - - City - - CountryCode - properties: - AddressLine: - description: Address Line of the Facility. - maximum: 3 - type: string - oneOf: - - items: - type: string - type: array - - type: string - City: - description: Facilities City. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: Facility state or province code. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Facility Postal Code. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - CountryCode: - description: UPS Drop Off facility country or territory code. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - ResidentialIndicator: - description: "Indicates if the pickup address is a residential place or - not. \nValid Values:\nY = Residential address\nN = Non-residential (Commercial) - address (default)" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: Address - description: Address of the facility. - DropOffFacilities_FacilityTime: - type: object - required: - - DayOfWeek - properties: - DayOfWeek: - type: array - items: - "$ref": "#/components/schemas/FacilityTime_DayOfWeek" - xml: - name: FacilityTime - description: Facility Time Container - maximum: 1 - FacilityTime_DayOfWeek: - type: object - maximum: 1 - required: - - OpenHours - - Day - - CloseHours - properties: - Day: - description: Day of the week. Mon-Sun - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - EarliestDropOfforPickup: - description: Earliest time that a customer can drop-off a package. - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - LatestDropOfforPickup: - description: Latest time that a customer can drop-off a package. - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - OpenHours: - description: |- - Facility Open Hours. The latest local open time. Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - CloseHours: - description: |- - Facility Close Hours. The latest local close time. Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - PrepTime: - description: Time required by the facility to prepare your shipment for movement - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - LastDrop: - description: Cut-off time for drop off that day. - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - xml: - name: DayOfWeek - description: Facility Hours of Operation Container - DropOffFacilities_LocalizedInstruction: - type: object - maximum: 1 - properties: - Locale: - description: 'Locale. Example: en_US' - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - Last50ftInstruction: - description: |- - Last 50ft instructions that relates to an available facility and depend on the locale passing in request. - Last 50 feet instruction in the language asked in request or the English for that country. - maximum: 1 - type: string - minLength: 1 - maxLength: 750 - xml: - name: LocalizedInstruction - description: Localized Instruction Container. Localized Instructions will be - returned for drop off location search by proximity order. - DropOffFacilities_Distance: - type: object - maximum: 1 - properties: - Value: - description: |- - Distance from origin address. Distance based on distance UOM in request. - - Numeric value up to 200 and .2 decimal positions. Distance will be retuned for drop off location search by proximity order. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - UnitOfMeasurement: - description: |- - Unit Of Measure. - Example: MI or KM - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: Distance - description: Distance from origin Distance will be retuned for drop off location search by proximity order. - ServiceCenterLocation_PickupFacilities: - type: object - maximum: 1 - required: - - Timezone - - Type - - Address - - SLIC - - Phone - - Fax - - Name - properties: - Name: - description: Name of the facility - maximum: 1 - type: string - Address: - "$ref": "#/components/schemas/PickupFacilities_Address" - SLIC: - description: SLIC code for the UPS Pickup facility - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - Type: - description: Freight or Package. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Timezone: - description: |- - Facility's Timezone. Format: - - America/New_York - - Asia/Hong_Kong - - Europe/London - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Phone: - description: Phone Number of the Pickup Facility - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - Fax: - description: Pickup Facilities Fax Number - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - FacilityTime: - "$ref": "#/components/schemas/PickupFacilities_FacilityTime" - AirportCode: - 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" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: PickupFacilities - description: Returns information for Pickup Facilities. This includes name of - facility, address, and business hours. - PickupFacilities_Address: - type: object - maximum: 1 - required: - - AddressLine - - StateProvince - - ResidentialIndicator - - PostalCode - - City - - CountryCode - properties: - AddressLine: - description: Address Line of the Facility. - maximum: 1 - type: string - minLength: 1 - maxLength: 73 - City: - description: Facilities City. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StateProvince: - description: Facility state or province code. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - PostalCode: - description: Facility Postal Code. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - CountryCode: - description: UPS Pickup facility country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ResidentialIndicator: - description: |- - Indicates if the pickup location is commerical or residential. - Valid values: - Y = Residential address - N = Non-residential (Commercial) address (default) - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - xml: - name: Address - description: Address of the facility - PickupFacilities_FacilityTime: - type: object - required: - - DayOfWeek - properties: - DayOfWeek: - type: array - items: - "$ref": "#/components/schemas/PickupFacilities_FacilityTime_DayOfWeek" - xml: - name: FacilityTime - description: Facility Time Container - maximum: 1 - PickupFacilities_FacilityTime_DayOfWeek: - type: object - maximum: 1 - required: - - OpenHours - - Day - - CloseHours - properties: - Day: - description: Day of the week. Mon-Sun - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - EarliestDropOfforPickup: - description: Earliest time that a customer can pick up a package. - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - LatestDropOfforPickup: - description: Latest time that a customer can pick up a package. - maximum: 1 - type: string - minLength: 10 - maxLength: 10 - OpenHours: - description: |- - Facility Open Hours. The latest local open time. Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - CloseHours: - description: |- - Facility Close Hours. The latest local close time. Format: HHmm - - Hour: 0-23 - - Minute: 0-59 - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - PrepTime: - description: Preparation time for hold for pickup Conditionally required if request is for hold for pickup. - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - LastDrop: - description: Latest time a package, requiring preparation can be dropped off (Close time - Prep time). - maximum: 1 - type: string - minLength: 20 - maxLength: 20 - xml: - name: DayOfWeek - description: Facility Hours of Operation Container - PICKUPPendingRequestWrapper: - xml: - name: PickupPendingStatusRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupPendingStatusRequest - properties: - PickupPendingStatusRequest: - "$ref": "#/components/schemas/PickupPendingStatusRequest" - PICKUPPendingResponseWrapper: - xml: - name: PickupPendingStatusResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PickupPendingStatusResponse - properties: - PickupPendingStatusResponse: - "$ref": "#/components/schemas/PickupPendingStatusResponse" - PickupPendingStatusRequest: - type: object - required: - - Request - - PickupType - - AccountNumber - properties: - Request: - "$ref": "#/components/schemas/PickupPendingStatusRequest_Request" - PickupType: - description: |- - Specify the type of pending pickup. - 01 = On-Call Pickup - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - AccountNumber: - description: The specific account number belongs to the shipper - maximum: 1 - type: string - minLength: 6 - maxLength: 10 - xml: - name: PickupPendingStatusRequest - maximum: 1 - description: This request is used to get the pending pickup status. - PickupPendingStatusRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Common element for all services. - maximum: 1 - PickupPendingStatusResponse: - type: object - required: - - Response - - PendingStatus - properties: - Response: - "$ref": "#/components/schemas/PickupPendingStatusResponse_Response" - PendingStatus: - type: array - items: - "$ref": "#/components/schemas/PickupPendingStatusResponse_PendingStatus" - xml: - name: PickupPendingStatusResponse - description: The response of the pending status for on-callpickup. - maximum: 1 - PickupPendingStatusResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - type: array - items: - "$ref": "#/components/schemas/Response_Alert" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Response Container. - maximum: 1 - PickupPendingStatusResponse_PendingStatus: - type: object - maximum: 1 - required: - - ServiceDate - - PickupType - - PRN - - PickupStatusMessage - properties: - PickupType: - description: |- - Specify the type of pending pickup. - - 01 = on-callPickup - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ServiceDate: - description: |- - Local service date. Format: yyyyMMdd - - yyyy = Year applicable - - MM = 01-12 - - dd = 01-31 - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - PRN: - description: Returned PRN - maximum: 1 - type: string - minLength: 11 - maxLength: 11 - GWNStatusCode: - description: Status code for Smart Pickup. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - OnCallStatusCode: - description: A unique string identifier to identify a success pre-notification - processing. Only available if end result is success. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - PickupStatusMessage: - description: | - The status for on-callpickup. - - PickupPendingStatusResponse will only display incomplete status for today and tomorrow only. - - 002 and 012 are the most common responses. - - 001 = Received at dispatch - - 002 = Dispatched to driver - - 003 = Order successfully completed - - 004 = Order unsuccessfully completed - - 005 = Missed commit – Updated ETA supplied by driver - - 007 = Cancelled - - 008 = Order has invalid order status - - 012 = Your pickup request is being processed - maximum: 1 - type: string - minLength: 1 - maxLength: 500 - BillingCode: - description: |- - Pickup billing classification for on call - - 01 = Regular - - 02 = Return - - 03 = Alternate Address (Not supported for now) - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ContactName: - description: on-callpickup contact name - maximum: 1 - type: string - minLength: 1 - maxLength: 22 - ReferenceNumber: - description: Customer provided reference number for on-call pickup - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PendingStatus - description: The result of retrieving pending pickups. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +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 + - Appendix + - Errors + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/shipments/{version}/pickup/{pickuptype}": + post: + description: Using the POST operation of the pickuptype endpoint within the Pickup API, users can request rates for UPS on-demand package pickup. The endpoint allows users to specify pickup details like address, date/time, and other options, and returns pricing information for booking that pickup. + summary: Pickup Rate + tags: + - Pickup + security: + - OAuth2: [] + operationId: Pickup Rate + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of the API. + + Valid values: + - v2409 + required: true + - in: path + name: pickuptype + schema: + type: string + minimum: 1 + description: |- + Type of pickup. Valid values: + oncall + smart + both. Length 6 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPRequestWrapper" + examples: + json: + summary: A sample JSON request(Standard Example) + value: + PickupRateRequest: + PickupAddress: + AddressLine: 315 Saddle Bridge Drive + City: Allendale + StateProvince: NJ + PostalCode: '07401' + CountryCode: US + ResidentialIndicator: Y + AlternateAddressIndicator: N + ServiceDateOption: '02' + PickupDateInfo: + CloseTime: '2000' + ReadyTime: '900' + PickupDate: '20160405' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + 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 + tags: + - Pickup + security: + - OAuth2: [] + operationId: Pickup Pending Status + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: header + name: AccountNumber + schema: + type: string + description: "The specific account number that belongs to the \nshipper.Length + 6 or 10" + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of API + + Valid values: + - v2409 + required: true + - in: path + name: pickuptype + schema: + type: string + minimum: 1 + description: |- + Type of pickup. Valid values: + oncall + smart + both. Length 6 + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPPendingResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/shipments/{version}/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. + summary: Pickup Cancel + tags: + - Pickup + security: + - OAuth2: [] + operationId: Pickup Cancel + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: header + name: Prn + schema: + type: string + description: "The pickup equest number (PRN) generated by \nUPS pickup system.\nRequired + if CancelBy = prn.Length 26" + required: false + - in: path + name: CancelBy + schema: + type: string + description: 'Valid Values: 01 = AccountNumber, 02 = PRN' + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of API. + + Valid values: + - v2409 + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPCancelResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/pickupcreation/{version}/pickup": + post: + description: Using the Pickup API, applications can schedule pickups, manage + previously scheduled pickups, or cancel previously scheduled pickups. + summary: Pickup Creation + tags: + - Pickup + security: + - OAuth2: [] + operationId: Pickup Creation + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of the API. + + Valid values: + - v2409 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPCreationRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PickupCreationRequest: + RatePickupIndicator: N + Shipper: + Account: + AccountNumber: ShipperNumber + AccountCountryCode: US + PickupDateInfo: + CloseTime: '1400' + ReadyTime: '0500' + PickupDate: '20221214' + PickupAddress: + CompanyName: Pickup Proxy + ContactName: Pickup Manager + AddressLine: 123 Main Street + Room: R01 + Floor: '2' + City: Allendale + StateProvince: NJ + Urbanization: '' + PostalCode: '07401' + CountryCode: US + ResidentialIndicator: Y + PickupPoint: Lobby + Phone: + Number: '5555555555' + Extension: '911' + AlternateAddressIndicator: Y + PickupPiece: + - ServiceCode: '001' + Quantity: '27' + DestinationCountryCode: US + ContainerCode: '01' + - ServiceCode: '012' + Quantity: '4' + DestinationCountryCode: US + ContainerCode: '01' + TotalWeight: + Weight: '5.5' + UnitOfMeasurement: LBS + OverweightIndicator: N + PaymentMethod: '01' + SpecialInstruction: 'Test ' + ReferenceNumber: CreatePickupRef + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPCreationResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/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. + summary: Pickup Get Political Division1 List + tags: + - Pickup + security: + - OAuth2: [] + operationId: Pickup Get Political Division1 List + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: true + - in: path + name: version + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of API. + + Valid values: + - v2409 + required: true + - in: path + name: countrycode + schema: + type: string + minimum: 1 + description: "Country or terrirtory for which the list will \nrepresent.Length + 2" + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPPolDivResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/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 + summary: Pickup Get Service Center Facilities + tags: + - Pickup + security: + - OAuth2: [] + operationId: Pickup Get Service Center Facilities + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: version + schema: + type: string + default: v2409 + description: | + Version of API. + + Valid values: + - v2409 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPServCenterRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PickupGetServiceCenterFacilitiesRequest: + PickupPiece: + ServiceCode: '096' + ContainerCode: '03' + DestinationAddress: + City: Allendale + StateProvince: NJ + PostalCode: '07401' + CountryCode: US + ProximitySearchIndicator: '' + Locale: en_HK + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPServCenterResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + delete: + deprecated: true + 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. + summary: Pickup Cancel + tags: + - Pickup + security: + - OAuth2: [] + operationId: Deprecated Pickup Cancel + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: header + name: Prn + schema: + type: string + description: "The pickup equest number (PRN) generated by \nUPS pickup system.\nRequired + if CancelBy = prn.Length 26" + required: false + - in: path + name: CancelBy + schema: + type: string + description: 'Valid Values: 01 = AccountNumber, 02 = PRN' + required: true + - in: path + name: deprecatedVersion + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of API. + + Valid values: + - v2409 + required: true + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPCancelResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/pickupcreation/{deprecatedVersion}/pickup": + post: + deprecated: true + description: Using the Pickup API, applications can schedule pickups, manage + previously scheduled pickups, or cancel previously scheduled pickups. + summary: Pickup Creation + tags: + - Pickup + security: + - OAuth2: [] + operationId: Deprecated Pickup Creation + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: deprecatedVersion + schema: + type: string + minimum: 1 + default: v2409 + description: | + Version of the API. + + Valid values: + - v1 + - v1607 + - v1707 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPCreationRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PickupCreationRequest: + RatePickupIndicator: N + Shipper: + Account: + AccountNumber: ShipperNumber + AccountCountryCode: US + PickupDateInfo: + CloseTime: '1400' + ReadyTime: '0500' + PickupDate: '20221214' + PickupAddress: + CompanyName: Pickup Proxy + ContactName: Pickup Manager + AddressLine: 123 Main Street + Room: R01 + Floor: '2' + City: Allendale + StateProvince: NJ + Urbanization: '' + PostalCode: '07401' + CountryCode: US + ResidentialIndicator: Y + PickupPoint: Lobby + Phone: + Number: '5555555555' + Extension: '911' + AlternateAddressIndicator: Y + PickupPiece: + - ServiceCode: '001' + Quantity: '27' + DestinationCountryCode: US + ContainerCode: '01' + - ServiceCode: '012' + Quantity: '4' + DestinationCountryCode: US + ContainerCode: '01' + TotalWeight: + Weight: '5.5' + UnitOfMeasurement: LBS + OverweightIndicator: N + PaymentMethod: '01' + SpecialInstruction: 'Test ' + ReferenceNumber: CreatePickupRef + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PICKUPCreationResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + PICKUPRequestWrapper: + xml: + name: PickupRateRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupRateRequest + properties: + PickupRateRequest: + "$ref": "#/components/schemas/PickupRateRequest" + PICKUPResponseWrapper: + xml: + name: PickupRateResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupRateResponse + properties: + PickupRateResponse: + "$ref": "#/components/schemas/PickupRateResponse" + PickupRateRequest: + type: object + required: + - ServiceDateOption + - PickupAddress + - Request + - AlternateAddressIndicator + properties: + Request: + "$ref": "#/components/schemas/PickupRateRequest_Request" + ShipperAccount: + "$ref": "#/components/schemas/PickupRateRequest_ShipperAccount" + 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 + = Original pickup address (default)" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ServiceDateOption: + description: |- + Indicates the pickup timeframe. + - 01 = Same-Day Pickup + - 02 = Future-Day Pickup + - 03 = A Specific-Day Pickup + + If 03 is selected, then PickupDate, EarliestReadyTime, and LatestClosetime must be specified. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PickupDateInfo: + "$ref": "#/components/schemas/PickupRateRequest_PickupDateInfo" + RateChartType: + description: | + Rate Type with which pickup is rated. Possible RateChart values for different regions will be: + + US 48 origin: + 1 – Daily Rates + 3 – Standard List Rates + 4 – Retail Rates. + + Alaska/Hawaii origin: + 1 – Daily Rates + 3 – Standard List Rates + 4 – Retail Rates. + + All Other origins: + 1 – Rates + 5 - Regional Rates + 6 - General List Rates. + + 3 and 4 do not apply + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TaxInformationIndicator: + description: |- + Indicates whether to return detailed taxes for on-callpickups. + Valid values: + - Y = Rate this pickup with taxes + - N = Do not rate this pickup with taxes (default) + maximum: 1 + type: string + minLength: 1 + 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 + promo discount\nN = Do not rate this pickup with user level promo discount(default)" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: PickupRateRequest + maximum: 1 + description: This request is used to rate an on-callpickup. + PickupRateRequest_Request: + type: object + properties: + RequestOption: + description: Not used by pick up + type: string + minLength: 1 + maxLength: 15 + SubVersion: + description: "When UPS introduces new elements in the response that are + not associated with new request elements, Subversion is used. This ensures + backward compatibility.\n\nTo get such elements you need to have the right + Subversion. The value of the subversion is explained in the Response element + Description. 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: + 1601 = 2016 January" + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + maximum: 1 + description: Common element for all services + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information that is echoed back during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container + PickupRateRequest_ShipperAccount: + type: object + maximum: 1 + required: + - AccountCountryCode + - AccountNumber + properties: + AccountNumber: + description: UPS account number. Shipper's (requester of the pickup) UPS + account number + maximum: 1 + type: string + minLength: 6 + maxLength: 10 + AccountCountryCode: + description: |- + Country code as defined by ISO-3166. + Refer to Country or Territory Codes in the Appendix for valid values. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipperAccount + description: Shipper account information. + PickupRateRequest_PickupAddress: + type: object + maximum: 1 + properties: + AddressLine: + description: "Detailed street address. \nFor Jan. 2010 release, only one + AddressLine is allowed." + maximum: 1 + type: string + minLength: 1 + maxLength: 73 + City: + description: City or equivalent + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: State province code or equivalent + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Postal code for countries with postal codes. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: "Upper-case two-char long country code as defined by ISO-3166. + \nRefer to Country or Territory Codes in the Appendix for valid values." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ResidentialIndicator: + description: |- + Indicates if the pickup address is commerical or residential. + Valid values: + Y = Residential address + N = Non-residential (Commercial) address (default) + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: PickupAddress + required: + - ResidentialIndicator + - PostalCode + - City + - CountryCode + description: The address to pickup the packages + PickupRateRequest_PickupDateInfo: + type: object + maximum: 1 + required: + - ReadyTime + - CloseTime + - PickupDate + properties: + CloseTime: + description: |- + The latest local close time. Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + ReadyTime: + description: |- + The earliest local ready Time. Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + PickupDate: + description: |- + The specific local pickup date. Format: yyyyMMdd + - yyyy = Year Applicable + - MM = 01-12 + - dd = 01-31 + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: PickupDateInfo + description: "Required if the ServiceDateOption is: \n03 A Specific-Day Pickup" + PickupRateResponse: + type: object + required: + - Response + - RateResult + properties: + Response: + "$ref": "#/components/schemas/PickupRateResponse_Response" + 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: + - Y = WST + - N = Non-WST + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + WeekendServiceTerritory: + "$ref": "#/components/schemas/PickupRateResponse_WeekendServiceTerritory" + xml: + name: PickupRateResponse + maximum: 1 + description: The response of rating on-callpickup. + PickupRateResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Identifies the success of the transaction. + - 1=Success + - 0=failed + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response Status Container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information that is echoed back during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + PickupRateResponse_RateResult: + type: object + properties: + Disclaimer: + "$ref": "#/components/schemas/RateResult_Disclaimer" + RateType: + description: |- + Indicates the pickup is rated as same-day or future-day pickup. + - SD = Same-day Pickup + - FD = Future-day Pickup + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + CurrencyCode: + description: IATA currency codes for the pickup charge. Such as USD + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + ChargeDetail: + type: array + items: + "$ref": "#/components/schemas/RateResult_ChargeDetail" + TaxCharges: + type: array + items: + "$ref": "#/components/schemas/RateResult_TaxCharges" + TotalTax: + description: The sum of all taxes. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + GrandTotalOfAllCharge: + description: The grand total of each charge and applied tax. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + GrandTotalOfAllIncentedCharge: + description: The grand total of each incented charge and applied tax. Only + present if 1. UserLevelDiscountIndicator = Y and User Level Promotion + is applied to the pickup or 2 .if any incentive rate is applied to the + pickup and SubVersion on the request is greater than or equal to 1707. + maximum: 1 + type: string + minLength: 2 + maxLength: 8 + PreTaxTotalCharge: + description: Total of charges before taxes. Only present when tax details + requested in input. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + PreTaxTotalIncentedCharge: + description: Total of incented charges before taxes. Only present if 1. + UserLevelDiscountIndicator = Y and User Level Promotion is applied to + the pickup or 2 .if any incentive rate is applied to the pickup and SubVersion + on the request is greater than or equal to 1707. + maximum: 1 + type: string + minLength: 2 + maxLength: 8 + xml: + name: RateResult + maximum: 1 + required: + - CurrencyCode + description: The result of rating an on-callpickup. + RateResult_ChargeDetail: + type: object + maximum: 1 + required: + - ChargeCode + - ChargeAmount + properties: + ChargeCode: + description: |- + Indicates the general charge type + - A = ACCESSORIAL TYPE + - B = BASE CHARGE TYPE + - S = SURCHARGE TYPE + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ChargeDescription: + description: |- + Description of each charge.The possible descriptions are: + - BASE CHARGE + - EXTENDED AREA SURCHARGE + - FUEL SURCHARGE + - REMOTE AREA SURCHARGE + - RESIDENTIAL SURCHARGE + - SATURDAY ON-CALL STOP CHARGE + maximum: 1 + type: string + minLength: 1 + maxLength: 100 + ChargeAmount: + description: Monetary value of the charge. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + IncentedAmount: + description: Monetary value of the incented charge. Only present if 1. UserLevelDiscountIndicator + = Y and User Level Promotion is applied to the pickup or 2 .if any incentive + rate is applied to the pickup and SubVersion on the request is greater + than or equal to 1707. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + TaxAmount: + description: Monetary value of the tax if apply. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: ChargeDetail + description: Detailed charges. + RateResult_TaxCharges: + type: object + maximum: 1 + required: + - Type + - MonetaryValue + properties: + Type: + 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 + type: string + minLength: 3 + maxLength: 3 + MonetaryValue: + description: Monetary value of the tax. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: TaxCharges + description: Container to hold taxes when, detailed taxes are request via RateTaxIndicator. + PickupRateResponse_WeekendServiceTerritory: + type: object + maximum: 1 + required: + - SunWST + - SatWST + properties: + SatWST: + 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 2007. Valid Values: + - Y = Saturday WST + - N = Non-Saturday WST + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + SunWST: + description: | + Indicates if the pickup address qualifies for WST (Weekend Service Territory). Returned if the pickup date is Sunday and subversion greater or equal to 2007. Valid Values: + - Y = Sunday WST + - N = Non-Sunday WST + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: WeekendServiceTerritory + description: WeekendServiceTerritory Container.Returned if the subversion greater + or equal to 2007. + PICKUPCancelRequestWrapper: + xml: + name: PickupCancelRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupCancelRequest + properties: + PickupCancelRequest: + "$ref": "#/components/schemas/PickupCancelRequest" + PICKUPCancelResponseWrapper: + xml: + name: PickupCancelResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupCancelResponse + properties: + PickupCancelResponse: + "$ref": "#/components/schemas/PickupCancelResponse" + PickupCancelRequest: + type: object + required: + - CancelBy + - Request + properties: + Request: + "$ref": "#/components/schemas/PickupCancelRequest_Request" + CancelBy: + description: |- + Cancel pickup by Pickup Request Number (PRN). + - 01= Account Number + - 02 = PRN + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + PRN: + description: |- + The pickup request number (PRN) generated by UPS pickup system. + Required if CancelBy = 02 + maximum: 1 + type: string + minLength: 11 + maxLength: 11 + xml: + name: PickupCancelRequest + maximum: 1 + description: This request is to cancel an on-callpickup. + PickupCancelRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Request Container. + maximum: 1 + PickupCancelResponse: + type: object + required: + - Response + - PickupType + properties: + Response: + "$ref": "#/components/schemas/PickupCancelResponse_Response" + PickupType: + description: |- + The type of pickup that has been cancelled. + - 01 = On-Call Pickup + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + GWNStatus: + "$ref": "#/components/schemas/PickupCancelResponse_GWNStatus" + xml: + name: PickupCancelResponse + maximum: 1 + description: The response for cancelling pickup(s) + PickupCancelResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container + maximum: 1 + PickupCancelResponse_GWNStatus: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + The status code defined by operation system. + - 001 = User Triggered + - 002 = User Cancelled + - 003 = Completed + - 004 = Missed + - 005 = Not In + - 006 = Not Ready + - 007 = Closed + - 008 = Cancelled By Driver + - 999 = Unknown + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Please refer to /PickupPendingStatusResponse/PendingStatus/PickupStatusMessage + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: GWNStatus + description: The status of Smart Pickup that has been cancelled. + PICKUPCreationRequestWrapper: + xml: + name: PickupCreationRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupCreationRequest + properties: + PickupCreationRequest: + "$ref": "#/components/schemas/PickupCreationRequest" + PICKUPCreationResponseWrapper: + xml: + name: PickupCreationResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupCreationResponse + properties: + PickupCreationResponse: + "$ref": "#/components/schemas/PickupCreationResponse" + PickupCreationRequest: + type: object + required: + - PickupDateInfo + - PickupAddress + - Request + - PaymentMethod + - PickupPiece + - RatePickupIndicator + - AlternateAddressIndicator + properties: + Request: + "$ref": "#/components/schemas/PickupCreationRequest_Request" + RatePickupIndicator: + 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 + minLength: 1 + maxLength: 1 + RateChartType: + description: | + Rate Type with which pickup is rated. Possible RateChart values for different regions will be: + + US 48 origin: + - 1 – Daily Rates + - 3 – Standard List Rates + - 4 – Retail Rates. + + Alaska/Hawaii origin: + - 1 – Daily Rates + - 3 – Standard List Rates + - 4 – Retail Rates. + + All Other origins: + - 1 – Rates + - 5 - Regional Rates + - 6 - General List Rates. + + 3 and 4 do not apply + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TaxInformationIndicator: + description: "Indicates whether to return detailed taxes for the on-callpickups. + \nValid values:\nY = Rate this pickup with taxes\nN = Do not rate this + pickup with taxes (default)" + maximum: 1 + type: string + minLength: 1 + 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 + 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" + PickupDateInfo: + "$ref": "#/components/schemas/PickupCreationRequest_PickupDateInfo" + 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 + = Original pickup address (default)" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PickupPiece: + type: array + items: + "$ref": "#/components/schemas/PickupCreationRequest_PickupPiece" + 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 + required for WWEF service." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TrackingData: + type: array + items: + "$ref": "#/components/schemas/PickupCreationRequest_TrackingData" + 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 + 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 + the pickup packages.\n- If 05 is selected, then the shipper will pay for + the pickup packages with a check or money order." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + SpecialInstruction: + description: Special handling instruction from the customer + maximum: 1 + type: string + minLength: 1 + maxLength: 57 + ReferenceNumber: + description: Information entered by a customer for Privileged reference + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + 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 + - international\n03 - transborder" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + CashType: + description: "Describes the type of cash funds that the driver will collect.\nApplicable + to the following countries:\nBE,FR,DE,IT,MX,NL,PL,ES,GB\nValid values: + \n01 - Pickup only (default)\n02 - Transportation only\n03 - Pickup and + Transportation" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ShippingLabelsAvailable: + description: This element should be set to "Y" in the request to indicate that user has pre-printed shipping labels for all the packages, otherwise this will be treated as false. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Notification: + "$ref": "#/components/schemas/PickupCreationRequest_Notification" + xml: + name: PickupCreationRequest + maximum: 1 + description: This request is for scheduling an on-call pickup + PickupCreationRequest_Request: + type: object + maximum: 1 + properties: + SubVersion: + description: "When UPS introduces new elements in the response that are + not associated with new request elements, Subversion is used. This ensures + backward compatibility.\n\nTo get such elements you need to have the right + 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: + 1601 = 2016 January" + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Common element for all services + PickupCreationRequest_Shipper: + type: object + properties: + Account: + "$ref": "#/components/schemas/Shipper_Account" + ChargeCard: + "$ref": "#/components/schemas/Shipper_ChargeCard" + xml: + name: Shipper + 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 + any other payment method. However, it is highly recommended to provide if + available." + maximum: 1 + Shipper_Account: + type: object + maximum: 1 + required: + - AccountCountryCode + - AccountNumber + properties: + AccountNumber: + description: UPS account number. Shipper's (requester of the pickup) UPS + account number + maximum: 1 + type: string + minLength: 6 + maxLength: 10 + AccountCountryCode: + description: |- + Country or territory code as defined by ISO-3166. + Refer to Country or Terriotry Codes in the Appendix for valid values. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: Account + description: "Shipper account information. \nMust provide when choose to pay + the pickup by shipper account number" + Shipper_ChargeCard: + type: object + maximum: 1 + properties: + CardHolderName: + description: Charge card holder name. If the name is not provided, defaults + to "No Name Provided". + maximum: 1 + type: string + minLength: 1 + maxLength: 22 + CardType: + description: |- + Charge card type. Valid values: + - 01 = American Express + - 03 = Discover + - 04 = Mastercard + - 06 = VISA Discover card Pickup country US only. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + CardNumber: + description: Charge card number. For Privileged clients, this element must + be tokenized card number. + maximum: 1 + type: string + minLength: 9 + maxLength: 16 + ExpirationDate: + description: |- + Credit card expiration date. + Format: yyyyMM + yyyy = 4 digit year, valid value current year - 10 years. + MM = 2 digit month, valid values 01-12 + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + SecurityCode: + description: "Three or four digits that can be found either on top of credit + card number or on the back of credit card. \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" + xml: + name: ChargeCard + required: + - CardNumber + - ExpirationDate + - CardType + - CardAddress + - SecurityCode + description: Container for Charge Card payment method Required if Payment method + is 03. Credit/Charge card payment is valid for US, CA, PR and GB origin pickups. + ChargeCard_CardAddress: + type: object + maximum: 1 + properties: + AddressLine: + description: Address Lines of the credit card billing address. Max of three + address lines can be provided. + type: array + items: + type: string + maximum: 3 + minLength: 1 + maxLength: 35 + City: + description: Charge card billing city + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: Charge card billing State province code + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Charge card billing address postal code. This is a required + field for postal countries. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: |- + Charge card billing address country or territory code defined by ISO-3166. + + Upper-case two letter string. For Discover card it should be US. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: CardAddress + required: + - CountryCode + description: Container to hold the Charge card address. + PickupCreationRequest_PickupDateInfo: + type: object + maximum: 1 + required: + - ReadyTime + - CloseTime + - PickupDate + properties: + CloseTime: + description: | + Pickup location's local close time. + - User provided Close Time must be later than the Earliest Allowed Customer Close Time. + - Earliest Allowed Customer Close Time is defined by UPS pickup operation system. + - CloseTime minus ReadyTime must be greater than the LeadTime. + - LeadTime is determined by UPS pickup operation system. LeadTime is the minimum amount of time UPS requires between customer's request for a pickup and driver arriving at the location for the pickup. + + Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + 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 + 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 + than current local time, UPS uses the current local time as the ReadyTime. + \ Format: HHmm\nHour: 0-23\nMinute: 0-59" + type: string + PickupDate: + description: | + Local pickup date of the location. Format: yyyyMMdd + - yyyy = Year Appliable + - MM = 01–12 + - dd = 01–31 + maximum: 1 + type: string + minLength: 4 + maxLength: 4 + xml: + name: PickupDateInfo + description: The container of desired pickup date + PickupCreationRequest_PickupAddress: + type: object + maximum: 1 + required: + - CompanyName + - AddressLine + - ResidentialIndicator + - Phone + - City + - CountryCode + - ContactName + properties: + CompanyName: + description: Company name + maximum: 1 + type: string + minLength: 1 + maxLength: 27 + ContactName: + description: Name of contact person + maximum: 1 + type: string + minLength: 1 + maxLength: 22 + AddressLine: + description: Detailed street address. For Jan. 2010 release, only one AddressLine + is allowed + type: array + items: + maximum: 1 + type: string + minLength: 1 + maxLength: 73 + Room: + description: Room number + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + Floor: + description: Floor number + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + City: + description: City or equivalent + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: State or province for postal countries; county for Ireland + (IE) and district code for Hong Kong (HK) + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Urbanization: + description: |- + - Barrio for Mexico (MX) + - Urbanization for Puerto Rico (PR) + - Shire for United Kingdom (UK) + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Postal code or equivalent for postal countries + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: "The pickup country or territory code as defined by ISO-3166. + \nRefer to Country or Territory Codes in the Appendix for valid values." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ResidentialIndicator: + description: "Indicates if the pickup address is commercial or residential. + \nValid values:\nY = Residential address\nN = Non-residential (Commercial) + address (default)" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PickupPoint: + description: The specific spot to pickup at the address. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + Phone: + "$ref": "#/components/schemas/PickupAddress_Phone" + xml: + name: PickupAddress + description: The container of pickup address. + PickupAddress_Phone: + type: object + maximum: 1 + required: + - Number + properties: + Number: + description: Phone number + maximum: 1 + type: string + minLength: 1 + maxLength: 25 + Extension: + description: Phone extension + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: Phone + description: Contact telephone number. + PickupCreationRequest_PickupPiece: + type: object + maximum: 1 + required: + - ServiceCode + - DestinationCountryCode + - Quantity + - ContainerCode + properties: + ServiceCode: + description: Refer to Service Codes in the Appendix for valid values. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Quantity: + description: "Number of pieces to be picked up. \nMax per service: 999" + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + DestinationCountryCode: + description: |- + The destination country code as defined by ISO-3166. + Refer to Country or Territory Codes in the Appendix for valid values. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ContainerCode: + description: | + Container type. Valid values: + - 01 = PACKAGE + - 02 = UPS LETTER + - 03 = PALLET + + Note: 03 is used for only WWEF services + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + 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 + exceed 9,999." + PickupCreationRequest_TotalWeight: + type: object + maximum: 1 + required: + - UnitOfMeasurement + - Weight + properties: + Weight: + description: "The weight of the package. \nOne decimal digit is allowed. + Example: 10.9" + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + UnitOfMeasurement: + description: |- + The code representing the unit of measurement associated with the package. + LBS = Pounds + KGS = Kilograms + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: TotalWeight + description: Container for the total weight of all the items. + PickupCreationRequest_TrackingData: + type: object + maximum: 1 + properties: + TrackingNumber: + 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 + type: string + minLength: 18 + maxLength: 18 + xml: + name: TrackingData + description: |- + 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: + type: object + maximum: 3 + required: + - TrackingNumber + properties: + TrackingNumber: + description: Tracking number for shipment packages. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + ReferenceNumber: + description: The reference number associated with the tracking number. + maximum: 3 + type: array + items: + type: string + minLength: 1 + maxLength: 35 + xml: + name: TrackingDataWithReferenceNumber + 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 + container cannot be present at the same time. + PickupCreationRequest_FreightOptions: + type: object + properties: + ShipmentServiceOptions: + "$ref": "#/components/schemas/FreightOptions_ShipmentServiceOptions" + OriginServiceCenterCode: + description: Origin SLIC. This will be obtained from submitting a pickup + service center request. See PickupGetFacilitiesServiceCenterRequest. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + OriginServiceCountryCode: + description: Country or territory of Service Center SLIC chosen to drop + off. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + DestinationAddress: + "$ref": "#/components/schemas/FreightOptions_DestinationAddress" + ShipmentDetail: + "$ref": "#/components/schemas/FreightOptions_ShipmentDetail" + xml: + name: FreightOptions + maximum: 1 + required: + - ShipmentDetail + description: Container will be used to indicate Service options, add optional + Original service center, destination address and shipment details related + to the UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday. + FreightOptions_ShipmentServiceOptions: + type: object + maximum: 1 + properties: + OriginLiftGateIndicator: + description: Presence indicates OriginLiftGateRequiredIndicator is present. Conditionally + requirements. Must not be present if DropOffAtUPSFacilityIndicator is + true + maximum: 1 + type: string + DropoffAtUPSFacilityIndicator: + description: Identifies service center location information for Origin List + of UPS Facilities. + maximum: 1 + type: string + HoldForPickupIndicator: + description: Identifies service center location information for Destination + of UPS Facilities. + maximum: 1 + type: string + xml: + name: ShipmentServiceOptions + description: Supports various optional indicators + FreightOptions_DestinationAddress: + type: object + maximum: 1 + properties: + City: + description: The city of pickup address if available. It is required for + non-postal country Ireland (IE). + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: |- + 1. It means district code for Hong Kong (HK) + 2. It means county for Ireland (IE) + 3. It means state or province for all the postal countries It is required for non-postal countries including HK and IE. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Postal Code for postal countries. It does not apply to non-postal + countries such as IE and HK + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: "The pickup country or territory code as defined by ISO-3166. + \nRefer to Country or Territory Codes in the Appendix for valid values. + \ Upper-case two-letter string." + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + xml: + name: DestinationAddress + required: + - CountryCode + description: Destination Address Container. + FreightOptions_ShipmentDetail: + type: object + maximum: 1 + properties: + HazmatIndicator: + description: Indicates hazardous materials + maximum: 1 + type: string + PalletInformation: + "$ref": "#/components/schemas/ShipmentDetail_PalletInformation" + xml: + name: ShipmentDetail + description: Refers to the ShipmentDetail Container under Freight Options + PickupCreationRequest_Notification: + type: object + properties: + ConfirmationEmailAddress: + description: Email address where the pickup notification is sent. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + UndeliverableEmailAddress: + description: Email address for used exceptions. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: Notification + maximum: 1 + description: Container for pickup notification + ShipmentDetail_PalletInformation: + type: object + properties: + Dimensions: + "$ref": "#/components/schemas/PalletInformation_Dimensions" + xml: + name: PalletInformation + description: Pallet Details. + maximum: 1 + PalletInformation_Dimensions: + type: object + required: + - UnitOfMeasurement + - Length + - Height + - Width + properties: + UnitOfMeasurement: + "$ref": "#/components/schemas/Dimensions_UnitOfMeasurement" + Length: + description: Dimension length of pallet. + maximum: 1 + type: string + Width: + description: Dimension width of pallet. + maximum: 1 + type: string + Height: + description: Dimension height of pallet. + maximum: 1 + type: string + xml: + name: Dimensions + maximum: 1 + description: Dimensions of largest pallet + Dimensions_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + - IN = Inches + - CM = Centimeters + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: See Code above. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: The code representing the unit of measurement associated with the + package. + PickupCreationResponse: + type: object + required: + - Response + - RateStatus + properties: + 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 + already exists for a pickup address/ point. + maximum: 1 + type: string + minLength: 11 + maxLength: 11 + 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: + - Y = WST + - N = Non-WST + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + RateStatus: + "$ref": "#/components/schemas/PickupCreationResponse_RateStatus" + RateResult: + "$ref": "#/components/schemas/PickupCreationResponse_RateResult" + xml: + name: PickupCreationResponse + maximum: 1 + description: The response for scheduling an on-callpickup. + PickupCreationResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container. + maximum: 1 + PickupCreationResponse_WeekendServiceTerritory: + type: object + maximum: 1 + required: + - SunWST + - SatWST + properties: + SatWST: + 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 2007. Valid Values: + - Y = Saturday WST + - N = Non-Saturday WST + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + SunWST: + description: "Indicates if the pickup address qualifies for WST (Weekend Service Territory). Returned if the pickup date is Sunday and subversion greater or equal to 2007. Valid Values: + - Y = Sunday WST + - N = Non-Sunday WST" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: WeekendServiceTerritory + description: WeekendServiceTerritory Container.Returned if the subversion greater + or equal to 2007. + PickupCreationResponse_RateStatus: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + The rating status. + - 01 = Rate available + - 02 = Rate not available + - 03 = Rate not apply + - 04 = Rate not requested + + - If 01 is returned, then OnCallPickupRateResult will also be returned with rate details. + - If 02 is returned, then OnCallPickupRateResult will not be returned. + - If 03 is returned, then OnCallPickupRateResult will not be returned. The rate option is not appliable to this return pickup. The requester will not be charged. + - If 04 is returned, then OnCallPickupRateResult will not be returned. The requester did not ask for rating this on-callpickup. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: The matching description of rating status code (see above). + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: RateStatus + description: The rating result of on-callpickup + PickupCreationResponse_RateResult: + type: object + properties: + Disclaimer: + "$ref": "#/components/schemas/RateResult_Disclaimer" + RateType: + description: |- + Indicates this pickup is rated as same-day or future-day pickup. + - SD = Same-day Pickup + - FD = Future-day Pickup + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + CurrencyCode: + description: IATA currency codes for the pickup charge. Such as USD + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + ChargeDetail: + description: | + Container to hold taxes when, detailed taxes are request via RateTaxIndicator. + + **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" + TaxCharges: + description: | + Container to hold taxes when, detailed taxes are request via RateTaxIndicator. + + **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" + TotalTax: + description: The sum of all taxes. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + GrandTotalOfAllCharge: + description: The grand total of each charge and applied tax. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + GrandTotalOfAllIncentedCharge: + description: The grand total of each incented charge and applied tax. Only + present if 1. UserLevelDiscountIndicator = Y and User Level Promotion + is applied to the pickup or 2 .if any incentive rate is applied to the + pickup and SubVersion on the request is greater than or equal to 1707. + maximum: 1 + type: string + minLength: 2 + maxLength: 8 + PreTaxTotalCharge: + description: Total of charges before taxes. Only present when tax details + requested in input. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + PreTaxTotalIncentedCharge: + description: Total of incented charges before taxes. Only present if 1. + UserLevelDiscountIndicator = Y and User Level Promotion is applied to + the pickup or 2 .if any incentive rate is applied to the pickup and SubVersion + on the request is greater than or equal to 1707. + maximum: 1 + type: string + minLength: 2 + maxLength: 8 + xml: + name: RateResult + maximum: 1 + required: + - GrandTotalOfAllCharge + description: The result of rating on-callpickup. It correlates to rate status + code 01 + RateResult_Disclaimer: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Disclaimer code. Valid values: + - 01 = Taxes are included in the shipping cost and apply to the transportation charges but additional duties/taxes may apply and are not reflected in the total amount due. + - 02 = Additional duties/taxes may apply and are not reflected in the total amount due. + - 03 = Additional duties/taxes may apply and are not reflected in the total amount due. + - 04 = Taxes were unable to be determined and may apply to the shipment. + - 05 = Rate excludes VAT. Rate includes a fuel surcharge, but excludes taxes, duties and other charges that may apply to the shipment. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Description of Disclaimer. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: Disclaimer + description: Container to hold Disclaimer message applicable to taxes and charges. + Available only when tax information is requested. + PICKUPPolDivRequestWrapper: + xml: + name: PickupGetPoliticalDivision1ListRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupGetPoliticalDivision1ListRequest + properties: + PickupGetPoliticalDivision1ListRequest: + "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListRequest" + PICKUPPolDivResponseWrapper: + xml: + name: PickupGetPoliticalDivision1ListResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupGetPoliticalDivision1ListResponse + properties: + PickupGetPoliticalDivision1ListResponse: + "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListResponse" + PickupGetPoliticalDivision1ListRequest: + type: object + required: + - Request + - CountryCode + properties: + Request: + "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListRequest_Request" + CountryCode: + description: Specifies the country for which the list of Political Division + 1 will be returned if available. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: PickupGetPoliticalDivision1ListRequest + maximum: 1 + description: This request is for client to get a list of valid Political Division + 1s/State field for a specific country or territory + PickupGetPoliticalDivision1ListRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Common element for all services + maximum: 1 + PickupGetPoliticalDivision1ListResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/PickupGetPoliticalDivision1ListResponse_Response" + PoliticalDivision1: + description: The Political Division 1/State Field. + minLength: 1 + maxLength: 50 + type: array + items: + type: string + xml: + name: PickupGetPoliticalDivision1ListResponse + description: The response for getting a list of valid Political Division 1 or + State field in the specified country or territory. + maximum: 1 + PickupGetPoliticalDivision1ListResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container. + maximum: 1 + PICKUPServCenterRequestWrapper: + xml: + name: PickupGetServiceCenterFacilitiesRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupGetServiceCenterFacilitiesRequest + properties: + PickupGetServiceCenterFacilitiesRequest: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest" + PICKUPServCenterResponseWrapper: + xml: + name: PickupGetServiceCenterFacilitiesResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupGetServiceCenterFacilitiesResponse + properties: + PickupGetServiceCenterFacilitiesResponse: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse" + PickupGetServiceCenterFacilitiesRequest: + type: object + required: + - Locale + - Request + - PickupPiece + properties: + Request: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_Request" + PickupPiece: + items: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_PickupPiece" + OriginAddress: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesRequest_OriginAddress" + 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 + on this locale. Locale is required if PoximityIndicator is present for + Drop Off facilities." + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + ProximitySearchIndicator: + description: Proximity Indicator. Indicates the user requested the proximity search for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday locations for the origin address and/or the airport code, and the sort code for destination address. + maximum: 1 + type: string + xml: + name: PickupGetServiceCenterFacilitiesRequest + maximum: 1 + description: This request is to retrieve UPS Facility location information including + location address, phone number, SLIC, and hours of operation for pick-up and + drop-off requests + PickupGetServiceCenterFacilitiesRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Container for the Request. + maximum: 1 + PickupGetServiceCenterFacilitiesRequest_PickupPiece: + type: object + maximum: 1 + required: + - ServiceCode + - ContainerCode + properties: + ServiceCode: + description: |- + The service code. + 96 = WWEF Required for WWEF shipments. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + ContainerCode: + description: |- + The container type + 03 = PALLET Required for WWEF shipments. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: PickupPiece + description: Pickup Piece Container. + PickupGetServiceCenterFacilitiesRequest_OriginAddress: + type: object + maximum: 1 + properties: + StreetAddress: + description: Indicates the address of the shipper to allow for the nearest + Drop off facility Search. Conditionally required if proximitySearchIndicator + is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 73 + City: + description: Indicates the address of the shipper to allow for the nearest + Drop off facility Search Conditionally required if proximitySearchIndicator + is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: Indicates the address of the shipper to allow for the nearest + Drop off facility Search. Conditionally required if proximitySearchIndicator + is present and if country or territory is US/CA/IE/HK. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Indicates the address of the shipper to allow for the nearest + Drop off facility Search Conditionally required if proximitySearchIndicator + is present and if country or territory has postal code.It does not apply + to non-postal countries such as IE and HK. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: Indicates the address of the shipper to allow for the nearest + Drop off facility Search + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + 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. + OriginAddress_OriginSearchCriteria: + type: object + maximum: 1 + properties: + SearchRadius: + description: |- + Search Request range. Valied values: + - 1 to 200 + + Default: 200 + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + DistanceUnitOfMeasure: + description: 'Unit of Measure Required if ProximitySearchIndicator is present. + Example: MI or KM' + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + MaximumLocation: + description: |- + Maximum Number of locations. Valied values: + - 1 to 100 + + Default: 100 + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: OriginSearchCriteria + required: + - DistanceUnitOfMeasure + description: Origin Search Criteria Container Required if Proximity SearchIndicator + is present. + PickupGetServiceCenterFacilitiesRequest_DestinationAddress: + type: object + maximum: 1 + properties: + City: + description: Indicates the address of the consignee to allow for the nearest + Pickup facility Search. Required for non-postal country Ireland (IE). + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: |- + Indicates the address of the consignee to allow for the nearest Pickup facility Search. + 1 = District code for Hong Kong (HK) + 2 = County for Ireland (IE) + 3 = State or province for all the postal countries Required for non-postal countries including HK and IE. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: 'Indicates the address of the consignee to allow for the nearest + Pickup facility Search It does not apply to non-postal countries. Example: + IE and HK.' + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: The pickup country or territory code as defined by ISO-3166. + Please check check separate pickup country or territory list to find out + all the pickup eligible countries. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + xml: + name: DestinationAddress + required: + - CountryCode + description: DestinationAddress container. Conditionally required for pickup + location search. + PickupGetServiceCenterFacilitiesResponse: + type: object + required: + - Response + - ServiceCenterLocation + properties: + Response: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_Response" + ServiceCenterLocation: + "$ref": "#/components/schemas/PickupGetServiceCenterFacilitiesResponse_ServiceCenterLocation" + xml: + name: PickupGetServiceCenterFacilitiesResponse + description: Returns service center location information for Origin UPS Facilities + and Destination Facilities + maximum: 1 + PickupGetServiceCenterFacilitiesResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Container for response. + maximum: 1 + PickupGetServiceCenterFacilitiesResponse_ServiceCenterLocation: + type: object + properties: + DropOffFacilities: + type: array + items: + "$ref": "#/components/schemas/ServiceCenterLocation_DropOffFacilities" + PickupFacilities: + "$ref": "#/components/schemas/ServiceCenterLocation_PickupFacilities" + xml: + name: ServiceCenterLocation + description: Locations of the nearest Service Center for Dropoff and Pickup + maximum: 1 + ServiceCenterLocation_DropOffFacilities: + type: object + maximum: 1 + required: + - Timezone + - Type + - Address + - SLIC + - Phone + - OriginOrDestination + - Fax + - Name + properties: + Name: + description: Name of the Facility. + maximum: 1 + type: string + Address: + "$ref": "#/components/schemas/DropOffFacilities_Address" + SLIC: + description: SLIC code for the UPS Drop off facility. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + Type: + description: FRT for Freight or PKG for Package + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Timezone: + description: |- + Facility's Timezone. Format: + - America/New_York + - Asia/Hong_Kong + - Europe/London + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Phone: + description: Phone Number of the Drop off Facility + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + Fax: + description: Drop off Facilities Fax Number + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + FacilityTime: + "$ref": "#/components/schemas/DropOffFacilities_FacilityTime" + OriginOrDestination: + description: Type of Facility. + maximum: 1 + type: string + LocalizedInstruction: + type: array + items: + "$ref": "#/components/schemas/DropOffFacilities_LocalizedInstruction" + Distance: + "$ref": "#/components/schemas/DropOffFacilities_Distance" + xml: + name: DropOffFacilities + description: Returns information for DropOff Facilities. This includes name + of facility, address, business hours, and SLIC. + DropOffFacilities_Address: + type: object + maximum: 1 + required: + - AddressLine + - StateProvince + - ResidentialIndicator + - PostalCode + - City + - CountryCode + properties: + AddressLine: + description: Address Line of the Facility. + maximum: 3 + type: string + oneOf: + - items: + type: string + type: array + - type: string + City: + description: Facilities City. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: Facility state or province code. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Facility Postal Code. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + CountryCode: + description: UPS Drop Off facility country or territory code. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + ResidentialIndicator: + description: "Indicates if the pickup address is a residential place or + not. \nValid Values:\nY = Residential address\nN = Non-residential (Commercial) + address (default)" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: Address + description: Address of the facility. + DropOffFacilities_FacilityTime: + type: object + required: + - DayOfWeek + properties: + DayOfWeek: + type: array + items: + "$ref": "#/components/schemas/FacilityTime_DayOfWeek" + xml: + name: FacilityTime + description: Facility Time Container + maximum: 1 + FacilityTime_DayOfWeek: + type: object + maximum: 1 + required: + - OpenHours + - Day + - CloseHours + properties: + Day: + description: Day of the week. Mon-Sun + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + EarliestDropOfforPickup: + description: Earliest time that a customer can drop-off a package. + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + LatestDropOfforPickup: + description: Latest time that a customer can drop-off a package. + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + OpenHours: + description: |- + Facility Open Hours. The latest local open time. Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + CloseHours: + description: |- + Facility Close Hours. The latest local close time. Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + PrepTime: + description: Time required by the facility to prepare your shipment for movement + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + LastDrop: + description: Cut-off time for drop off that day. + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + xml: + name: DayOfWeek + description: Facility Hours of Operation Container + DropOffFacilities_LocalizedInstruction: + type: object + maximum: 1 + properties: + Locale: + description: 'Locale. Example: en_US' + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + Last50ftInstruction: + description: |- + Last 50ft instructions that relates to an available facility and depend on the locale passing in request. + Last 50 feet instruction in the language asked in request or the English for that country. + maximum: 1 + type: string + minLength: 1 + maxLength: 750 + xml: + name: LocalizedInstruction + description: Localized Instruction Container. Localized Instructions will be + returned for drop off location search by proximity order. + DropOffFacilities_Distance: + type: object + maximum: 1 + properties: + Value: + description: |- + Distance from origin address. Distance based on distance UOM in request. + + Numeric value up to 200 and .2 decimal positions. Distance will be retuned for drop off location search by proximity order. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + UnitOfMeasurement: + description: |- + Unit Of Measure. + Example: MI or KM + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: Distance + description: Distance from origin Distance will be retuned for drop off location search by proximity order. + ServiceCenterLocation_PickupFacilities: + type: object + maximum: 1 + required: + - Timezone + - Type + - Address + - SLIC + - Phone + - Fax + - Name + properties: + Name: + description: Name of the facility + maximum: 1 + type: string + Address: + "$ref": "#/components/schemas/PickupFacilities_Address" + SLIC: + description: SLIC code for the UPS Pickup facility + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + Type: + description: Freight or Package. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Timezone: + description: |- + Facility's Timezone. Format: + - America/New_York + - Asia/Hong_Kong + - Europe/London + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Phone: + description: Phone Number of the Pickup Facility + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + Fax: + description: Pickup Facilities Fax Number + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + FacilityTime: + "$ref": "#/components/schemas/PickupFacilities_FacilityTime" + AirportCode: + 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" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: PickupFacilities + description: Returns information for Pickup Facilities. This includes name of + facility, address, and business hours. + PickupFacilities_Address: + type: object + maximum: 1 + required: + - AddressLine + - StateProvince + - ResidentialIndicator + - PostalCode + - City + - CountryCode + properties: + AddressLine: + description: Address Line of the Facility. + maximum: 1 + type: string + minLength: 1 + maxLength: 73 + City: + description: Facilities City. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StateProvince: + description: Facility state or province code. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + PostalCode: + description: Facility Postal Code. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + CountryCode: + description: UPS Pickup facility country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ResidentialIndicator: + description: |- + Indicates if the pickup location is commerical or residential. + Valid values: + Y = Residential address + N = Non-residential (Commercial) address (default) + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + xml: + name: Address + description: Address of the facility + PickupFacilities_FacilityTime: + type: object + required: + - DayOfWeek + properties: + DayOfWeek: + type: array + items: + "$ref": "#/components/schemas/PickupFacilities_FacilityTime_DayOfWeek" + xml: + name: FacilityTime + description: Facility Time Container + maximum: 1 + PickupFacilities_FacilityTime_DayOfWeek: + type: object + maximum: 1 + required: + - OpenHours + - Day + - CloseHours + properties: + Day: + description: Day of the week. Mon-Sun + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + EarliestDropOfforPickup: + description: Earliest time that a customer can pick up a package. + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + LatestDropOfforPickup: + description: Latest time that a customer can pick up a package. + maximum: 1 + type: string + minLength: 10 + maxLength: 10 + OpenHours: + description: |- + Facility Open Hours. The latest local open time. Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + CloseHours: + description: |- + Facility Close Hours. The latest local close time. Format: HHmm + - Hour: 0-23 + - Minute: 0-59 + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + PrepTime: + description: Preparation time for hold for pickup Conditionally required if request is for hold for pickup. + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + LastDrop: + description: Latest time a package, requiring preparation can be dropped off (Close time - Prep time). + maximum: 1 + type: string + minLength: 20 + maxLength: 20 + xml: + name: DayOfWeek + description: Facility Hours of Operation Container + PICKUPPendingRequestWrapper: + xml: + name: PickupPendingStatusRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupPendingStatusRequest + properties: + PickupPendingStatusRequest: + "$ref": "#/components/schemas/PickupPendingStatusRequest" + PICKUPPendingResponseWrapper: + xml: + name: PickupPendingStatusResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PickupPendingStatusResponse + properties: + PickupPendingStatusResponse: + "$ref": "#/components/schemas/PickupPendingStatusResponse" + PickupPendingStatusRequest: + type: object + required: + - Request + - PickupType + - AccountNumber + properties: + Request: + "$ref": "#/components/schemas/PickupPendingStatusRequest_Request" + PickupType: + description: |- + Specify the type of pending pickup. + 01 = On-Call Pickup + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + AccountNumber: + description: The specific account number belongs to the shipper + maximum: 1 + type: string + minLength: 6 + maxLength: 10 + xml: + name: PickupPendingStatusRequest + maximum: 1 + description: This request is used to get the pending pickup status. + PickupPendingStatusRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Common element for all services. + maximum: 1 + PickupPendingStatusResponse: + type: object + required: + - Response + - PendingStatus + properties: + Response: + "$ref": "#/components/schemas/PickupPendingStatusResponse_Response" + PendingStatus: + type: array + items: + "$ref": "#/components/schemas/PickupPendingStatusResponse_PendingStatus" + xml: + name: PickupPendingStatusResponse + description: The response of the pending status for on-callpickup. + maximum: 1 + PickupPendingStatusResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + type: array + items: + "$ref": "#/components/schemas/Response_Alert" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Response Container. + maximum: 1 + PickupPendingStatusResponse_PendingStatus: + type: object + maximum: 1 + required: + - ServiceDate + - PickupType + - PRN + - PickupStatusMessage + properties: + PickupType: + description: |- + Specify the type of pending pickup. + - 01 = on-callPickup + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ServiceDate: + description: |- + Local service date. Format: yyyyMMdd + - yyyy = Year applicable + - MM = 01-12 + - dd = 01-31 + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + PRN: + description: Returned PRN + maximum: 1 + type: string + minLength: 11 + maxLength: 11 + GWNStatusCode: + description: Status code for Smart Pickup. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + OnCallStatusCode: + description: A unique string identifier to identify a success pre-notification + processing. Only available if end result is success. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + PickupStatusMessage: + description: | + The status for on-callpickup. + + PickupPendingStatusResponse will only display incomplete status for today and tomorrow only. + - 002 and 012 are the most common responses. + - 001 = Received at dispatch + - 002 = Dispatched to driver + - 003 = Order successfully completed + - 004 = Order unsuccessfully completed + - 005 = Missed commit – Updated ETA supplied by driver + - 007 = Cancelled + - 008 = Order has invalid order status + - 012 = Your pickup request is being processed + maximum: 1 + type: string + minLength: 1 + maxLength: 500 + BillingCode: + description: |- + Pickup billing classification for on call + - 01 = Regular + - 02 = Return + - 03 = Alternate Address (Not supported for now) + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ContactName: + description: on-callpickup contact name + maximum: 1 + type: string + minLength: 1 + maxLength: 22 + ReferenceNumber: + description: Customer provided reference number for on-call pickup + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PendingStatus + description: The result of retrieving pending pickups. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/PreNotification-Ready.yaml b/PreNotification-Ready.yaml index ad65622..b51c50b 100644 --- a/PreNotification-Ready.yaml +++ b/PreNotification-Ready.yaml @@ -1,908 +1,908 @@ -openapi: 3.0.3 -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 - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/dangerousgoods/{version}/prenotification": - post: - summary: Pre-Notification - tags: - - Pre-Notification - security: - - OAuth2: [] - 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. - operationId: PreNotification - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API. - - Valid values: - - v2 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PreNotificationRequest: - Request: - RequestOption: RequestOption - SubVersion: '3' - TransactionReference: - CustomerContext: '' - Shipment: - ShipperNumber: '' - ShipmentIdentificationNumber: 1Z2398YY81288 - ShipFromAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - ShipToAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - PickupDate: '20171101' - Service: - Code: GND - Description: Ground - RegulationSet: TDG - Package: - TrackingNumber: 1Z33445567001 - PackageWeight: - UnitOfMeasurement: - Code: KGS - Description: Kilo - Weight: '12' - TransportationMode: GND - VoidIndicator: '' - PackagePoints: '12' - ChemicalRecord: - ReportableQuantity: '1' - ClassDivisionNumber: I - SubRiskClass: '1234' - IDNumber: UN2761 - PackagingGroupType: '0' - Quantity: '1' - UOM: LBS - PackagingInstructionCode: TEST - EmergencyPhone: '' - EmergencyContact: '' - ProperShippingName: TEST SHIPPING - TechnicalName: '' - AdditionalDescription: '' - PackagingType: '' - HazardLabelRequired: LABEL - PackagingTypeQuantity: '1' - CommodityRegulatedLevelCode: LR - TransportCategory: '0' - TunnelRestrictionCode: '1' - QValue: '0.1' - OverPackedIndicator: '' - AllPackedInOneIndicator: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/dangerousgoods/{deprecatedVersion}/prenotification": - post: - deprecated: true - summary: Pre-Notification - tags: - - Pre-Notification - security: - - OAuth2: [] - 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. - operationId: Deprecated PreNotification - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API. - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PreNotificationRequest: - Request: - RequestOption: RequestOption - SubVersion: '3' - TransactionReference: - CustomerContext: '' - Shipment: - ShipperNumber: '' - ShipmentIdentificationNumber: 1Z2398YY81288 - ShipFromAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - ShipToAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - PickupDate: '20171101' - Service: - Code: GND - Description: Ground - RegulationSet: TDG - Package: - TrackingNumber: 1Z33445567001 - PackageWeight: - UnitOfMeasurement: - Code: KGS - Description: Kilo - Weight: '12' - TransportationMode: GND - VoidIndicator: '' - PackagePoints: '12' - ChemicalRecord: - ReportableQuantity: '1' - ClassDivisionNumber: I - SubRiskClass: '1234' - IDNumber: UN2761 - PackagingGroupType: '0' - Quantity: '1' - UOM: LBS - PackagingInstructionCode: TEST - EmergencyPhone: '' - EmergencyContact: '' - ProperShippingName: TEST SHIPPING - TechnicalName: '' - AdditionalDescription: '' - PackagingType: '' - HazardLabelRequired: LABEL - PackagingTypeQuantity: '1' - CommodityRegulatedLevelCode: LR - TransportCategory: '0' - TunnelRestrictionCode: '1' - QValue: '0.1' - OverPackedIndicator: '' - AllPackedInOneIndicator: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - PRENOTIFICATIONRequestWrapper: - xml: - name: PreNotificationRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PreNotificationRequest - properties: - PreNotificationRequest: - "$ref": "#/components/schemas/PreNotificationRequest" - PRENOTIFICATIONResponseWrapper: - xml: - name: PreNotificationResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PreNotificationResponse - properties: - PreNotificationResponse: - "$ref": "#/components/schemas/PreNotificationResponse" - PreNotificationRequest: - type: object - required: - - Request - - Shipment - properties: - Request: - "$ref": "#/components/schemas/PreNotificationRequest_Request" - Shipment: - "$ref": "#/components/schemas/PreNotificationRequest_Shipment" - xml: - name: PreNotificationRequest - description: Pre-Notification Request. - maximum: 1 - PreNotificationRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Request Container - maximum: 1 - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - PreNotificationRequest_Shipment: - type: object - maximum: 1 - required: - - ShipToAddress - - ShipFromAddress - - Service - - ShipperNumber - - RegulationSet - - Package - - ShipmentIdentificationNumber - - PickupDate - properties: - ShipperNumber: - description: Shipper's six digit account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ShipmentIdentificationNumber: - description: 1Z Number of the first package in the shipment. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - ShipToAddress: - "$ref": "#/components/schemas/Shipment_ShipToAddress" - ShipFromAddress: - "$ref": "#/components/schemas/Shipment_ShipFromAddress" - PickupDate: - description: Date of the On Call Air Pickup. Format is YYYYMMDD - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - 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: - - ADR – European Agreement concerning the International Carriage of Dangerous Goods by Road. - - 49CFR – Title 49 of the United States Code of Federal Regulations. - - IATA – International Air Transport Association (IATA) Dangerous Goods Regulations. - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - Package: - type: array - maximum: 1000 - items: - "$ref": "#/components/schemas/Shipment_Package" - xml: - name: Shipment - description: Shipment Container - Shipment_ShipToAddress: - type: object - maximum: 1 - required: - - AddressLine - - CountryCode - properties: - AddressLine: - description: The Ship To street address including name and number (when - applicable). - type: array - maximum: 4 - minLength: 1 - maxLength: 35 - items: - type: string - City: - description: The Ship To city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship To location's state or province code. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - PostalCode: - description: The Ship To location's postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship To location's country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipToAddress - description: Ship To address container. - Shipment_ShipFromAddress: - type: object - maximum: 1 - required: - - AddressLine - - CountryCode - properties: - AddressLine: - description: The Ship From street address including name and number (when - applicable). - type: array - maximum: 4 - minLength: 1 - maxLength: 35 - items: - type: string - City: - description: The Ship From city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship From location's state or province code. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - PostalCode: - description: The Ship From location's postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship From location's country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipFromAddress - description: Ship From address container. - Shipment_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: UPS service type code. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the service code. Examples are Next Day Air, - Worldwide Express, and Ground. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: Service - description: UPS service type. - Shipment_Package: - type: object - maximum: 1 - required: - - ChemicalRecord - - TrackingNumber - - PackageWeight - properties: - TrackingNumber: - description: The packages tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - 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.' - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - VoidIndicator: - description: Indicator to specify that a Dangerous Goods package is voided. - True if VoidIndicator tag exists; false otherwise. - maximum: 1 - type: string - PackagePoints: - description: Regulated Commodity Transport Package Score Quantity - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - ChemicalRecord: - type: array - maximum: 3 - items: - "$ref": "#/components/schemas/Package_ChemicalRecord" - xml: - name: Package - description: Package Information container. - Package_PackageWeight: - type: object - required: - - UnitOfMeasurement - - Weight - properties: - UnitOfMeasurement: - "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" - Weight: - description: Packages weight. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - xml: - name: PackageWeight - maximum: 1 - description: Container to hold package weight information. - PackageWeight_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: "Package weight unit of measurement code. \nCodes are: \nLBS - = Pounds\nKGS = Kilograms" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the unit of measurement for package weight. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: Container to hold UnitOfMeasurement information for package weight. - Package_ChemicalRecord: - type: object - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - ClassDivisionNumber: - description: This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' - maximum: 1 - type: string - minLength: 1 - maxLength: 7 - SubRiskClass: - description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma.) - maximum: 1 - type: string - minLength: 7 - maxLength: 7 - 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). - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - PackagingGroupType: - description: | - This is the packing group category associated to the specified commodity. Must be shown in Roman Numerals. Valid values are: - - I - - II - - III - - blank - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - Quantity: - description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - UOM: - description: Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PackagingInstructionCode: - description: The packing instructions related to the chemical record. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - EmergencyPhone: - description: | - 24 Hour Emergency Phone Number of the shipper. - - Valid values for this field are (0) through (9) with trailing blanks. - - For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries 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 - type: string - minLength: 1 - maxLength: 25 - EmergencyContact: - description: The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ProperShippingName: - description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LQ or FR. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - TechnicalName: - description: The technical name (when required) for the specified commodity. - maximum: 1 - type: string - minLength: 200 - maxLength: 200 - AdditionalDescription: - description: Additional remarks or special provision information. - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - PackagingType: - description: "The type of package used to contain the regulated good. (Ex: Fiberboard Box)." - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - HazardLabelRequired: - description: Defines the type of label that is required on the package for the commodity. - maximum: 1 - type: string - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - CommodityRegulatedLevelCode: - description: Indicates the type of commodity, Fully Regulated (FR), Limited Quantity (LQ), Lightly Regulated (LR) Valid values are LR, FR and LQ. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - TransportCategory: - description: Transport Category. Valid values are 0 to 4. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: Defines what is restricted to pass through a tunnel. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - QValue: - description: 'When a HazMat shipment specifies AllPackedInOneIndicator and - the regulation set for that shipment is IATA, Q-Value specifies exactly - one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; - 1.0 Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - OverPackedIndicator: - description: Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack. - maximum: 1 - type: string - AllPackedInOneIndicator: - description: Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package - maximum: 1 - type: string - xml: - name: ChemicalRecord - required: - - CommodityRegulatedLevelCode - description: Dangerous Goods Accessorial Commodity Container - PreNotificationResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/PreNotificationResponse_Response" - xml: - name: PreNotificationResponse - description: Pre-Notification Response container. - maximum: 1 - PreNotificationResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Contains Pre-Notification response components. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Identifies the success or failure of the transaction. Valid - values 1 = Successful. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of Success. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response status container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +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 + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + +
+

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/dangerousgoods/{version}/prenotification": + post: + summary: Pre-Notification + tags: + - Pre-Notification + security: + - OAuth2: [] + 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. + operationId: PreNotification + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API. + + Valid values: + - v2 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PreNotificationRequest: + Request: + RequestOption: RequestOption + SubVersion: '3' + TransactionReference: + CustomerContext: '' + Shipment: + ShipperNumber: '' + ShipmentIdentificationNumber: 1Z2398YY81288 + ShipFromAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + ShipToAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + PickupDate: '20171101' + Service: + Code: GND + Description: Ground + RegulationSet: TDG + Package: + TrackingNumber: 1Z33445567001 + PackageWeight: + UnitOfMeasurement: + Code: KGS + Description: Kilo + Weight: '12' + TransportationMode: GND + VoidIndicator: '' + PackagePoints: '12' + ChemicalRecord: + ReportableQuantity: '1' + ClassDivisionNumber: I + SubRiskClass: '1234' + IDNumber: UN2761 + PackagingGroupType: '0' + Quantity: '1' + UOM: LBS + PackagingInstructionCode: TEST + EmergencyPhone: '' + EmergencyContact: '' + ProperShippingName: TEST SHIPPING + TechnicalName: '' + AdditionalDescription: '' + PackagingType: '' + HazardLabelRequired: LABEL + PackagingTypeQuantity: '1' + CommodityRegulatedLevelCode: LR + TransportCategory: '0' + TunnelRestrictionCode: '1' + QValue: '0.1' + OverPackedIndicator: '' + AllPackedInOneIndicator: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/dangerousgoods/{deprecatedVersion}/prenotification": + post: + deprecated: true + summary: Pre-Notification + tags: + - Pre-Notification + security: + - OAuth2: [] + 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. + operationId: Deprecated PreNotification + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API. + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PreNotificationRequest: + Request: + RequestOption: RequestOption + SubVersion: '3' + TransactionReference: + CustomerContext: '' + Shipment: + ShipperNumber: '' + ShipmentIdentificationNumber: 1Z2398YY81288 + ShipFromAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + ShipToAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + PickupDate: '20171101' + Service: + Code: GND + Description: Ground + RegulationSet: TDG + Package: + TrackingNumber: 1Z33445567001 + PackageWeight: + UnitOfMeasurement: + Code: KGS + Description: Kilo + Weight: '12' + TransportationMode: GND + VoidIndicator: '' + PackagePoints: '12' + ChemicalRecord: + ReportableQuantity: '1' + ClassDivisionNumber: I + SubRiskClass: '1234' + IDNumber: UN2761 + PackagingGroupType: '0' + Quantity: '1' + UOM: LBS + PackagingInstructionCode: TEST + EmergencyPhone: '' + EmergencyContact: '' + ProperShippingName: TEST SHIPPING + TechnicalName: '' + AdditionalDescription: '' + PackagingType: '' + HazardLabelRequired: LABEL + PackagingTypeQuantity: '1' + CommodityRegulatedLevelCode: LR + TransportCategory: '0' + TunnelRestrictionCode: '1' + QValue: '0.1' + OverPackedIndicator: '' + AllPackedInOneIndicator: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + PRENOTIFICATIONRequestWrapper: + xml: + name: PreNotificationRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PreNotificationRequest + properties: + PreNotificationRequest: + "$ref": "#/components/schemas/PreNotificationRequest" + PRENOTIFICATIONResponseWrapper: + xml: + name: PreNotificationResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PreNotificationResponse + properties: + PreNotificationResponse: + "$ref": "#/components/schemas/PreNotificationResponse" + PreNotificationRequest: + type: object + required: + - Request + - Shipment + properties: + Request: + "$ref": "#/components/schemas/PreNotificationRequest_Request" + Shipment: + "$ref": "#/components/schemas/PreNotificationRequest_Shipment" + xml: + name: PreNotificationRequest + description: Pre-Notification Request. + maximum: 1 + PreNotificationRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Request Container + maximum: 1 + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + PreNotificationRequest_Shipment: + type: object + maximum: 1 + required: + - ShipToAddress + - ShipFromAddress + - Service + - ShipperNumber + - RegulationSet + - Package + - ShipmentIdentificationNumber + - PickupDate + properties: + ShipperNumber: + description: Shipper's six digit account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ShipmentIdentificationNumber: + description: 1Z Number of the first package in the shipment. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + ShipToAddress: + "$ref": "#/components/schemas/Shipment_ShipToAddress" + ShipFromAddress: + "$ref": "#/components/schemas/Shipment_ShipFromAddress" + PickupDate: + description: Date of the On Call Air Pickup. Format is YYYYMMDD + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + 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: + - ADR – European Agreement concerning the International Carriage of Dangerous Goods by Road. + - 49CFR – Title 49 of the United States Code of Federal Regulations. + - IATA – International Air Transport Association (IATA) Dangerous Goods Regulations. + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + Package: + type: array + maximum: 1000 + items: + "$ref": "#/components/schemas/Shipment_Package" + xml: + name: Shipment + description: Shipment Container + Shipment_ShipToAddress: + type: object + maximum: 1 + required: + - AddressLine + - CountryCode + properties: + AddressLine: + description: The Ship To street address including name and number (when + applicable). + type: array + maximum: 4 + minLength: 1 + maxLength: 35 + items: + type: string + City: + description: The Ship To city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship To location's state or province code. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + PostalCode: + description: The Ship To location's postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship To location's country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipToAddress + description: Ship To address container. + Shipment_ShipFromAddress: + type: object + maximum: 1 + required: + - AddressLine + - CountryCode + properties: + AddressLine: + description: The Ship From street address including name and number (when + applicable). + type: array + maximum: 4 + minLength: 1 + maxLength: 35 + items: + type: string + City: + description: The Ship From city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship From location's state or province code. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + PostalCode: + description: The Ship From location's postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship From location's country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipFromAddress + description: Ship From address container. + Shipment_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: UPS service type code. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the service code. Examples are Next Day Air, + Worldwide Express, and Ground. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: Service + description: UPS service type. + Shipment_Package: + type: object + maximum: 1 + required: + - ChemicalRecord + - TrackingNumber + - PackageWeight + properties: + TrackingNumber: + description: The packages tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + 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.' + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + VoidIndicator: + description: Indicator to specify that a Dangerous Goods package is voided. + True if VoidIndicator tag exists; false otherwise. + maximum: 1 + type: string + PackagePoints: + description: Regulated Commodity Transport Package Score Quantity + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + ChemicalRecord: + type: array + maximum: 3 + items: + "$ref": "#/components/schemas/Package_ChemicalRecord" + xml: + name: Package + description: Package Information container. + Package_PackageWeight: + type: object + required: + - UnitOfMeasurement + - Weight + properties: + UnitOfMeasurement: + "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" + Weight: + description: Packages weight. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + xml: + name: PackageWeight + maximum: 1 + description: Container to hold package weight information. + PackageWeight_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: "Package weight unit of measurement code. \nCodes are: \nLBS + = Pounds\nKGS = Kilograms" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the unit of measurement for package weight. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: Container to hold UnitOfMeasurement information for package weight. + Package_ChemicalRecord: + type: object + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + ClassDivisionNumber: + description: This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' + maximum: 1 + type: string + minLength: 1 + maxLength: 7 + SubRiskClass: + description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma.) + maximum: 1 + type: string + minLength: 7 + maxLength: 7 + 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). + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + PackagingGroupType: + description: | + This is the packing group category associated to the specified commodity. Must be shown in Roman Numerals. Valid values are: + - I + - II + - III + - blank + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + Quantity: + description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + UOM: + description: Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PackagingInstructionCode: + description: The packing instructions related to the chemical record. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + EmergencyPhone: + description: | + 24 Hour Emergency Phone Number of the shipper. + + Valid values for this field are (0) through (9) with trailing blanks. + + For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries 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 + type: string + minLength: 1 + maxLength: 25 + EmergencyContact: + description: The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ProperShippingName: + description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LQ or FR. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + TechnicalName: + description: The technical name (when required) for the specified commodity. + maximum: 1 + type: string + minLength: 200 + maxLength: 200 + AdditionalDescription: + description: Additional remarks or special provision information. + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + PackagingType: + description: "The type of package used to contain the regulated good. (Ex: Fiberboard Box)." + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + HazardLabelRequired: + description: Defines the type of label that is required on the package for the commodity. + maximum: 1 + type: string + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + CommodityRegulatedLevelCode: + description: Indicates the type of commodity, Fully Regulated (FR), Limited Quantity (LQ), Lightly Regulated (LR) Valid values are LR, FR and LQ. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + TransportCategory: + description: Transport Category. Valid values are 0 to 4. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: Defines what is restricted to pass through a tunnel. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + QValue: + description: 'When a HazMat shipment specifies AllPackedInOneIndicator and + the regulation set for that shipment is IATA, Q-Value specifies exactly + one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; + 1.0 Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + OverPackedIndicator: + description: Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack. + maximum: 1 + type: string + AllPackedInOneIndicator: + description: Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package + maximum: 1 + type: string + xml: + name: ChemicalRecord + required: + - CommodityRegulatedLevelCode + description: Dangerous Goods Accessorial Commodity Container + PreNotificationResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/PreNotificationResponse_Response" + xml: + name: PreNotificationResponse + description: Pre-Notification Response container. + maximum: 1 + PreNotificationResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Contains Pre-Notification response components. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Identifies the success or failure of the transaction. Valid + values 1 = Successful. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of Success. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response status container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/PreNotification.yaml b/PreNotification.yaml index 93d7a5e..28d3ac1 100644 --- a/PreNotification.yaml +++ b/PreNotification.yaml @@ -1,902 +1,902 @@ -openapi: 3.0.3 -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 - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/dangerousgoods/{version}/prenotification": - post: - summary: Pre-Notification - tags: - - Pre-Notification - security: - - OAuth2: [] - 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. - operationId: PreNotification - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: version - schema: - type: string - default: v2 - description: | - Version of API. - - Valid values: - - v2 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PreNotificationRequest: - Request: - RequestOption: RequestOption - SubVersion: '3' - TransactionReference: - CustomerContext: '' - Shipment: - ShipperNumber: '' - ShipmentIdentificationNumber: 1Z2398YY81288 - ShipFromAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - ShipToAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - PickupDate: '20171101' - Service: - Code: GND - Description: Ground - RegulationSet: TDG - Package: - TrackingNumber: 1Z33445567001 - PackageWeight: - UnitOfMeasurement: - Code: KGS - Description: Kilo - Weight: '12' - TransportationMode: GND - VoidIndicator: '' - PackagePoints: '12' - ChemicalRecord: - ReportableQuantity: '1' - ClassDivisionNumber: I - SubRiskClass: '1234' - IDNumber: UN2761 - PackagingGroupType: '0' - Quantity: '1' - UOM: LBS - PackagingInstructionCode: TEST - EmergencyPhone: '' - EmergencyContact: '' - ProperShippingName: TEST SHIPPING - TechnicalName: '' - AdditionalDescription: '' - PackagingType: '' - HazardLabelRequired: LABEL - PackagingTypeQuantity: '1' - CommodityRegulatedLevelCode: LR - TransportCategory: '0' - TunnelRestrictionCode: '1' - QValue: '0.1' - OverPackedIndicator: '' - AllPackedInOneIndicator: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/dangerousgoods/{deprecatedVersion}/prenotification": - post: - deprecated: true - summary: Pre-Notification - tags: - - Pre-Notification - security: - - OAuth2: [] - 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. - operationId: Deprecated PreNotification - parameters: - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: false - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: An identifier of the client/source application that is making - the request.Length 512 - required: false - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API. - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - PreNotificationRequest: - Request: - RequestOption: RequestOption - SubVersion: '3' - TransactionReference: - CustomerContext: '' - Shipment: - ShipperNumber: '' - ShipmentIdentificationNumber: 1Z2398YY81288 - ShipFromAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - ShipToAddress: - AddressLine: MY STREET 12 - City: BOGOTA - StateProvinceCode: NJ - PostalCode: K1A0B1 - CountryCode: CA - PickupDate: '20171101' - Service: - Code: GND - Description: Ground - RegulationSet: TDG - Package: - TrackingNumber: 1Z33445567001 - PackageWeight: - UnitOfMeasurement: - Code: KGS - Description: Kilo - Weight: '12' - TransportationMode: GND - VoidIndicator: '' - PackagePoints: '12' - ChemicalRecord: - ReportableQuantity: '1' - ClassDivisionNumber: I - SubRiskClass: '1234' - IDNumber: UN2761 - PackagingGroupType: '0' - Quantity: '1' - UOM: LBS - PackagingInstructionCode: TEST - EmergencyPhone: '' - EmergencyContact: '' - ProperShippingName: TEST SHIPPING - TechnicalName: '' - AdditionalDescription: '' - PackagingType: '' - HazardLabelRequired: LABEL - PackagingTypeQuantity: '1' - CommodityRegulatedLevelCode: LR - TransportCategory: '0' - TunnelRestrictionCode: '1' - QValue: '0.1' - OverPackedIndicator: '' - AllPackedInOneIndicator: '' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - PRENOTIFICATIONRequestWrapper: - xml: - name: PreNotificationRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - PreNotificationRequest - properties: - PreNotificationRequest: - "$ref": "#/components/schemas/PreNotificationRequest" - PRENOTIFICATIONResponseWrapper: - xml: - name: PreNotificationResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - PreNotificationResponse - properties: - PreNotificationResponse: - "$ref": "#/components/schemas/PreNotificationResponse" - PreNotificationRequest: - type: object - required: - - Request - - Shipment - properties: - Request: - "$ref": "#/components/schemas/PreNotificationRequest_Request" - Shipment: - "$ref": "#/components/schemas/PreNotificationRequest_Shipment" - xml: - name: PreNotificationRequest - description: Pre-Notification Request. - maximum: 1 - PreNotificationRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - xml: - name: Request - description: Request Container - maximum: 1 - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - PreNotificationRequest_Shipment: - type: object - maximum: 1 - required: - - ShipToAddress - - ShipFromAddress - - Service - - ShipperNumber - - RegulationSet - - Package - - ShipmentIdentificationNumber - - PickupDate - properties: - ShipperNumber: - description: Shipper's six digit account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ShipmentIdentificationNumber: - description: 1Z Number of the first package in the shipment. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - ShipToAddress: - "$ref": "#/components/schemas/Shipment_ShipToAddress" - ShipFromAddress: - "$ref": "#/components/schemas/Shipment_ShipFromAddress" - PickupDate: - description: Date of the On Call Air Pickup. Format is YYYYMMDD - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - 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: - - ADR – European Agreement concerning the International Carriage of Dangerous Goods by Road. - - 49CFR – Title 49 of the United States Code of Federal Regulations. - - IATA – International Air Transport Association (IATA) Dangerous Goods Regulations. - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - Package: - type: array - maximum: 1000 - items: - "$ref": "#/components/schemas/Shipment_Package" - xml: - name: Shipment - description: Shipment Container - Shipment_ShipToAddress: - type: object - maximum: 1 - required: - - AddressLine - - CountryCode - properties: - AddressLine: - description: The Ship To street address including name and number (when - applicable). - type: array - maximum: 4 - minLength: 1 - maxLength: 35 - items: - type: string - City: - description: The Ship To city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship To location's state or province code. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - PostalCode: - description: The Ship To location's postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship To location's country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipToAddress - description: Ship To address container. - Shipment_ShipFromAddress: - type: object - maximum: 1 - required: - - AddressLine - - CountryCode - properties: - AddressLine: - description: The Ship From street address including name and number (when - applicable). - type: array - maximum: 4 - minLength: 1 - maxLength: 35 - items: - type: string - City: - description: The Ship From city. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: The Ship From location's state or province code. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - PostalCode: - description: The Ship From location's postal code. 9 characters are accepted. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: The Ship From location's country or territory code. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: ShipFromAddress - description: Ship From address container. - Shipment_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: UPS service type code. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the service code. Examples are Next Day Air, - Worldwide Express, and Ground. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: Service - description: UPS service type. - Shipment_Package: - type: object - maximum: 1 - required: - - ChemicalRecord - - TrackingNumber - - PackageWeight - properties: - TrackingNumber: - description: The packages tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - 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.' - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - VoidIndicator: - description: Indicator to specify that a Dangerous Goods package is voided. - True if VoidIndicator tag exists; false otherwise. - maximum: 1 - type: string - PackagePoints: - description: Regulated Commodity Transport Package Score Quantity - maximum: 1 - type: string - minLength: 5 - maxLength: 5 - ChemicalRecord: - type: array - maximum: 3 - items: - "$ref": "#/components/schemas/Package_ChemicalRecord" - xml: - name: Package - description: Package Information container. - Package_PackageWeight: - type: object - required: - - UnitOfMeasurement - - Weight - properties: - UnitOfMeasurement: - "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" - Weight: - description: Packages weight. - maximum: 1 - type: string - minLength: 15 - maxLength: 15 - xml: - name: PackageWeight - maximum: 1 - description: Container to hold package weight information. - PackageWeight_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: "Package weight unit of measurement code. \nCodes are: \nLBS - = Pounds\nKGS = Kilograms" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the unit of measurement for package weight. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: Container to hold UnitOfMeasurement information for package weight. - Package_ChemicalRecord: - type: object - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - ClassDivisionNumber: - description: This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' - maximum: 1 - type: string - minLength: 1 - maxLength: 7 - SubRiskClass: - description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma.) - maximum: 1 - type: string - minLength: 7 - maxLength: 7 - 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). - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - PackagingGroupType: - description: | - This is the packing group category associated to the specified commodity. Must be shown in Roman Numerals. Valid values are: - - I - - II - - III - - blank - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - Quantity: - description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - UOM: - description: Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - PackagingInstructionCode: - description: The packing instructions related to the chemical record. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - EmergencyPhone: - description: | - 24 Hour Emergency Phone Number of the shipper. - - Valid values for this field are (0) through (9) with trailing blanks. - - For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries 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 - type: string - minLength: 1 - maxLength: 25 - EmergencyContact: - description: The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ProperShippingName: - description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LQ or FR. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - TechnicalName: - description: The technical name (when required) for the specified commodity. - maximum: 1 - type: string - minLength: 200 - maxLength: 200 - AdditionalDescription: - description: Additional remarks or special provision information. - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - PackagingType: - description: "The type of package used to contain the regulated good. (Ex: Fiberboard Box)." - maximum: 1 - type: string - minLength: 1 - maxLength: 255 - HazardLabelRequired: - description: Defines the type of label that is required on the package for the commodity. - maximum: 1 - type: string - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - CommodityRegulatedLevelCode: - description: Indicates the type of commodity, Fully Regulated (FR), Limited Quantity (LQ), Lightly Regulated (LR) Valid values are LR, FR and LQ. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - TransportCategory: - description: Transport Category. Valid values are 0 to 4. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TunnelRestrictionCode: - description: Defines what is restricted to pass through a tunnel. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - QValue: - description: 'When a HazMat shipment specifies AllPackedInOneIndicator and - the regulation set for that shipment is IATA, Q-Value specifies exactly - one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; - 1.0 Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - OverPackedIndicator: - description: Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack. - maximum: 1 - type: string - AllPackedInOneIndicator: - description: Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package - maximum: 1 - type: string - xml: - name: ChemicalRecord - required: - - CommodityRegulatedLevelCode - description: Dangerous Goods Accessorial Commodity Container - PreNotificationResponse: - type: object - required: - - Response - properties: - Response: - "$ref": "#/components/schemas/PreNotificationResponse_Response" - xml: - name: PreNotificationResponse - description: Pre-Notification Response container. - maximum: 1 - PreNotificationResponse_Response: - type: object - required: - - ResponseStatus - properties: - ResponseStatus: - "$ref": "#/components/schemas/Response_ResponseStatus" - Alert: - description: | - Alert Container. There can be zero to many alert containers with code and description. - - **NOTE:** For versions >= 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" - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - xml: - name: Response - description: Contains Pre-Notification response components. - maximum: 1 - Response_ResponseStatus: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Identifies the success or failure of the transaction. Valid - values 1 = Successful. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Describes Response Status Code. Returns text of Success. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ResponseStatus - description: Response status container. - Response_Alert: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: Warning code returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - Description: - description: Warning messages returned by the system. - maximum: 1 - type: string - minLength: 1 - maxLength: 150 - xml: - name: Alert - description: Alert Container. There can be zero to many alert containers with - code and description. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext information which will be echoed during - response. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - xml: - name: TransactionReference - description: Transaction Reference Container. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +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 + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/dangerousgoods/{version}/prenotification": + post: + summary: Pre-Notification + tags: + - Pre-Notification + security: + - OAuth2: [] + 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. + operationId: PreNotification + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: version + schema: + type: string + default: v2 + description: | + Version of API. + + Valid values: + - v2 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PreNotificationRequest: + Request: + RequestOption: RequestOption + SubVersion: '3' + TransactionReference: + CustomerContext: '' + Shipment: + ShipperNumber: '' + ShipmentIdentificationNumber: 1Z2398YY81288 + ShipFromAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + ShipToAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + PickupDate: '20171101' + Service: + Code: GND + Description: Ground + RegulationSet: TDG + Package: + TrackingNumber: 1Z33445567001 + PackageWeight: + UnitOfMeasurement: + Code: KGS + Description: Kilo + Weight: '12' + TransportationMode: GND + VoidIndicator: '' + PackagePoints: '12' + ChemicalRecord: + ReportableQuantity: '1' + ClassDivisionNumber: I + SubRiskClass: '1234' + IDNumber: UN2761 + PackagingGroupType: '0' + Quantity: '1' + UOM: LBS + PackagingInstructionCode: TEST + EmergencyPhone: '' + EmergencyContact: '' + ProperShippingName: TEST SHIPPING + TechnicalName: '' + AdditionalDescription: '' + PackagingType: '' + HazardLabelRequired: LABEL + PackagingTypeQuantity: '1' + CommodityRegulatedLevelCode: LR + TransportCategory: '0' + TunnelRestrictionCode: '1' + QValue: '0.1' + OverPackedIndicator: '' + AllPackedInOneIndicator: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/dangerousgoods/{deprecatedVersion}/prenotification": + post: + deprecated: true + summary: Pre-Notification + tags: + - Pre-Notification + security: + - OAuth2: [] + 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. + operationId: Deprecated PreNotification + parameters: + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: false + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: An identifier of the client/source application that is making + the request.Length 512 + required: false + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API. + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + PreNotificationRequest: + Request: + RequestOption: RequestOption + SubVersion: '3' + TransactionReference: + CustomerContext: '' + Shipment: + ShipperNumber: '' + ShipmentIdentificationNumber: 1Z2398YY81288 + ShipFromAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + ShipToAddress: + AddressLine: MY STREET 12 + City: BOGOTA + StateProvinceCode: NJ + PostalCode: K1A0B1 + CountryCode: CA + PickupDate: '20171101' + Service: + Code: GND + Description: Ground + RegulationSet: TDG + Package: + TrackingNumber: 1Z33445567001 + PackageWeight: + UnitOfMeasurement: + Code: KGS + Description: Kilo + Weight: '12' + TransportationMode: GND + VoidIndicator: '' + PackagePoints: '12' + ChemicalRecord: + ReportableQuantity: '1' + ClassDivisionNumber: I + SubRiskClass: '1234' + IDNumber: UN2761 + PackagingGroupType: '0' + Quantity: '1' + UOM: LBS + PackagingInstructionCode: TEST + EmergencyPhone: '' + EmergencyContact: '' + ProperShippingName: TEST SHIPPING + TechnicalName: '' + AdditionalDescription: '' + PackagingType: '' + HazardLabelRequired: LABEL + PackagingTypeQuantity: '1' + CommodityRegulatedLevelCode: LR + TransportCategory: '0' + TunnelRestrictionCode: '1' + QValue: '0.1' + OverPackedIndicator: '' + AllPackedInOneIndicator: '' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/PRENOTIFICATIONResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + PRENOTIFICATIONRequestWrapper: + xml: + name: PreNotificationRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - PreNotificationRequest + properties: + PreNotificationRequest: + "$ref": "#/components/schemas/PreNotificationRequest" + PRENOTIFICATIONResponseWrapper: + xml: + name: PreNotificationResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - PreNotificationResponse + properties: + PreNotificationResponse: + "$ref": "#/components/schemas/PreNotificationResponse" + PreNotificationRequest: + type: object + required: + - Request + - Shipment + properties: + Request: + "$ref": "#/components/schemas/PreNotificationRequest_Request" + Shipment: + "$ref": "#/components/schemas/PreNotificationRequest_Shipment" + xml: + name: PreNotificationRequest + description: Pre-Notification Request. + maximum: 1 + PreNotificationRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + xml: + name: Request + description: Request Container + maximum: 1 + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + PreNotificationRequest_Shipment: + type: object + maximum: 1 + required: + - ShipToAddress + - ShipFromAddress + - Service + - ShipperNumber + - RegulationSet + - Package + - ShipmentIdentificationNumber + - PickupDate + properties: + ShipperNumber: + description: Shipper's six digit account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ShipmentIdentificationNumber: + description: 1Z Number of the first package in the shipment. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + ShipToAddress: + "$ref": "#/components/schemas/Shipment_ShipToAddress" + ShipFromAddress: + "$ref": "#/components/schemas/Shipment_ShipFromAddress" + PickupDate: + description: Date of the On Call Air Pickup. Format is YYYYMMDD + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + 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: + - ADR – European Agreement concerning the International Carriage of Dangerous Goods by Road. + - 49CFR – Title 49 of the United States Code of Federal Regulations. + - IATA – International Air Transport Association (IATA) Dangerous Goods Regulations. + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + Package: + type: array + maximum: 1000 + items: + "$ref": "#/components/schemas/Shipment_Package" + xml: + name: Shipment + description: Shipment Container + Shipment_ShipToAddress: + type: object + maximum: 1 + required: + - AddressLine + - CountryCode + properties: + AddressLine: + description: The Ship To street address including name and number (when + applicable). + type: array + maximum: 4 + minLength: 1 + maxLength: 35 + items: + type: string + City: + description: The Ship To city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship To location's state or province code. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + PostalCode: + description: The Ship To location's postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship To location's country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipToAddress + description: Ship To address container. + Shipment_ShipFromAddress: + type: object + maximum: 1 + required: + - AddressLine + - CountryCode + properties: + AddressLine: + description: The Ship From street address including name and number (when + applicable). + type: array + maximum: 4 + minLength: 1 + maxLength: 35 + items: + type: string + City: + description: The Ship From city. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: The Ship From location's state or province code. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + PostalCode: + description: The Ship From location's postal code. 9 characters are accepted. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: The Ship From location's country or territory code. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: ShipFromAddress + description: Ship From address container. + Shipment_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: UPS service type code. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the service code. Examples are Next Day Air, + Worldwide Express, and Ground. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: Service + description: UPS service type. + Shipment_Package: + type: object + maximum: 1 + required: + - ChemicalRecord + - TrackingNumber + - PackageWeight + properties: + TrackingNumber: + description: The packages tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + 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.' + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + VoidIndicator: + description: Indicator to specify that a Dangerous Goods package is voided. + True if VoidIndicator tag exists; false otherwise. + maximum: 1 + type: string + PackagePoints: + description: Regulated Commodity Transport Package Score Quantity + maximum: 1 + type: string + minLength: 5 + maxLength: 5 + ChemicalRecord: + type: array + maximum: 3 + items: + "$ref": "#/components/schemas/Package_ChemicalRecord" + xml: + name: Package + description: Package Information container. + Package_PackageWeight: + type: object + required: + - UnitOfMeasurement + - Weight + properties: + UnitOfMeasurement: + "$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement" + Weight: + description: Packages weight. + maximum: 1 + type: string + minLength: 15 + maxLength: 15 + xml: + name: PackageWeight + maximum: 1 + description: Container to hold package weight information. + PackageWeight_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: "Package weight unit of measurement code. \nCodes are: \nLBS + = Pounds\nKGS = Kilograms" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the unit of measurement for package weight. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: Container to hold UnitOfMeasurement information for package weight. + Package_ChemicalRecord: + type: object + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + ClassDivisionNumber: + description: This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' + maximum: 1 + type: string + minLength: 1 + maxLength: 7 + SubRiskClass: + description: Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma.) + maximum: 1 + type: string + minLength: 7 + maxLength: 7 + 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). + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + PackagingGroupType: + description: | + This is the packing group category associated to the specified commodity. Must be shown in Roman Numerals. Valid values are: + - I + - II + - III + - blank + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + Quantity: + description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + UOM: + description: Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + PackagingInstructionCode: + description: The packing instructions related to the chemical record. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + EmergencyPhone: + description: | + 24 Hour Emergency Phone Number of the shipper. + + Valid values for this field are (0) through (9) with trailing blanks. + + For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries 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 + type: string + minLength: 1 + maxLength: 25 + EmergencyContact: + description: The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ProperShippingName: + description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LQ or FR. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + TechnicalName: + description: The technical name (when required) for the specified commodity. + maximum: 1 + type: string + minLength: 200 + maxLength: 200 + AdditionalDescription: + description: Additional remarks or special provision information. + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + PackagingType: + description: "The type of package used to contain the regulated good. (Ex: Fiberboard Box)." + maximum: 1 + type: string + minLength: 1 + maxLength: 255 + HazardLabelRequired: + description: Defines the type of label that is required on the package for the commodity. + maximum: 1 + type: string + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + CommodityRegulatedLevelCode: + description: Indicates the type of commodity, Fully Regulated (FR), Limited Quantity (LQ), Lightly Regulated (LR) Valid values are LR, FR and LQ. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + TransportCategory: + description: Transport Category. Valid values are 0 to 4. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TunnelRestrictionCode: + description: Defines what is restricted to pass through a tunnel. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + QValue: + description: 'When a HazMat shipment specifies AllPackedInOneIndicator and + the regulation set for that shipment is IATA, Q-Value specifies exactly + one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; + 1.0 Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0' + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + OverPackedIndicator: + description: Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack. + maximum: 1 + type: string + AllPackedInOneIndicator: + description: Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package + maximum: 1 + type: string + xml: + name: ChemicalRecord + required: + - CommodityRegulatedLevelCode + description: Dangerous Goods Accessorial Commodity Container + PreNotificationResponse: + type: object + required: + - Response + properties: + Response: + "$ref": "#/components/schemas/PreNotificationResponse_Response" + xml: + name: PreNotificationResponse + description: Pre-Notification Response container. + maximum: 1 + PreNotificationResponse_Response: + type: object + required: + - ResponseStatus + properties: + ResponseStatus: + "$ref": "#/components/schemas/Response_ResponseStatus" + Alert: + description: | + Alert Container. There can be zero to many alert containers with code and description. + + **NOTE:** For versions >= 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" + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + xml: + name: Response + description: Contains Pre-Notification response components. + maximum: 1 + Response_ResponseStatus: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Identifies the success or failure of the transaction. Valid + values 1 = Successful. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Describes Response Status Code. Returns text of Success. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ResponseStatus + description: Response status container. + Response_Alert: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: Warning code returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + Description: + description: Warning messages returned by the system. + maximum: 1 + type: string + minLength: 1 + maxLength: 150 + xml: + name: Alert + description: Alert Container. There can be zero to many alert containers with + code and description. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext information which will be echoed during + response. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + xml: + name: TransactionReference + description: Transaction Reference Container. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/QuantumView-Ready.yaml b/QuantumView-Ready.yaml index fdea2fe..8e2d713 100644 --- a/QuantumView-Ready.yaml +++ b/QuantumView-Ready.yaml @@ -1,3013 +1,3013 @@ -openapi: 3.0.3 -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 - - Appendix - - Errors - - FAQ - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/quantumview/{version}/events": - post: - summary: Quantum View - tags: - - Quantum View - security: - - OAuth2: [] - description: Get Quantum View Response - operationId: QuantumView - parameters: - - in: path - name: version - schema: - type: string - default: v3 - description: | - Version of API. - - Valid values: - - v3 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - QuantumViewRequest: - Request: - TransactionReference: - CustomerContext: '' - XpciVersion: '1.0007' - RequestAction: QVEvents - SubscriptionRequest: - FileName: '220104_140019001' - Name: OutboundXML - Bookmark: WE9MVFFBMQ== - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/quantumview/{deprecatedVersion}/events": - post: - deprecated: true - summary: Quantum View - tags: - - Quantum View - security: - - OAuth2: [] - description: Get Quantum View Response - operationId: Deprecated QuantumView - parameters: - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API. - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - QuantumViewRequest: - Request: - TransactionReference: - CustomerContext: '' - XpciVersion: '1.0007' - RequestAction: QVEvents - SubscriptionRequest: - FileName: '220104_140019001' - Name: OutboundXML - Bookmark: WE9MVFFBMQ== - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - QUANTUMVIEWRequestWrapper: - xml: - name: QuantumViewRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - QuantumViewRequest - properties: - QuantumViewRequest: - "$ref": "#/components/schemas/QuantumViewRequest" - QUANTUMVIEWResponseWrapper: - xml: - name: QuantumViewResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - QuantumViewResponse - properties: - QuantumViewResponse: - "$ref": "#/components/schemas/QuantumViewResponse" - QuantumViewRequest: - type: object - required: - - Request - properties: - Request: - "$ref": "#/components/schemas/QuantumViewRequest_Request" - SubscriptionRequest: - type: array - items: - "$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 - \ 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 - request." - maximum: 1 - type: string - xml: - name: QuantumViewRequest - maximum: 1 - description: Container for QuantumView request information. - QuantumViewRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - RequestAction: - description: Indicates the action to be taken by the XML service. The only - valid value is 'QVEvents' - maximum: 1 - type: string - minLength: 11 - maxLength: 11 - xml: - name: Request - maximum: 1 - required: - - RequestAction - description: Contains QuantumView request criteria components. - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during response. - maximum: 1 - type: string - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - QuantumViewRequest_SubscriptionRequest: - type: object - properties: - Name: - description: Name of subscription requested by user, as one type of request - criteria. Required when the customer wants to request data for a specific - subscription name. Subscription name consists of up to 21 alphanumerics. - type: string - maxLength: 21 - DateTimeRange: - "$ref": "#/components/schemas/SubscriptionRequest_DateTimeRange" - FileName: - description: 'File name of specific subscription requested by user. Format: - YYMMDD_HHmmssnnn. (nnn - sequence number: usually = 001)' - type: array - items: - type: string - minLength: 16 - maxLength: 16 - xml: - name: SubscriptionRequest - description: Subscription requested by user to retrieve Inbound or/and Outbound - XML formed subscription information. - SubscriptionRequest_DateTimeRange: - type: object - maximum: 1 - properties: - BeginDateTime: - description: 'Beginning date time for the retrieval criteria of the subscriptions. - It is required for date time request criteria. Format: YYYYMMDDHHmmss.' - maximum: 1 - type: string - minLength: 14 - 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 - the request, it is defaulted to 7 days from the given begin date.' - maximum: 1 - type: string - minLength: 14 - maxLength: 14 - xml: - name: DateTimeRange - description: The range of date time of subscription requested by user, as one - type of request criteria, valid up to but not exceeding 7 days into the past, - starting from current day. - QuantumViewResponse: - type: object - required: - - Response - - QuantumViewEvents - properties: - Response: - "$ref": "#/components/schemas/QuantumViewResponse_Response" - 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 - + File Name if the request is for all data. It 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 request. - type: string - xml: - name: QuantumViewResponse - maximum: 1 - description: Container for QuantumView response information. - QuantumViewResponse_Response: - type: object - required: - - TransactionReference - - ResponseStatusCode - properties: - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - ResponseStatusCode: - description: "Identifies the success or failure of the interchange. \n1 - = Success, 0 = Failure" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ResponseStatusDescription: - description: "'Success' or 'Failure'" - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - Error: - description: | - If an error is encountered during the interchange, the Response contains an error. If the error is present, then the ErrorSeverity and ErrorCodes are required. - - **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" - xml: - name: Response - maximum: 1 - description: Contains Errors information tags along with the success/fail status - of the QuantumView request. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during response. - type: string - XpciVersion: - description: "XPCI version. Current version: 1.0007" - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ToolVersion: - description: "Current tool version. \nValid value: 1.0" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: TransactionReference - description: Container for customer provided data and the XPCI Version. - Response_Error: - type: object - maximum: 1 - properties: - ErrorSeverity: - description: Describes the severity of the error. Required if the error is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ErrorCode: - description: A numeric value that describes the error. Each tool defines a range of error codes. Required if the error is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ErrorDescription: - description: Describes the error code. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - MinimumRetrySeconds: - description: Number of seconds to wait until retry. This field is populated on special conditions of the Transient Error only, as defined by the service. A number between 1 and 86400 (24 hours) - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - ErrorLocation: - description: | - Identifies the element in error. - - **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" - ErrorDigest: - description: | - The contents of the element in error. - - **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: - type: string - xml: - name: Error - required: - - ErrorLocation - Error_ErrorLocation: - type: object - maximum: 1 - properties: - ErrorLocationElementName: - description: The Xpath name of the element in error. This is a valid Xpath pointing to an element in the request document. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - ErrorLocationAttributeName: - description: The name of the attribute in error. This is the name of the attribute contained by the Error Location element. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: ErrorLocation - Error_ErrorDigest: - description: The contents of the element in error. - type: string - QuantumViewResponse_QuantumViewEvents: - type: object - maximum: 1 - required: - - SubscriptionEvents - - SubscriberID - properties: - SubscriberID: - description: QV XOLT subscribers ID. It is the same as the User ID. - maximum: 1 - type: string - minLength: 1 - maxLength: 16 - SubscriptionEvents: - description: | - The event that a user receives a subset of Tracking information specific to either packages coming or packages going, after subscription request is made. - - **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" - xml: - name: QuantumViewEvents - description: The event that a user receives echoing Subscriber ID and information - for subscription event, which is a subset of Tracking information specific - to either packages coming or packages going, after subscription request is - made, if the user requests for XML format. - QuantumViewEvents_SubscriptionEvents: - type: object - maximum: 1 - properties: - Name: - description: A name uniquely defined associated to the Subscription ID, for each subscription. Required if the SubscriptionEvents container is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 21 - Number: - description: A number uniquely defined associated to the Subscriber ID, for each subscription. Required if the SubscriptionEvents container is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 16 - SubscriptionStatus: - "$ref": "#/components/schemas/SubscriptionEvents_SubscriptionStatus" - DateRange: - "$ref": "#/components/schemas/SubscriptionEvents_DateRange" - SubscriptionFile: - description: | - Container holds all of the unread files associated with the subscription. - - **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" - xml: - name: SubscriptionEvents - required: - - SubscriptionStatus - SubscriptionEvents_SubscriptionStatus: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - Status types of subscription. Valid values: - - UN – Unknown - - AT – Activate - - P – Pending - - A –Active - - I – Inactive - - S - Suspended - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - Description: - 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 - and is active.)\n- Inactive (The subscriber puts the subscription on hold.)\n- - Suspended (UPS disables the subscription.)" - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - xml: - name: SubscriptionStatus - description: Container for whether the subscription is active or not. - SubscriptionEvents_DateRange: - type: object - maximum: 1 - required: - - BeginDate - properties: - BeginDate: - description: |- - Beginning date time of subscription requested by user. - Format: MM-DD-YYYY-HH-MM - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - EndDate: - description: |- - Ending date time of subscription requested by user. - Format: MM-DD-YYYY-HH-MM - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - xml: - name: DateRange - description: The range of date time of subscription requested by user, as one - type of request criteria, valid up to but not exceeding 7 days into the past, - starting from current day. - SubscriptionEvents_SubscriptionFile: - type: object - maximum: 1 - required: - - StatusType - - FileName - properties: - FileName: - description: |- - File name belonging to specific subscription requested by user. - Format: YYMMDD_HHmmssnnn - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - 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. - - **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" - Origin: - description: | - Information about shipment's origin. - - **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" - Exception: - description: | - Shipment exception data. - - **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" - Delivery: - description: | - Container for delivery information. - - **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" - Generic: - description: | - Container for generic record information. - - **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" - xml: - name: SubscriptionFile - SubscriptionFile_StatusType: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Status types of subscription file. Valid values: - - R – Read - - U - Unread - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Description of a subscription file. - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - xml: - name: StatusType - description: Container that displays whether the file is read or unread. - SubscriptionFile_Manifest: - type: object - required: - - Shipper - - ConsigneeBillIndicator - - ShipTo - - CollectBillIndicator - properties: - Shipper: - "$ref": "#/components/schemas/Manifest_Shipper" - ShipTo: - "$ref": "#/components/schemas/Manifest_ShipTo" - ReferenceNumber: - description: | - Shipment-level reference numbers. - - **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" - 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). - Formatted as YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - ScheduledDeliveryDate: - description: The date the shipment originally was scheduled for delivery. - Formatted as YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - ScheduledDeliveryTime: - description: Schedule delivery time. Time format is HHMMSS - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - DocumentsOnly: - description: | - If the tag is present then the shipment is a document, otherwise the shipment is a non-document. Valid values: - - 1 = Letter - - 2 = Document (Non-Letter Document) - - 3 = Non-Document - - 4 = Pallet - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Package: - description: | - Defines a package. - - **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" - ShipmentServiceOptions: - "$ref": "#/components/schemas/Manifest_ShipmentServiceOptions" - ManufactureCountry: - description: Country or Territory of Manufacture of the contents of the - package. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - HarmonizedCode: - description: Harmonized code of the package. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - CustomsValue: - "$ref": "#/components/schemas/Manifest_CustomsValue" - SpecialInstructions: - description: User-defined special instructions for delivery. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ShipmentChargeType: - description: |- - Shipment charge type. - Valid values: - C/F - Cost and Freight - C/B - Consignee Billed Package - F/C - Freight Collect - DDP - Delivered Duty Paid - VAT Unpaid - FOB - Free On Board - P/P - Prepaid - F/D - Free Domicile - T/P - Third Party Billing - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - BillToAccount: - "$ref": "#/components/schemas/Manifest_BillToAccount" - ConsigneeBillIndicator: - description: Indicates if consignee will be billed the shipment. - maximum: 1 - type: string - CollectBillIndicator: - description: Indicates whether or not to collect bill at time of delivery. - maximum: 1 - type: string - LocationAssured: - description: 'Indicates Location Assured Values: Y - Location Assured accessorial - requested' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ImportControl: - description: Import Control Indication is used to designate that the shipment - is an Import Control shipment. If the shipment is an import control shipment - then this element will have value. For no import shipment this will not - be appear - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - LabelDeliveryMethod: - description: "Indicates Label Delivery Method, Values are: LDE Electronic Label. LDO One Attempt. LDP Print Label. LDT Three Attempt. LPM Print and Mail Label." - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - CommercialInvoiceRemoval: - description: Commercial Invoice Removal (CIR) is an accessorial or indication - that will allow a shipper to dictate that UPS remove the Commercial Invoice - from the user's shipment before the shipment is delivered to the ultimate - consignee. If shipment is CIR then this element will have value. For no - CIR this element will not be appear - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PostalServiceTrackingID: - description: Postal Service Tracking ID transport company tracking number. - maximum: 1 - type: string - minLength: 35 - maxLength: 35 - ReturnsFlexibleAccess: - description: "(RFA) UPS returns flexible access. This element will appear - with value only when returns flexible access uploaded. For no returns - flexible access this element will not be appear" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - UPScarbonneutral: - description: UPS carbon neutral is a term used to reflect a generic term - for the tagging to be included on any document, label, e-mail, etc. used - to identify that the UPS carbon neutral fee is applied. This element will - appear only when shipment is UPS carbon neutral with value. For non UPS - carbon neutral shipping this element appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Product: - description: This element will have value "PAC" for CAR shipments. For no CAR shipments this element will not be appeared. - maximum: 1 - type: string - UPSReturnsExchange: - description: UPS Return and Exchange – This element will appear with value Y only when UPS Return and Exchange was requested. For no UPS Returns and Exchange then this element will not appear - maximum: 1 - type: string - LiftGateOnDelivery: - description: Lift Gate On Delivery - This element will appear only when - Lift Gate For Delivery was requested for UPS World Wide Express Freight - Shipments. If no Lift Gate for Delivery was requested, this element will - not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - LiftGateOnPickUp: - description: Lift Gate On PickUp - This element will appear only when Lift - Gate For PickUp was requested for UPS World Wide Express Freight Shipments. - If no Lift Gate for PickUp was requested, this element will not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PickupPreference: - description: Pickup Preference -This element will appear only when Dropoff - At UPS Facility was requested for UPS World Wide Express Freight Shipments. - If no Dropoff At UPS Facility was requested, this element will not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - DeliveryPreference: - description: Delivery Preference - This element will appear only when Hold - for pick up was requested for UPS World Wide Express Freight Shipments. - If no Hold for pick up was requested, this element will not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - HoldForPickupAtUPSAccessPoint: - description: '"Y" Indicates Shipment is Direct to Retail.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - UAPAddress: - "$ref": "#/components/schemas/Manifest_UAPAddress" - DeliverToAddresseeOnlyIndicator: - description: '"Y" Indicates Shipment is Deliver to Addressee.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - UPSAccessPointCODIndicator: - description: '"Y" Indicates Shipment is Cash on Delivery in Direct to Retail' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ClinicalTrialIndicator: - description: 'An accessorial Indicator flag: Y = Clinical Trial accessorial - provided in Manifest. Spaces = Clinical Trial accessorial not provided - in Manifest.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ClinicalTrialIndicationNumber: - description: An unique Clinical Trial associated with the shipment provided - in Manifest. - maximum: 1 - type: string - maxLength: 20 - CategoryAHazardousIndicator: - description: 'An accessorial Indicator flag: Y = Category A Hazardous materials - accessorial provided in Manifest. Spaces = Category A Hazardous materials - accessorial not provided in Manifest.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - DirectDeliveryIndicator: - description: 'An accessorial Indicator flag: Y = Direct Delivery accessorisal - provided in Manifest. Spaces = Direct Delivery accessorial not provided - in Manifest.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PackageReleaseCodeIndicator: - description: '"Y" indicates Shipment has PackageReleaseCode Accessorial.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ProactiveResponseIndicator: - description: '"Y" indicates that a UPS Proactive Response Accessorial is - provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - WhiteGloveDeliveryIndicator: - description: '"Y" indicates that a Heavy Goods White Glove Delivery Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - RoomOfChoiceIndicator: - description: '"Y" indicates that a Heavy Goods Room of Choice Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - InstallationDeliveryIndicator: - description: '"Y" indicates that a Heavy Goods Installation Delivery Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ItemDisposalIndicator: - description: '"Y" indicates that a Heavy Goods Item Disposal Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - LeadShipmentTrackingNumber: - description: Lead Tracking Number in shipment - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - SaturdayNonPremiumCommercialDeliveryIndicator: - description: '"Y" indicates that a SaturdayNonPremiumCommercialDeliveryIndicator - is provided.' - type: string - minLength: 1 - maxLength: 1 - SundayNonPremiumCommercialDeliveryIndicator: - description: '"Y" indicates that a SundayNonPremiumCommercialDeliveryIndicator - is provided.' - type: string - minLength: 1 - maxLength: 1 - UPSPremierAccessorialIndicator: - description: "\"Y\" indicates that the UPS Premier accessorial is provided." - type: string - minLength: 1 - maxLength: 1 - UPSPremierCategoryCode: - description: | - Indicates the UPS Premier category applied to the package Valid values: - - 'PRS' – UPS Premier Silver - - 'PRG' – UPS Premier Gold - - 'PRP' - UPS Premier Platinum - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: Manifest - maximum: 1 - Manifest_Shipper: - type: object - maximum: 1 - required: - - Name - properties: - Name: - description: Shipper's company name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AttentionName: - description: Shipper's Attention Name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - TaxIdentificationNumber: - description: Shipper's Tax Identification Number. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - PhoneNumber: - description: Shipper's Phone Number. US Phone numbers must be 10 digits. - No formatting is allowed. Required if origin and destination countries - or territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - FaxNumber: - description: Shipper's Fax Number. US Fax numbers must be 10 digits. No - formatting is allowed. Required if origin and destination countries or - territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - EMailAddress: - description: Shipper's designated contact eMail address. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Address: - "$ref": "#/components/schemas/Shipper_Address" - xml: - name: Shipper - description: Shipper's record for a shipment. - Shipper_Address: - type: object - maximum: 1 - properties: - AddressLine1: - description: Address Line 1 of the Shipper. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine2: - description: Address Line 2 of the Shipper. Usually room/floor information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine3: - description: Address Line 3 of the shipper. Usually department information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: Shipper's City. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: Shipper's state or province code. Must be valid US state. If the Shipper's country or territory is US or CA a two character code is required, otherwise the StateProvinceCode is optional. - maximum: 1 - type: string - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: | - Shipper's country or territory code. - - Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ResidentialAddressIndicator: - description: If tag is present, then the address is residential address. Pickup location residential address indicator. The presence indicates residential address, the absence indicates a business address. - maximum: 1 - type: string - xml: - name: Address - description: Information that specifies a physical location. - Manifest_ShipTo: - type: object - maximum: 1 - properties: - ShipperAssignedIdentificationNumber: - description: An identification number specified by shipper. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - CompanyName: - description: Consignee's company name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AttentionName: - description: Contact name at the consignee's location. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - PhoneNumber: - description: Consignee's Phone Number. US Phone numbers must be 10 digits. - No formatting is allowed. Required if origin and destination countries - or territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - TaxIdentificationNumber: - description: Consignee's Tax Identification Number. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - FaxNumber: - description: Consignee's Fax Number. US Fax numbers must be 10 digits. No - formatting is allowed. Required if origin and destination countries or - territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - EMailAddress: - description: Consignee's email address. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Address: - "$ref": "#/components/schemas/ShipTo_Address" - LocationID: - description: Location name that the package is shipped to. - maximum: 1 - type: string - minLength: 3 - maxLength: 10 - ReceivingAddressName: - description: Name of the location where the package is received. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipTo - description: Address and contact information describing the location where a - return is to be delivered. - ShipTo_Address: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Consignee's name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine1: - description: Address Line 1 of the Consignee. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine2: - description: Address Line 2 of the Consignee. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine3: - description: Address Line 3 of the Consignee. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: Consignee's City. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: Consignee's state or province code. Must be valid US state. If the consignee's country or territory is US or CA a two character code is required. Otherwise, the StateProvinceCode is optional. - maximum: 1 - type: string - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: | - Consignee's country or territory code. - - Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: Address - description: Information that specifies a physical location. - Manifest_ReferenceNumber: - type: object - maximum: 1 - properties: - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: Reflects what will go on the label as the name of the reference. For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ReferenceNumber - required: - - Value - Manifest_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: For addition information, refer to the Service Codes table - in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground. - maximum: 1 - type: string - xml: - name: Service - description: Container for service code and description. - Manifest_Package: - type: object - properties: - Activity: - description: | - Information about package delivery activity. - - **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" - Description: - description: Description of package merchandise. - maximum: 1 - type: string - minLength: 1 - maxLength: 120 - Dimensions: - "$ref": "#/components/schemas/Package_Dimensions" - DimensionalWeight: - "$ref": "#/components/schemas/Package_DimensionalWeight" - PackageWeight: - "$ref": "#/components/schemas/Package_PackageWeight" - LargePackage: - description: | - Values for LargePackage are: - - 1 - Oversize 1 - - 2 - Oversize 2 - - 4 - Large package - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TrackingNumber: - description: Package's tracking number. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ReferenceNumber: - description: | - Container tag for information about the package-level reference number. - - **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" - PackageServiceOptions: - "$ref": "#/components/schemas/Package_PackageServiceOptions" - UPSPremiumCareIndicator: - description: Presence of the tag indicates UPSPremiumCare applies to this - package - maximum: 1 - type: string - maxLength: 1 - xml: - name: Package - maximum: 1 - Package_Activity: - type: object - maximum: 1 - properties: - Date: - description: "Date of package delivery activity. Date format: YYYYMMDD." - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: "Time of package delivery activity. Time format: HHMMSS" - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: Activity - Package_Dimensions: - type: object - maximum: 1 - required: - - Length - - Height - - Width - properties: - Length: - description: "Package length. \nValid values: 0 to 108 IN and 0 to 270 CM" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Width: - description: Package width. - maximum: 1 - type: string - minLength: 9 - maxLength: 9 - Height: - description: Package height. - maximum: 1 - type: string - minLength: 9 - maxLength: 9 - xml: - name: Dimensions - 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 - required: - - UnitOfMeasurement - - Weight - properties: - UnitOfMeasurement: - "$ref": "#/components/schemas/DimensionalWeight_UnitOfMeasurement" - Weight: - description: The value of package dimensional weight. A value of zero should - be used for letters. - type: string - xml: - name: DimensionalWeight - maximum: 1 - description: Container tag for package dimensional weight. - DimensionalWeight_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - The code representing the unit of measure associated with the shipment's dimensional weight. - Valid values: - LBS - Pounds (default) - KGS - Kilograms - Defaults Unit of Measurement used in the shipper's country or territory. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: A text description of the code representing the unit of measure - associated with the package weight. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: Container tag for package dimensional weight measurement units. - DimensionalWeight_Weight: - description: The value of package dimensional weight. A value of zero should - be used for letters. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - Package_PackageWeight: - type: object - maximum: 1 - required: - - Weight - properties: - Weight: - description: Package weight. Set to 0 for package type of letters or envelops. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: PackageWeight - description: Container tag for package weight. Required when the package type - is not UPS Letter. - Package_LargePackage: - description: Values for LargePackage are:1 - Oversize 1,� 2 - Oversize 2,� 4 - - Large package - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Package_TrackingNumber: - description: Package's tracking number. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - Package_ReferenceNumber: - type: object - maximum: 1 - properties: - Number: - description: Number tag. - type: string - Code: - description: "Reference number type code for entire shipment, two-character - 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 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number, defined by the shipper - and can contain any character string. Valid if the origin/destination - pair is US/US or PR/PR. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ReferenceNumber - required: - - Value - Package_PackageServiceOptions: - type: object - properties: - COD: - "$ref": "#/components/schemas/PackageServiceOptions_COD" - InsuredValue: - "$ref": "#/components/schemas/PackageServiceOptions_InsuredValue" - EarliestDeliveryTime: - description: Earliest delivery time. Time format is HHMMSS. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - HazardousMaterialsCode: - description: | - Indicates if the package contains hazardous materials. Valid values: - - 1 - Hazardous Material - - 2 - Electronically billed hazardous material. - - If present, only one package may exist in the shipment. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - HoldForPickup: - description: A flag indicating if a package should be held for pickup. True - if tag exists, false otherwise. - maximum: 1 - type: string - AddShippingChargesToCODIndicator: - description: An indicator flag that represents a Collect on Delivery (COD) - package. - maximum: 1 - type: string - xml: - name: PackageServiceOptions - maximum: 1 - required: - - HoldForPickup - description: Defines service options used for the package(s). - PackageServiceOptions_COD: - type: object - maximum: 1 - properties: - CODCode: - description: |- - The code associated with the type of COD. Valid values: - 1 - Regular COD - 2 - Express COD - 3 - Tagless COD - type: string - CODAmount: - "$ref": "#/components/schemas/COD_CODAmount" - xml: - name: COD - description: Container for cash on delivery (COD) information. - COD_CODCode: - description: |- - The code associated with the type of COD. Valid values: - 1 - Regular COD - 2 - Express COD - 3 - Tagless COD - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - COD_CODAmount: - type: object - maximum: 1 - properties: - CurrencyCode: - description: | - The IATA currency code associated with the COD amount for the package. - - Required if the value for COD amount exists in MonetaryValue tag. - - Must match one of the IATA currency codes. - - For addition information, refer to the Currency Codes table in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - MonetaryValue: - description: The COD value for the package. Required if CODCode is 1.Absolute maximum value is 21474836.47 (limited by the maximum value of a 32-bit integer). - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: CODAmount - description: The amount of the COD that is to be collected for the shipment. - PackageServiceOptions_InsuredValue: - type: object - maximum: 1 - properties: - CurrencyCode: - description: Not populated in this release. - maximum: 1 - type: string - MonetaryValue: - description: The monetary value for the insured value amount associated - with the package. Max value of 5,000 USD for Local and 50,000 USD for - Remote. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: InsuredValue - required: - - MonetaryValue - description: Container tag for insured value amount for the package. - Manifest_ShipmentServiceOptions: - type: object - maximum: 1 - required: - - SaturdayDelivery - - SaturdayPickup - properties: - SaturdayPickup: - description: A flag indicating if the shipment requires a Saturday pickup. - True if tag exists, false otherwise. - maximum: 1 - type: string - SaturdayDelivery: - description: A flag indicating if the shipment requires a Saturday Delivery. - True if tag exists, false otherwise. - maximum: 1 - type: string - CallTagARS: - "$ref": "#/components/schemas/ShipmentServiceOptions_CallTagARS" - xml: - name: ShipmentServiceOptions - description: Container tag for optional UPS services related to a shipment. - ShipmentServiceOptions_CallTagARS: - type: object - maximum: 1 - properties: - Number: - description: A reference number associated with the Call Tag service. Required - if CallTagARS/Code is 1. - maximum: 1 - type: string - minLength: 12 - maxLength: 12 - Code: - 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 - the Web" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: CallTagARS - description: Container for Call Tag service. - Manifest_CustomsValue: - type: object - maximum: 1 - required: - - MonetaryValue - properties: - MonetaryValue: - description: The shipment's customs value amount. - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - xml: - name: CustomsValue - description: Information about shipment's customs value. - Manifest_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - Manifest_UAPAddress: - type: object - maximum: 1 - properties: - CompanyName: - description: The name of person or company to whom package was shipped. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AttentionName: - description: The "Attention To" field for the person/company to whom package - is shipped. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - 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 - or territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - xml: - name: UAPAddress - description: Information about Hold for Pickup UPS Access Point Address - UAPAddress_Address: - type: object - maximum: 1 - properties: - AddressLine1: - description: Address Line 1 of the UPS Access Point. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine2: - description: Address Line 2 of the UPS Access Point. Usually room/floor - information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine3: - description: Address Line 3 of the UPS Access Point. Usually department - information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: UPS Access Point City. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: UPS Access Point's state or province code. Must be valid US - state. If the UPS Access Point country or territory is US or CA a two - character code is required, otherwise, the StateProvinceCode is optional. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - PostalCode: - description: 'UPS Access Point''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 an alphabetic character - and # is numeric digit. Otherwise, 1 to 16 alphanumeric characters are - allowed.' - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: 'UPS Access Point''s country or territory code. Valid values: - CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, - and VA' - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: Address - description: Information that specifies a physical location. - SubscriptionFile_Origin: - type: object - properties: - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - TrackingNumber: - description: Package's 1Z tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - Date: - description: Date that the package is picked up at the origin. Date format - is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: Time that the package is picked up at the origin. Time format - is HHMMSS. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ActivityLocation: - "$ref": "#/components/schemas/Origin_ActivityLocation" - BillToAccount: - "$ref": "#/components/schemas/Origin_BillToAccount" - ScheduledDeliveryDate: - description: Scheduled delivery date for destination address. Date format - is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - ScheduledDeliveryTime: - description: Scheduled delivery time for destination address. Time format - is HHMMSS. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: Origin - maximum: 1 - required: - - TrackingNumber - - ShipperNumber - - Time - - Date - Origin_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Origin_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Origin_ActivityLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" - xml: - name: ActivityLocation - description: Geographic location where an activity occurred during a movement - of a package or shipment. (ActivityLocation in Origin is identical to the - one in Manifest. But three of all elements in Origin/ActivityLocation/AddressArtifactFormat - are populated in this release. Refer to Manifest for remaining unpopulated - elements.) - maximum: 1 - ActivityLocation_AddressArtifactFormat: - type: object - maximum: 1 - properties: - PoliticalDivision2: - description: City of an activity occurred during a package shipment. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: State or province code of an activity occurred during a package shipment. Must be valid US state. If the country or territory is US or CA a two character code is required, otherwise, the StateProvinceCode is optional. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - CountryCode: - description: "Country or Territory code of an activity occurred during a package shipment. Valid values: CA, MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, and VA" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: AddressArtifactFormat - description: Information that specifies a physical location where package delivery - activity occurs. - Origin_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid Values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - SubscriptionFile_Exception: - type: object - properties: - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - TrackingNumber: - description: Package's 1Z tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - Date: - description: Date that the package is delivered. Date format is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: Time that the package is delivered. Time format is HHMMSS - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - UpdatedAddress: - "$ref": "#/components/schemas/Exception_UpdatedAddress" - StatusCode: - description: Code for status of updating shipping address issue. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - StatusDescription: - description: Description for status of updating shipping address issue. - maximum: 1 - type: string - minLength: 1 - maxLength: 120 - ReasonCode: - description: Code for reason of updating shipping address issue. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ReasonDescription: - description: Description for reason of updating shipping address issue. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - Resolution: - "$ref": "#/components/schemas/Exception_Resolution" - RescheduledDeliveryDate: - description: Rescheduled delivery date for updated shipping address. Date - format is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - RescheduledDeliveryTime: - description: Rescheduled delivery time for updated shipping address. Time - format is HHMMSS - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ActivityLocation: - "$ref": "#/components/schemas/Exception_ActivityLocation" - BillToAccount: - "$ref": "#/components/schemas/Exception_BillToAccount" - AccessPointLocationID: - description: The UPS Access Point Location ID. - maximum: 1 - type: string - maxLength: 9 - xml: - name: Exception - maximum: 1 - required: - - TrackingNumber - - ShipperNumber - - Time - - Date - Exception_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Exception_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Exception_UpdatedAddress: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Consignee's name for package shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - StreetNumberLow: - description: Street number of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - StreetPrefix: - description: Street prefix of updated shipping address, e.g. N, SE. It will - be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - StreetName: - description: Street name of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StreetType: - description: Street type of updated shipping address, e.g. ST. It will be - returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - StreetSuffix: - description: Street suffix of updated shipping address, e.g. N, SE. It will - be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - AddressExtendedInformation: - description: | - Container for information about updated shipping address. It will be returned if there is any update due to exception. - - **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" - PoliticalDivision3: - description: The neighborhood, town, barrio etc. It will be returned if - there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision2: - description: City name of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: Abbreviated state or province name of updated shipping address. - It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - CountryCode: - description: Abbreviated country or territory name of updated shipping address. - It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - PostcodePrimaryLow: - description: Postal Code of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: UpdatedAddress - description: Contains information about updated shipping address. - UpdatedAddress_AddressExtendedInformation: - type: object - maximum: 1 - properties: - Type: - description: Allows for secondary address information such as s suite or apartment. It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - Low: - description: The lower limit associated with the extended address type. It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - High: - description: The higher limit associated with the extended address type. It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - xml: - name: AddressExtendedInformation - Exception_Resolution: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: Type of resolution for updating shipping address issue. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Description of resolution type for updating shipping address. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - xml: - name: Resolution - description: Resolution for updating shipping address issue. - Exception_ActivityLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" - xml: - name: ActivityLocation - description: Geographic location where an activity occurred during a movement - of a package or shipment.(ActivityLocation in Exception is identical to the - one in Manifest. But three of all elements in Exception/ActivityLocation/AddressArtifactFormat - are populated in this release. Refer to Manifest for remaining unpopulated - elements.) - maximum: 1 - Exception_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid Values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - Indicates how shipping charges for the package were billed. Valid Values: 01 Shipper, 02 Consignee Billing ,03 Third Party, 04 Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - SubscriptionFile_Delivery: - type: object - properties: - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - TrackingNumber: - description: Package's 1Z tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - Date: - description: Date that the package is delivered. Date format is YYYYMMDD. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - Time: - description: Time that the package is delivered. Time format is HHMMSS - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - DriverRelease: - description: Information about driver release note / signature. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - ActivityLocation: - "$ref": "#/components/schemas/Delivery_ActivityLocation" - DeliveryLocation: - "$ref": "#/components/schemas/Delivery_DeliveryLocation" - COD: - "$ref": "#/components/schemas/Delivery_COD" - BillToAccount: - "$ref": "#/components/schemas/Delivery_BillToAccount" - LastPickupDate: - description: Last pickup by Date from the UPS Access Point Location. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - AccessPointLocationID: - description: UPS Access Point Location ID. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - xml: - name: Delivery - maximum: 1 - required: - - TrackingNumber - - ShipperNumber - - Time - - Date - Delivery_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Delivery_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Delivery_ActivityLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" - xml: - name: ActivityLocation - description: Geographic location where an activity occurred during a movement - of a package or shipment. (ActivityLocation in Delivery is identical to the - one in Manifest. But all elements in Delivery/ActivityLocation/AddressArtifactFormat - are populated in this release. Refer to Manifest for remaining unpopulated - elements.) - maximum: 1 - Delivery_DeliveryLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/DeliveryLocation_AddressArtifactFormat" - Code: - description: Location Code for delivered package. - maximum: 1 - type: string - minLength: 1 - maxLength: 16 - Description: - description: Description of the location where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - SignedForByName: - description: The person who signed for the package. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: DeliveryLocation - maximum: 1 - description: Information about the location where package is delivered. - DeliveryLocation_AddressArtifactFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Consignee's name at the location where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - StreetNumberLow: - description: Street number where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - StreetPrefix: - description: Street prefix where package is delivered, e.g. N, SE. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - StreetName: - description: Street name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StreetType: - description: Street type where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - StreetSuffix: - description: Street suffix where package is delivered, e.g. N, SE. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - BuildingName: - description: Building name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AddressExtendedInformation: - description: | - Container tag for additional address information where package is delivered. - - **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" - PoliticalDivision3: - description: The neighborhood, town, barrio etc. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision2: - description: City name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: Abbreviated state or province name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - CountryCode: - description: Abbreviated country or territory name where package is delivered. - type: string - PostcodePrimaryLow: - description: Postal Code where package is delivered. Required if the user - does not submit the City, Alphanumeric State/Province address combination. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - PostcodeExtendedLow: - description: 4 Digit postal code extension where package is delivered. Valid for US only. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - ResidentialAddressIndicator: - description: Residential address indicator for the location where package - is delivered. The presence indicates residential address, the absence - indicates a business address. - maximum: 1 - type: string - xml: - name: AddressArtifactFormat - description: Information that specifies a physical location where package is - delivered. - AddressArtifactFormat_AddressExtendedInformation: - type: object - maximum: 1 - properties: - Type: - description: Allows for secondary address information such as a suite or - apartment. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - Low: - description: The low number associated with an extended address. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - High: - description: The high number associated with an extended address. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - xml: - name: AddressExtendedInformation - Delivery_COD: - type: object - properties: - CODAmount: - "$ref": "#/components/schemas/COD_CODAmount" - xml: - name: COD - description: Container for cash on delivery (COD) information. - maximum: 1 - Delivery_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid Values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - SubscriptionFile_Generic: - type: object - maximum: 1 - required: - - TrackingNumber - - ActivityType - properties: - ActivityType: - description: | - Unique identifier that defines the type of activity. - - VM = Void for Manifest - - UR = Undeliverable Returns - - IR = Invoice Removal Successful - - TC = Transport Company USPS scan PS = 'Postal Service Possession Scan' - - FN = UPS Access Point/Alternate Delivery Location Email Notification Failure - - DS = Destination Scan - - AG = Package is in transit to a UPS facility - - RE = UPS Returns Exchange - - RP = Retail Pickup - - UD = Updated delivery date - - OD = Out for Delivery - - SD = Scheduled for Delivery - - FM = Tendered to FMP - - PT = UPS Courier Handoff (Package Tendered) DIALS -VX - - PC = UPS Courier Confirmation – XPLD -VX - - OT = Out For Delivery Today scan - - AD = At Delivery Site scan - - RO = Roadie Out for Delivery - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - TrackingNumber: - description: Package's tracking number. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ShipperNumber: - description: Shipper's alphanumeric account number. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - Service: - "$ref": "#/components/schemas/Generic_Service" - Activity: - "$ref": "#/components/schemas/Generic_Activity" - BillToAccount: - "$ref": "#/components/schemas/Generic_BillToAccount" - 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. - - If Activity Type is "OD", this element will contain Rescheduled Delivery Date. Format will be YYYYMMDD. - - If Activity Type is "SD", this element will contain agreed upon date with Customer for delivery Date. Format will be YYYYMMDD. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - FailureNotification: - "$ref": "#/components/schemas/Generic_FailureNotification" - xml: - name: Generic - Generic_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: "Reflects what will go on the label as the name of the reference. - \nFor addition information, refer to the Service Codes table in the Appendix." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Generic_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: "Reflects what will go on the label as the name of the reference. - \nFor addition information, refer to the Service Codes table in the Appendix." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Generic_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: For addition information, refer to the Service Codes table - in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Not used. - maximum: 1 - type: string - xml: - name: Service - description: Container for service code and description. - Generic_Activity: - type: object - maximum: 1 - properties: - Date: - description: Date of package activity (i.e. YYYYMMDD). If generic record ActivityType is TC then event date is the date of first USPS scan. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: Time of package activity(i.e. HHMMSS). If generic record ActivityType is TC then event time is the time of first USPS scan. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: Activity - description: Information about package activity. - Generic_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - 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 - Bill Option" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - Generic_ShipTo: - type: object - maximum: 1 - properties: - LocationID: - description: Location name that the package is shipped to. - maximum: 1 - type: string - minLength: 3 - maxLength: 10 - ReceivingAddressName: - description: Alias of the location where the package is received. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - Bookmark: - description: Bookmark of the package is shifted to. - maximum: 1 - type: string - xml: - name: ShipTo - description: Address and contact information describing the location where a - return is to be delivered. - Generic_FailureNotification: - type: object - maximum: 1 - properties: - FailedEmailAddress: - description: Email address that failed when an attempt was made to send - email to the customer - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - FailureNotificationCode: - "$ref": "#/components/schemas/FailureNotification_FailureNotificationCode" - xml: - name: FailureNotification - description: Failure notification information containing email address and Notification - code - FailureNotification_FailureNotificationCode: - type: object - maximum: 1 - properties: - Code: - description: |- - Code representing type of failure email notification. Valid values: - - 01 – Package is ready to pickup at UPS Access Point - Original - - 02 – Package is ready to pickup at UPS Access Point - Reminder - - 03 – Package is delivery to alternate delivery location - - 04 – Package is returned to Sender from UPS Access Point Location - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Not used. - maximum: 1 - type: string - xml: - name: FailureNotificationCode - description: Failure notification code information describing code. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +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 + - Appendix + - Errors + - FAQ + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/quantumview/{version}/events": + post: + summary: Quantum View + tags: + - Quantum View + security: + - OAuth2: [] + description: Get Quantum View Response + operationId: QuantumView + parameters: + - in: path + name: version + schema: + type: string + default: v3 + description: | + Version of API. + + Valid values: + - v3 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + QuantumViewRequest: + Request: + TransactionReference: + CustomerContext: '' + XpciVersion: '1.0007' + RequestAction: QVEvents + SubscriptionRequest: + FileName: '220104_140019001' + Name: OutboundXML + Bookmark: WE9MVFFBMQ== + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/quantumview/{deprecatedVersion}/events": + post: + deprecated: true + summary: Quantum View + tags: + - Quantum View + security: + - OAuth2: [] + description: Get Quantum View Response + operationId: Deprecated QuantumView + parameters: + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API. + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + QuantumViewRequest: + Request: + TransactionReference: + CustomerContext: '' + XpciVersion: '1.0007' + RequestAction: QVEvents + SubscriptionRequest: + FileName: '220104_140019001' + Name: OutboundXML + Bookmark: WE9MVFFBMQ== + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + QUANTUMVIEWRequestWrapper: + xml: + name: QuantumViewRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - QuantumViewRequest + properties: + QuantumViewRequest: + "$ref": "#/components/schemas/QuantumViewRequest" + QUANTUMVIEWResponseWrapper: + xml: + name: QuantumViewResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - QuantumViewResponse + properties: + QuantumViewResponse: + "$ref": "#/components/schemas/QuantumViewResponse" + QuantumViewRequest: + type: object + required: + - Request + properties: + Request: + "$ref": "#/components/schemas/QuantumViewRequest_Request" + SubscriptionRequest: + type: array + items: + "$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 + \ 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 + request." + maximum: 1 + type: string + xml: + name: QuantumViewRequest + maximum: 1 + description: Container for QuantumView request information. + QuantumViewRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + RequestAction: + description: Indicates the action to be taken by the XML service. The only + valid value is 'QVEvents' + maximum: 1 + type: string + minLength: 11 + maxLength: 11 + xml: + name: Request + maximum: 1 + required: + - RequestAction + description: Contains QuantumView request criteria components. + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during response. + maximum: 1 + type: string + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + QuantumViewRequest_SubscriptionRequest: + type: object + properties: + Name: + description: Name of subscription requested by user, as one type of request + criteria. Required when the customer wants to request data for a specific + subscription name. Subscription name consists of up to 21 alphanumerics. + type: string + maxLength: 21 + DateTimeRange: + "$ref": "#/components/schemas/SubscriptionRequest_DateTimeRange" + FileName: + description: 'File name of specific subscription requested by user. Format: + YYMMDD_HHmmssnnn. (nnn - sequence number: usually = 001)' + type: array + items: + type: string + minLength: 16 + maxLength: 16 + xml: + name: SubscriptionRequest + description: Subscription requested by user to retrieve Inbound or/and Outbound + XML formed subscription information. + SubscriptionRequest_DateTimeRange: + type: object + maximum: 1 + properties: + BeginDateTime: + description: 'Beginning date time for the retrieval criteria of the subscriptions. + It is required for date time request criteria. Format: YYYYMMDDHHmmss.' + maximum: 1 + type: string + minLength: 14 + 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 + the request, it is defaulted to 7 days from the given begin date.' + maximum: 1 + type: string + minLength: 14 + maxLength: 14 + xml: + name: DateTimeRange + description: The range of date time of subscription requested by user, as one + type of request criteria, valid up to but not exceeding 7 days into the past, + starting from current day. + QuantumViewResponse: + type: object + required: + - Response + - QuantumViewEvents + properties: + Response: + "$ref": "#/components/schemas/QuantumViewResponse_Response" + 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 + + File Name if the request is for all data. It 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 request. + type: string + xml: + name: QuantumViewResponse + maximum: 1 + description: Container for QuantumView response information. + QuantumViewResponse_Response: + type: object + required: + - TransactionReference + - ResponseStatusCode + properties: + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + ResponseStatusCode: + description: "Identifies the success or failure of the interchange. \n1 + = Success, 0 = Failure" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ResponseStatusDescription: + description: "'Success' or 'Failure'" + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + Error: + description: | + If an error is encountered during the interchange, the Response contains an error. If the error is present, then the ErrorSeverity and ErrorCodes are required. + + **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" + xml: + name: Response + maximum: 1 + description: Contains Errors information tags along with the success/fail status + of the QuantumView request. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during response. + type: string + XpciVersion: + description: "XPCI version. Current version: 1.0007" + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ToolVersion: + description: "Current tool version. \nValid value: 1.0" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: TransactionReference + description: Container for customer provided data and the XPCI Version. + Response_Error: + type: object + maximum: 1 + properties: + ErrorSeverity: + description: Describes the severity of the error. Required if the error is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ErrorCode: + description: A numeric value that describes the error. Each tool defines a range of error codes. Required if the error is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ErrorDescription: + description: Describes the error code. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + MinimumRetrySeconds: + description: Number of seconds to wait until retry. This field is populated on special conditions of the Transient Error only, as defined by the service. A number between 1 and 86400 (24 hours) + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + ErrorLocation: + description: | + Identifies the element in error. + + **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" + ErrorDigest: + description: | + The contents of the element in error. + + **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: + type: string + xml: + name: Error + required: + - ErrorLocation + Error_ErrorLocation: + type: object + maximum: 1 + properties: + ErrorLocationElementName: + description: The Xpath name of the element in error. This is a valid Xpath pointing to an element in the request document. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + ErrorLocationAttributeName: + description: The name of the attribute in error. This is the name of the attribute contained by the Error Location element. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: ErrorLocation + Error_ErrorDigest: + description: The contents of the element in error. + type: string + QuantumViewResponse_QuantumViewEvents: + type: object + maximum: 1 + required: + - SubscriptionEvents + - SubscriberID + properties: + SubscriberID: + description: QV XOLT subscribers ID. It is the same as the User ID. + maximum: 1 + type: string + minLength: 1 + maxLength: 16 + SubscriptionEvents: + description: | + The event that a user receives a subset of Tracking information specific to either packages coming or packages going, after subscription request is made. + + **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" + xml: + name: QuantumViewEvents + description: The event that a user receives echoing Subscriber ID and information + for subscription event, which is a subset of Tracking information specific + to either packages coming or packages going, after subscription request is + made, if the user requests for XML format. + QuantumViewEvents_SubscriptionEvents: + type: object + maximum: 1 + properties: + Name: + description: A name uniquely defined associated to the Subscription ID, for each subscription. Required if the SubscriptionEvents container is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 21 + Number: + description: A number uniquely defined associated to the Subscriber ID, for each subscription. Required if the SubscriptionEvents container is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 16 + SubscriptionStatus: + "$ref": "#/components/schemas/SubscriptionEvents_SubscriptionStatus" + DateRange: + "$ref": "#/components/schemas/SubscriptionEvents_DateRange" + SubscriptionFile: + description: | + Container holds all of the unread files associated with the subscription. + + **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" + xml: + name: SubscriptionEvents + required: + - SubscriptionStatus + SubscriptionEvents_SubscriptionStatus: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + Status types of subscription. Valid values: + - UN – Unknown + - AT – Activate + - P – Pending + - A –Active + - I – Inactive + - S - Suspended + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + Description: + 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 + and is active.)\n- Inactive (The subscriber puts the subscription on hold.)\n- + Suspended (UPS disables the subscription.)" + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + xml: + name: SubscriptionStatus + description: Container for whether the subscription is active or not. + SubscriptionEvents_DateRange: + type: object + maximum: 1 + required: + - BeginDate + properties: + BeginDate: + description: |- + Beginning date time of subscription requested by user. + Format: MM-DD-YYYY-HH-MM + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + EndDate: + description: |- + Ending date time of subscription requested by user. + Format: MM-DD-YYYY-HH-MM + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + xml: + name: DateRange + description: The range of date time of subscription requested by user, as one + type of request criteria, valid up to but not exceeding 7 days into the past, + starting from current day. + SubscriptionEvents_SubscriptionFile: + type: object + maximum: 1 + required: + - StatusType + - FileName + properties: + FileName: + description: |- + File name belonging to specific subscription requested by user. + Format: YYMMDD_HHmmssnnn + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + 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. + + **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" + Origin: + description: | + Information about shipment's origin. + + **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" + Exception: + description: | + Shipment exception data. + + **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" + Delivery: + description: | + Container for delivery information. + + **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" + Generic: + description: | + Container for generic record information. + + **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" + xml: + name: SubscriptionFile + SubscriptionFile_StatusType: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Status types of subscription file. Valid values: + - R – Read + - U - Unread + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Description of a subscription file. + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + xml: + name: StatusType + description: Container that displays whether the file is read or unread. + SubscriptionFile_Manifest: + type: object + required: + - Shipper + - ConsigneeBillIndicator + - ShipTo + - CollectBillIndicator + properties: + Shipper: + "$ref": "#/components/schemas/Manifest_Shipper" + ShipTo: + "$ref": "#/components/schemas/Manifest_ShipTo" + ReferenceNumber: + description: | + Shipment-level reference numbers. + + **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" + 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). + Formatted as YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + ScheduledDeliveryDate: + description: The date the shipment originally was scheduled for delivery. + Formatted as YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + ScheduledDeliveryTime: + description: Schedule delivery time. Time format is HHMMSS + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + DocumentsOnly: + description: | + If the tag is present then the shipment is a document, otherwise the shipment is a non-document. Valid values: + - 1 = Letter + - 2 = Document (Non-Letter Document) + - 3 = Non-Document + - 4 = Pallet + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Package: + description: | + Defines a package. + + **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" + ShipmentServiceOptions: + "$ref": "#/components/schemas/Manifest_ShipmentServiceOptions" + ManufactureCountry: + description: Country or Territory of Manufacture of the contents of the + package. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + HarmonizedCode: + description: Harmonized code of the package. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + CustomsValue: + "$ref": "#/components/schemas/Manifest_CustomsValue" + SpecialInstructions: + description: User-defined special instructions for delivery. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ShipmentChargeType: + description: |- + Shipment charge type. + Valid values: + C/F - Cost and Freight + C/B - Consignee Billed Package + F/C - Freight Collect + DDP - Delivered Duty Paid + VAT Unpaid + FOB - Free On Board + P/P - Prepaid + F/D - Free Domicile + T/P - Third Party Billing + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + BillToAccount: + "$ref": "#/components/schemas/Manifest_BillToAccount" + ConsigneeBillIndicator: + description: Indicates if consignee will be billed the shipment. + maximum: 1 + type: string + CollectBillIndicator: + description: Indicates whether or not to collect bill at time of delivery. + maximum: 1 + type: string + LocationAssured: + description: 'Indicates Location Assured Values: Y - Location Assured accessorial + requested' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ImportControl: + description: Import Control Indication is used to designate that the shipment + is an Import Control shipment. If the shipment is an import control shipment + then this element will have value. For no import shipment this will not + be appear + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + LabelDeliveryMethod: + description: "Indicates Label Delivery Method, Values are: LDE Electronic Label. LDO One Attempt. LDP Print Label. LDT Three Attempt. LPM Print and Mail Label." + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + CommercialInvoiceRemoval: + description: Commercial Invoice Removal (CIR) is an accessorial or indication + that will allow a shipper to dictate that UPS remove the Commercial Invoice + from the user's shipment before the shipment is delivered to the ultimate + consignee. If shipment is CIR then this element will have value. For no + CIR this element will not be appear + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PostalServiceTrackingID: + description: Postal Service Tracking ID transport company tracking number. + maximum: 1 + type: string + minLength: 35 + maxLength: 35 + ReturnsFlexibleAccess: + description: "(RFA) UPS returns flexible access. This element will appear + with value only when returns flexible access uploaded. For no returns + flexible access this element will not be appear" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + UPScarbonneutral: + description: UPS carbon neutral is a term used to reflect a generic term + for the tagging to be included on any document, label, e-mail, etc. used + to identify that the UPS carbon neutral fee is applied. This element will + appear only when shipment is UPS carbon neutral with value. For non UPS + carbon neutral shipping this element appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Product: + description: This element will have value "PAC" for CAR shipments. For no CAR shipments this element will not be appeared. + maximum: 1 + type: string + UPSReturnsExchange: + description: UPS Return and Exchange – This element will appear with value Y only when UPS Return and Exchange was requested. For no UPS Returns and Exchange then this element will not appear + maximum: 1 + type: string + LiftGateOnDelivery: + description: Lift Gate On Delivery - This element will appear only when + Lift Gate For Delivery was requested for UPS World Wide Express Freight + Shipments. If no Lift Gate for Delivery was requested, this element will + not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + LiftGateOnPickUp: + description: Lift Gate On PickUp - This element will appear only when Lift + Gate For PickUp was requested for UPS World Wide Express Freight Shipments. + If no Lift Gate for PickUp was requested, this element will not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PickupPreference: + description: Pickup Preference -This element will appear only when Dropoff + At UPS Facility was requested for UPS World Wide Express Freight Shipments. + If no Dropoff At UPS Facility was requested, this element will not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + DeliveryPreference: + description: Delivery Preference - This element will appear only when Hold + for pick up was requested for UPS World Wide Express Freight Shipments. + If no Hold for pick up was requested, this element will not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + HoldForPickupAtUPSAccessPoint: + description: '"Y" Indicates Shipment is Direct to Retail.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + UAPAddress: + "$ref": "#/components/schemas/Manifest_UAPAddress" + DeliverToAddresseeOnlyIndicator: + description: '"Y" Indicates Shipment is Deliver to Addressee.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + UPSAccessPointCODIndicator: + description: '"Y" Indicates Shipment is Cash on Delivery in Direct to Retail' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ClinicalTrialIndicator: + description: 'An accessorial Indicator flag: Y = Clinical Trial accessorial + provided in Manifest. Spaces = Clinical Trial accessorial not provided + in Manifest.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ClinicalTrialIndicationNumber: + description: An unique Clinical Trial associated with the shipment provided + in Manifest. + maximum: 1 + type: string + maxLength: 20 + CategoryAHazardousIndicator: + description: 'An accessorial Indicator flag: Y = Category A Hazardous materials + accessorial provided in Manifest. Spaces = Category A Hazardous materials + accessorial not provided in Manifest.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + DirectDeliveryIndicator: + description: 'An accessorial Indicator flag: Y = Direct Delivery accessorisal + provided in Manifest. Spaces = Direct Delivery accessorial not provided + in Manifest.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PackageReleaseCodeIndicator: + description: '"Y" indicates Shipment has PackageReleaseCode Accessorial.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ProactiveResponseIndicator: + description: '"Y" indicates that a UPS Proactive Response Accessorial is + provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + WhiteGloveDeliveryIndicator: + description: '"Y" indicates that a Heavy Goods White Glove Delivery Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + RoomOfChoiceIndicator: + description: '"Y" indicates that a Heavy Goods Room of Choice Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + InstallationDeliveryIndicator: + description: '"Y" indicates that a Heavy Goods Installation Delivery Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ItemDisposalIndicator: + description: '"Y" indicates that a Heavy Goods Item Disposal Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + LeadShipmentTrackingNumber: + description: Lead Tracking Number in shipment + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + SaturdayNonPremiumCommercialDeliveryIndicator: + description: '"Y" indicates that a SaturdayNonPremiumCommercialDeliveryIndicator + is provided.' + type: string + minLength: 1 + maxLength: 1 + SundayNonPremiumCommercialDeliveryIndicator: + description: '"Y" indicates that a SundayNonPremiumCommercialDeliveryIndicator + is provided.' + type: string + minLength: 1 + maxLength: 1 + UPSPremierAccessorialIndicator: + description: "\"Y\" indicates that the UPS Premier accessorial is provided." + type: string + minLength: 1 + maxLength: 1 + UPSPremierCategoryCode: + description: | + Indicates the UPS Premier category applied to the package Valid values: + - 'PRS' – UPS Premier Silver + - 'PRG' – UPS Premier Gold + - 'PRP' - UPS Premier Platinum + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: Manifest + maximum: 1 + Manifest_Shipper: + type: object + maximum: 1 + required: + - Name + properties: + Name: + description: Shipper's company name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AttentionName: + description: Shipper's Attention Name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + TaxIdentificationNumber: + description: Shipper's Tax Identification Number. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + PhoneNumber: + description: Shipper's Phone Number. US Phone numbers must be 10 digits. + No formatting is allowed. Required if origin and destination countries + or territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + FaxNumber: + description: Shipper's Fax Number. US Fax numbers must be 10 digits. No + formatting is allowed. Required if origin and destination countries or + territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + EMailAddress: + description: Shipper's designated contact eMail address. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Address: + "$ref": "#/components/schemas/Shipper_Address" + xml: + name: Shipper + description: Shipper's record for a shipment. + Shipper_Address: + type: object + maximum: 1 + properties: + AddressLine1: + description: Address Line 1 of the Shipper. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine2: + description: Address Line 2 of the Shipper. Usually room/floor information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine3: + description: Address Line 3 of the shipper. Usually department information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: Shipper's City. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: Shipper's state or province code. Must be valid US state. If the Shipper's country or territory is US or CA a two character code is required, otherwise the StateProvinceCode is optional. + maximum: 1 + type: string + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: | + Shipper's country or territory code. + + Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ResidentialAddressIndicator: + description: If tag is present, then the address is residential address. Pickup location residential address indicator. The presence indicates residential address, the absence indicates a business address. + maximum: 1 + type: string + xml: + name: Address + description: Information that specifies a physical location. + Manifest_ShipTo: + type: object + maximum: 1 + properties: + ShipperAssignedIdentificationNumber: + description: An identification number specified by shipper. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + CompanyName: + description: Consignee's company name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AttentionName: + description: Contact name at the consignee's location. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + PhoneNumber: + description: Consignee's Phone Number. US Phone numbers must be 10 digits. + No formatting is allowed. Required if origin and destination countries + or territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + TaxIdentificationNumber: + description: Consignee's Tax Identification Number. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + FaxNumber: + description: Consignee's Fax Number. US Fax numbers must be 10 digits. No + formatting is allowed. Required if origin and destination countries or + territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + EMailAddress: + description: Consignee's email address. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Address: + "$ref": "#/components/schemas/ShipTo_Address" + LocationID: + description: Location name that the package is shipped to. + maximum: 1 + type: string + minLength: 3 + maxLength: 10 + ReceivingAddressName: + description: Name of the location where the package is received. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipTo + description: Address and contact information describing the location where a + return is to be delivered. + ShipTo_Address: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Consignee's name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine1: + description: Address Line 1 of the Consignee. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine2: + description: Address Line 2 of the Consignee. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine3: + description: Address Line 3 of the Consignee. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: Consignee's City. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: Consignee's state or province code. Must be valid US state. If the consignee's country or territory is US or CA a two character code is required. Otherwise, the StateProvinceCode is optional. + maximum: 1 + type: string + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: | + Consignee's country or territory code. + + Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: Address + description: Information that specifies a physical location. + Manifest_ReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: Reflects what will go on the label as the name of the reference. For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ReferenceNumber + required: + - Value + Manifest_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: For addition information, refer to the Service Codes table + in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground. + maximum: 1 + type: string + xml: + name: Service + description: Container for service code and description. + Manifest_Package: + type: object + properties: + Activity: + description: | + Information about package delivery activity. + + **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" + Description: + description: Description of package merchandise. + maximum: 1 + type: string + minLength: 1 + maxLength: 120 + Dimensions: + "$ref": "#/components/schemas/Package_Dimensions" + DimensionalWeight: + "$ref": "#/components/schemas/Package_DimensionalWeight" + PackageWeight: + "$ref": "#/components/schemas/Package_PackageWeight" + LargePackage: + description: | + Values for LargePackage are: + - 1 - Oversize 1 + - 2 - Oversize 2 + - 4 - Large package + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TrackingNumber: + description: Package's tracking number. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ReferenceNumber: + description: | + Container tag for information about the package-level reference number. + + **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" + PackageServiceOptions: + "$ref": "#/components/schemas/Package_PackageServiceOptions" + UPSPremiumCareIndicator: + description: Presence of the tag indicates UPSPremiumCare applies to this + package + maximum: 1 + type: string + maxLength: 1 + xml: + name: Package + maximum: 1 + Package_Activity: + type: object + maximum: 1 + properties: + Date: + description: "Date of package delivery activity. Date format: YYYYMMDD." + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: "Time of package delivery activity. Time format: HHMMSS" + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: Activity + Package_Dimensions: + type: object + maximum: 1 + required: + - Length + - Height + - Width + properties: + Length: + description: "Package length. \nValid values: 0 to 108 IN and 0 to 270 CM" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Width: + description: Package width. + maximum: 1 + type: string + minLength: 9 + maxLength: 9 + Height: + description: Package height. + maximum: 1 + type: string + minLength: 9 + maxLength: 9 + xml: + name: Dimensions + 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 + required: + - UnitOfMeasurement + - Weight + properties: + UnitOfMeasurement: + "$ref": "#/components/schemas/DimensionalWeight_UnitOfMeasurement" + Weight: + description: The value of package dimensional weight. A value of zero should + be used for letters. + type: string + xml: + name: DimensionalWeight + maximum: 1 + description: Container tag for package dimensional weight. + DimensionalWeight_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + The code representing the unit of measure associated with the shipment's dimensional weight. + Valid values: + LBS - Pounds (default) + KGS - Kilograms + Defaults Unit of Measurement used in the shipper's country or territory. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: A text description of the code representing the unit of measure + associated with the package weight. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: Container tag for package dimensional weight measurement units. + DimensionalWeight_Weight: + description: The value of package dimensional weight. A value of zero should + be used for letters. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + Package_PackageWeight: + type: object + maximum: 1 + required: + - Weight + properties: + Weight: + description: Package weight. Set to 0 for package type of letters or envelops. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: PackageWeight + description: Container tag for package weight. Required when the package type + is not UPS Letter. + Package_LargePackage: + description: Values for LargePackage are:1 - Oversize 1,� 2 - Oversize 2,� 4 + - Large package + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Package_TrackingNumber: + description: Package's tracking number. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + Package_ReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: Number tag. + type: string + Code: + description: "Reference number type code for entire shipment, two-character + 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 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number, defined by the shipper + and can contain any character string. Valid if the origin/destination + pair is US/US or PR/PR. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ReferenceNumber + required: + - Value + Package_PackageServiceOptions: + type: object + properties: + COD: + "$ref": "#/components/schemas/PackageServiceOptions_COD" + InsuredValue: + "$ref": "#/components/schemas/PackageServiceOptions_InsuredValue" + EarliestDeliveryTime: + description: Earliest delivery time. Time format is HHMMSS. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + HazardousMaterialsCode: + description: | + Indicates if the package contains hazardous materials. Valid values: + - 1 - Hazardous Material + - 2 - Electronically billed hazardous material. + + If present, only one package may exist in the shipment. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + HoldForPickup: + description: A flag indicating if a package should be held for pickup. True + if tag exists, false otherwise. + maximum: 1 + type: string + AddShippingChargesToCODIndicator: + description: An indicator flag that represents a Collect on Delivery (COD) + package. + maximum: 1 + type: string + xml: + name: PackageServiceOptions + maximum: 1 + required: + - HoldForPickup + description: Defines service options used for the package(s). + PackageServiceOptions_COD: + type: object + maximum: 1 + properties: + CODCode: + description: |- + The code associated with the type of COD. Valid values: + 1 - Regular COD + 2 - Express COD + 3 - Tagless COD + type: string + CODAmount: + "$ref": "#/components/schemas/COD_CODAmount" + xml: + name: COD + description: Container for cash on delivery (COD) information. + COD_CODCode: + description: |- + The code associated with the type of COD. Valid values: + 1 - Regular COD + 2 - Express COD + 3 - Tagless COD + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + COD_CODAmount: + type: object + maximum: 1 + properties: + CurrencyCode: + description: | + The IATA currency code associated with the COD amount for the package. + + Required if the value for COD amount exists in MonetaryValue tag. + + Must match one of the IATA currency codes. + + For addition information, refer to the Currency Codes table in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + MonetaryValue: + description: The COD value for the package. Required if CODCode is 1.Absolute maximum value is 21474836.47 (limited by the maximum value of a 32-bit integer). + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: CODAmount + description: The amount of the COD that is to be collected for the shipment. + PackageServiceOptions_InsuredValue: + type: object + maximum: 1 + properties: + CurrencyCode: + description: Not populated in this release. + maximum: 1 + type: string + MonetaryValue: + description: The monetary value for the insured value amount associated + with the package. Max value of 5,000 USD for Local and 50,000 USD for + Remote. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: InsuredValue + required: + - MonetaryValue + description: Container tag for insured value amount for the package. + Manifest_ShipmentServiceOptions: + type: object + maximum: 1 + required: + - SaturdayDelivery + - SaturdayPickup + properties: + SaturdayPickup: + description: A flag indicating if the shipment requires a Saturday pickup. + True if tag exists, false otherwise. + maximum: 1 + type: string + SaturdayDelivery: + description: A flag indicating if the shipment requires a Saturday Delivery. + True if tag exists, false otherwise. + maximum: 1 + type: string + CallTagARS: + "$ref": "#/components/schemas/ShipmentServiceOptions_CallTagARS" + xml: + name: ShipmentServiceOptions + description: Container tag for optional UPS services related to a shipment. + ShipmentServiceOptions_CallTagARS: + type: object + maximum: 1 + properties: + Number: + description: A reference number associated with the Call Tag service. Required + if CallTagARS/Code is 1. + maximum: 1 + type: string + minLength: 12 + maxLength: 12 + Code: + 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 + the Web" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: CallTagARS + description: Container for Call Tag service. + Manifest_CustomsValue: + type: object + maximum: 1 + required: + - MonetaryValue + properties: + MonetaryValue: + description: The shipment's customs value amount. + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + xml: + name: CustomsValue + description: Information about shipment's customs value. + Manifest_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + Manifest_UAPAddress: + type: object + maximum: 1 + properties: + CompanyName: + description: The name of person or company to whom package was shipped. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AttentionName: + description: The "Attention To" field for the person/company to whom package + is shipped. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + 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 + or territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + xml: + name: UAPAddress + description: Information about Hold for Pickup UPS Access Point Address + UAPAddress_Address: + type: object + maximum: 1 + properties: + AddressLine1: + description: Address Line 1 of the UPS Access Point. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine2: + description: Address Line 2 of the UPS Access Point. Usually room/floor + information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine3: + description: Address Line 3 of the UPS Access Point. Usually department + information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: UPS Access Point City. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: UPS Access Point's state or province code. Must be valid US + state. If the UPS Access Point country or territory is US or CA a two + character code is required, otherwise, the StateProvinceCode is optional. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + PostalCode: + description: 'UPS Access Point''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 an alphabetic character + and # is numeric digit. Otherwise, 1 to 16 alphanumeric characters are + allowed.' + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: 'UPS Access Point''s country or territory code. Valid values: + CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, + and VA' + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: Address + description: Information that specifies a physical location. + SubscriptionFile_Origin: + type: object + properties: + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + TrackingNumber: + description: Package's 1Z tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + Date: + description: Date that the package is picked up at the origin. Date format + is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: Time that the package is picked up at the origin. Time format + is HHMMSS. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ActivityLocation: + "$ref": "#/components/schemas/Origin_ActivityLocation" + BillToAccount: + "$ref": "#/components/schemas/Origin_BillToAccount" + ScheduledDeliveryDate: + description: Scheduled delivery date for destination address. Date format + is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + ScheduledDeliveryTime: + description: Scheduled delivery time for destination address. Time format + is HHMMSS. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: Origin + maximum: 1 + required: + - TrackingNumber + - ShipperNumber + - Time + - Date + Origin_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Origin_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Origin_ActivityLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" + xml: + name: ActivityLocation + description: Geographic location where an activity occurred during a movement + of a package or shipment. (ActivityLocation in Origin is identical to the + one in Manifest. But three of all elements in Origin/ActivityLocation/AddressArtifactFormat + are populated in this release. Refer to Manifest for remaining unpopulated + elements.) + maximum: 1 + ActivityLocation_AddressArtifactFormat: + type: object + maximum: 1 + properties: + PoliticalDivision2: + description: City of an activity occurred during a package shipment. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: State or province code of an activity occurred during a package shipment. Must be valid US state. If the country or territory is US or CA a two character code is required, otherwise, the StateProvinceCode is optional. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + CountryCode: + description: "Country or Territory code of an activity occurred during a package shipment. Valid values: CA, MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, and VA" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: AddressArtifactFormat + description: Information that specifies a physical location where package delivery + activity occurs. + Origin_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid Values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + SubscriptionFile_Exception: + type: object + properties: + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + TrackingNumber: + description: Package's 1Z tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + Date: + description: Date that the package is delivered. Date format is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: Time that the package is delivered. Time format is HHMMSS + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + UpdatedAddress: + "$ref": "#/components/schemas/Exception_UpdatedAddress" + StatusCode: + description: Code for status of updating shipping address issue. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + StatusDescription: + description: Description for status of updating shipping address issue. + maximum: 1 + type: string + minLength: 1 + maxLength: 120 + ReasonCode: + description: Code for reason of updating shipping address issue. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ReasonDescription: + description: Description for reason of updating shipping address issue. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + Resolution: + "$ref": "#/components/schemas/Exception_Resolution" + RescheduledDeliveryDate: + description: Rescheduled delivery date for updated shipping address. Date + format is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + RescheduledDeliveryTime: + description: Rescheduled delivery time for updated shipping address. Time + format is HHMMSS + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ActivityLocation: + "$ref": "#/components/schemas/Exception_ActivityLocation" + BillToAccount: + "$ref": "#/components/schemas/Exception_BillToAccount" + AccessPointLocationID: + description: The UPS Access Point Location ID. + maximum: 1 + type: string + maxLength: 9 + xml: + name: Exception + maximum: 1 + required: + - TrackingNumber + - ShipperNumber + - Time + - Date + Exception_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Exception_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Exception_UpdatedAddress: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Consignee's name for package shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + StreetNumberLow: + description: Street number of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + StreetPrefix: + description: Street prefix of updated shipping address, e.g. N, SE. It will + be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + StreetName: + description: Street name of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StreetType: + description: Street type of updated shipping address, e.g. ST. It will be + returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + StreetSuffix: + description: Street suffix of updated shipping address, e.g. N, SE. It will + be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + AddressExtendedInformation: + description: | + Container for information about updated shipping address. It will be returned if there is any update due to exception. + + **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" + PoliticalDivision3: + description: The neighborhood, town, barrio etc. It will be returned if + there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision2: + description: City name of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: Abbreviated state or province name of updated shipping address. + It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + CountryCode: + description: Abbreviated country or territory name of updated shipping address. + It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + PostcodePrimaryLow: + description: Postal Code of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: UpdatedAddress + description: Contains information about updated shipping address. + UpdatedAddress_AddressExtendedInformation: + type: object + maximum: 1 + properties: + Type: + description: Allows for secondary address information such as s suite or apartment. It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + Low: + description: The lower limit associated with the extended address type. It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + High: + description: The higher limit associated with the extended address type. It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + xml: + name: AddressExtendedInformation + Exception_Resolution: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: Type of resolution for updating shipping address issue. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Description of resolution type for updating shipping address. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + xml: + name: Resolution + description: Resolution for updating shipping address issue. + Exception_ActivityLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" + xml: + name: ActivityLocation + description: Geographic location where an activity occurred during a movement + of a package or shipment.(ActivityLocation in Exception is identical to the + one in Manifest. But three of all elements in Exception/ActivityLocation/AddressArtifactFormat + are populated in this release. Refer to Manifest for remaining unpopulated + elements.) + maximum: 1 + Exception_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid Values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + Indicates how shipping charges for the package were billed. Valid Values: 01 Shipper, 02 Consignee Billing ,03 Third Party, 04 Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + SubscriptionFile_Delivery: + type: object + properties: + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + TrackingNumber: + description: Package's 1Z tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + Date: + description: Date that the package is delivered. Date format is YYYYMMDD. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + Time: + description: Time that the package is delivered. Time format is HHMMSS + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + DriverRelease: + description: Information about driver release note / signature. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + ActivityLocation: + "$ref": "#/components/schemas/Delivery_ActivityLocation" + DeliveryLocation: + "$ref": "#/components/schemas/Delivery_DeliveryLocation" + COD: + "$ref": "#/components/schemas/Delivery_COD" + BillToAccount: + "$ref": "#/components/schemas/Delivery_BillToAccount" + LastPickupDate: + description: Last pickup by Date from the UPS Access Point Location. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + AccessPointLocationID: + description: UPS Access Point Location ID. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + xml: + name: Delivery + maximum: 1 + required: + - TrackingNumber + - ShipperNumber + - Time + - Date + Delivery_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Delivery_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Delivery_ActivityLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" + xml: + name: ActivityLocation + description: Geographic location where an activity occurred during a movement + of a package or shipment. (ActivityLocation in Delivery is identical to the + one in Manifest. But all elements in Delivery/ActivityLocation/AddressArtifactFormat + are populated in this release. Refer to Manifest for remaining unpopulated + elements.) + maximum: 1 + Delivery_DeliveryLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/DeliveryLocation_AddressArtifactFormat" + Code: + description: Location Code for delivered package. + maximum: 1 + type: string + minLength: 1 + maxLength: 16 + Description: + description: Description of the location where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + SignedForByName: + description: The person who signed for the package. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: DeliveryLocation + maximum: 1 + description: Information about the location where package is delivered. + DeliveryLocation_AddressArtifactFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Consignee's name at the location where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + StreetNumberLow: + description: Street number where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + StreetPrefix: + description: Street prefix where package is delivered, e.g. N, SE. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + StreetName: + description: Street name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StreetType: + description: Street type where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + StreetSuffix: + description: Street suffix where package is delivered, e.g. N, SE. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + BuildingName: + description: Building name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AddressExtendedInformation: + description: | + Container tag for additional address information where package is delivered. + + **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" + PoliticalDivision3: + description: The neighborhood, town, barrio etc. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision2: + description: City name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: Abbreviated state or province name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + CountryCode: + description: Abbreviated country or territory name where package is delivered. + type: string + PostcodePrimaryLow: + description: Postal Code where package is delivered. Required if the user + does not submit the City, Alphanumeric State/Province address combination. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + PostcodeExtendedLow: + description: 4 Digit postal code extension where package is delivered. Valid for US only. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + ResidentialAddressIndicator: + description: Residential address indicator for the location where package + is delivered. The presence indicates residential address, the absence + indicates a business address. + maximum: 1 + type: string + xml: + name: AddressArtifactFormat + description: Information that specifies a physical location where package is + delivered. + AddressArtifactFormat_AddressExtendedInformation: + type: object + maximum: 1 + properties: + Type: + description: Allows for secondary address information such as a suite or + apartment. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + Low: + description: The low number associated with an extended address. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + High: + description: The high number associated with an extended address. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + xml: + name: AddressExtendedInformation + Delivery_COD: + type: object + properties: + CODAmount: + "$ref": "#/components/schemas/COD_CODAmount" + xml: + name: COD + description: Container for cash on delivery (COD) information. + maximum: 1 + Delivery_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid Values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + SubscriptionFile_Generic: + type: object + maximum: 1 + required: + - TrackingNumber + - ActivityType + properties: + ActivityType: + description: | + Unique identifier that defines the type of activity. + - VM = Void for Manifest + - UR = Undeliverable Returns + - IR = Invoice Removal Successful + - TC = Transport Company USPS scan PS = 'Postal Service Possession Scan' + - FN = UPS Access Point/Alternate Delivery Location Email Notification Failure + - DS = Destination Scan + - AG = Package is in transit to a UPS facility + - RE = UPS Returns Exchange + - RP = Retail Pickup + - UD = Updated delivery date + - OD = Out for Delivery + - SD = Scheduled for Delivery + - FM = Tendered to FMP + - PT = UPS Courier Handoff (Package Tendered) DIALS -VX + - PC = UPS Courier Confirmation – XPLD -VX + - OT = Out For Delivery Today scan + - AD = At Delivery Site scan + - RO = Roadie Out for Delivery + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + TrackingNumber: + description: Package's tracking number. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ShipperNumber: + description: Shipper's alphanumeric account number. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + Service: + "$ref": "#/components/schemas/Generic_Service" + Activity: + "$ref": "#/components/schemas/Generic_Activity" + BillToAccount: + "$ref": "#/components/schemas/Generic_BillToAccount" + 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. + + If Activity Type is "OD", this element will contain Rescheduled Delivery Date. Format will be YYYYMMDD. + + If Activity Type is "SD", this element will contain agreed upon date with Customer for delivery Date. Format will be YYYYMMDD. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + FailureNotification: + "$ref": "#/components/schemas/Generic_FailureNotification" + xml: + name: Generic + Generic_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: "Reflects what will go on the label as the name of the reference. + \nFor addition information, refer to the Service Codes table in the Appendix." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Generic_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: "Reflects what will go on the label as the name of the reference. + \nFor addition information, refer to the Service Codes table in the Appendix." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Generic_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: For addition information, refer to the Service Codes table + in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Not used. + maximum: 1 + type: string + xml: + name: Service + description: Container for service code and description. + Generic_Activity: + type: object + maximum: 1 + properties: + Date: + description: Date of package activity (i.e. YYYYMMDD). If generic record ActivityType is TC then event date is the date of first USPS scan. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: Time of package activity(i.e. HHMMSS). If generic record ActivityType is TC then event time is the time of first USPS scan. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: Activity + description: Information about package activity. + Generic_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + 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 + Bill Option" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + Generic_ShipTo: + type: object + maximum: 1 + properties: + LocationID: + description: Location name that the package is shipped to. + maximum: 1 + type: string + minLength: 3 + maxLength: 10 + ReceivingAddressName: + description: Alias of the location where the package is received. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + Bookmark: + description: Bookmark of the package is shifted to. + maximum: 1 + type: string + xml: + name: ShipTo + description: Address and contact information describing the location where a + return is to be delivered. + Generic_FailureNotification: + type: object + maximum: 1 + properties: + FailedEmailAddress: + description: Email address that failed when an attempt was made to send + email to the customer + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + FailureNotificationCode: + "$ref": "#/components/schemas/FailureNotification_FailureNotificationCode" + xml: + name: FailureNotification + description: Failure notification information containing email address and Notification + code + FailureNotification_FailureNotificationCode: + type: object + maximum: 1 + properties: + Code: + description: |- + Code representing type of failure email notification. Valid values: + - 01 – Package is ready to pickup at UPS Access Point - Original + - 02 – Package is ready to pickup at UPS Access Point - Reminder + - 03 – Package is delivery to alternate delivery location + - 04 – Package is returned to Sender from UPS Access Point Location + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Not used. + maximum: 1 + type: string + xml: + name: FailureNotificationCode + description: Failure notification code information describing code. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/QuantumView.yaml b/QuantumView.yaml index df0fe51..46d48dd 100644 --- a/QuantumView.yaml +++ b/QuantumView.yaml @@ -1,3007 +1,3007 @@ -openapi: 3.0.3 -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 - - Appendix - - Errors - - FAQ - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/quantumview/{version}/events": - post: - summary: Quantum View - tags: - - Quantum View - security: - - OAuth2: [] - description: Get Quantum View Response - operationId: QuantumView - parameters: - - in: path - name: version - schema: - type: string - default: v3 - description: | - Version of API. - - Valid values: - - v3 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - QuantumViewRequest: - Request: - TransactionReference: - CustomerContext: '' - XpciVersion: '1.0007' - RequestAction: QVEvents - SubscriptionRequest: - FileName: '220104_140019001' - Name: OutboundXML - Bookmark: WE9MVFFBMQ== - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - "/quantumview/{deprecatedVersion}/events": - post: - deprecated: true - summary: Quantum View - tags: - - Quantum View - security: - - OAuth2: [] - description: Get Quantum View Response - operationId: Deprecated QuantumView - parameters: - - in: path - name: deprecatedVersion - schema: - type: string - default: v1 - description: | - Version of API. - - Valid values: - - v1 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" - examples: - json: - summary: A sample JSON request (Standard Example) - value: - QuantumViewRequest: - Request: - TransactionReference: - CustomerContext: '' - XpciVersion: '1.0007' - RequestAction: QVEvents - SubscriptionRequest: - FileName: '220104_140019001' - Name: OutboundXML - Bookmark: WE9MVFFBMQ== - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/ErrorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - QUANTUMVIEWRequestWrapper: - xml: - name: QuantumViewRequest - description: 'N/A ' - maximum: 1 - type: object - required: - - QuantumViewRequest - properties: - QuantumViewRequest: - "$ref": "#/components/schemas/QuantumViewRequest" - QUANTUMVIEWResponseWrapper: - xml: - name: QuantumViewResponse - description: 'N/A ' - maximum: 1 - type: object - required: - - QuantumViewResponse - properties: - QuantumViewResponse: - "$ref": "#/components/schemas/QuantumViewResponse" - QuantumViewRequest: - type: object - required: - - Request - properties: - Request: - "$ref": "#/components/schemas/QuantumViewRequest_Request" - SubscriptionRequest: - type: array - items: - "$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 - \ 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 - request." - maximum: 1 - type: string - xml: - name: QuantumViewRequest - maximum: 1 - description: Container for QuantumView request information. - QuantumViewRequest_Request: - type: object - properties: - TransactionReference: - "$ref": "#/components/schemas/Request_TransactionReference" - RequestAction: - description: Indicates the action to be taken by the XML service. The only - valid value is 'QVEvents' - maximum: 1 - type: string - minLength: 11 - maxLength: 11 - xml: - name: Request - maximum: 1 - required: - - RequestAction - description: Contains QuantumView request criteria components. - Request_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during response. - maximum: 1 - type: string - maxLength: 512 - xml: - name: TransactionReference - description: TransactionReference identifies transactions between client and - server. - QuantumViewRequest_SubscriptionRequest: - type: object - properties: - Name: - description: Name of subscription requested by user, as one type of request - criteria. Required when the customer wants to request data for a specific - subscription name. Subscription name consists of up to 21 alphanumerics. - type: string - maxLength: 21 - DateTimeRange: - "$ref": "#/components/schemas/SubscriptionRequest_DateTimeRange" - FileName: - description: 'File name of specific subscription requested by user. Format: - YYMMDD_HHmmssnnn. (nnn - sequence number: usually = 001)' - type: array - items: - type: string - minLength: 16 - maxLength: 16 - xml: - name: SubscriptionRequest - description: Subscription requested by user to retrieve Inbound or/and Outbound - XML formed subscription information. - SubscriptionRequest_DateTimeRange: - type: object - maximum: 1 - properties: - BeginDateTime: - description: 'Beginning date time for the retrieval criteria of the subscriptions. - It is required for date time request criteria. Format: YYYYMMDDHHmmss.' - maximum: 1 - type: string - minLength: 14 - 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 - the request, it is defaulted to 7 days from the given begin date.' - maximum: 1 - type: string - minLength: 14 - maxLength: 14 - xml: - name: DateTimeRange - description: The range of date time of subscription requested by user, as one - type of request criteria, valid up to but not exceeding 7 days into the past, - starting from current day. - QuantumViewResponse: - type: object - required: - - Response - - QuantumViewEvents - properties: - Response: - "$ref": "#/components/schemas/QuantumViewResponse_Response" - 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 - + File Name if the request is for all data. It 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 request. - type: string - xml: - name: QuantumViewResponse - maximum: 1 - description: Container for QuantumView response information. - QuantumViewResponse_Response: - type: object - required: - - TransactionReference - - ResponseStatusCode - properties: - TransactionReference: - "$ref": "#/components/schemas/Response_TransactionReference" - ResponseStatusCode: - description: "Identifies the success or failure of the interchange. \n1 - = Success, 0 = Failure" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ResponseStatusDescription: - description: "'Success' or 'Failure'" - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - Error: - description: | - If an error is encountered during the interchange, the Response contains an error. If the error is present, then the ErrorSeverity and ErrorCodes are required. - - **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" - xml: - name: Response - maximum: 1 - description: Contains Errors information tags along with the success/fail status - of the QuantumView request. - Response_TransactionReference: - type: object - maximum: 1 - properties: - CustomerContext: - description: The CustomerContext Information which will be echoed during response. - type: string - XpciVersion: - description: "XPCI version. Current version: 1.0007" - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ToolVersion: - description: "Current tool version. \nValid value: 1.0" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: TransactionReference - description: Container for customer provided data and the XPCI Version. - Response_Error: - type: object - maximum: 1 - properties: - ErrorSeverity: - description: Describes the severity of the error. Required if the error is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ErrorCode: - description: A numeric value that describes the error. Each tool defines a range of error codes. Required if the error is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ErrorDescription: - description: Describes the error code. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - MinimumRetrySeconds: - description: Number of seconds to wait until retry. This field is populated on special conditions of the Transient Error only, as defined by the service. A number between 1 and 86400 (24 hours) - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - ErrorLocation: - description: | - Identifies the element in error. - - **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" - ErrorDigest: - description: | - The contents of the element in error. - - **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: - type: string - xml: - name: Error - required: - - ErrorLocation - Error_ErrorLocation: - type: object - maximum: 1 - properties: - ErrorLocationElementName: - description: The Xpath name of the element in error. This is a valid Xpath pointing to an element in the request document. - maximum: 1 - type: string - minLength: 1 - maxLength: 512 - ErrorLocationAttributeName: - description: The name of the attribute in error. This is the name of the attribute contained by the Error Location element. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - xml: - name: ErrorLocation - Error_ErrorDigest: - description: The contents of the element in error. - type: string - QuantumViewResponse_QuantumViewEvents: - type: object - maximum: 1 - required: - - SubscriptionEvents - - SubscriberID - properties: - SubscriberID: - description: QV XOLT subscribers ID. It is the same as the User ID. - maximum: 1 - type: string - minLength: 1 - maxLength: 16 - SubscriptionEvents: - description: | - The event that a user receives a subset of Tracking information specific to either packages coming or packages going, after subscription request is made. - - **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" - xml: - name: QuantumViewEvents - description: The event that a user receives echoing Subscriber ID and information - for subscription event, which is a subset of Tracking information specific - to either packages coming or packages going, after subscription request is - made, if the user requests for XML format. - QuantumViewEvents_SubscriptionEvents: - type: object - maximum: 1 - properties: - Name: - description: A name uniquely defined associated to the Subscription ID, for each subscription. Required if the SubscriptionEvents container is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 21 - Number: - description: A number uniquely defined associated to the Subscriber ID, for each subscription. Required if the SubscriptionEvents container is present. - maximum: 1 - type: string - minLength: 1 - maxLength: 16 - SubscriptionStatus: - "$ref": "#/components/schemas/SubscriptionEvents_SubscriptionStatus" - DateRange: - "$ref": "#/components/schemas/SubscriptionEvents_DateRange" - SubscriptionFile: - description: | - Container holds all of the unread files associated with the subscription. - - **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" - xml: - name: SubscriptionEvents - required: - - SubscriptionStatus - SubscriptionEvents_SubscriptionStatus: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: | - Status types of subscription. Valid values: - - UN – Unknown - - AT – Activate - - P – Pending - - A –Active - - I – Inactive - - S - Suspended - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - Description: - 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 - and is active.)\n- Inactive (The subscriber puts the subscription on hold.)\n- - Suspended (UPS disables the subscription.)" - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - xml: - name: SubscriptionStatus - description: Container for whether the subscription is active or not. - SubscriptionEvents_DateRange: - type: object - maximum: 1 - required: - - BeginDate - properties: - BeginDate: - description: |- - Beginning date time of subscription requested by user. - Format: MM-DD-YYYY-HH-MM - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - EndDate: - description: |- - Ending date time of subscription requested by user. - Format: MM-DD-YYYY-HH-MM - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - xml: - name: DateRange - description: The range of date time of subscription requested by user, as one - type of request criteria, valid up to but not exceeding 7 days into the past, - starting from current day. - SubscriptionEvents_SubscriptionFile: - type: object - maximum: 1 - required: - - StatusType - - FileName - properties: - FileName: - description: |- - File name belonging to specific subscription requested by user. - Format: YYMMDD_HHmmssnnn - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - 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. - - **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" - Origin: - description: | - Information about shipment's origin. - - **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" - Exception: - description: | - Shipment exception data. - - **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" - Delivery: - description: | - Container for delivery information. - - **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" - Generic: - description: | - Container for generic record information. - - **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" - xml: - name: SubscriptionFile - SubscriptionFile_StatusType: - type: object - maximum: 1 - required: - - Description - - Code - properties: - Code: - description: | - Status types of subscription file. Valid values: - - R – Read - - U - Unread - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Description: - description: Description of a subscription file. - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - xml: - name: StatusType - description: Container that displays whether the file is read or unread. - SubscriptionFile_Manifest: - type: object - required: - - Shipper - - ConsigneeBillIndicator - - ShipTo - - CollectBillIndicator - properties: - Shipper: - "$ref": "#/components/schemas/Manifest_Shipper" - ShipTo: - "$ref": "#/components/schemas/Manifest_ShipTo" - ReferenceNumber: - description: | - Shipment-level reference numbers. - - **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" - 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). - Formatted as YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - ScheduledDeliveryDate: - description: The date the shipment originally was scheduled for delivery. - Formatted as YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - ScheduledDeliveryTime: - description: Schedule delivery time. Time format is HHMMSS - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - DocumentsOnly: - description: | - If the tag is present then the shipment is a document, otherwise the shipment is a non-document. Valid values: - - 1 = Letter - - 2 = Document (Non-Letter Document) - - 3 = Non-Document - - 4 = Pallet - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Package: - description: | - Defines a package. - - **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" - ShipmentServiceOptions: - "$ref": "#/components/schemas/Manifest_ShipmentServiceOptions" - ManufactureCountry: - description: Country or Territory of Manufacture of the contents of the - package. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - HarmonizedCode: - description: Harmonized code of the package. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - CustomsValue: - "$ref": "#/components/schemas/Manifest_CustomsValue" - SpecialInstructions: - description: User-defined special instructions for delivery. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ShipmentChargeType: - description: |- - Shipment charge type. - Valid values: - C/F - Cost and Freight - C/B - Consignee Billed Package - F/C - Freight Collect - DDP - Delivered Duty Paid - VAT Unpaid - FOB - Free On Board - P/P - Prepaid - F/D - Free Domicile - T/P - Third Party Billing - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - BillToAccount: - "$ref": "#/components/schemas/Manifest_BillToAccount" - ConsigneeBillIndicator: - description: Indicates if consignee will be billed the shipment. - maximum: 1 - type: string - CollectBillIndicator: - description: Indicates whether or not to collect bill at time of delivery. - maximum: 1 - type: string - LocationAssured: - description: 'Indicates Location Assured Values: Y - Location Assured accessorial - requested' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ImportControl: - description: Import Control Indication is used to designate that the shipment - is an Import Control shipment. If the shipment is an import control shipment - then this element will have value. For no import shipment this will not - be appear - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - LabelDeliveryMethod: - description: "Indicates Label Delivery Method, Values are: LDE Electronic Label. LDO One Attempt. LDP Print Label. LDT Three Attempt. LPM Print and Mail Label." - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - CommercialInvoiceRemoval: - description: Commercial Invoice Removal (CIR) is an accessorial or indication - that will allow a shipper to dictate that UPS remove the Commercial Invoice - from the user's shipment before the shipment is delivered to the ultimate - consignee. If shipment is CIR then this element will have value. For no - CIR this element will not be appear - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PostalServiceTrackingID: - description: Postal Service Tracking ID transport company tracking number. - maximum: 1 - type: string - minLength: 35 - maxLength: 35 - ReturnsFlexibleAccess: - description: "(RFA) UPS returns flexible access. This element will appear - with value only when returns flexible access uploaded. For no returns - flexible access this element will not be appear" - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - UPScarbonneutral: - description: UPS carbon neutral is a term used to reflect a generic term - for the tagging to be included on any document, label, e-mail, etc. used - to identify that the UPS carbon neutral fee is applied. This element will - appear only when shipment is UPS carbon neutral with value. For non UPS - carbon neutral shipping this element appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Product: - description: This element will have value "PAC" for CAR shipments. For no CAR shipments this element will not be appeared. - maximum: 1 - type: string - UPSReturnsExchange: - description: UPS Return and Exchange – This element will appear with value Y only when UPS Return and Exchange was requested. For no UPS Returns and Exchange then this element will not appear - maximum: 1 - type: string - LiftGateOnDelivery: - description: Lift Gate On Delivery - This element will appear only when - Lift Gate For Delivery was requested for UPS World Wide Express Freight - Shipments. If no Lift Gate for Delivery was requested, this element will - not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - LiftGateOnPickUp: - description: Lift Gate On PickUp - This element will appear only when Lift - Gate For PickUp was requested for UPS World Wide Express Freight Shipments. - If no Lift Gate for PickUp was requested, this element will not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PickupPreference: - description: Pickup Preference -This element will appear only when Dropoff - At UPS Facility was requested for UPS World Wide Express Freight Shipments. - If no Dropoff At UPS Facility was requested, this element will not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - DeliveryPreference: - description: Delivery Preference - This element will appear only when Hold - for pick up was requested for UPS World Wide Express Freight Shipments. - If no Hold for pick up was requested, this element will not appear. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - HoldForPickupAtUPSAccessPoint: - description: '"Y" Indicates Shipment is Direct to Retail.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - UAPAddress: - "$ref": "#/components/schemas/Manifest_UAPAddress" - DeliverToAddresseeOnlyIndicator: - description: '"Y" Indicates Shipment is Deliver to Addressee.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - UPSAccessPointCODIndicator: - description: '"Y" Indicates Shipment is Cash on Delivery in Direct to Retail' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ClinicalTrialIndicator: - description: 'An accessorial Indicator flag: Y = Clinical Trial accessorial - provided in Manifest. Spaces = Clinical Trial accessorial not provided - in Manifest.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ClinicalTrialIndicationNumber: - description: An unique Clinical Trial associated with the shipment provided - in Manifest. - maximum: 1 - type: string - maxLength: 20 - CategoryAHazardousIndicator: - description: 'An accessorial Indicator flag: Y = Category A Hazardous materials - accessorial provided in Manifest. Spaces = Category A Hazardous materials - accessorial not provided in Manifest.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - DirectDeliveryIndicator: - description: 'An accessorial Indicator flag: Y = Direct Delivery accessorisal - provided in Manifest. Spaces = Direct Delivery accessorial not provided - in Manifest.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - PackageReleaseCodeIndicator: - description: '"Y" indicates Shipment has PackageReleaseCode Accessorial.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ProactiveResponseIndicator: - description: '"Y" indicates that a UPS Proactive Response Accessorial is - provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - WhiteGloveDeliveryIndicator: - description: '"Y" indicates that a Heavy Goods White Glove Delivery Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - RoomOfChoiceIndicator: - description: '"Y" indicates that a Heavy Goods Room of Choice Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - InstallationDeliveryIndicator: - description: '"Y" indicates that a Heavy Goods Installation Delivery Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ItemDisposalIndicator: - description: '"Y" indicates that a Heavy Goods Item Disposal Accessorial - is provided.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - LeadShipmentTrackingNumber: - description: Lead Tracking Number in shipment - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - SaturdayNonPremiumCommercialDeliveryIndicator: - description: '"Y" indicates that a SaturdayNonPremiumCommercialDeliveryIndicator - is provided.' - type: string - minLength: 1 - maxLength: 1 - SundayNonPremiumCommercialDeliveryIndicator: - description: '"Y" indicates that a SundayNonPremiumCommercialDeliveryIndicator - is provided.' - type: string - minLength: 1 - maxLength: 1 - UPSPremierAccessorialIndicator: - description: "\"Y\" indicates that the UPS Premier accessorial is provided." - type: string - minLength: 1 - maxLength: 1 - UPSPremierCategoryCode: - description: | - Indicates the UPS Premier category applied to the package Valid values: - - 'PRS' – UPS Premier Silver - - 'PRG' – UPS Premier Gold - - 'PRP' - UPS Premier Platinum - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: Manifest - maximum: 1 - Manifest_Shipper: - type: object - maximum: 1 - required: - - Name - properties: - Name: - description: Shipper's company name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AttentionName: - description: Shipper's Attention Name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - TaxIdentificationNumber: - description: Shipper's Tax Identification Number. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - PhoneNumber: - description: Shipper's Phone Number. US Phone numbers must be 10 digits. - No formatting is allowed. Required if origin and destination countries - or territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - FaxNumber: - description: Shipper's Fax Number. US Fax numbers must be 10 digits. No - formatting is allowed. Required if origin and destination countries or - territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - EMailAddress: - description: Shipper's designated contact eMail address. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Address: - "$ref": "#/components/schemas/Shipper_Address" - xml: - name: Shipper - description: Shipper's record for a shipment. - Shipper_Address: - type: object - maximum: 1 - properties: - AddressLine1: - description: Address Line 1 of the Shipper. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine2: - description: Address Line 2 of the Shipper. Usually room/floor information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine3: - description: Address Line 3 of the shipper. Usually department information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: Shipper's City. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: Shipper's state or province code. Must be valid US state. If the Shipper's country or territory is US or CA a two character code is required, otherwise the StateProvinceCode is optional. - maximum: 1 - type: string - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: | - Shipper's country or territory code. - - Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ResidentialAddressIndicator: - description: If tag is present, then the address is residential address. Pickup location residential address indicator. The presence indicates residential address, the absence indicates a business address. - maximum: 1 - type: string - xml: - name: Address - description: Information that specifies a physical location. - Manifest_ShipTo: - type: object - maximum: 1 - properties: - ShipperAssignedIdentificationNumber: - description: An identification number specified by shipper. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - CompanyName: - description: Consignee's company name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AttentionName: - description: Contact name at the consignee's location. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - PhoneNumber: - description: Consignee's Phone Number. US Phone numbers must be 10 digits. - No formatting is allowed. Required if origin and destination countries - or territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - TaxIdentificationNumber: - description: Consignee's Tax Identification Number. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - FaxNumber: - description: Consignee's Fax Number. US Fax numbers must be 10 digits. No - formatting is allowed. Required if origin and destination countries or - territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - EMailAddress: - description: Consignee's email address. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - Address: - "$ref": "#/components/schemas/ShipTo_Address" - LocationID: - description: Location name that the package is shipped to. - maximum: 1 - type: string - minLength: 3 - maxLength: 10 - ReceivingAddressName: - description: Name of the location where the package is received. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipTo - description: Address and contact information describing the location where a - return is to be delivered. - ShipTo_Address: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Consignee's name. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine1: - description: Address Line 1 of the Consignee. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine2: - description: Address Line 2 of the Consignee. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine3: - description: Address Line 3 of the Consignee. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: Consignee's City. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: Consignee's state or province code. Must be valid US state. If the consignee's country or territory is US or CA a two character code is required. Otherwise, the StateProvinceCode is optional. - maximum: 1 - type: string - 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. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: | - Consignee's country or territory code. - - Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: Address - description: Information that specifies a physical location. - Manifest_ReferenceNumber: - type: object - maximum: 1 - properties: - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: Reflects what will go on the label as the name of the reference. For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ReferenceNumber - required: - - Value - Manifest_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: For addition information, refer to the Service Codes table - in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground. - maximum: 1 - type: string - xml: - name: Service - description: Container for service code and description. - Manifest_Package: - type: object - properties: - Activity: - description: | - Information about package delivery activity. - - **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" - Description: - description: Description of package merchandise. - maximum: 1 - type: string - minLength: 1 - maxLength: 120 - Dimensions: - "$ref": "#/components/schemas/Package_Dimensions" - DimensionalWeight: - "$ref": "#/components/schemas/Package_DimensionalWeight" - PackageWeight: - "$ref": "#/components/schemas/Package_PackageWeight" - LargePackage: - description: | - Values for LargePackage are: - - 1 - Oversize 1 - - 2 - Oversize 2 - - 4 - Large package - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - TrackingNumber: - description: Package's tracking number. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ReferenceNumber: - description: | - Container tag for information about the package-level reference number. - - **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" - PackageServiceOptions: - "$ref": "#/components/schemas/Package_PackageServiceOptions" - UPSPremiumCareIndicator: - description: Presence of the tag indicates UPSPremiumCare applies to this - package - maximum: 1 - type: string - maxLength: 1 - xml: - name: Package - maximum: 1 - Package_Activity: - type: object - maximum: 1 - properties: - Date: - description: "Date of package delivery activity. Date format: YYYYMMDD." - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: "Time of package delivery activity. Time format: HHMMSS" - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: Activity - Package_Dimensions: - type: object - maximum: 1 - required: - - Length - - Height - - Width - properties: - Length: - description: "Package length. \nValid values: 0 to 108 IN and 0 to 270 CM" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Width: - description: Package width. - maximum: 1 - type: string - minLength: 9 - maxLength: 9 - Height: - description: Package height. - maximum: 1 - type: string - minLength: 9 - maxLength: 9 - xml: - name: Dimensions - 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 - required: - - UnitOfMeasurement - - Weight - properties: - UnitOfMeasurement: - "$ref": "#/components/schemas/DimensionalWeight_UnitOfMeasurement" - Weight: - description: The value of package dimensional weight. A value of zero should - be used for letters. - type: string - xml: - name: DimensionalWeight - maximum: 1 - description: Container tag for package dimensional weight. - DimensionalWeight_UnitOfMeasurement: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: |- - The code representing the unit of measure associated with the shipment's dimensional weight. - Valid values: - LBS - Pounds (default) - KGS - Kilograms - Defaults Unit of Measurement used in the shipper's country or territory. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: A text description of the code representing the unit of measure - associated with the package weight. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: UnitOfMeasurement - description: Container tag for package dimensional weight measurement units. - DimensionalWeight_Weight: - description: The value of package dimensional weight. A value of zero should - be used for letters. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - Package_PackageWeight: - type: object - maximum: 1 - required: - - Weight - properties: - Weight: - description: Package weight. Set to 0 for package type of letters or envelops. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: PackageWeight - description: Container tag for package weight. Required when the package type - is not UPS Letter. - Package_LargePackage: - description: Values for LargePackage are:1 - Oversize 1,� 2 - Oversize 2,� 4 - - Large package - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Package_TrackingNumber: - description: Package's tracking number. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - Package_ReferenceNumber: - type: object - maximum: 1 - properties: - Number: - description: Number tag. - type: string - Code: - description: "Reference number type code for entire shipment, two-character - 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 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number, defined by the shipper - and can contain any character string. Valid if the origin/destination - pair is US/US or PR/PR. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ReferenceNumber - required: - - Value - Package_PackageServiceOptions: - type: object - properties: - COD: - "$ref": "#/components/schemas/PackageServiceOptions_COD" - InsuredValue: - "$ref": "#/components/schemas/PackageServiceOptions_InsuredValue" - EarliestDeliveryTime: - description: Earliest delivery time. Time format is HHMMSS. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - HazardousMaterialsCode: - description: | - Indicates if the package contains hazardous materials. Valid values: - - 1 - Hazardous Material - - 2 - Electronically billed hazardous material. - - If present, only one package may exist in the shipment. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - HoldForPickup: - description: A flag indicating if a package should be held for pickup. True - if tag exists, false otherwise. - maximum: 1 - type: string - AddShippingChargesToCODIndicator: - description: An indicator flag that represents a Collect on Delivery (COD) - package. - maximum: 1 - type: string - xml: - name: PackageServiceOptions - maximum: 1 - required: - - HoldForPickup - description: Defines service options used for the package(s). - PackageServiceOptions_COD: - type: object - maximum: 1 - properties: - CODCode: - description: |- - The code associated with the type of COD. Valid values: - 1 - Regular COD - 2 - Express COD - 3 - Tagless COD - type: string - CODAmount: - "$ref": "#/components/schemas/COD_CODAmount" - xml: - name: COD - description: Container for cash on delivery (COD) information. - COD_CODCode: - description: |- - The code associated with the type of COD. Valid values: - 1 - Regular COD - 2 - Express COD - 3 - Tagless COD - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - COD_CODAmount: - type: object - maximum: 1 - properties: - CurrencyCode: - description: | - The IATA currency code associated with the COD amount for the package. - - Required if the value for COD amount exists in MonetaryValue tag. - - Must match one of the IATA currency codes. - - For addition information, refer to the Currency Codes table in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - MonetaryValue: - description: The COD value for the package. Required if CODCode is 1.Absolute maximum value is 21474836.47 (limited by the maximum value of a 32-bit integer). - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: CODAmount - description: The amount of the COD that is to be collected for the shipment. - PackageServiceOptions_InsuredValue: - type: object - maximum: 1 - properties: - CurrencyCode: - description: Not populated in this release. - maximum: 1 - type: string - MonetaryValue: - description: The monetary value for the insured value amount associated - with the package. Max value of 5,000 USD for Local and 50,000 USD for - Remote. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - xml: - name: InsuredValue - required: - - MonetaryValue - description: Container tag for insured value amount for the package. - Manifest_ShipmentServiceOptions: - type: object - maximum: 1 - required: - - SaturdayDelivery - - SaturdayPickup - properties: - SaturdayPickup: - description: A flag indicating if the shipment requires a Saturday pickup. - True if tag exists, false otherwise. - maximum: 1 - type: string - SaturdayDelivery: - description: A flag indicating if the shipment requires a Saturday Delivery. - True if tag exists, false otherwise. - maximum: 1 - type: string - CallTagARS: - "$ref": "#/components/schemas/ShipmentServiceOptions_CallTagARS" - xml: - name: ShipmentServiceOptions - description: Container tag for optional UPS services related to a shipment. - ShipmentServiceOptions_CallTagARS: - type: object - maximum: 1 - properties: - Number: - description: A reference number associated with the Call Tag service. Required - if CallTagARS/Code is 1. - maximum: 1 - type: string - minLength: 12 - maxLength: 12 - Code: - 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 - the Web" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: CallTagARS - description: Container for Call Tag service. - Manifest_CustomsValue: - type: object - maximum: 1 - required: - - MonetaryValue - properties: - MonetaryValue: - description: The shipment's customs value amount. - maximum: 1 - type: string - minLength: 16 - maxLength: 16 - xml: - name: CustomsValue - description: Information about shipment's customs value. - Manifest_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - Manifest_UAPAddress: - type: object - maximum: 1 - properties: - CompanyName: - description: The name of person or company to whom package was shipped. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AttentionName: - description: The "Attention To" field for the person/company to whom package - is shipped. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - 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 - or territories are different. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - xml: - name: UAPAddress - description: Information about Hold for Pickup UPS Access Point Address - UAPAddress_Address: - type: object - maximum: 1 - properties: - AddressLine1: - description: Address Line 1 of the UPS Access Point. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine2: - description: Address Line 2 of the UPS Access Point. Usually room/floor - information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - AddressLine3: - description: Address Line 3 of the UPS Access Point. Usually department - information. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - City: - description: UPS Access Point City. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - StateProvinceCode: - description: UPS Access Point's state or province code. Must be valid US - state. If the UPS Access Point country or territory is US or CA a two - character code is required, otherwise, the StateProvinceCode is optional. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - PostalCode: - description: 'UPS Access Point''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 an alphabetic character - and # is numeric digit. Otherwise, 1 to 16 alphanumeric characters are - allowed.' - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - CountryCode: - description: 'UPS Access Point''s country or territory code. Valid values: - CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, - and VA' - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - xml: - name: Address - description: Information that specifies a physical location. - SubscriptionFile_Origin: - type: object - properties: - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - TrackingNumber: - description: Package's 1Z tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - Date: - description: Date that the package is picked up at the origin. Date format - is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: Time that the package is picked up at the origin. Time format - is HHMMSS. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ActivityLocation: - "$ref": "#/components/schemas/Origin_ActivityLocation" - BillToAccount: - "$ref": "#/components/schemas/Origin_BillToAccount" - ScheduledDeliveryDate: - description: Scheduled delivery date for destination address. Date format - is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - ScheduledDeliveryTime: - description: Scheduled delivery time for destination address. Time format - is HHMMSS. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: Origin - maximum: 1 - required: - - TrackingNumber - - ShipperNumber - - Time - - Date - Origin_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Origin_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Origin_ActivityLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" - xml: - name: ActivityLocation - description: Geographic location where an activity occurred during a movement - of a package or shipment. (ActivityLocation in Origin is identical to the - one in Manifest. But three of all elements in Origin/ActivityLocation/AddressArtifactFormat - are populated in this release. Refer to Manifest for remaining unpopulated - elements.) - maximum: 1 - ActivityLocation_AddressArtifactFormat: - type: object - maximum: 1 - properties: - PoliticalDivision2: - description: City of an activity occurred during a package shipment. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: State or province code of an activity occurred during a package shipment. Must be valid US state. If the country or territory is US or CA a two character code is required, otherwise, the StateProvinceCode is optional. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - CountryCode: - description: "Country or Territory code of an activity occurred during a package shipment. Valid values: CA, MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, and VA" - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - xml: - name: AddressArtifactFormat - description: Information that specifies a physical location where package delivery - activity occurs. - Origin_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid Values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - SubscriptionFile_Exception: - type: object - properties: - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - TrackingNumber: - description: Package's 1Z tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - Date: - description: Date that the package is delivered. Date format is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: Time that the package is delivered. Time format is HHMMSS - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - UpdatedAddress: - "$ref": "#/components/schemas/Exception_UpdatedAddress" - StatusCode: - description: Code for status of updating shipping address issue. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - StatusDescription: - description: Description for status of updating shipping address issue. - maximum: 1 - type: string - minLength: 1 - maxLength: 120 - ReasonCode: - description: Code for reason of updating shipping address issue. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ReasonDescription: - description: Description for reason of updating shipping address issue. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - Resolution: - "$ref": "#/components/schemas/Exception_Resolution" - RescheduledDeliveryDate: - description: Rescheduled delivery date for updated shipping address. Date - format is YYYYMMDD. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - RescheduledDeliveryTime: - description: Rescheduled delivery time for updated shipping address. Time - format is HHMMSS - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - ActivityLocation: - "$ref": "#/components/schemas/Exception_ActivityLocation" - BillToAccount: - "$ref": "#/components/schemas/Exception_BillToAccount" - AccessPointLocationID: - description: The UPS Access Point Location ID. - maximum: 1 - type: string - maxLength: 9 - xml: - name: Exception - maximum: 1 - required: - - TrackingNumber - - ShipperNumber - - Time - - Date - Exception_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Exception_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - maximum: 1 - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Exception_UpdatedAddress: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Consignee's name for package shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - StreetNumberLow: - description: Street number of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - StreetPrefix: - description: Street prefix of updated shipping address, e.g. N, SE. It will - be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - StreetName: - description: Street name of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StreetType: - description: Street type of updated shipping address, e.g. ST. It will be - returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - StreetSuffix: - description: Street suffix of updated shipping address, e.g. N, SE. It will - be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - AddressExtendedInformation: - description: | - Container for information about updated shipping address. It will be returned if there is any update due to exception. - - **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" - PoliticalDivision3: - description: The neighborhood, town, barrio etc. It will be returned if - there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision2: - description: City name of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: Abbreviated state or province name of updated shipping address. - It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 2 - maxLength: 5 - CountryCode: - description: Abbreviated country or territory name of updated shipping address. - It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - PostcodePrimaryLow: - description: Postal Code of updated shipping address. It will be returned - if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: UpdatedAddress - description: Contains information about updated shipping address. - UpdatedAddress_AddressExtendedInformation: - type: object - maximum: 1 - properties: - Type: - description: Allows for secondary address information such as s suite or apartment. It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - Low: - description: The lower limit associated with the extended address type. It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - High: - description: The higher limit associated with the extended address type. It will be returned if there is any update due to exception. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - xml: - name: AddressExtendedInformation - Exception_Resolution: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: Type of resolution for updating shipping address issue. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Description of resolution type for updating shipping address. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - xml: - name: Resolution - description: Resolution for updating shipping address issue. - Exception_ActivityLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" - xml: - name: ActivityLocation - description: Geographic location where an activity occurred during a movement - of a package or shipment.(ActivityLocation in Exception is identical to the - one in Manifest. But three of all elements in Exception/ActivityLocation/AddressArtifactFormat - are populated in this release. Refer to Manifest for remaining unpopulated - elements.) - maximum: 1 - Exception_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid Values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - Indicates how shipping charges for the package were billed. Valid Values: 01 Shipper, 02 Consignee Billing ,03 Third Party, 04 Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - SubscriptionFile_Delivery: - type: object - properties: - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - ShipperNumber: - description: Shipper's six digit alphanumeric account number. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - TrackingNumber: - description: Package's 1Z tracking number. - maximum: 1 - type: string - minLength: 18 - maxLength: 18 - Date: - description: Date that the package is delivered. Date format is YYYYMMDD. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - Time: - description: Time that the package is delivered. Time format is HHMMSS - maximum: 1 - type: string - minLength: 1 - maxLength: 6 - DriverRelease: - description: Information about driver release note / signature. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - ActivityLocation: - "$ref": "#/components/schemas/Delivery_ActivityLocation" - DeliveryLocation: - "$ref": "#/components/schemas/Delivery_DeliveryLocation" - COD: - "$ref": "#/components/schemas/Delivery_COD" - BillToAccount: - "$ref": "#/components/schemas/Delivery_BillToAccount" - LastPickupDate: - description: Last pickup by Date from the UPS Access Point Location. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - AccessPointLocationID: - description: UPS Access Point Location ID. - maximum: 1 - type: string - minLength: 1 - maxLength: 9 - xml: - name: Delivery - maximum: 1 - required: - - TrackingNumber - - ShipperNumber - - Time - - Date - Delivery_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Delivery_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: | - Reflects what will go on the label as the name of the reference. - - For additional information, refer to the Reference Codes table in the Appendix. - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Delivery_ActivityLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" - xml: - name: ActivityLocation - description: Geographic location where an activity occurred during a movement - of a package or shipment. (ActivityLocation in Delivery is identical to the - one in Manifest. But all elements in Delivery/ActivityLocation/AddressArtifactFormat - are populated in this release. Refer to Manifest for remaining unpopulated - elements.) - maximum: 1 - Delivery_DeliveryLocation: - type: object - required: - - AddressArtifactFormat - properties: - AddressArtifactFormat: - "$ref": "#/components/schemas/DeliveryLocation_AddressArtifactFormat" - Code: - description: Location Code for delivered package. - maximum: 1 - type: string - minLength: 1 - maxLength: 16 - Description: - description: Description of the location where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - SignedForByName: - description: The person who signed for the package. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: DeliveryLocation - maximum: 1 - description: Information about the location where package is delivered. - DeliveryLocation_AddressArtifactFormat: - type: object - maximum: 1 - properties: - ConsigneeName: - description: Consignee's name at the location where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - StreetNumberLow: - description: Street number where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - StreetPrefix: - description: Street prefix where package is delivered, e.g. N, SE. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - StreetName: - description: Street name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - StreetType: - description: Street type where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - StreetSuffix: - description: Street suffix where package is delivered, e.g. N, SE. - maximum: 1 - type: string - minLength: 1 - maxLength: 2 - BuildingName: - description: Building name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - AddressExtendedInformation: - description: | - Container tag for additional address information where package is delivered. - - **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" - PoliticalDivision3: - description: The neighborhood, town, barrio etc. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision2: - description: City name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 30 - PoliticalDivision1: - description: Abbreviated state or province name where package is delivered. - maximum: 1 - type: string - minLength: 1 - maxLength: 5 - CountryCode: - description: Abbreviated country or territory name where package is delivered. - type: string - PostcodePrimaryLow: - description: Postal Code where package is delivered. Required if the user - does not submit the City, Alphanumeric State/Province address combination. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - PostcodeExtendedLow: - description: 4 Digit postal code extension where package is delivered. Valid for US only. - maximum: 1 - type: string - minLength: 1 - maxLength: 4 - ResidentialAddressIndicator: - description: Residential address indicator for the location where package - is delivered. The presence indicates residential address, the absence - indicates a business address. - maximum: 1 - type: string - xml: - name: AddressArtifactFormat - description: Information that specifies a physical location where package is - delivered. - AddressArtifactFormat_AddressExtendedInformation: - type: object - maximum: 1 - properties: - Type: - description: Allows for secondary address information such as a suite or - apartment. - maximum: 1 - type: string - minLength: 1 - maxLength: 40 - Low: - description: The low number associated with an extended address. - maximum: 1 - type: string - minLength: 1 - maxLength: 11 - High: - description: The high number associated with an extended address. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - xml: - name: AddressExtendedInformation - Delivery_COD: - type: object - properties: - CODAmount: - "$ref": "#/components/schemas/COD_CODAmount" - xml: - name: COD - description: Container for cash on delivery (COD) information. - maximum: 1 - Delivery_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - properties: - Option: - description: | - Indicates how shipping charges for the package were billed. Valid Values: - - 01 - Shipper - - 02 - Consignee Billing - - 03 - Third Party - - 04 - Freight Collect - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - SubscriptionFile_Generic: - type: object - maximum: 1 - required: - - TrackingNumber - - ActivityType - properties: - ActivityType: - description: | - Unique identifier that defines the type of activity. - - VM = Void for Manifest - - UR = Undeliverable Returns - - IR = Invoice Removal Successful - - TC = Transport Company USPS scan PS = 'Postal Service Possession Scan' - - FN = UPS Access Point/Alternate Delivery Location Email Notification Failure - - DS = Destination Scan - - AG = Package is in transit to a UPS facility - - RE = UPS Returns Exchange - - RP = Retail Pickup - - UD = Updated delivery date - - OD = Out for Delivery - - SD = Scheduled for Delivery - - FM = Tendered to FMP - - PT = UPS Courier Handoff (Package Tendered) DIALS -VX - - PC = UPS Courier Confirmation – XPLD -VX - - OT = Out For Delivery Today scan - - AD = At Delivery Site scan - - RO = Roadie Out for Delivery - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - TrackingNumber: - description: Package's tracking number. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - ShipperNumber: - description: Shipper's alphanumeric account number. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - ShipmentReferenceNumber: - description: | - Container tag for shipment reference number. - - **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" - PackageReferenceNumber: - description: | - Package-level reference number. - - **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" - Service: - "$ref": "#/components/schemas/Generic_Service" - Activity: - "$ref": "#/components/schemas/Generic_Activity" - BillToAccount: - "$ref": "#/components/schemas/Generic_BillToAccount" - 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. - - If Activity Type is "OD", this element will contain Rescheduled Delivery Date. Format will be YYYYMMDD. - - If Activity Type is "SD", this element will contain agreed upon date with Customer for delivery Date. Format will be YYYYMMDD. - maximum: 1 - type: string - minLength: 1 - maxLength: 8 - FailureNotification: - "$ref": "#/components/schemas/Generic_FailureNotification" - xml: - name: Generic - Generic_ShipmentReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: "Reflects what will go on the label as the name of the reference. - \nFor addition information, refer to the Service Codes table in the Appendix." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: ShipmentReferenceNumber - required: - - Value - Generic_PackageReferenceNumber: - type: object - maximum: 1 - properties: - BarCodeIndicator: - description: Not used. - type: string - Number: - description: Number tag. - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - Code: - description: "Reflects what will go on the label as the name of the reference. - \nFor addition information, refer to the Service Codes table in the Appendix." - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Value: - description: Customer supplied reference number. Reference numbers are defined - by the shipper and can contain any character string. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - xml: - name: PackageReferenceNumber - required: - - Value - Generic_Service: - type: object - maximum: 1 - required: - - Code - properties: - Code: - description: For addition information, refer to the Service Codes table - in the Appendix. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - Description: - description: Not used. - maximum: 1 - type: string - xml: - name: Service - description: Container for service code and description. - Generic_Activity: - type: object - maximum: 1 - properties: - Date: - description: Date of package activity (i.e. YYYYMMDD). If generic record ActivityType is TC then event date is the date of first USPS scan. - maximum: 1 - type: string - minLength: 8 - maxLength: 8 - Time: - description: Time of package activity(i.e. HHMMSS). If generic record ActivityType is TC then event time is the time of first USPS scan. - maximum: 1 - type: string - minLength: 6 - maxLength: 6 - xml: - name: Activity - description: Information about package activity. - Generic_BillToAccount: - type: object - maximum: 1 - required: - - Number - - Option - 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 - Bill Option" - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Number: - description: The UPS Account number to which the shipping charges were billed. - maximum: 1 - type: string - minLength: 1 - maxLength: 10 - xml: - name: BillToAccount - description: The information provided within this container identifies the shipper - number and billing option the user specified to view during the subscription - process. - Generic_ShipTo: - type: object - maximum: 1 - properties: - LocationID: - description: Location name that the package is shipped to. - maximum: 1 - type: string - minLength: 3 - maxLength: 10 - ReceivingAddressName: - description: Alias of the location where the package is received. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - Bookmark: - description: Bookmark of the package is shifted to. - maximum: 1 - type: string - xml: - name: ShipTo - description: Address and contact information describing the location where a - return is to be delivered. - Generic_FailureNotification: - type: object - maximum: 1 - properties: - FailedEmailAddress: - description: Email address that failed when an attempt was made to send - email to the customer - maximum: 1 - type: string - minLength: 1 - maxLength: 50 - FailureNotificationCode: - "$ref": "#/components/schemas/FailureNotification_FailureNotificationCode" - xml: - name: FailureNotification - description: Failure notification information containing email address and Notification - code - FailureNotification_FailureNotificationCode: - type: object - maximum: 1 - properties: - Code: - description: |- - Code representing type of failure email notification. Valid values: - - 01 – Package is ready to pickup at UPS Access Point - Original - - 02 – Package is ready to pickup at UPS Access Point - Reminder - - 03 – Package is delivery to alternate delivery location - - 04 – Package is returned to Sender from UPS Access Point Location - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - Description: - description: Not used. - maximum: 1 - type: string - xml: - name: FailureNotificationCode - description: Failure notification code information describing code. - ErrorResponse: - type: object - properties: - response: - "$ref": "#/components/schemas/CommonErrorResponse" - CommonErrorResponse: - type: object - description: The error response containing any errors that occurred. - properties: - errors: - type: array - description: The error array containing any errors that occurred. - items: - "$ref": "#/components/schemas/ErrorMessage" - ErrorMessage: - type: object - properties: - code: - type: string - description: The error code. - message: - type: string - description: The error message. - description: The error response containing any errors that occurred. +openapi: 3.0.3 +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 + - Appendix + - Errors + - FAQ + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/quantumview/{version}/events": + post: + summary: Quantum View + tags: + - Quantum View + security: + - OAuth2: [] + description: Get Quantum View Response + operationId: QuantumView + parameters: + - in: path + name: version + schema: + type: string + default: v3 + description: | + Version of API. + + Valid values: + - v3 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + QuantumViewRequest: + Request: + TransactionReference: + CustomerContext: '' + XpciVersion: '1.0007' + RequestAction: QVEvents + SubscriptionRequest: + FileName: '220104_140019001' + Name: OutboundXML + Bookmark: WE9MVFFBMQ== + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + "/quantumview/{deprecatedVersion}/events": + post: + deprecated: true + summary: Quantum View + tags: + - Quantum View + security: + - OAuth2: [] + description: Get Quantum View Response + operationId: Deprecated QuantumView + parameters: + - in: path + name: deprecatedVersion + schema: + type: string + default: v1 + description: | + Version of API. + + Valid values: + - v1 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWRequestWrapper" + examples: + json: + summary: A sample JSON request (Standard Example) + value: + QuantumViewRequest: + Request: + TransactionReference: + CustomerContext: '' + XpciVersion: '1.0007' + RequestAction: QVEvents + SubscriptionRequest: + FileName: '220104_140019001' + Name: OutboundXML + Bookmark: WE9MVFFBMQ== + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/QUANTUMVIEWResponseWrapper" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/ErrorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + QUANTUMVIEWRequestWrapper: + xml: + name: QuantumViewRequest + description: 'N/A ' + maximum: 1 + type: object + required: + - QuantumViewRequest + properties: + QuantumViewRequest: + "$ref": "#/components/schemas/QuantumViewRequest" + QUANTUMVIEWResponseWrapper: + xml: + name: QuantumViewResponse + description: 'N/A ' + maximum: 1 + type: object + required: + - QuantumViewResponse + properties: + QuantumViewResponse: + "$ref": "#/components/schemas/QuantumViewResponse" + QuantumViewRequest: + type: object + required: + - Request + properties: + Request: + "$ref": "#/components/schemas/QuantumViewRequest_Request" + SubscriptionRequest: + type: array + items: + "$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 + \ 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 + request." + maximum: 1 + type: string + xml: + name: QuantumViewRequest + maximum: 1 + description: Container for QuantumView request information. + QuantumViewRequest_Request: + type: object + properties: + TransactionReference: + "$ref": "#/components/schemas/Request_TransactionReference" + RequestAction: + description: Indicates the action to be taken by the XML service. The only + valid value is 'QVEvents' + maximum: 1 + type: string + minLength: 11 + maxLength: 11 + xml: + name: Request + maximum: 1 + required: + - RequestAction + description: Contains QuantumView request criteria components. + Request_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during response. + maximum: 1 + type: string + maxLength: 512 + xml: + name: TransactionReference + description: TransactionReference identifies transactions between client and + server. + QuantumViewRequest_SubscriptionRequest: + type: object + properties: + Name: + description: Name of subscription requested by user, as one type of request + criteria. Required when the customer wants to request data for a specific + subscription name. Subscription name consists of up to 21 alphanumerics. + type: string + maxLength: 21 + DateTimeRange: + "$ref": "#/components/schemas/SubscriptionRequest_DateTimeRange" + FileName: + description: 'File name of specific subscription requested by user. Format: + YYMMDD_HHmmssnnn. (nnn - sequence number: usually = 001)' + type: array + items: + type: string + minLength: 16 + maxLength: 16 + xml: + name: SubscriptionRequest + description: Subscription requested by user to retrieve Inbound or/and Outbound + XML formed subscription information. + SubscriptionRequest_DateTimeRange: + type: object + maximum: 1 + properties: + BeginDateTime: + description: 'Beginning date time for the retrieval criteria of the subscriptions. + It is required for date time request criteria. Format: YYYYMMDDHHmmss.' + maximum: 1 + type: string + minLength: 14 + 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 + the request, it is defaulted to 7 days from the given begin date.' + maximum: 1 + type: string + minLength: 14 + maxLength: 14 + xml: + name: DateTimeRange + description: The range of date time of subscription requested by user, as one + type of request criteria, valid up to but not exceeding 7 days into the past, + starting from current day. + QuantumViewResponse: + type: object + required: + - Response + - QuantumViewEvents + properties: + Response: + "$ref": "#/components/schemas/QuantumViewResponse_Response" + 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 + + File Name if the request is for all data. It 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 request. + type: string + xml: + name: QuantumViewResponse + maximum: 1 + description: Container for QuantumView response information. + QuantumViewResponse_Response: + type: object + required: + - TransactionReference + - ResponseStatusCode + properties: + TransactionReference: + "$ref": "#/components/schemas/Response_TransactionReference" + ResponseStatusCode: + description: "Identifies the success or failure of the interchange. \n1 + = Success, 0 = Failure" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ResponseStatusDescription: + description: "'Success' or 'Failure'" + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + Error: + description: | + If an error is encountered during the interchange, the Response contains an error. If the error is present, then the ErrorSeverity and ErrorCodes are required. + + **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" + xml: + name: Response + maximum: 1 + description: Contains Errors information tags along with the success/fail status + of the QuantumView request. + Response_TransactionReference: + type: object + maximum: 1 + properties: + CustomerContext: + description: The CustomerContext Information which will be echoed during response. + type: string + XpciVersion: + description: "XPCI version. Current version: 1.0007" + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ToolVersion: + description: "Current tool version. \nValid value: 1.0" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: TransactionReference + description: Container for customer provided data and the XPCI Version. + Response_Error: + type: object + maximum: 1 + properties: + ErrorSeverity: + description: Describes the severity of the error. Required if the error is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ErrorCode: + description: A numeric value that describes the error. Each tool defines a range of error codes. Required if the error is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ErrorDescription: + description: Describes the error code. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + MinimumRetrySeconds: + description: Number of seconds to wait until retry. This field is populated on special conditions of the Transient Error only, as defined by the service. A number between 1 and 86400 (24 hours) + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + ErrorLocation: + description: | + Identifies the element in error. + + **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" + ErrorDigest: + description: | + The contents of the element in error. + + **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: + type: string + xml: + name: Error + required: + - ErrorLocation + Error_ErrorLocation: + type: object + maximum: 1 + properties: + ErrorLocationElementName: + description: The Xpath name of the element in error. This is a valid Xpath pointing to an element in the request document. + maximum: 1 + type: string + minLength: 1 + maxLength: 512 + ErrorLocationAttributeName: + description: The name of the attribute in error. This is the name of the attribute contained by the Error Location element. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + xml: + name: ErrorLocation + Error_ErrorDigest: + description: The contents of the element in error. + type: string + QuantumViewResponse_QuantumViewEvents: + type: object + maximum: 1 + required: + - SubscriptionEvents + - SubscriberID + properties: + SubscriberID: + description: QV XOLT subscribers ID. It is the same as the User ID. + maximum: 1 + type: string + minLength: 1 + maxLength: 16 + SubscriptionEvents: + description: | + The event that a user receives a subset of Tracking information specific to either packages coming or packages going, after subscription request is made. + + **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" + xml: + name: QuantumViewEvents + description: The event that a user receives echoing Subscriber ID and information + for subscription event, which is a subset of Tracking information specific + to either packages coming or packages going, after subscription request is + made, if the user requests for XML format. + QuantumViewEvents_SubscriptionEvents: + type: object + maximum: 1 + properties: + Name: + description: A name uniquely defined associated to the Subscription ID, for each subscription. Required if the SubscriptionEvents container is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 21 + Number: + description: A number uniquely defined associated to the Subscriber ID, for each subscription. Required if the SubscriptionEvents container is present. + maximum: 1 + type: string + minLength: 1 + maxLength: 16 + SubscriptionStatus: + "$ref": "#/components/schemas/SubscriptionEvents_SubscriptionStatus" + DateRange: + "$ref": "#/components/schemas/SubscriptionEvents_DateRange" + SubscriptionFile: + description: | + Container holds all of the unread files associated with the subscription. + + **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" + xml: + name: SubscriptionEvents + required: + - SubscriptionStatus + SubscriptionEvents_SubscriptionStatus: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: | + Status types of subscription. Valid values: + - UN – Unknown + - AT – Activate + - P – Pending + - A –Active + - I – Inactive + - S - Suspended + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + Description: + 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 + and is active.)\n- Inactive (The subscriber puts the subscription on hold.)\n- + Suspended (UPS disables the subscription.)" + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + xml: + name: SubscriptionStatus + description: Container for whether the subscription is active or not. + SubscriptionEvents_DateRange: + type: object + maximum: 1 + required: + - BeginDate + properties: + BeginDate: + description: |- + Beginning date time of subscription requested by user. + Format: MM-DD-YYYY-HH-MM + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + EndDate: + description: |- + Ending date time of subscription requested by user. + Format: MM-DD-YYYY-HH-MM + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + xml: + name: DateRange + description: The range of date time of subscription requested by user, as one + type of request criteria, valid up to but not exceeding 7 days into the past, + starting from current day. + SubscriptionEvents_SubscriptionFile: + type: object + maximum: 1 + required: + - StatusType + - FileName + properties: + FileName: + description: |- + File name belonging to specific subscription requested by user. + Format: YYMMDD_HHmmssnnn + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + 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. + + **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" + Origin: + description: | + Information about shipment's origin. + + **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" + Exception: + description: | + Shipment exception data. + + **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" + Delivery: + description: | + Container for delivery information. + + **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" + Generic: + description: | + Container for generic record information. + + **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" + xml: + name: SubscriptionFile + SubscriptionFile_StatusType: + type: object + maximum: 1 + required: + - Description + - Code + properties: + Code: + description: | + Status types of subscription file. Valid values: + - R – Read + - U - Unread + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Description: + description: Description of a subscription file. + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + xml: + name: StatusType + description: Container that displays whether the file is read or unread. + SubscriptionFile_Manifest: + type: object + required: + - Shipper + - ConsigneeBillIndicator + - ShipTo + - CollectBillIndicator + properties: + Shipper: + "$ref": "#/components/schemas/Manifest_Shipper" + ShipTo: + "$ref": "#/components/schemas/Manifest_ShipTo" + ReferenceNumber: + description: | + Shipment-level reference numbers. + + **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" + 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). + Formatted as YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + ScheduledDeliveryDate: + description: The date the shipment originally was scheduled for delivery. + Formatted as YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + ScheduledDeliveryTime: + description: Schedule delivery time. Time format is HHMMSS + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + DocumentsOnly: + description: | + If the tag is present then the shipment is a document, otherwise the shipment is a non-document. Valid values: + - 1 = Letter + - 2 = Document (Non-Letter Document) + - 3 = Non-Document + - 4 = Pallet + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Package: + description: | + Defines a package. + + **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" + ShipmentServiceOptions: + "$ref": "#/components/schemas/Manifest_ShipmentServiceOptions" + ManufactureCountry: + description: Country or Territory of Manufacture of the contents of the + package. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + HarmonizedCode: + description: Harmonized code of the package. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + CustomsValue: + "$ref": "#/components/schemas/Manifest_CustomsValue" + SpecialInstructions: + description: User-defined special instructions for delivery. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ShipmentChargeType: + description: |- + Shipment charge type. + Valid values: + C/F - Cost and Freight + C/B - Consignee Billed Package + F/C - Freight Collect + DDP - Delivered Duty Paid + VAT Unpaid + FOB - Free On Board + P/P - Prepaid + F/D - Free Domicile + T/P - Third Party Billing + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + BillToAccount: + "$ref": "#/components/schemas/Manifest_BillToAccount" + ConsigneeBillIndicator: + description: Indicates if consignee will be billed the shipment. + maximum: 1 + type: string + CollectBillIndicator: + description: Indicates whether or not to collect bill at time of delivery. + maximum: 1 + type: string + LocationAssured: + description: 'Indicates Location Assured Values: Y - Location Assured accessorial + requested' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ImportControl: + description: Import Control Indication is used to designate that the shipment + is an Import Control shipment. If the shipment is an import control shipment + then this element will have value. For no import shipment this will not + be appear + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + LabelDeliveryMethod: + description: "Indicates Label Delivery Method, Values are: LDE Electronic Label. LDO One Attempt. LDP Print Label. LDT Three Attempt. LPM Print and Mail Label." + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + CommercialInvoiceRemoval: + description: Commercial Invoice Removal (CIR) is an accessorial or indication + that will allow a shipper to dictate that UPS remove the Commercial Invoice + from the user's shipment before the shipment is delivered to the ultimate + consignee. If shipment is CIR then this element will have value. For no + CIR this element will not be appear + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PostalServiceTrackingID: + description: Postal Service Tracking ID transport company tracking number. + maximum: 1 + type: string + minLength: 35 + maxLength: 35 + ReturnsFlexibleAccess: + description: "(RFA) UPS returns flexible access. This element will appear + with value only when returns flexible access uploaded. For no returns + flexible access this element will not be appear" + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + UPScarbonneutral: + description: UPS carbon neutral is a term used to reflect a generic term + for the tagging to be included on any document, label, e-mail, etc. used + to identify that the UPS carbon neutral fee is applied. This element will + appear only when shipment is UPS carbon neutral with value. For non UPS + carbon neutral shipping this element appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Product: + description: This element will have value "PAC" for CAR shipments. For no CAR shipments this element will not be appeared. + maximum: 1 + type: string + UPSReturnsExchange: + description: UPS Return and Exchange – This element will appear with value Y only when UPS Return and Exchange was requested. For no UPS Returns and Exchange then this element will not appear + maximum: 1 + type: string + LiftGateOnDelivery: + description: Lift Gate On Delivery - This element will appear only when + Lift Gate For Delivery was requested for UPS World Wide Express Freight + Shipments. If no Lift Gate for Delivery was requested, this element will + not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + LiftGateOnPickUp: + description: Lift Gate On PickUp - This element will appear only when Lift + Gate For PickUp was requested for UPS World Wide Express Freight Shipments. + If no Lift Gate for PickUp was requested, this element will not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PickupPreference: + description: Pickup Preference -This element will appear only when Dropoff + At UPS Facility was requested for UPS World Wide Express Freight Shipments. + If no Dropoff At UPS Facility was requested, this element will not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + DeliveryPreference: + description: Delivery Preference - This element will appear only when Hold + for pick up was requested for UPS World Wide Express Freight Shipments. + If no Hold for pick up was requested, this element will not appear. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + HoldForPickupAtUPSAccessPoint: + description: '"Y" Indicates Shipment is Direct to Retail.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + UAPAddress: + "$ref": "#/components/schemas/Manifest_UAPAddress" + DeliverToAddresseeOnlyIndicator: + description: '"Y" Indicates Shipment is Deliver to Addressee.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + UPSAccessPointCODIndicator: + description: '"Y" Indicates Shipment is Cash on Delivery in Direct to Retail' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ClinicalTrialIndicator: + description: 'An accessorial Indicator flag: Y = Clinical Trial accessorial + provided in Manifest. Spaces = Clinical Trial accessorial not provided + in Manifest.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ClinicalTrialIndicationNumber: + description: An unique Clinical Trial associated with the shipment provided + in Manifest. + maximum: 1 + type: string + maxLength: 20 + CategoryAHazardousIndicator: + description: 'An accessorial Indicator flag: Y = Category A Hazardous materials + accessorial provided in Manifest. Spaces = Category A Hazardous materials + accessorial not provided in Manifest.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + DirectDeliveryIndicator: + description: 'An accessorial Indicator flag: Y = Direct Delivery accessorisal + provided in Manifest. Spaces = Direct Delivery accessorial not provided + in Manifest.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + PackageReleaseCodeIndicator: + description: '"Y" indicates Shipment has PackageReleaseCode Accessorial.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ProactiveResponseIndicator: + description: '"Y" indicates that a UPS Proactive Response Accessorial is + provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + WhiteGloveDeliveryIndicator: + description: '"Y" indicates that a Heavy Goods White Glove Delivery Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + RoomOfChoiceIndicator: + description: '"Y" indicates that a Heavy Goods Room of Choice Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + InstallationDeliveryIndicator: + description: '"Y" indicates that a Heavy Goods Installation Delivery Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ItemDisposalIndicator: + description: '"Y" indicates that a Heavy Goods Item Disposal Accessorial + is provided.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + LeadShipmentTrackingNumber: + description: Lead Tracking Number in shipment + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + SaturdayNonPremiumCommercialDeliveryIndicator: + description: '"Y" indicates that a SaturdayNonPremiumCommercialDeliveryIndicator + is provided.' + type: string + minLength: 1 + maxLength: 1 + SundayNonPremiumCommercialDeliveryIndicator: + description: '"Y" indicates that a SundayNonPremiumCommercialDeliveryIndicator + is provided.' + type: string + minLength: 1 + maxLength: 1 + UPSPremierAccessorialIndicator: + description: "\"Y\" indicates that the UPS Premier accessorial is provided." + type: string + minLength: 1 + maxLength: 1 + UPSPremierCategoryCode: + description: | + Indicates the UPS Premier category applied to the package Valid values: + - 'PRS' – UPS Premier Silver + - 'PRG' – UPS Premier Gold + - 'PRP' - UPS Premier Platinum + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: Manifest + maximum: 1 + Manifest_Shipper: + type: object + maximum: 1 + required: + - Name + properties: + Name: + description: Shipper's company name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AttentionName: + description: Shipper's Attention Name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + TaxIdentificationNumber: + description: Shipper's Tax Identification Number. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + PhoneNumber: + description: Shipper's Phone Number. US Phone numbers must be 10 digits. + No formatting is allowed. Required if origin and destination countries + or territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + FaxNumber: + description: Shipper's Fax Number. US Fax numbers must be 10 digits. No + formatting is allowed. Required if origin and destination countries or + territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + EMailAddress: + description: Shipper's designated contact eMail address. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Address: + "$ref": "#/components/schemas/Shipper_Address" + xml: + name: Shipper + description: Shipper's record for a shipment. + Shipper_Address: + type: object + maximum: 1 + properties: + AddressLine1: + description: Address Line 1 of the Shipper. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine2: + description: Address Line 2 of the Shipper. Usually room/floor information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine3: + description: Address Line 3 of the shipper. Usually department information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: Shipper's City. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: Shipper's state or province code. Must be valid US state. If the Shipper's country or territory is US or CA a two character code is required, otherwise the StateProvinceCode is optional. + maximum: 1 + type: string + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: | + Shipper's country or territory code. + + Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ResidentialAddressIndicator: + description: If tag is present, then the address is residential address. Pickup location residential address indicator. The presence indicates residential address, the absence indicates a business address. + maximum: 1 + type: string + xml: + name: Address + description: Information that specifies a physical location. + Manifest_ShipTo: + type: object + maximum: 1 + properties: + ShipperAssignedIdentificationNumber: + description: An identification number specified by shipper. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + CompanyName: + description: Consignee's company name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AttentionName: + description: Contact name at the consignee's location. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + PhoneNumber: + description: Consignee's Phone Number. US Phone numbers must be 10 digits. + No formatting is allowed. Required if origin and destination countries + or territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + TaxIdentificationNumber: + description: Consignee's Tax Identification Number. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + FaxNumber: + description: Consignee's Fax Number. US Fax numbers must be 10 digits. No + formatting is allowed. Required if origin and destination countries or + territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + EMailAddress: + description: Consignee's email address. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + Address: + "$ref": "#/components/schemas/ShipTo_Address" + LocationID: + description: Location name that the package is shipped to. + maximum: 1 + type: string + minLength: 3 + maxLength: 10 + ReceivingAddressName: + description: Name of the location where the package is received. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipTo + description: Address and contact information describing the location where a + return is to be delivered. + ShipTo_Address: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Consignee's name. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine1: + description: Address Line 1 of the Consignee. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine2: + description: Address Line 2 of the Consignee. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine3: + description: Address Line 3 of the Consignee. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: Consignee's City. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: Consignee's state or province code. Must be valid US state. If the consignee's country or territory is US or CA a two character code is required. Otherwise, the StateProvinceCode is optional. + maximum: 1 + type: string + 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. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: | + Consignee's country or territory code. + + Valid values: CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC and VA + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: Address + description: Information that specifies a physical location. + Manifest_ReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: Reflects what will go on the label as the name of the reference. For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ReferenceNumber + required: + - Value + Manifest_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: For addition information, refer to the Service Codes table + in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground. + maximum: 1 + type: string + xml: + name: Service + description: Container for service code and description. + Manifest_Package: + type: object + properties: + Activity: + description: | + Information about package delivery activity. + + **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" + Description: + description: Description of package merchandise. + maximum: 1 + type: string + minLength: 1 + maxLength: 120 + Dimensions: + "$ref": "#/components/schemas/Package_Dimensions" + DimensionalWeight: + "$ref": "#/components/schemas/Package_DimensionalWeight" + PackageWeight: + "$ref": "#/components/schemas/Package_PackageWeight" + LargePackage: + description: | + Values for LargePackage are: + - 1 - Oversize 1 + - 2 - Oversize 2 + - 4 - Large package + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + TrackingNumber: + description: Package's tracking number. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ReferenceNumber: + description: | + Container tag for information about the package-level reference number. + + **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" + PackageServiceOptions: + "$ref": "#/components/schemas/Package_PackageServiceOptions" + UPSPremiumCareIndicator: + description: Presence of the tag indicates UPSPremiumCare applies to this + package + maximum: 1 + type: string + maxLength: 1 + xml: + name: Package + maximum: 1 + Package_Activity: + type: object + maximum: 1 + properties: + Date: + description: "Date of package delivery activity. Date format: YYYYMMDD." + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: "Time of package delivery activity. Time format: HHMMSS" + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: Activity + Package_Dimensions: + type: object + maximum: 1 + required: + - Length + - Height + - Width + properties: + Length: + description: "Package length. \nValid values: 0 to 108 IN and 0 to 270 CM" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Width: + description: Package width. + maximum: 1 + type: string + minLength: 9 + maxLength: 9 + Height: + description: Package height. + maximum: 1 + type: string + minLength: 9 + maxLength: 9 + xml: + name: Dimensions + 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 + required: + - UnitOfMeasurement + - Weight + properties: + UnitOfMeasurement: + "$ref": "#/components/schemas/DimensionalWeight_UnitOfMeasurement" + Weight: + description: The value of package dimensional weight. A value of zero should + be used for letters. + type: string + xml: + name: DimensionalWeight + maximum: 1 + description: Container tag for package dimensional weight. + DimensionalWeight_UnitOfMeasurement: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: |- + The code representing the unit of measure associated with the shipment's dimensional weight. + Valid values: + LBS - Pounds (default) + KGS - Kilograms + Defaults Unit of Measurement used in the shipper's country or territory. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: A text description of the code representing the unit of measure + associated with the package weight. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: UnitOfMeasurement + description: Container tag for package dimensional weight measurement units. + DimensionalWeight_Weight: + description: The value of package dimensional weight. A value of zero should + be used for letters. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + Package_PackageWeight: + type: object + maximum: 1 + required: + - Weight + properties: + Weight: + description: Package weight. Set to 0 for package type of letters or envelops. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: PackageWeight + description: Container tag for package weight. Required when the package type + is not UPS Letter. + Package_LargePackage: + description: Values for LargePackage are:1 - Oversize 1,� 2 - Oversize 2,� 4 + - Large package + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Package_TrackingNumber: + description: Package's tracking number. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + Package_ReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: Number tag. + type: string + Code: + description: "Reference number type code for entire shipment, two-character + 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 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number, defined by the shipper + and can contain any character string. Valid if the origin/destination + pair is US/US or PR/PR. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ReferenceNumber + required: + - Value + Package_PackageServiceOptions: + type: object + properties: + COD: + "$ref": "#/components/schemas/PackageServiceOptions_COD" + InsuredValue: + "$ref": "#/components/schemas/PackageServiceOptions_InsuredValue" + EarliestDeliveryTime: + description: Earliest delivery time. Time format is HHMMSS. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + HazardousMaterialsCode: + description: | + Indicates if the package contains hazardous materials. Valid values: + - 1 - Hazardous Material + - 2 - Electronically billed hazardous material. + + If present, only one package may exist in the shipment. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + HoldForPickup: + description: A flag indicating if a package should be held for pickup. True + if tag exists, false otherwise. + maximum: 1 + type: string + AddShippingChargesToCODIndicator: + description: An indicator flag that represents a Collect on Delivery (COD) + package. + maximum: 1 + type: string + xml: + name: PackageServiceOptions + maximum: 1 + required: + - HoldForPickup + description: Defines service options used for the package(s). + PackageServiceOptions_COD: + type: object + maximum: 1 + properties: + CODCode: + description: |- + The code associated with the type of COD. Valid values: + 1 - Regular COD + 2 - Express COD + 3 - Tagless COD + type: string + CODAmount: + "$ref": "#/components/schemas/COD_CODAmount" + xml: + name: COD + description: Container for cash on delivery (COD) information. + COD_CODCode: + description: |- + The code associated with the type of COD. Valid values: + 1 - Regular COD + 2 - Express COD + 3 - Tagless COD + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + COD_CODAmount: + type: object + maximum: 1 + properties: + CurrencyCode: + description: | + The IATA currency code associated with the COD amount for the package. + + Required if the value for COD amount exists in MonetaryValue tag. + + Must match one of the IATA currency codes. + + For addition information, refer to the Currency Codes table in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + MonetaryValue: + description: The COD value for the package. Required if CODCode is 1.Absolute maximum value is 21474836.47 (limited by the maximum value of a 32-bit integer). + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: CODAmount + description: The amount of the COD that is to be collected for the shipment. + PackageServiceOptions_InsuredValue: + type: object + maximum: 1 + properties: + CurrencyCode: + description: Not populated in this release. + maximum: 1 + type: string + MonetaryValue: + description: The monetary value for the insured value amount associated + with the package. Max value of 5,000 USD for Local and 50,000 USD for + Remote. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + xml: + name: InsuredValue + required: + - MonetaryValue + description: Container tag for insured value amount for the package. + Manifest_ShipmentServiceOptions: + type: object + maximum: 1 + required: + - SaturdayDelivery + - SaturdayPickup + properties: + SaturdayPickup: + description: A flag indicating if the shipment requires a Saturday pickup. + True if tag exists, false otherwise. + maximum: 1 + type: string + SaturdayDelivery: + description: A flag indicating if the shipment requires a Saturday Delivery. + True if tag exists, false otherwise. + maximum: 1 + type: string + CallTagARS: + "$ref": "#/components/schemas/ShipmentServiceOptions_CallTagARS" + xml: + name: ShipmentServiceOptions + description: Container tag for optional UPS services related to a shipment. + ShipmentServiceOptions_CallTagARS: + type: object + maximum: 1 + properties: + Number: + description: A reference number associated with the Call Tag service. Required + if CallTagARS/Code is 1. + maximum: 1 + type: string + minLength: 12 + maxLength: 12 + Code: + 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 + the Web" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: CallTagARS + description: Container for Call Tag service. + Manifest_CustomsValue: + type: object + maximum: 1 + required: + - MonetaryValue + properties: + MonetaryValue: + description: The shipment's customs value amount. + maximum: 1 + type: string + minLength: 16 + maxLength: 16 + xml: + name: CustomsValue + description: Information about shipment's customs value. + Manifest_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + Manifest_UAPAddress: + type: object + maximum: 1 + properties: + CompanyName: + description: The name of person or company to whom package was shipped. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AttentionName: + description: The "Attention To" field for the person/company to whom package + is shipped. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + 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 + or territories are different. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + xml: + name: UAPAddress + description: Information about Hold for Pickup UPS Access Point Address + UAPAddress_Address: + type: object + maximum: 1 + properties: + AddressLine1: + description: Address Line 1 of the UPS Access Point. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine2: + description: Address Line 2 of the UPS Access Point. Usually room/floor + information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + AddressLine3: + description: Address Line 3 of the UPS Access Point. Usually department + information. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + City: + description: UPS Access Point City. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + StateProvinceCode: + description: UPS Access Point's state or province code. Must be valid US + state. If the UPS Access Point country or territory is US or CA a two + character code is required, otherwise, the StateProvinceCode is optional. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + PostalCode: + description: 'UPS Access Point''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 an alphabetic character + and # is numeric digit. Otherwise, 1 to 16 alphanumeric characters are + allowed.' + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + CountryCode: + description: 'UPS Access Point''s country or territory code. Valid values: + CA,MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, + and VA' + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + xml: + name: Address + description: Information that specifies a physical location. + SubscriptionFile_Origin: + type: object + properties: + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + TrackingNumber: + description: Package's 1Z tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + Date: + description: Date that the package is picked up at the origin. Date format + is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: Time that the package is picked up at the origin. Time format + is HHMMSS. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ActivityLocation: + "$ref": "#/components/schemas/Origin_ActivityLocation" + BillToAccount: + "$ref": "#/components/schemas/Origin_BillToAccount" + ScheduledDeliveryDate: + description: Scheduled delivery date for destination address. Date format + is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + ScheduledDeliveryTime: + description: Scheduled delivery time for destination address. Time format + is HHMMSS. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: Origin + maximum: 1 + required: + - TrackingNumber + - ShipperNumber + - Time + - Date + Origin_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Origin_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Origin_ActivityLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" + xml: + name: ActivityLocation + description: Geographic location where an activity occurred during a movement + of a package or shipment. (ActivityLocation in Origin is identical to the + one in Manifest. But three of all elements in Origin/ActivityLocation/AddressArtifactFormat + are populated in this release. Refer to Manifest for remaining unpopulated + elements.) + maximum: 1 + ActivityLocation_AddressArtifactFormat: + type: object + maximum: 1 + properties: + PoliticalDivision2: + description: City of an activity occurred during a package shipment. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: State or province code of an activity occurred during a package shipment. Must be valid US state. If the country or territory is US or CA a two character code is required, otherwise, the StateProvinceCode is optional. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + CountryCode: + description: "Country or Territory code of an activity occurred during a package shipment. Valid values: CA, MX, PR, US, AT, BE, DE, DK, ES, FI, FR, GB, IE, IT, NL, PT, SE, MC, and VA" + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + xml: + name: AddressArtifactFormat + description: Information that specifies a physical location where package delivery + activity occurs. + Origin_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid Values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + SubscriptionFile_Exception: + type: object + properties: + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + TrackingNumber: + description: Package's 1Z tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + Date: + description: Date that the package is delivered. Date format is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: Time that the package is delivered. Time format is HHMMSS + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + UpdatedAddress: + "$ref": "#/components/schemas/Exception_UpdatedAddress" + StatusCode: + description: Code for status of updating shipping address issue. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + StatusDescription: + description: Description for status of updating shipping address issue. + maximum: 1 + type: string + minLength: 1 + maxLength: 120 + ReasonCode: + description: Code for reason of updating shipping address issue. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ReasonDescription: + description: Description for reason of updating shipping address issue. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + Resolution: + "$ref": "#/components/schemas/Exception_Resolution" + RescheduledDeliveryDate: + description: Rescheduled delivery date for updated shipping address. Date + format is YYYYMMDD. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + RescheduledDeliveryTime: + description: Rescheduled delivery time for updated shipping address. Time + format is HHMMSS + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + ActivityLocation: + "$ref": "#/components/schemas/Exception_ActivityLocation" + BillToAccount: + "$ref": "#/components/schemas/Exception_BillToAccount" + AccessPointLocationID: + description: The UPS Access Point Location ID. + maximum: 1 + type: string + maxLength: 9 + xml: + name: Exception + maximum: 1 + required: + - TrackingNumber + - ShipperNumber + - Time + - Date + Exception_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Exception_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + maximum: 1 + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Exception_UpdatedAddress: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Consignee's name for package shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + StreetNumberLow: + description: Street number of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + StreetPrefix: + description: Street prefix of updated shipping address, e.g. N, SE. It will + be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + StreetName: + description: Street name of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StreetType: + description: Street type of updated shipping address, e.g. ST. It will be + returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + StreetSuffix: + description: Street suffix of updated shipping address, e.g. N, SE. It will + be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + AddressExtendedInformation: + description: | + Container for information about updated shipping address. It will be returned if there is any update due to exception. + + **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" + PoliticalDivision3: + description: The neighborhood, town, barrio etc. It will be returned if + there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision2: + description: City name of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: Abbreviated state or province name of updated shipping address. + It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 2 + maxLength: 5 + CountryCode: + description: Abbreviated country or territory name of updated shipping address. + It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + PostcodePrimaryLow: + description: Postal Code of updated shipping address. It will be returned + if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: UpdatedAddress + description: Contains information about updated shipping address. + UpdatedAddress_AddressExtendedInformation: + type: object + maximum: 1 + properties: + Type: + description: Allows for secondary address information such as s suite or apartment. It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + Low: + description: The lower limit associated with the extended address type. It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + High: + description: The higher limit associated with the extended address type. It will be returned if there is any update due to exception. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + xml: + name: AddressExtendedInformation + Exception_Resolution: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: Type of resolution for updating shipping address issue. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Description of resolution type for updating shipping address. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + xml: + name: Resolution + description: Resolution for updating shipping address issue. + Exception_ActivityLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" + xml: + name: ActivityLocation + description: Geographic location where an activity occurred during a movement + of a package or shipment.(ActivityLocation in Exception is identical to the + one in Manifest. But three of all elements in Exception/ActivityLocation/AddressArtifactFormat + are populated in this release. Refer to Manifest for remaining unpopulated + elements.) + maximum: 1 + Exception_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid Values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + Indicates how shipping charges for the package were billed. Valid Values: 01 Shipper, 02 Consignee Billing ,03 Third Party, 04 Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + SubscriptionFile_Delivery: + type: object + properties: + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + ShipperNumber: + description: Shipper's six digit alphanumeric account number. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + TrackingNumber: + description: Package's 1Z tracking number. + maximum: 1 + type: string + minLength: 18 + maxLength: 18 + Date: + description: Date that the package is delivered. Date format is YYYYMMDD. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + Time: + description: Time that the package is delivered. Time format is HHMMSS + maximum: 1 + type: string + minLength: 1 + maxLength: 6 + DriverRelease: + description: Information about driver release note / signature. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + ActivityLocation: + "$ref": "#/components/schemas/Delivery_ActivityLocation" + DeliveryLocation: + "$ref": "#/components/schemas/Delivery_DeliveryLocation" + COD: + "$ref": "#/components/schemas/Delivery_COD" + BillToAccount: + "$ref": "#/components/schemas/Delivery_BillToAccount" + LastPickupDate: + description: Last pickup by Date from the UPS Access Point Location. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + AccessPointLocationID: + description: UPS Access Point Location ID. + maximum: 1 + type: string + minLength: 1 + maxLength: 9 + xml: + name: Delivery + maximum: 1 + required: + - TrackingNumber + - ShipperNumber + - Time + - Date + Delivery_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Delivery_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: | + Reflects what will go on the label as the name of the reference. + + For additional information, refer to the Reference Codes table in the Appendix. + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Delivery_ActivityLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/ActivityLocation_AddressArtifactFormat" + xml: + name: ActivityLocation + description: Geographic location where an activity occurred during a movement + of a package or shipment. (ActivityLocation in Delivery is identical to the + one in Manifest. But all elements in Delivery/ActivityLocation/AddressArtifactFormat + are populated in this release. Refer to Manifest for remaining unpopulated + elements.) + maximum: 1 + Delivery_DeliveryLocation: + type: object + required: + - AddressArtifactFormat + properties: + AddressArtifactFormat: + "$ref": "#/components/schemas/DeliveryLocation_AddressArtifactFormat" + Code: + description: Location Code for delivered package. + maximum: 1 + type: string + minLength: 1 + maxLength: 16 + Description: + description: Description of the location where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + SignedForByName: + description: The person who signed for the package. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: DeliveryLocation + maximum: 1 + description: Information about the location where package is delivered. + DeliveryLocation_AddressArtifactFormat: + type: object + maximum: 1 + properties: + ConsigneeName: + description: Consignee's name at the location where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + StreetNumberLow: + description: Street number where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + StreetPrefix: + description: Street prefix where package is delivered, e.g. N, SE. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + StreetName: + description: Street name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + StreetType: + description: Street type where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + StreetSuffix: + description: Street suffix where package is delivered, e.g. N, SE. + maximum: 1 + type: string + minLength: 1 + maxLength: 2 + BuildingName: + description: Building name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + AddressExtendedInformation: + description: | + Container tag for additional address information where package is delivered. + + **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" + PoliticalDivision3: + description: The neighborhood, town, barrio etc. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision2: + description: City name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 30 + PoliticalDivision1: + description: Abbreviated state or province name where package is delivered. + maximum: 1 + type: string + minLength: 1 + maxLength: 5 + CountryCode: + description: Abbreviated country or territory name where package is delivered. + type: string + PostcodePrimaryLow: + description: Postal Code where package is delivered. Required if the user + does not submit the City, Alphanumeric State/Province address combination. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + PostcodeExtendedLow: + description: 4 Digit postal code extension where package is delivered. Valid for US only. + maximum: 1 + type: string + minLength: 1 + maxLength: 4 + ResidentialAddressIndicator: + description: Residential address indicator for the location where package + is delivered. The presence indicates residential address, the absence + indicates a business address. + maximum: 1 + type: string + xml: + name: AddressArtifactFormat + description: Information that specifies a physical location where package is + delivered. + AddressArtifactFormat_AddressExtendedInformation: + type: object + maximum: 1 + properties: + Type: + description: Allows for secondary address information such as a suite or + apartment. + maximum: 1 + type: string + minLength: 1 + maxLength: 40 + Low: + description: The low number associated with an extended address. + maximum: 1 + type: string + minLength: 1 + maxLength: 11 + High: + description: The high number associated with an extended address. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + xml: + name: AddressExtendedInformation + Delivery_COD: + type: object + properties: + CODAmount: + "$ref": "#/components/schemas/COD_CODAmount" + xml: + name: COD + description: Container for cash on delivery (COD) information. + maximum: 1 + Delivery_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + properties: + Option: + description: | + Indicates how shipping charges for the package were billed. Valid Values: + - 01 - Shipper + - 02 - Consignee Billing + - 03 - Third Party + - 04 - Freight Collect + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + SubscriptionFile_Generic: + type: object + maximum: 1 + required: + - TrackingNumber + - ActivityType + properties: + ActivityType: + description: | + Unique identifier that defines the type of activity. + - VM = Void for Manifest + - UR = Undeliverable Returns + - IR = Invoice Removal Successful + - TC = Transport Company USPS scan PS = 'Postal Service Possession Scan' + - FN = UPS Access Point/Alternate Delivery Location Email Notification Failure + - DS = Destination Scan + - AG = Package is in transit to a UPS facility + - RE = UPS Returns Exchange + - RP = Retail Pickup + - UD = Updated delivery date + - OD = Out for Delivery + - SD = Scheduled for Delivery + - FM = Tendered to FMP + - PT = UPS Courier Handoff (Package Tendered) DIALS -VX + - PC = UPS Courier Confirmation – XPLD -VX + - OT = Out For Delivery Today scan + - AD = At Delivery Site scan + - RO = Roadie Out for Delivery + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + TrackingNumber: + description: Package's tracking number. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + ShipperNumber: + description: Shipper's alphanumeric account number. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + ShipmentReferenceNumber: + description: | + Container tag for shipment reference number. + + **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" + PackageReferenceNumber: + description: | + Package-level reference number. + + **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" + Service: + "$ref": "#/components/schemas/Generic_Service" + Activity: + "$ref": "#/components/schemas/Generic_Activity" + BillToAccount: + "$ref": "#/components/schemas/Generic_BillToAccount" + 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. + + If Activity Type is "OD", this element will contain Rescheduled Delivery Date. Format will be YYYYMMDD. + + If Activity Type is "SD", this element will contain agreed upon date with Customer for delivery Date. Format will be YYYYMMDD. + maximum: 1 + type: string + minLength: 1 + maxLength: 8 + FailureNotification: + "$ref": "#/components/schemas/Generic_FailureNotification" + xml: + name: Generic + Generic_ShipmentReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: "Reflects what will go on the label as the name of the reference. + \nFor addition information, refer to the Service Codes table in the Appendix." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: ShipmentReferenceNumber + required: + - Value + Generic_PackageReferenceNumber: + type: object + maximum: 1 + properties: + BarCodeIndicator: + description: Not used. + type: string + Number: + description: Number tag. + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + Code: + description: "Reflects what will go on the label as the name of the reference. + \nFor addition information, refer to the Service Codes table in the Appendix." + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Value: + description: Customer supplied reference number. Reference numbers are defined + by the shipper and can contain any character string. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + xml: + name: PackageReferenceNumber + required: + - Value + Generic_Service: + type: object + maximum: 1 + required: + - Code + properties: + Code: + description: For addition information, refer to the Service Codes table + in the Appendix. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + Description: + description: Not used. + maximum: 1 + type: string + xml: + name: Service + description: Container for service code and description. + Generic_Activity: + type: object + maximum: 1 + properties: + Date: + description: Date of package activity (i.e. YYYYMMDD). If generic record ActivityType is TC then event date is the date of first USPS scan. + maximum: 1 + type: string + minLength: 8 + maxLength: 8 + Time: + description: Time of package activity(i.e. HHMMSS). If generic record ActivityType is TC then event time is the time of first USPS scan. + maximum: 1 + type: string + minLength: 6 + maxLength: 6 + xml: + name: Activity + description: Information about package activity. + Generic_BillToAccount: + type: object + maximum: 1 + required: + - Number + - Option + 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 + Bill Option" + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Number: + description: The UPS Account number to which the shipping charges were billed. + maximum: 1 + type: string + minLength: 1 + maxLength: 10 + xml: + name: BillToAccount + description: The information provided within this container identifies the shipper + number and billing option the user specified to view during the subscription + process. + Generic_ShipTo: + type: object + maximum: 1 + properties: + LocationID: + description: Location name that the package is shipped to. + maximum: 1 + type: string + minLength: 3 + maxLength: 10 + ReceivingAddressName: + description: Alias of the location where the package is received. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + Bookmark: + description: Bookmark of the package is shifted to. + maximum: 1 + type: string + xml: + name: ShipTo + description: Address and contact information describing the location where a + return is to be delivered. + Generic_FailureNotification: + type: object + maximum: 1 + properties: + FailedEmailAddress: + description: Email address that failed when an attempt was made to send + email to the customer + maximum: 1 + type: string + minLength: 1 + maxLength: 50 + FailureNotificationCode: + "$ref": "#/components/schemas/FailureNotification_FailureNotificationCode" + xml: + name: FailureNotification + description: Failure notification information containing email address and Notification + code + FailureNotification_FailureNotificationCode: + type: object + maximum: 1 + properties: + Code: + description: |- + Code representing type of failure email notification. Valid values: + - 01 – Package is ready to pickup at UPS Access Point - Original + - 02 – Package is ready to pickup at UPS Access Point - Reminder + - 03 – Package is delivery to alternate delivery location + - 04 – Package is returned to Sender from UPS Access Point Location + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + Description: + description: Not used. + maximum: 1 + type: string + xml: + name: FailureNotificationCode + description: Failure notification code information describing code. + ErrorResponse: + type: object + properties: + response: + "$ref": "#/components/schemas/CommonErrorResponse" + CommonErrorResponse: + type: object + description: The error response containing any errors that occurred. + properties: + errors: + type: array + description: The error array containing any errors that occurred. + items: + "$ref": "#/components/schemas/ErrorMessage" + ErrorMessage: + type: object + properties: + code: + type: string + description: The error code. + message: + type: string + description: The error message. + description: The error response containing any errors that occurred. diff --git a/Rating.yaml b/Rating.yaml index fcf03c2..8462b0c 100644 --- a/Rating.yaml +++ b/Rating.yaml @@ -1,5983 +1,5980 @@ -openapi: 3.0.3 -info: - title: Rate - 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 - - Appendix - - Errors - - FAQ - - Best Practices - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

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

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

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

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

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

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

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

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/shipments/{version}/transittimes": - post: - summary: TimeInTransit - tags: - - Time in Transit - security: - - OAuth2: [] - operationId: TimeInTransit - parameters: - - in: path - name: version - schema: - type: string - default: v1 - description: API Version - required: true - - in: header - name: transId - schema: - type: string - description: An identifier unique to the request. Length 32 - required: true - - in: header - name: transactionSrc - schema: - type: string - default: testing - description: Identifies the clients/source application that is calling. Length - 512 - required: true - requestBody: - description: Generate sample code for popular API requests by selecting an - example below. To view a full sample request and response, first click "Authorize" - and enter your application credentials, then populate the required parameters - above and click "Try it out". - required: true - content: - application/json: - schema: - "$ref": "#/components/schemas/TimeInTransitRequest" - examples: - '1': - summary: A sample JSON request (Standard Example) - value: - originCountryCode: DE - originStateProvince: '' - originCityName: '' - originTownName: '' - originPostalCode: '10703' - destinationCountryCode: US - destinationStateProvince: NH - destinationCityName: MANCHESTER - destinationTownName: '' - destinationPostalCode: '03104' - weight: '10.5' - weightUnitOfMeasure: LBS - shipmentContentsValue: '10.5' - shipmentContentsCurrencyCode: USD - billType: '03' - shipDate: '2019-05-01' - shipTime: '' - residentialIndicator: '' - avvFlag: true - numberOfPackages: '1' - responses: - '200': - description: successful operation - content: - application/json: - schema: - "$ref": "#/components/schemas/TimeInTransitResponse" - '400': - description: Invalid Request - content: - application/json: - schema: - "$ref": "#/components/schemas/errorResponse" - '401': - description: Unauthorized Request - content: - application/json: - schema: - "$ref": "#/components/schemas/errorResponse" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/errorResponse" - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/errorResponse" -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - TimeInTransitRequest: - type: object - required: - - 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 - 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, - 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." - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - originCityName: - description: The shipment origin city. Required for International requests - for those countries that do not utilize postal codes. - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - originTownName: - description: The shipment origin town. Town is a subdivision of city. - type: string - maximum: 1 - 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. - \ For non-U.S. addresses, this is recommended for all countries that utilize - postal codes." - type: string - maximum: 1 - minLength: 1 - maxLength: 10 - destinationCountryCode: - description: "The country code of the destination. \n Valid 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, - 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." - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - destinationCityName: - description: The shipment destination city. Required for International Requests - for those countries that do not utilize postal codes. - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - destinationTownName: - 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 - 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." - type: string - maximum: 1 - minLength: 1 - 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." - 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 - 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." - 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 - Defaults to current time if not provided." - type: string - maximum: 1 - minLength: 1 - 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." - 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\"" - type: string - maximum: 1 - minLength: 1 - maxLength: 3 - shipmentContentsValue: - description: "The monetary value of shipment contents. \n \n Required 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 - tenths." - type: number - maximum: 3 - minLength: 1 - maxLength: 11 - shipmentContentsCurrencyCode: - description: "The unit of currency used for values. Required if ShipmentContentsValue - is populated. \n Valid 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)" - 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." - type: boolean - maximum: 1 - numberOfPackages: - 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\" " - 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\" " - 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 - 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." - type: integer - maximum: 1 - premierIndicator: - description: "Sets the indicator for premier time in transit when the shipment contains a premier package. - \n \n Valid values: “00”, “01”. \n \n 00 = Non-premier time in transit. - \n \n 01 = Premier time in transit. \n \n The default value is “00”." - type: string - maximum: 1 - minLength: 2 - maxLength: 2 - maximum: 1 - description: N/A - TimeInTransitResponse: - type: object - properties: - validationList: - "$ref": "#/components/schemas/validationList" - destinationPickList: - "$ref": "#/components/schemas/destinationPickList" - originPickList: - "$ref": "#/components/schemas/originPickList" - emsResponse: - "$ref": "#/components/schemas/emsResponse" - maximum: 1 - description: N/A - errorResponse: - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/errors" - validationList: - type: object - properties: - invalidFieldList: - type: array - items: - type: string - invalidFieldListCodes: - type: array - items: - type: string - destinationAmbiguous: - description: Returned as true when destination address has a candidate list - type: boolean - maximum: 1 - originAmbiguous: - description: Returned as true when original address has a candidate list. - type: boolean - maximum: 1 - destinationPickList: - type: array - items: - "$ref": "#/components/schemas/candidateAddress" - originPickList: - type: array - items: - "$ref": "#/components/schemas/candidateAddress" - emsResponse: - type: object - required: - - shipDate - - shipTime - - serviceLevel - - billType - - residentialIndicator - - destinationCountryName - - destinationCountryCode - - originCountryName - - originCountryCode - - guaranteeSuspended - - numberOfServices - 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" - 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" - 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." - 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" - 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" - 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" - type: string - maximum: 1 - minLength: 2 - maxLength: 2 - destinationCountryName: - description: Destination country name value - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - destinationCountryCode: - description: Destination country code, conforms to ISO-defined country codes. - type: string - maximum: 1 - 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 - 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 - 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 - 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. - 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." - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - destinationCityName: - description: "The shipment destination city. \n \n Required for International - requests for those countries that do not utilize postal codes." - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - originCountryName: - description: Origin country name value - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - originCountryCode: - description: Origin country code, conforms to ISO-defined country codes. - type: string - maximum: 1 - 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 - 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 - 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 - 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, - 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." - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - originCityName: - description: "The shipment origin city. \n \n Required 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" - type: string - maximum: 1 - minLength: 1 - maxLength: 8 - weightUnitOfMeasure: - description: Returned on response when weight was present on the request. - type: string - maximum: 1 - minLength: 1 - maxLength: 3 - shipmentContentsValue: - description: "Shipment contents value. Value is only required for international - shipment. \n \n Defaults to 0.0" - type: string - maximum: 1 - minLength: 1 - maxLength: 11 - shipmentContentsCurrencyCode: - description: Returned on response when shipmentContentsValue was present - on the request. - type: string - maximum: 1 - minLength: 3 - maxLength: 3 - 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 - if a shipment falls within a defined peak date range: shipDate (from the - response), deliveryDate (from the response), server Date. \n \n Defined - peak date range (range for when guarantees are suspended) is inclusive - of start and end dates." - type: boolean - maximum: 1 - numberOfServices: - description: Number of services being returned in the services array. - type: integer - maximum: 1 - services: - type: array - items: - "$ref": "#/components/schemas/services" - candidateAddress: - type: object - required: - - countryName - - CountryCode - properties: - countryName: - description: Spelled out country name. - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - countryCode: - description: Country code, follows ISO-defined country codes. - type: string - maximum: 1 - minLength: 2 - maxLength: 2 - stateProvince: - description: Present on response when candidate value has a political division - 1 value available. - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - city: - description: Present on response when candidate value has a political division - 2 value available. - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - town: - description: Present on response when candidate value has a political division - 3 value available. - type: string - maximum: 1 - minLength: 1 - maxLength: 50 - postalCode: - description: Present on response when candidate has a postal code value - available - type: string - maximum: 1 - minLength: 1 - maxLength: 10 - postalCodeLow: - description: Present on response when candidate value has a postal code - range value available. This is the postal range low value. - type: string - maximum: 1 - minLength: 1 - maxLength: 10 - postalCodeHigh: - description: Present on response when candidate value has a postal code - range value available. This is the postal range high value. - type: string - maximum: 1 - minLength: 1 - maxLength: 10 - services: - type: object - required: - - serviceLevel - - serviceLevelDescription - - shipDate - - deliveryDate - - commitTime - - deliveryTime - - deliveryDayOfWeek - - nextDayPickupIndicator - - saturdayPickupIndicator - - saturdayDeliveryIndicator - - guaranteeIndicator - - totalTransitDays - - businessTransitDays - - restDaysCount - - holidayCount - - delayCount - - pickupDate - - pickupTime - - 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\". " - type: string - maximum: 1 - minLength: 2 - maxLength: 2 - serviceLevelDescription: - description: 'Service name. Examples are: UPS Next Day Air, UPS Ground, - UPS Expedited, UPS Worldwide Express Freight' - type: string - 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" - type: string - maximum: 1 - minLength: 10 - maxLength: 10 - deliveryDate: - description: "Scheduled delivery date. \n \n Valid format: YYYY-MM-DD" - type: string - maximum: 1 - minLength: 10 - maxLength: 10 - commitTime: - description: "Scheduled commit time. \n \n For 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" - 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" - type: string - maximum: 1 - minLength: 8 - maxLength: 8 - deliveryDayOfWeek: - description: "Three character scheduled delivery day of week. \n \n Valid - values: \"MON\",\"TUE\",\"WED\",\"THU\",\"FRI\", \"SAT\"" - type: string - maximum: 1 - minLength: 3 - 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 flag is set, WWDTDisclaimer.getNextDayDisclaimer method could be - called to return the next day disclaimer message." - type: string - maximum: 1 - minLength: 1 - 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 - 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" - type: string - maximum: 1 - minLength: 10 - maxLength: 10 - saturdayDeliveryTime: - description: "Delivery time of Saturday deliver \n \n Valid format: HH:MM:SS" - type: string - maximum: 1 - minLength: 8 - maxLength: 8 - serviceRemarksText: - description: Service remarks text. The contents of this field will represent - text that the back end application/function needs to display to clarify - the time in transit calculation. - type: string - 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 - 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 - 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." - type: string - maximum: 1 - minLength: 1 - 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." - type: integer - maximum: 1 - businessTransitDays: - description: Returns the number of UPS business days from origin location - to destination location. - type: integer - 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." - 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." - 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." - 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 - shipped on date is a holiday or for locations needing 24 hour notice before - a pickup could be made." - type: string - maximum: 1 - minLength: 10 - maxLength: 10 - pickupTime: - description: Latest possible pickup time. This data is available only for - international transactions. If the package was not actually picked by - UPS before this time, the services will not meet the guarantee commitment. - type: string - maximum: 1 - minLength: 8 - maxLength: 8 - cstccutoffTime: - description: Latest time a customer can contact UPS CST to be notified for - requesting a pickup. This data is available only for international transactions. - If customer does not notify UPS for a pickup before this time, the services - will not meet the guarantee commitment. - type: string - maximum: 1 - minLength: 8 - maxLength: 8 - poddate: - description: Returns the date proof of delivery information would be available. This - data is available only for international transactions. - type: string - maximum: 1 - minLength: 10 - maxLength: 10 - poddays: - description: Returns the number of days proof of delivery information will - be available. This data is available only for international transactions. - type: integer - maximum: 1 - errors: - type: object - properties: - code: - description: Error code - type: string - message: - description: Error message - type: string +openapi: 3.0.3 +info: + title: Time In Transit + description: | + + The Time In Transit API provides estimated delivery times for various UPS shipping services, between specified locations. + + Key Business Values: + - **Enhanced Customer Experience**: Allows businesses provide accurate delivery estimates to their customers, enhancing customer service. + - **Operational Efficiency**: Helps in logistics planning by providing transit times for different UPS services. + + # Reference + - Appendix + - Errors + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/shipments/{version}/transittimes": + post: + summary: TimeInTransit + tags: + - Time in Transit + security: + - OAuth2: [] + operationId: TimeInTransit + parameters: + - in: path + name: version + schema: + type: string + default: v1 + description: API Version + required: true + - in: header + name: transId + schema: + type: string + description: An identifier unique to the request. Length 32 + required: true + - in: header + name: transactionSrc + schema: + type: string + default: testing + description: Identifies the clients/source application that is calling. Length + 512 + required: true + requestBody: + description: Generate sample code for popular API requests by selecting an + example below. To view a full sample request and response, first click "Authorize" + and enter your application credentials, then populate the required parameters + above and click "Try it out". + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/TimeInTransitRequest" + examples: + '1': + summary: A sample JSON request (Standard Example) + value: + originCountryCode: DE + originStateProvince: '' + originCityName: '' + originTownName: '' + originPostalCode: '10703' + destinationCountryCode: US + destinationStateProvince: NH + destinationCityName: MANCHESTER + destinationTownName: '' + destinationPostalCode: '03104' + weight: '10.5' + weightUnitOfMeasure: LBS + shipmentContentsValue: '10.5' + shipmentContentsCurrencyCode: USD + billType: '03' + shipDate: '2019-05-01' + shipTime: '' + residentialIndicator: '' + avvFlag: true + numberOfPackages: '1' + responses: + '200': + description: successful operation + content: + application/json: + schema: + "$ref": "#/components/schemas/TimeInTransitResponse" + '400': + description: Invalid Request + content: + application/json: + schema: + "$ref": "#/components/schemas/errorResponse" + '401': + description: Unauthorized Request + content: + application/json: + schema: + "$ref": "#/components/schemas/errorResponse" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/errorResponse" + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/errorResponse" +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + TimeInTransitRequest: + type: object + required: + - 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 + 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, + 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." + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + originCityName: + description: The shipment origin city. Required for International requests + for those countries that do not utilize postal codes. + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + originTownName: + description: The shipment origin town. Town is a subdivision of city. + type: string + maximum: 1 + 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. + \ For non-U.S. addresses, this is recommended for all countries that utilize + postal codes." + type: string + maximum: 1 + minLength: 1 + maxLength: 10 + destinationCountryCode: + description: "The country code of the destination. \n Valid 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, + 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." + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + destinationCityName: + description: The shipment destination city. Required for International Requests + for those countries that do not utilize postal codes. + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + destinationTownName: + 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 + 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." + type: string + maximum: 1 + minLength: 1 + 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." + 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 + 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." + 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 + Defaults to current time if not provided." + type: string + maximum: 1 + minLength: 1 + 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." + 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\"" + type: string + maximum: 1 + minLength: 1 + maxLength: 3 + shipmentContentsValue: + description: "The monetary value of shipment contents. \n \n Required 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 + tenths." + type: number + maximum: 3 + minLength: 1 + maxLength: 11 + shipmentContentsCurrencyCode: + description: "The unit of currency used for values. Required if ShipmentContentsValue + is populated. \n Valid 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)" + 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." + type: boolean + maximum: 1 + numberOfPackages: + 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\" " + 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\" " + 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 + 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." + type: integer + maximum: 1 + premierIndicator: + description: "Sets the indicator for premier time in transit when the shipment contains a premier package. + \n \n Valid values: “00”, “01”. \n \n 00 = Non-premier time in transit. + \n \n 01 = Premier time in transit. \n \n The default value is “00”." + type: string + maximum: 1 + minLength: 2 + maxLength: 2 + maximum: 1 + description: N/A + TimeInTransitResponse: + type: object + properties: + validationList: + "$ref": "#/components/schemas/validationList" + destinationPickList: + "$ref": "#/components/schemas/destinationPickList" + originPickList: + "$ref": "#/components/schemas/originPickList" + emsResponse: + "$ref": "#/components/schemas/emsResponse" + maximum: 1 + description: N/A + errorResponse: + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/errors" + validationList: + type: object + properties: + invalidFieldList: + type: array + items: + type: string + invalidFieldListCodes: + type: array + items: + type: string + destinationAmbiguous: + description: Returned as true when destination address has a candidate list + type: boolean + maximum: 1 + originAmbiguous: + description: Returned as true when original address has a candidate list. + type: boolean + maximum: 1 + destinationPickList: + type: array + items: + "$ref": "#/components/schemas/candidateAddress" + originPickList: + type: array + items: + "$ref": "#/components/schemas/candidateAddress" + emsResponse: + type: object + required: + - shipDate + - shipTime + - serviceLevel + - billType + - residentialIndicator + - destinationCountryName + - destinationCountryCode + - originCountryName + - originCountryCode + - guaranteeSuspended + - numberOfServices + 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" + 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" + 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." + 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" + 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" + 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" + type: string + maximum: 1 + minLength: 2 + maxLength: 2 + destinationCountryName: + description: Destination country name value + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + destinationCountryCode: + description: Destination country code, conforms to ISO-defined country codes. + type: string + maximum: 1 + 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 + 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 + 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 + 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. + 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." + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + destinationCityName: + description: "The shipment destination city. \n \n Required for International + requests for those countries that do not utilize postal codes." + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + originCountryName: + description: Origin country name value + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + originCountryCode: + description: Origin country code, conforms to ISO-defined country codes. + type: string + maximum: 1 + 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 + 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 + 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 + 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, + 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." + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + originCityName: + description: "The shipment origin city. \n \n Required 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" + type: string + maximum: 1 + minLength: 1 + maxLength: 8 + weightUnitOfMeasure: + description: Returned on response when weight was present on the request. + type: string + maximum: 1 + minLength: 1 + maxLength: 3 + shipmentContentsValue: + description: "Shipment contents value. Value is only required for international + shipment. \n \n Defaults to 0.0" + type: string + maximum: 1 + minLength: 1 + maxLength: 11 + shipmentContentsCurrencyCode: + description: Returned on response when shipmentContentsValue was present + on the request. + type: string + maximum: 1 + minLength: 3 + maxLength: 3 + 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 + if a shipment falls within a defined peak date range: shipDate (from the + response), deliveryDate (from the response), server Date. \n \n Defined + peak date range (range for when guarantees are suspended) is inclusive + of start and end dates." + type: boolean + maximum: 1 + numberOfServices: + description: Number of services being returned in the services array. + type: integer + maximum: 1 + services: + type: array + items: + "$ref": "#/components/schemas/services" + candidateAddress: + type: object + required: + - countryName + - CountryCode + properties: + countryName: + description: Spelled out country name. + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + countryCode: + description: Country code, follows ISO-defined country codes. + type: string + maximum: 1 + minLength: 2 + maxLength: 2 + stateProvince: + description: Present on response when candidate value has a political division + 1 value available. + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + city: + description: Present on response when candidate value has a political division + 2 value available. + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + town: + description: Present on response when candidate value has a political division + 3 value available. + type: string + maximum: 1 + minLength: 1 + maxLength: 50 + postalCode: + description: Present on response when candidate has a postal code value + available + type: string + maximum: 1 + minLength: 1 + maxLength: 10 + postalCodeLow: + description: Present on response when candidate value has a postal code + range value available. This is the postal range low value. + type: string + maximum: 1 + minLength: 1 + maxLength: 10 + postalCodeHigh: + description: Present on response when candidate value has a postal code + range value available. This is the postal range high value. + type: string + maximum: 1 + minLength: 1 + maxLength: 10 + services: + type: object + required: + - serviceLevel + - serviceLevelDescription + - shipDate + - deliveryDate + - commitTime + - deliveryTime + - deliveryDayOfWeek + - nextDayPickupIndicator + - saturdayPickupIndicator + - saturdayDeliveryIndicator + - guaranteeIndicator + - totalTransitDays + - businessTransitDays + - restDaysCount + - holidayCount + - delayCount + - pickupDate + - pickupTime + - 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\". " + type: string + maximum: 1 + minLength: 2 + maxLength: 2 + serviceLevelDescription: + description: 'Service name. Examples are: UPS Next Day Air, UPS Ground, + UPS Expedited, UPS Worldwide Express Freight' + type: string + 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" + type: string + maximum: 1 + minLength: 10 + maxLength: 10 + deliveryDate: + description: "Scheduled delivery date. \n \n Valid format: YYYY-MM-DD" + type: string + maximum: 1 + minLength: 10 + maxLength: 10 + commitTime: + description: "Scheduled commit time. \n \n For 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" + 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" + type: string + maximum: 1 + minLength: 8 + maxLength: 8 + deliveryDayOfWeek: + description: "Three character scheduled delivery day of week. \n \n Valid + values: \"MON\",\"TUE\",\"WED\",\"THU\",\"FRI\", \"SAT\"" + type: string + maximum: 1 + minLength: 3 + 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 flag is set, WWDTDisclaimer.getNextDayDisclaimer method could be + called to return the next day disclaimer message." + type: string + maximum: 1 + minLength: 1 + 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 + 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" + type: string + maximum: 1 + minLength: 10 + maxLength: 10 + saturdayDeliveryTime: + description: "Delivery time of Saturday deliver \n \n Valid format: HH:MM:SS" + type: string + maximum: 1 + minLength: 8 + maxLength: 8 + serviceRemarksText: + description: Service remarks text. The contents of this field will represent + text that the back end application/function needs to display to clarify + the time in transit calculation. + type: string + 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 + 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 + 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." + type: string + maximum: 1 + minLength: 1 + 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." + type: integer + maximum: 1 + businessTransitDays: + description: Returns the number of UPS business days from origin location + to destination location. + type: integer + 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." + 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." + 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." + 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 + shipped on date is a holiday or for locations needing 24 hour notice before + a pickup could be made." + type: string + maximum: 1 + minLength: 10 + maxLength: 10 + pickupTime: + description: Latest possible pickup time. This data is available only for + international transactions. If the package was not actually picked by + UPS before this time, the services will not meet the guarantee commitment. + type: string + maximum: 1 + minLength: 8 + maxLength: 8 + cstccutoffTime: + description: Latest time a customer can contact UPS CST to be notified for + requesting a pickup. This data is available only for international transactions. + If customer does not notify UPS for a pickup before this time, the services + will not meet the guarantee commitment. + type: string + maximum: 1 + minLength: 8 + maxLength: 8 + poddate: + description: Returns the date proof of delivery information would be available. This + data is available only for international transactions. + type: string + maximum: 1 + minLength: 10 + maxLength: 10 + poddays: + description: Returns the number of days proof of delivery information will + be available. This data is available only for international transactions. + type: integer + maximum: 1 + errors: + type: object + properties: + code: + description: Error code + type: string + message: + description: Error message + type: string diff --git a/Tracking-Ready.yaml b/Tracking-Ready.yaml index 649894f..cfa30c6 100644 --- a/Tracking-Ready.yaml +++ b/Tracking-Ready.yaml @@ -1,838 +1,836 @@ -openapi: 3.0.1 -info: - title: UPS TrackService API - 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.
The response returns an array of shipment objects containing detailed tracking information and status for the package(s) associated with the inquiryNumber, including current status, activity history, delivery details, package details, and more. For more information on the Track API, please visit the Product Overview page. - - **Note:** Data is rolled off after the 120 day retention period and may not be returned in the response after the retention period. - - Key Business Values: - - **Near real-time tracking information**: Get up-to-date information on the status and location of your shipments, so you can keep your customers informed. - - **Proof of Delivery**: Automated proof of delivery updates with signature verification to help prevent fraud and theft. - - **Improved cash flow**: Reduce the time it takes to collect payments by tracking shipments and invoices electronically. - - # Reference - - Business Rules - - Appendix - - Errors - - Tracking Best Practices - - Accelerate API Integration with UPS MCP Server - - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - - -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/track/v1/details/{inquiryNumber}": - get: - summary: Tracking - tags: - - Tracking - security: - - OAuth2: [] - description: '' - operationId: getSingleTrackResponseUsingGET - parameters: - - name: inquiryNumber - in: path - description: The tracking number for which tracking information is requested. - Each inquiry number must be between 7 and 34 characters in length. - required: true - schema: - type: string - - name: locale - in: query - description: Language and country code of the user, separated by an underscore. - Default value is 'en_US' - schema: - type: string - default: en_US - - name: returnSignature - in: query - description: Indicator requesting that the delivery signature image be included - as part of the response (by default the image will not be returned). Returns - image bytecodes of the signature. - schema: - type: string - default: 'false' - - name: returnMilestones - in: query - description: returnMilestones - schema: - type: string - default: 'false' - - name: returnPOD - in: query - description: Return Proof of Delivery - schema: - type: string - default: 'false' - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling - required: true - schema: - type: string - default: testing - responses: - '200': - description: Tracking Information found - content: - "application/json": - schema: - "$ref": "#/components/schemas/TrackApiResponse" - '400': - description: Invalid request - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/Response" - '404': - description: Tracking number information not found - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '500': - description: Internal server error - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '503': - description: Resource is not available - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - deprecated: false - "/track/v1/reference/details/{referenceNumber}": - get: - summary: Track by Reference Number - tags: - - Tracking - security: - - OAuth2: [] - description: '' - operationId: Reference Tracking API - parameters: - - name: referenceNumber - in: path - description: The reference number for which tracking information is requested. - required: true - schema: - type: string - - name: locale - in: query - description: Language and country code of the user, separated by an underscore. - Default value is 'en_US' - schema: - type: string - default: en_US - - name: fromPickUpDate - in: query - description: The tracking information for the above reference number will be searched from this date - schema: - type: string - default: currentDate-14 - - name: toPickUpDate - in: query - description: The tracking information for the above reference number will be searched till this date - schema: - type: string - default: currentDate - - name: destCountry - in: query - description: The Destination Country associated with above reference number - schema: - type: string - default: - - name: destZip - in: query - description: The Destination Zip associated with above reference number - schema: - type: string - default: - - name: shipperNum - in: query - description: The Shipper Number (Account Number) associated with above reference number - schema: - type: string - default: - - name: refNumType - in: query - description: The Reference number type which will define the tracking information is related to small package or fgv - schema: - type: string - default: 'SmallPackage. Valid values: SmallPackage, fgv' - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling - required: true - schema: - type: string - default: testing - responses: - '200': - description: Tracking Information found - content: - "application/json": - schema: - "$ref": "#/components/schemas/TrackApiResponse" - '400': - description: Invalid request - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/Response" - '404': - description: Tracking number information not found - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '500': - description: Internal server error - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '503': - description: Resource is not available - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - deprecated: false -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - AccessPointInformation: - title: AccessPointInformation - type: object - description: The container that has all the information related to the access - point where the package is destined for/delivered to. - properties: - pickupByDate: - type: string - Activity: - title: Activity - type: object - description: Container with all activities associated with the package. Activities - are returned in chronological order, with the most recent activity first. - properties: - date: - type: string - description: 'The date of the activity. Format: YYYYMMDD' - example: '20210210' - gmtDate: - type: string - description: 'gmtDate' - example: '20210210' - gmtOffset: - type: string - description: 'gmtOffset' - example: '-05:00' - gmtTime: - type: string - description: 'gmtTime' - example: '74700' - location: - "$ref": "#/components/schemas/Location" - status: - "$ref": "#/components/schemas/Status" - time: - type: string - description: 'The time of the activity. Format: HHMMSS (24 hr)' - example: '071356' - Address: - title: Address - type: object - description: The container which has the physical address. - properties: - addressLine1: - type: string - description: The physical street address line 1. - example: 100 Main St - addressLine2: - type: string - description: The physical street address line 2. - example: Warehouse - addressLine3: - type: string - description: The physical street address line 3. - example: Building 1 - city: - type: string - description: The physical address city. - example: Wayne - country: - type: string - description: The physical address country. - example: US - countryCode: - type: string - description: The physical address country code. - example: US - postalCode: - type: string - description: The physical address postal code. - example: '07470' - stateProvince: - type: string - description: The physical address state or province. - example: NJ - AlternateTrackingNumber: - title: AlternateTrackingNumber - type: object - description: The list of alternate tracking numbers associated with the package. - properties: - number: - type: string - description: The alternate tracking number. - example: '92419900000033499522966220' - type: - type: string - description: The type of alternate number. Non-typed numbers are typically - UPS tracking numbers. - example: USPS_PIC - DeliveryDate: - title: DeliveryDate - type: object - description: The list of delivery dates associated with the package. - properties: - date: - type: string - description: The date of this delivery detail. Format - YYYYMMDD - type: - type: string - description: 'The list of delivery dates associated with the package. - Valid values: - SDD - Scheduled Delivery Date - RDD - Rescheduled Delivery Date - DEL - Delivered Date' - DeliveryInformation: - title: DeliveryInformation - type: object - description: Container with all information related to the delivery of the package. - Populated only when the package is delivered. - properties: - deliveryPhoto: - "$ref": "#/components/schemas/DeliveryPhoto" - location: - type: string - description: 'The location where the package was dropped off. For example: - ''Front Door''' - example: Front Door - receivedBy: - type: string - description: The individual who took possession of the package at delivery. - example: '' - signature: - "$ref": "#/components/schemas/Signature" - pod: - 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 - package. - properties: - isNonPostalCodeCountry: - type: boolean - 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: - type: string - photoCaptureInd: - type: string - description: 'The photo capture indicator. Valid values: ''Y'' the photo is an - photo capture. ''N'' the photo is not a capture' - photoDispositionCode: - type: string - 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 - type: object - description: The container which has all delivery times associated with the - package. - properties: - endTime: - type: string - description: 'The end time of a window or the committed time or the delivered - time. Only returned when the type is “EDW” or “CDW” or “IDW” or “CMT” - or “DEL”. Format: HHMMSS (24 hr)' - startTime: - type: string - description: 'The start time of a delivery. Only returned when the type - is “EDW” or “CDW” or “IDW”. Format: HHMMSS (24 hr).' - type: - type: string - description: |- - The date of this delivery detail. - Valid values: - - EOD - End of Day - CMT - Commit Time - EDW - Estimated Delivery Window ** - CDW - Confirmed Delivery Window ** - IDW - Imminent Delivery Window ** - DEL - Delivered Time - Dimension: - title: Dimension - type: object - properties: - height: - type: string - description: 'Height of the package' - length: - type: string - description: 'Length of the package' - unitOfDimension: - type: string - description: 'The unit of the dimensions' - width: - type: string - description: 'Width of the package' - Error: - title: Error - type: object - properties: - code: - type: string - message: - type: string - InquireNumbers: - title: InquireNumbers - type: object - properties: - inquiryNumbers: - type: array - items: - type: string - description: Inquiry number - Location: - title: Location - type: object - properties: - address: - "$ref": "#/components/schemas/Address" - slic: - type: string - description: Site Location Indicator Code (SLIC) - example: '8566' - Milestones: - title: Milestones - type: object - description: The list of milestones associated with the package. Milestones - will be returned in chronological order, with the oldest first and most recent/future - milestones last. - properties: - category: - type: string - description: The milestone category. This will be present only when a milestone - is in a COMPLETE state. - code: - type: string - description: The milestone code. - current: - 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.' - description: - type: string - description: 'The milestone description. Note: this is not translated at - this time and is returned in US English.' - linkedActivity: - type: string - description: The 0-based index of the activity that triggered this milestone. - This will be returned only when a milestone is in a COMPLETE state. For - example the most recent activity on the response is index 0. - state: - type: string - description: 'The milestone state. Valid values: ''This milestone has already - occurred''/''This milestone has not yet been completed''.' - subMilestone: - "$ref": "#/components/schemas/SubMilestone" - Package: - title: Package - type: object - properties: - accessPointInformation: - "$ref": "#/components/schemas/AccessPointInformation" - activity: - type: array - items: - "$ref": "#/components/schemas/Activity" - additionalAttributes: - type: array - description: The list of additional attributes that may be associated with - the package. Presence of any element indicates the package has that attribute. - example: - - SENSOR_EVENT - items: - type: string - additionalServices: - type: array - description: The list of additional services that may be associated with - the package. Presence of any element indicates that the package has that - service. - example: - - ADULT_SIGNATURE_REQUIRED - - SIGNATURE_REQUIRED - - ADDITIONAL_HANDLING - - CARBON_NEUTRAL - - UPS_PREMIER_SILVER - - UPS_PREMIER_GOLD - - UPS_PREMIER_PLATINUM - items: - type: string - alternateTrackingNumber: - type: array - items: - "$ref": "#/components/schemas/AlternateTrackingNumber" - currentStatus: - "$ref": "#/components/schemas/Status" - deliveryDate: - type: array - items: - "$ref": "#/components/schemas/DeliveryDate" - deliveryInformation: - "$ref": "#/components/schemas/DeliveryInformation" - deliveryTime: - "$ref": "#/components/schemas/DeliveryTime" - dimension: - "$ref": "#/components/schemas/Dimension" - isSmartPackage: - type: boolean - description: 'Indicator of whether the package is a smart package' - milestones: - type: array - description: milestones - items: - "$ref": "#/components/schemas/Milestones" - packageAddress: - type: array - items: - "$ref": "#/components/schemas/PackageAddress" - packageCount: - type: integer - description: The total number of packages in the shipment. Note that this - number may be greater than the number of returned packages in the response. - In such cases subsequent calls are needed to get additional packages. - format: int32 - example: 2 - paymentInformation: - type: array - items: - "$ref": "#/components/schemas/PaymentInformation" - referenceNumber: - type: array - items: - "$ref": "#/components/schemas/ReferenceNumber" - service: - "$ref": "#/components/schemas/Service" - statusCode: - type: string - statusDescription: - type: string - description: 'The activity status description. Note: this field will be - translated based on the locale provided in the request.' - suppressionIndicators: - type: array - description: 'Contains values which signify that certain data should be - suppressed or hidden. Valid values: Tracking activity details should be - hidden. Note: this is mainly intended for use by UPS.com applications.' - example: DETAIL - items: - type: string - trackingNumber: - type: string - ucixStatus: - type: string - description: 'This indicator provides UCIX (UPS Customer Information Exchange) status - Valid values: ''O'' means open. ''C'' means closed.' - weight: - "$ref": "#/components/schemas/Weight" - PackageAddress: - title: PackageAddress - type: object - description: The container array that has all the addresses associated with - the package, such as the ship from (shipper), ship to (consignee), and delivery - addresses - properties: - address: - "$ref": "#/components/schemas/Address" - attentionName: - type: string - description: The specific name of an individual associated with the address - segment. - name: - type: string - description: Ship-to name. - example: Sears - type: - type: string - description: The type of address. - example: ORIGIN/DESTINATION - PaymentInformation: - title: PaymentInformation - type: object - description: The container array that has all the payment information associated - with the package, such as 'Collect on Delivery payment'. - properties: - amount: - type: string - description: 'The payment amount. This value will contain the amount in - dollars and cents, separated by a period (.) Example: ''1025.50''.9' - example: '243.5' - currency: - type: string - description: The payment currency code (see API codes for possible values). - example: EUR - id: - type: string - description: The payment internal ID. This may be used in other systems - to retrieve additional information on the payment. - example: 3S35571M1L381K5O0P316L0M1R2E6H14 - paid: - type: boolean - description: 'The indication for whether the payment is paid or not. Valid - values: ''true'' the payment is paid. ''false'' the payment is not paid.' - example: false - paymentMethod: - type: string - description: The applicable payment methods. - example: C0, C1, ... C9 - type: - type: string - description: The payment type. - example: ICOD/COD - ReferenceNumber: - title: ReferenceNumber - type: object - description: The list of reference numbers associated with the package. - properties: - number: - type: string - description: The reference number. - example: ShipRef123 - type: - type: string - description: The type of reference number. Specifies how the reference number - is associated with the package. - example: SHIPMENT - Response: - title: Response - type: object - properties: - response: - "$ref": "#/components/schemas/ErrorResponse" - ErrorResponse: - title: Response - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/Error" - Service: - title: Service - type: object - description: The container which has the package service information. - properties: - code: - type: string - description: The service name code. - example: '518' - description: - type: string - description: The service name description. Note that this field will be - translated based on the locale provided in the request. - example: UPS Ground - levelCode: - type: string - description: levelCode - example: '011' - Shipment: - title: Shipment - type: object - properties: - inquiryNumber: - type: string - description: inquiryNumber - example: 1Z023E2X0214323462 - package: - type: array - items: - "$ref": "#/components/schemas/Package" - userRelation: - type: array - description: The relationship of the user to the package(s) in the shipment. - No value means that the user has no relationship to the package. Note - that this check is only done when the request contains the 'Username' - and package rights checking is performed. Valid values:
'MYC_HOME' - - My Choice for Home
'MYC_BUS_OUTBOUND' - My Choice for Business - Outbound
'MYC_BUS_INBOUND' - My Choice for Business Inbound
'SHIPPER' - - Shipper - example: MYCHOICE_HOME - items: - type: string - warnings: - type: array - items: - "$ref": "#/components/schemas/Warning" - Signature: - title: Signature - type: object - description: Container with all the signature information associated to the - package being delivered. - properties: - image: - type: string - description: 'The base64 encoded string representation of the signature - image. Note: This is considered sensitive data and may only be returned - for a user that has rights to the package.' - example: encoding Base64 - Status: - title: Status - type: object - description: The container which has the current package status - properties: - code: - type: string - description: The current status code. - example: SR - description: - type: string - description: The current status description. Note that this field will be - translated based on the locale provided in the request. - example: Your package was released by the customs agency. - simplifiedTextDescription: - type: string - description: The current status in simplified text. This is a supplementary - description providing additional information on the status of the package. - Note that this field will be translated based on the locale provided in - the request. - example: Delivered - statusCode: - type: string - description: The activity package detail status code see API Codes for possible - values. - example: '003' - type: - type: string - description: The activity status type. - example: X - SubMilestone: - title: SubMilestone - type: object - description: The sub-milestone container containing information on a child milestone. - Will be present only if a child milestone exists. - properties: - category: - type: string - description: The sub-milestone category. - TrackApiResponse: - title: TrackApiResponse - type: object - properties: - trackResponse: - "$ref": "#/components/schemas/TrackResponse" - TrackResponse: - title: TrackResponse - type: object - properties: - shipment: - type: array - items: - "$ref": "#/components/schemas/Shipment" - Warning: - title: Warning - type: object - properties: - code: - type: string - message: - type: string - Weight: - title: Weight - type: object - description: The weight container for the package. - properties: - unitOfMeasurement: - type: string - description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. - ''KGS'' - kilograms.' - weight: - type: string - description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. - ''KGS'' - kilograms.' - - +openapi: 3.0.1 +info: + title: UPS TrackService API + 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.
The response returns an array of shipment objects containing detailed tracking information and status for the package(s) associated with the inquiryNumber, including current status, activity history, delivery details, package details, and more. For more information on the Track API, please visit the Product Overview page. + + **Note:** Data is rolled off after the 120 day retention period and may not be returned in the response after the retention period. + + Key Business Values: + - **Near real-time tracking information**: Get up-to-date information on the status and location of your shipments, so you can keep your customers informed. + - **Proof of Delivery**: Automated proof of delivery updates with signature verification to help prevent fraud and theft. + - **Improved cash flow**: Reduce the time it takes to collect payments by tracking shipments and invoices electronically. + + # Reference + - Business Rules + - Appendix + - Errors + - Tracking Best Practices + - Accelerate API Integration with UPS MCP Server + + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + + +
+

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/track/v1/details/{inquiryNumber}": + get: + summary: Tracking + tags: + - Tracking + security: + - OAuth2: [] + description: '' + operationId: getSingleTrackResponseUsingGET + parameters: + - name: inquiryNumber + in: path + description: The tracking number for which tracking information is requested. + Each inquiry number must be between 7 and 34 characters in length. + required: true + schema: + type: string + - name: locale + in: query + description: Language and country code of the user, separated by an underscore. + Default value is 'en_US' + schema: + type: string + default: en_US + - name: returnSignature + in: query + description: Indicator requesting that the delivery signature image be included + as part of the response (by default the image will not be returned). Returns + image bytecodes of the signature. + schema: + type: string + default: 'false' + - name: returnMilestones + in: query + description: returnMilestones + schema: + type: string + default: 'false' + - name: returnPOD + in: query + description: Return Proof of Delivery + schema: + type: string + default: 'false' + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling + required: true + schema: + type: string + default: testing + responses: + '200': + description: Tracking Information found + content: + "application/json": + schema: + "$ref": "#/components/schemas/TrackApiResponse" + '400': + description: Invalid request + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/Response" + '404': + description: Tracking number information not found + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '500': + description: Internal server error + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '503': + description: Resource is not available + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + deprecated: false + "/track/v1/reference/details/{referenceNumber}": + get: + summary: Track by Reference Number + tags: + - Tracking + security: + - OAuth2: [] + description: '' + operationId: Reference Tracking API + parameters: + - name: referenceNumber + in: path + description: The reference number for which tracking information is requested. + required: true + schema: + type: string + - name: locale + in: query + description: Language and country code of the user, separated by an underscore. + Default value is 'en_US' + schema: + type: string + default: en_US + - name: fromPickUpDate + in: query + description: The tracking information for the above reference number will be searched from this date + schema: + type: string + default: currentDate-14 + - name: toPickUpDate + in: query + description: The tracking information for the above reference number will be searched till this date + schema: + type: string + default: currentDate + - name: destCountry + in: query + description: The Destination Country associated with above reference number + schema: + type: string + default: + - name: destZip + in: query + description: The Destination Zip associated with above reference number + schema: + type: string + default: + - name: shipperNum + in: query + description: The Shipper Number (Account Number) associated with above reference number + schema: + type: string + default: + - name: refNumType + in: query + description: The Reference number type which will define the tracking information is related to small package or fgv + schema: + type: string + default: 'SmallPackage. Valid values: SmallPackage, fgv' + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling + required: true + schema: + type: string + default: testing + responses: + '200': + description: Tracking Information found + content: + "application/json": + schema: + "$ref": "#/components/schemas/TrackApiResponse" + '400': + description: Invalid request + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/Response" + '404': + description: Tracking number information not found + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '500': + description: Internal server error + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '503': + description: Resource is not available + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + deprecated: false +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + AccessPointInformation: + title: AccessPointInformation + type: object + description: The container that has all the information related to the access + point where the package is destined for/delivered to. + properties: + pickupByDate: + type: string + Activity: + title: Activity + type: object + description: Container with all activities associated with the package. Activities + are returned in chronological order, with the most recent activity first. + properties: + date: + type: string + description: 'The date of the activity. Format: YYYYMMDD' + example: '20210210' + gmtDate: + type: string + description: 'gmtDate' + example: '20210210' + gmtOffset: + type: string + description: 'gmtOffset' + example: '-05:00' + gmtTime: + type: string + description: 'gmtTime' + example: '74700' + location: + "$ref": "#/components/schemas/Location" + status: + "$ref": "#/components/schemas/Status" + time: + type: string + description: 'The time of the activity. Format: HHMMSS (24 hr)' + example: '071356' + Address: + title: Address + type: object + description: The container which has the physical address. + properties: + addressLine1: + type: string + description: The physical street address line 1. + example: 100 Main St + addressLine2: + type: string + description: The physical street address line 2. + example: Warehouse + addressLine3: + type: string + description: The physical street address line 3. + example: Building 1 + city: + type: string + description: The physical address city. + example: Wayne + country: + type: string + description: The physical address country. + example: US + countryCode: + type: string + description: The physical address country code. + example: US + postalCode: + type: string + description: The physical address postal code. + example: '07470' + stateProvince: + type: string + description: The physical address state or province. + example: NJ + AlternateTrackingNumber: + title: AlternateTrackingNumber + type: object + description: The list of alternate tracking numbers associated with the package. + properties: + number: + type: string + description: The alternate tracking number. + example: '92419900000033499522966220' + type: + type: string + description: The type of alternate number. Non-typed numbers are typically + UPS tracking numbers. + example: USPS_PIC + DeliveryDate: + title: DeliveryDate + type: object + description: The list of delivery dates associated with the package. + properties: + date: + type: string + description: The date of this delivery detail. Format - YYYYMMDD + type: + type: string + description: 'The list of delivery dates associated with the package. + Valid values: + SDD - Scheduled Delivery Date + RDD - Rescheduled Delivery Date + DEL - Delivered Date' + DeliveryInformation: + title: DeliveryInformation + type: object + description: Container with all information related to the delivery of the package. + Populated only when the package is delivered. + properties: + deliveryPhoto: + "$ref": "#/components/schemas/DeliveryPhoto" + location: + type: string + description: 'The location where the package was dropped off. For example: + ''Front Door''' + example: Front Door + receivedBy: + type: string + description: The individual who took possession of the package at delivery. + example: '' + signature: + "$ref": "#/components/schemas/Signature" + pod: + 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 + package. + properties: + isNonPostalCodeCountry: + type: boolean + 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: + type: string + photoCaptureInd: + type: string + description: 'The photo capture indicator. Valid values: ''Y'' the photo is an + photo capture. ''N'' the photo is not a capture' + photoDispositionCode: + type: string + 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 + type: object + description: The container which has all delivery times associated with the + package. + properties: + endTime: + type: string + description: 'The end time of a window or the committed time or the delivered + time. Only returned when the type is “EDW” or “CDW” or “IDW” or “CMT” + or “DEL”. Format: HHMMSS (24 hr)' + startTime: + type: string + description: 'The start time of a delivery. Only returned when the type + is “EDW” or “CDW” or “IDW”. Format: HHMMSS (24 hr).' + type: + type: string + description: |- + The date of this delivery detail. + Valid values: + + EOD - End of Day + CMT - Commit Time + EDW - Estimated Delivery Window ** + CDW - Confirmed Delivery Window ** + IDW - Imminent Delivery Window ** + DEL - Delivered Time + Dimension: + title: Dimension + type: object + properties: + height: + type: string + description: 'Height of the package' + length: + type: string + description: 'Length of the package' + unitOfDimension: + type: string + description: 'The unit of the dimensions' + width: + type: string + description: 'Width of the package' + Error: + title: Error + type: object + properties: + code: + type: string + message: + type: string + InquireNumbers: + title: InquireNumbers + type: object + properties: + inquiryNumbers: + type: array + items: + type: string + description: Inquiry number + Location: + title: Location + type: object + properties: + address: + "$ref": "#/components/schemas/Address" + slic: + type: string + description: Site Location Indicator Code (SLIC) + example: '8566' + Milestones: + title: Milestones + type: object + description: The list of milestones associated with the package. Milestones + will be returned in chronological order, with the oldest first and most recent/future + milestones last. + properties: + category: + type: string + description: The milestone category. This will be present only when a milestone + is in a COMPLETE state. + code: + type: string + description: The milestone code. + current: + 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.' + description: + type: string + description: 'The milestone description. Note: this is not translated at + this time and is returned in US English.' + linkedActivity: + type: string + description: The 0-based index of the activity that triggered this milestone. + This will be returned only when a milestone is in a COMPLETE state. For + example the most recent activity on the response is index 0. + state: + type: string + description: 'The milestone state. Valid values: ''This milestone has already + occurred''/''This milestone has not yet been completed''.' + subMilestone: + "$ref": "#/components/schemas/SubMilestone" + Package: + title: Package + type: object + properties: + accessPointInformation: + "$ref": "#/components/schemas/AccessPointInformation" + activity: + type: array + items: + "$ref": "#/components/schemas/Activity" + additionalAttributes: + type: array + description: The list of additional attributes that may be associated with + the package. Presence of any element indicates the package has that attribute. + example: + - SENSOR_EVENT + items: + type: string + additionalServices: + type: array + description: The list of additional services that may be associated with + the package. Presence of any element indicates that the package has that + service. + example: + - ADULT_SIGNATURE_REQUIRED + - SIGNATURE_REQUIRED + - ADDITIONAL_HANDLING + - CARBON_NEUTRAL + - UPS_PREMIER_SILVER + - UPS_PREMIER_GOLD + - UPS_PREMIER_PLATINUM + items: + type: string + alternateTrackingNumber: + type: array + items: + "$ref": "#/components/schemas/AlternateTrackingNumber" + currentStatus: + "$ref": "#/components/schemas/Status" + deliveryDate: + type: array + items: + "$ref": "#/components/schemas/DeliveryDate" + deliveryInformation: + "$ref": "#/components/schemas/DeliveryInformation" + deliveryTime: + "$ref": "#/components/schemas/DeliveryTime" + dimension: + "$ref": "#/components/schemas/Dimension" + isSmartPackage: + type: boolean + description: 'Indicator of whether the package is a smart package' + milestones: + type: array + description: milestones + items: + "$ref": "#/components/schemas/Milestones" + packageAddress: + type: array + items: + "$ref": "#/components/schemas/PackageAddress" + packageCount: + type: integer + description: The total number of packages in the shipment. Note that this + number may be greater than the number of returned packages in the response. + In such cases subsequent calls are needed to get additional packages. + format: int32 + example: 2 + paymentInformation: + type: array + items: + "$ref": "#/components/schemas/PaymentInformation" + referenceNumber: + type: array + items: + "$ref": "#/components/schemas/ReferenceNumber" + service: + "$ref": "#/components/schemas/Service" + statusCode: + type: string + statusDescription: + type: string + description: 'The activity status description. Note: this field will be + translated based on the locale provided in the request.' + suppressionIndicators: + type: array + description: 'Contains values which signify that certain data should be + suppressed or hidden. Valid values: Tracking activity details should be + hidden. Note: this is mainly intended for use by UPS.com applications.' + example: DETAIL + items: + type: string + trackingNumber: + type: string + ucixStatus: + type: string + description: 'This indicator provides UCIX (UPS Customer Information Exchange) status + Valid values: ''O'' means open. ''C'' means closed.' + weight: + "$ref": "#/components/schemas/Weight" + PackageAddress: + title: PackageAddress + type: object + description: The container array that has all the addresses associated with + the package, such as the ship from (shipper), ship to (consignee), and delivery + addresses + properties: + address: + "$ref": "#/components/schemas/Address" + attentionName: + type: string + description: The specific name of an individual associated with the address + segment. + name: + type: string + description: Ship-to name. + example: Sears + type: + type: string + description: The type of address. + example: ORIGIN/DESTINATION + PaymentInformation: + title: PaymentInformation + type: object + description: The container array that has all the payment information associated + with the package, such as 'Collect on Delivery payment'. + properties: + amount: + type: string + description: 'The payment amount. This value will contain the amount in + dollars and cents, separated by a period (.) Example: ''1025.50''.9' + example: '243.5' + currency: + type: string + description: The payment currency code (see API codes for possible values). + example: EUR + id: + type: string + description: The payment internal ID. This may be used in other systems + to retrieve additional information on the payment. + example: 3S35571M1L381K5O0P316L0M1R2E6H14 + paid: + type: boolean + description: 'The indication for whether the payment is paid or not. Valid + values: ''true'' the payment is paid. ''false'' the payment is not paid.' + example: false + paymentMethod: + type: string + description: The applicable payment methods. + example: C0, C1, ... C9 + type: + type: string + description: The payment type. + example: ICOD/COD + ReferenceNumber: + title: ReferenceNumber + type: object + description: The list of reference numbers associated with the package. + properties: + number: + type: string + description: The reference number. + example: ShipRef123 + type: + type: string + description: The type of reference number. Specifies how the reference number + is associated with the package. + example: SHIPMENT + Response: + title: Response + type: object + properties: + response: + "$ref": "#/components/schemas/ErrorResponse" + ErrorResponse: + title: Response + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/Error" + Service: + title: Service + type: object + description: The container which has the package service information. + properties: + code: + type: string + description: The service name code. + example: '518' + description: + type: string + description: The service name description. Note that this field will be + translated based on the locale provided in the request. + example: UPS Ground + levelCode: + type: string + description: levelCode + example: '011' + Shipment: + title: Shipment + type: object + properties: + inquiryNumber: + type: string + description: inquiryNumber + example: 1Z023E2X0214323462 + package: + type: array + items: + "$ref": "#/components/schemas/Package" + userRelation: + type: array + description: The relationship of the user to the package(s) in the shipment. + No value means that the user has no relationship to the package. Note + that this check is only done when the request contains the 'Username' + and package rights checking is performed. Valid values:
'MYC_HOME' + - My Choice for Home
'MYC_BUS_OUTBOUND' - My Choice for Business + Outbound
'MYC_BUS_INBOUND' - My Choice for Business Inbound
'SHIPPER' + - Shipper + example: MYCHOICE_HOME + items: + type: string + warnings: + type: array + items: + "$ref": "#/components/schemas/Warning" + Signature: + title: Signature + type: object + description: Container with all the signature information associated to the + package being delivered. + properties: + image: + type: string + description: 'The base64 encoded string representation of the signature + image. Note: This is considered sensitive data and may only be returned + for a user that has rights to the package.' + example: encoding Base64 + Status: + title: Status + type: object + description: The container which has the current package status + properties: + code: + type: string + description: The current status code. + example: SR + description: + type: string + description: The current status description. Note that this field will be + translated based on the locale provided in the request. + example: Your package was released by the customs agency. + simplifiedTextDescription: + type: string + description: The current status in simplified text. This is a supplementary + description providing additional information on the status of the package. + Note that this field will be translated based on the locale provided in + the request. + example: Delivered + statusCode: + type: string + description: The activity package detail status code see API Codes for possible + values. + example: '003' + type: + type: string + description: The activity status type. + example: X + SubMilestone: + title: SubMilestone + type: object + description: The sub-milestone container containing information on a child milestone. + Will be present only if a child milestone exists. + properties: + category: + type: string + description: The sub-milestone category. + TrackApiResponse: + title: TrackApiResponse + type: object + properties: + trackResponse: + "$ref": "#/components/schemas/TrackResponse" + TrackResponse: + title: TrackResponse + type: object + properties: + shipment: + type: array + items: + "$ref": "#/components/schemas/Shipment" + Warning: + title: Warning + type: object + properties: + code: + type: string + message: + type: string + Weight: + title: Weight + type: object + description: The weight container for the package. + properties: + unitOfMeasurement: + type: string + description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. + ''KGS'' - kilograms.' + weight: + type: string + description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. + ''KGS'' - kilograms.' diff --git a/Tracking.yaml b/Tracking.yaml index 1b3b35f..90d1f71 100644 --- a/Tracking.yaml +++ b/Tracking.yaml @@ -1,831 +1,829 @@ -openapi: 3.0.1 -info: - title: UPS TrackService API - 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.
The response returns an array of shipment objects containing detailed tracking information and status for the package(s) associated with the inquiryNumber, including current status, activity history, delivery details, package details, and more. For more information on the Track API, please visit the Product Overview page. - - **Note:** Data is rolled off after the 120 day retention period and may not be returned in the response after the retention period. - - Key Business Values: - - **Near real-time tracking information**: Get up-to-date information on the status and location of your shipments, so you can keep your customers informed. - - **Proof of Delivery**: Automated proof of delivery updates with signature verification to help prevent fraud and theft. - - **Improved cash flow**: Reduce the time it takes to collect payments by tracking shipments and invoices electronically. - - # Reference - - Business Rules - - Appendix - - Errors - - Tracking Best Practices - - Accelerate API Integration with UPS MCP Server - -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -paths: - "/track/v1/details/{inquiryNumber}": - get: - summary: Tracking - tags: - - Tracking - security: - - OAuth2: [] - description: '' - operationId: getSingleTrackResponseUsingGET - parameters: - - name: inquiryNumber - in: path - description: The tracking number for which tracking information is requested. - Each inquiry number must be between 7 and 34 characters in length. - required: true - schema: - type: string - - name: locale - in: query - description: Language and country code of the user, separated by an underscore. - Default value is 'en_US' - schema: - type: string - default: en_US - - name: returnSignature - in: query - description: Indicator requesting that the delivery signature image be included - as part of the response (by default the image will not be returned). Returns - image bytecodes of the signature. - schema: - type: string - default: 'false' - - name: returnMilestones - in: query - description: returnMilestones - schema: - type: string - default: 'false' - - name: returnPOD - in: query - description: Return Proof of Delivery - schema: - type: string - default: 'false' - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling - required: true - schema: - type: string - default: testing - responses: - '200': - description: Tracking Information found - content: - "application/json": - schema: - "$ref": "#/components/schemas/TrackApiResponse" - '400': - description: Invalid request - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/Response" - '404': - description: Tracking number information not found - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '500': - description: Internal server error - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '503': - description: Resource is not available - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - deprecated: false - "/track/v1/reference/details/{referenceNumber}": - get: - summary: Track by Reference Number - tags: - - Tracking - security: - - OAuth2: [] - description: '' - operationId: Reference Tracking API - parameters: - - name: referenceNumber - in: path - description: The reference number for which tracking information is requested. - required: true - schema: - type: string - - name: locale - in: query - description: Language and country code of the user, separated by an underscore. - Default value is 'en_US' - schema: - type: string - default: en_US - - name: fromPickUpDate - in: query - description: The tracking information for the above reference number will be searched from this date - schema: - type: string - default: currentDate-14 - - name: toPickUpDate - in: query - description: The tracking information for the above reference number will be searched till this date - schema: - type: string - default: currentDate - - name: destCountry - in: query - description: The Destination Country associated with above reference number - schema: - type: string - default: - - name: destZip - in: query - description: The Destination Zip associated with above reference number - schema: - type: string - default: - - name: shipperNum - in: query - description: The Shipper Number (Account Number) associated with above reference number - schema: - type: string - default: - - name: refNumType - in: query - description: The Reference number type which will define the tracking information is related to small package or fgv - schema: - type: string - default: 'SmallPackage. Valid values: SmallPackage, fgv' - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling - required: true - schema: - type: string - default: testing - responses: - '200': - description: Tracking Information found - content: - "application/json": - schema: - "$ref": "#/components/schemas/TrackApiResponse" - '400': - description: Invalid request - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/Response" - '404': - description: Tracking number information not found - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '500': - description: Internal server error - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - '503': - description: Resource is not available - content: - "application/json": - schema: - "$ref": "#/components/schemas/Response" - deprecated: false -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select \"Try It\" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select \"Send\" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - AccessPointInformation: - title: AccessPointInformation - type: object - description: The container that has all the information related to the access - point where the package is destined for/delivered to. - properties: - pickupByDate: - type: string - Activity: - title: Activity - type: object - description: Container with all activities associated with the package. Activities - are returned in chronological order, with the most recent activity first. - properties: - date: - type: string - description: 'The date of the activity. Format: YYYYMMDD' - example: '20210210' - gmtDate: - type: string - description: 'gmtDate' - example: '20210210' - gmtOffset: - type: string - description: 'gmtOffset' - example: '-05:00' - gmtTime: - type: string - description: 'gmtTime' - example: '74700' - location: - "$ref": "#/components/schemas/Location" - status: - "$ref": "#/components/schemas/Status" - time: - type: string - description: 'The time of the activity. Format: HHMMSS (24 hr)' - example: '071356' - Address: - title: Address - type: object - description: The container which has the physical address. - properties: - addressLine1: - type: string - description: The physical street address line 1. - example: 100 Main St - addressLine2: - type: string - description: The physical street address line 2. - example: Warehouse - addressLine3: - type: string - description: The physical street address line 3. - example: Building 1 - city: - type: string - description: The physical address city. - example: Wayne - country: - type: string - description: The physical address country. - example: US - countryCode: - type: string - description: The physical address country code. - example: US - postalCode: - type: string - description: The physical address postal code. - example: '07470' - stateProvince: - type: string - description: The physical address state or province. - example: NJ - AlternateTrackingNumber: - title: AlternateTrackingNumber - type: object - description: The list of alternate tracking numbers associated with the package. - properties: - number: - type: string - description: The alternate tracking number. - example: '92419900000033499522966220' - type: - type: string - description: The type of alternate number. Non-typed numbers are typically - UPS tracking numbers. - example: USPS_PIC - DeliveryDate: - title: DeliveryDate - type: object - description: The list of delivery dates associated with the package. - properties: - date: - type: string - description: The date of this delivery detail. Format - YYYYMMDD - type: - type: string - description: 'The list of delivery dates associated with the package. - Valid values: - SDD - Scheduled Delivery Date - RDD - Rescheduled Delivery Date - DEL - Delivered Date' - DeliveryInformation: - title: DeliveryInformation - type: object - description: Container with all information related to the delivery of the package. - Populated only when the package is delivered. - properties: - deliveryPhoto: - "$ref": "#/components/schemas/DeliveryPhoto" - location: - type: string - description: 'The location where the package was dropped off. For example: - ''Front Door''' - example: Front Door - receivedBy: - type: string - description: The individual who took possession of the package at delivery. - example: '' - signature: - "$ref": "#/components/schemas/Signature" - pod: - 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 - package. - properties: - isNonPostalCodeCountry: - type: boolean - 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: - type: string - photoCaptureInd: - type: string - description: 'The photo capture indicator. Valid values: ''Y'' the photo is an - photo capture. ''N'' the photo is not a capture' - photoDispositionCode: - type: string - 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 - type: object - description: The container which has all delivery times associated with the - package. - properties: - endTime: - type: string - description: 'The end time of a window or the committed time or the delivered - time. Only returned when the type is “EDW” or “CDW” or “IDW” or “CMT” - or “DEL”. Format: HHMMSS (24 hr)' - startTime: - type: string - description: 'The start time of a delivery. Only returned when the type - is “EDW” or “CDW” or “IDW”. Format: HHMMSS (24 hr).' - type: - type: string - description: |- - The date of this delivery detail. - Valid values: - - EOD - End of Day - CMT - Commit Time - EDW - Estimated Delivery Window ** - CDW - Confirmed Delivery Window ** - IDW - Imminent Delivery Window ** - DEL - Delivered Time - Dimension: - title: Dimension - type: object - properties: - height: - type: string - description: 'Height of the package' - length: - type: string - description: 'Length of the package' - unitOfDimension: - type: string - description: 'The unit of the dimensions' - width: - type: string - description: 'Width of the package' - Error: - title: Error - type: object - properties: - code: - type: string - message: - type: string - InquireNumbers: - title: InquireNumbers - type: object - properties: - inquiryNumbers: - type: array - items: - type: string - description: Inquiry number - Location: - title: Location - type: object - properties: - address: - "$ref": "#/components/schemas/Address" - slic: - type: string - description: Site Location Indicator Code (SLIC) - example: '8566' - Milestones: - title: Milestones - type: object - description: The list of milestones associated with the package. Milestones - will be returned in chronological order, with the oldest first and most recent/future - milestones last. - properties: - category: - type: string - description: The milestone category. This will be present only when a milestone - is in a COMPLETE state. - code: - type: string - description: The milestone code. - current: - 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.' - description: - type: string - description: 'The milestone description. Note: this is not translated at - this time and is returned in US English.' - linkedActivity: - type: string - description: The 0-based index of the activity that triggered this milestone. - This will be returned only when a milestone is in a COMPLETE state. For - example the most recent activity on the response is index 0. - state: - type: string - description: 'The milestone state. Valid values: ''This milestone has already - occurred''/''This milestone has not yet been completed''.' - subMilestone: - "$ref": "#/components/schemas/SubMilestone" - Package: - title: Package - type: object - properties: - accessPointInformation: - "$ref": "#/components/schemas/AccessPointInformation" - activity: - type: array - items: - "$ref": "#/components/schemas/Activity" - additionalAttributes: - type: array - description: The list of additional attributes that may be associated with - the package. Presence of any element indicates the package has that attribute. - example: - - SENSOR_EVENT - items: - type: string - additionalServices: - type: array - description: The list of additional services that may be associated with - the package. Presence of any element indicates that the package has that - service. - example: - - ADULT_SIGNATURE_REQUIRED - - SIGNATURE_REQUIRED - - ADDITIONAL_HANDLING - - CARBON_NEUTRAL - - UPS_PREMIER_SILVER - - UPS_PREMIER_GOLD - - UPS_PREMIER_PLATINUM - items: - type: string - alternateTrackingNumber: - type: array - items: - "$ref": "#/components/schemas/AlternateTrackingNumber" - currentStatus: - "$ref": "#/components/schemas/Status" - deliveryDate: - type: array - items: - "$ref": "#/components/schemas/DeliveryDate" - deliveryInformation: - "$ref": "#/components/schemas/DeliveryInformation" - deliveryTime: - "$ref": "#/components/schemas/DeliveryTime" - dimension: - "$ref": "#/components/schemas/Dimension" - isSmartPackage: - type: boolean - description: 'Indicator of whether the package is a smart package' - milestones: - type: array - description: milestones - items: - "$ref": "#/components/schemas/Milestones" - packageAddress: - type: array - items: - "$ref": "#/components/schemas/PackageAddress" - packageCount: - type: integer - description: The total number of packages in the shipment. Note that this - number may be greater than the number of returned packages in the response. - In such cases subsequent calls are needed to get additional packages. - format: int32 - example: 2 - paymentInformation: - type: array - items: - "$ref": "#/components/schemas/PaymentInformation" - referenceNumber: - type: array - items: - "$ref": "#/components/schemas/ReferenceNumber" - service: - "$ref": "#/components/schemas/Service" - statusCode: - type: string - statusDescription: - type: string - description: 'The activity status description. Note: this field will be - translated based on the locale provided in the request.' - suppressionIndicators: - type: array - description: 'Contains values which signify that certain data should be - suppressed or hidden. Valid values: Tracking activity details should be - hidden. Note: this is mainly intended for use by UPS.com applications.' - example: DETAIL - items: - type: string - trackingNumber: - type: string - ucixStatus: - type: string - description: 'This indicator provides UCIX (UPS Customer Information Exchange) status - Valid values: ''O'' means open. ''C'' means closed.' - weight: - "$ref": "#/components/schemas/Weight" - PackageAddress: - title: PackageAddress - type: object - description: The container array that has all the addresses associated with - the package, such as the ship from (shipper), ship to (consignee), and delivery - addresses - properties: - address: - "$ref": "#/components/schemas/Address" - attentionName: - type: string - description: The specific name of an individual associated with the address - segment. - name: - type: string - description: Ship-to name. - example: Sears - type: - type: string - description: The type of address. - example: ORIGIN/DESTINATION - PaymentInformation: - title: PaymentInformation - type: object - description: The container array that has all the payment information associated - with the package, such as 'Collect on Delivery payment'. - properties: - amount: - type: string - description: 'The payment amount. This value will contain the amount in - dollars and cents, separated by a period (.) Example: ''1025.50''.9' - example: '243.5' - currency: - type: string - description: The payment currency code (see API codes for possible values). - example: EUR - id: - type: string - description: The payment internal ID. This may be used in other systems - to retrieve additional information on the payment. - example: 3S35571M1L381K5O0P316L0M1R2E6H14 - paid: - type: boolean - description: 'The indication for whether the payment is paid or not. Valid - values: ''true'' the payment is paid. ''false'' the payment is not paid.' - example: false - paymentMethod: - type: string - description: The applicable payment methods. - example: C0, C1, ... C9 - type: - type: string - description: The payment type. - example: ICOD/COD - ReferenceNumber: - title: ReferenceNumber - type: object - description: The list of reference numbers associated with the package. - properties: - number: - type: string - description: The reference number. - example: ShipRef123 - type: - type: string - description: The type of reference number. Specifies how the reference number - is associated with the package. - example: SHIPMENT - Response: - title: Response - type: object - properties: - response: - "$ref": "#/components/schemas/ErrorResponse" - ErrorResponse: - title: Response - type: object - properties: - errors: - type: array - items: - "$ref": "#/components/schemas/Error" - Service: - title: Service - type: object - description: The container which has the package service information. - properties: - code: - type: string - description: The service name code. - example: '518' - description: - type: string - description: The service name description. Note that this field will be - translated based on the locale provided in the request. - example: UPS Ground - levelCode: - type: string - description: levelCode - example: '011' - Shipment: - title: Shipment - type: object - properties: - inquiryNumber: - type: string - description: inquiryNumber - example: 1Z023E2X0214323462 - package: - type: array - items: - "$ref": "#/components/schemas/Package" - userRelation: - type: array - description: The relationship of the user to the package(s) in the shipment. - No value means that the user has no relationship to the package. Note - that this check is only done when the request contains the 'Username' - and package rights checking is performed. Valid values:
'MYC_HOME' - - My Choice for Home
'MYC_BUS_OUTBOUND' - My Choice for Business - Outbound
'MYC_BUS_INBOUND' - My Choice for Business Inbound
'SHIPPER' - - Shipper - example: MYCHOICE_HOME - items: - type: string - warnings: - type: array - items: - "$ref": "#/components/schemas/Warning" - Signature: - title: Signature - type: object - description: Container with all the signature information associated to the - package being delivered. - properties: - image: - type: string - description: 'The base64 encoded string representation of the signature - image. Note: This is considered sensitive data and may only be returned - for a user that has rights to the package.' - example: encoding Base64 - Status: - title: Status - type: object - description: The container which has the current package status - properties: - code: - type: string - description: The current status code. - example: SR - description: - type: string - description: The current status description. Note that this field will be - translated based on the locale provided in the request. - example: Your package was released by the customs agency. - simplifiedTextDescription: - type: string - description: The current status in simplified text. This is a supplementary - description providing additional information on the status of the package. - Note that this field will be translated based on the locale provided in - the request. - example: Delivered - statusCode: - type: string - description: The activity package detail status code see API Codes for possible - values. - example: '003' - type: - type: string - description: The activity status type. - example: X - SubMilestone: - title: SubMilestone - type: object - description: The sub-milestone container containing information on a child milestone. - Will be present only if a child milestone exists. - properties: - category: - type: string - description: The sub-milestone category. - TrackApiResponse: - title: TrackApiResponse - type: object - properties: - trackResponse: - "$ref": "#/components/schemas/TrackResponse" - TrackResponse: - title: TrackResponse - type: object - properties: - shipment: - type: array - items: - "$ref": "#/components/schemas/Shipment" - Warning: - title: Warning - type: object - properties: - code: - type: string - message: - type: string - Weight: - title: Weight - type: object - description: The weight container for the package. - properties: - unitOfMeasurement: - type: string - description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. - ''KGS'' - kilograms.' - weight: - type: string - description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. - ''KGS'' - kilograms.' - - +openapi: 3.0.1 +info: + title: UPS TrackService API + 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.
The response returns an array of shipment objects containing detailed tracking information and status for the package(s) associated with the inquiryNumber, including current status, activity history, delivery details, package details, and more. For more information on the Track API, please visit the Product Overview page. + + **Note:** Data is rolled off after the 120 day retention period and may not be returned in the response after the retention period. + + Key Business Values: + - **Near real-time tracking information**: Get up-to-date information on the status and location of your shipments, so you can keep your customers informed. + - **Proof of Delivery**: Automated proof of delivery updates with signature verification to help prevent fraud and theft. + - **Improved cash flow**: Reduce the time it takes to collect payments by tracking shipments and invoices electronically. + + # Reference + - Business Rules + - Appendix + - Errors + - Tracking Best Practices + - Accelerate API Integration with UPS MCP Server + +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +paths: + "/track/v1/details/{inquiryNumber}": + get: + summary: Tracking + tags: + - Tracking + security: + - OAuth2: [] + description: '' + operationId: getSingleTrackResponseUsingGET + parameters: + - name: inquiryNumber + in: path + description: The tracking number for which tracking information is requested. + Each inquiry number must be between 7 and 34 characters in length. + required: true + schema: + type: string + - name: locale + in: query + description: Language and country code of the user, separated by an underscore. + Default value is 'en_US' + schema: + type: string + default: en_US + - name: returnSignature + in: query + description: Indicator requesting that the delivery signature image be included + as part of the response (by default the image will not be returned). Returns + image bytecodes of the signature. + schema: + type: string + default: 'false' + - name: returnMilestones + in: query + description: returnMilestones + schema: + type: string + default: 'false' + - name: returnPOD + in: query + description: Return Proof of Delivery + schema: + type: string + default: 'false' + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling + required: true + schema: + type: string + default: testing + responses: + '200': + description: Tracking Information found + content: + "application/json": + schema: + "$ref": "#/components/schemas/TrackApiResponse" + '400': + description: Invalid request + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/Response" + '404': + description: Tracking number information not found + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '500': + description: Internal server error + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '503': + description: Resource is not available + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + deprecated: false + "/track/v1/reference/details/{referenceNumber}": + get: + summary: Track by Reference Number + tags: + - Tracking + security: + - OAuth2: [] + description: '' + operationId: Reference Tracking API + parameters: + - name: referenceNumber + in: path + description: The reference number for which tracking information is requested. + required: true + schema: + type: string + - name: locale + in: query + description: Language and country code of the user, separated by an underscore. + Default value is 'en_US' + schema: + type: string + default: en_US + - name: fromPickUpDate + in: query + description: The tracking information for the above reference number will be searched from this date + schema: + type: string + default: currentDate-14 + - name: toPickUpDate + in: query + description: The tracking information for the above reference number will be searched till this date + schema: + type: string + default: currentDate + - name: destCountry + in: query + description: The Destination Country associated with above reference number + schema: + type: string + default: + - name: destZip + in: query + description: The Destination Zip associated with above reference number + schema: + type: string + default: + - name: shipperNum + in: query + description: The Shipper Number (Account Number) associated with above reference number + schema: + type: string + default: + - name: refNumType + in: query + description: The Reference number type which will define the tracking information is related to small package or fgv + schema: + type: string + default: 'SmallPackage. Valid values: SmallPackage, fgv' + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling + required: true + schema: + type: string + default: testing + responses: + '200': + description: Tracking Information found + content: + "application/json": + schema: + "$ref": "#/components/schemas/TrackApiResponse" + '400': + description: Invalid request + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/Response" + '404': + description: Tracking number information not found + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '500': + description: Internal server error + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '503': + description: Resource is not available + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + deprecated: false +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select \"Try It\" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select \"Send\" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + AccessPointInformation: + title: AccessPointInformation + type: object + description: The container that has all the information related to the access + point where the package is destined for/delivered to. + properties: + pickupByDate: + type: string + Activity: + title: Activity + type: object + description: Container with all activities associated with the package. Activities + are returned in chronological order, with the most recent activity first. + properties: + date: + type: string + description: 'The date of the activity. Format: YYYYMMDD' + example: '20210210' + gmtDate: + type: string + description: 'gmtDate' + example: '20210210' + gmtOffset: + type: string + description: 'gmtOffset' + example: '-05:00' + gmtTime: + type: string + description: 'gmtTime' + example: '74700' + location: + "$ref": "#/components/schemas/Location" + status: + "$ref": "#/components/schemas/Status" + time: + type: string + description: 'The time of the activity. Format: HHMMSS (24 hr)' + example: '071356' + Address: + title: Address + type: object + description: The container which has the physical address. + properties: + addressLine1: + type: string + description: The physical street address line 1. + example: 100 Main St + addressLine2: + type: string + description: The physical street address line 2. + example: Warehouse + addressLine3: + type: string + description: The physical street address line 3. + example: Building 1 + city: + type: string + description: The physical address city. + example: Wayne + country: + type: string + description: The physical address country. + example: US + countryCode: + type: string + description: The physical address country code. + example: US + postalCode: + type: string + description: The physical address postal code. + example: '07470' + stateProvince: + type: string + description: The physical address state or province. + example: NJ + AlternateTrackingNumber: + title: AlternateTrackingNumber + type: object + description: The list of alternate tracking numbers associated with the package. + properties: + number: + type: string + description: The alternate tracking number. + example: '92419900000033499522966220' + type: + type: string + description: The type of alternate number. Non-typed numbers are typically + UPS tracking numbers. + example: USPS_PIC + DeliveryDate: + title: DeliveryDate + type: object + description: The list of delivery dates associated with the package. + properties: + date: + type: string + description: The date of this delivery detail. Format - YYYYMMDD + type: + type: string + description: 'The list of delivery dates associated with the package. + Valid values: + SDD - Scheduled Delivery Date + RDD - Rescheduled Delivery Date + DEL - Delivered Date' + DeliveryInformation: + title: DeliveryInformation + type: object + description: Container with all information related to the delivery of the package. + Populated only when the package is delivered. + properties: + deliveryPhoto: + "$ref": "#/components/schemas/DeliveryPhoto" + location: + type: string + description: 'The location where the package was dropped off. For example: + ''Front Door''' + example: Front Door + receivedBy: + type: string + description: The individual who took possession of the package at delivery. + example: '' + signature: + "$ref": "#/components/schemas/Signature" + pod: + 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 + package. + properties: + isNonPostalCodeCountry: + type: boolean + 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: + type: string + photoCaptureInd: + type: string + description: 'The photo capture indicator. Valid values: ''Y'' the photo is an + photo capture. ''N'' the photo is not a capture' + photoDispositionCode: + type: string + 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 + type: object + description: The container which has all delivery times associated with the + package. + properties: + endTime: + type: string + description: 'The end time of a window or the committed time or the delivered + time. Only returned when the type is “EDW” or “CDW” or “IDW” or “CMT” + or “DEL”. Format: HHMMSS (24 hr)' + startTime: + type: string + description: 'The start time of a delivery. Only returned when the type + is “EDW” or “CDW” or “IDW”. Format: HHMMSS (24 hr).' + type: + type: string + description: |- + The date of this delivery detail. + Valid values: + + EOD - End of Day + CMT - Commit Time + EDW - Estimated Delivery Window ** + CDW - Confirmed Delivery Window ** + IDW - Imminent Delivery Window ** + DEL - Delivered Time + Dimension: + title: Dimension + type: object + properties: + height: + type: string + description: 'Height of the package' + length: + type: string + description: 'Length of the package' + unitOfDimension: + type: string + description: 'The unit of the dimensions' + width: + type: string + description: 'Width of the package' + Error: + title: Error + type: object + properties: + code: + type: string + message: + type: string + InquireNumbers: + title: InquireNumbers + type: object + properties: + inquiryNumbers: + type: array + items: + type: string + description: Inquiry number + Location: + title: Location + type: object + properties: + address: + "$ref": "#/components/schemas/Address" + slic: + type: string + description: Site Location Indicator Code (SLIC) + example: '8566' + Milestones: + title: Milestones + type: object + description: The list of milestones associated with the package. Milestones + will be returned in chronological order, with the oldest first and most recent/future + milestones last. + properties: + category: + type: string + description: The milestone category. This will be present only when a milestone + is in a COMPLETE state. + code: + type: string + description: The milestone code. + current: + 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.' + description: + type: string + description: 'The milestone description. Note: this is not translated at + this time and is returned in US English.' + linkedActivity: + type: string + description: The 0-based index of the activity that triggered this milestone. + This will be returned only when a milestone is in a COMPLETE state. For + example the most recent activity on the response is index 0. + state: + type: string + description: 'The milestone state. Valid values: ''This milestone has already + occurred''/''This milestone has not yet been completed''.' + subMilestone: + "$ref": "#/components/schemas/SubMilestone" + Package: + title: Package + type: object + properties: + accessPointInformation: + "$ref": "#/components/schemas/AccessPointInformation" + activity: + type: array + items: + "$ref": "#/components/schemas/Activity" + additionalAttributes: + type: array + description: The list of additional attributes that may be associated with + the package. Presence of any element indicates the package has that attribute. + example: + - SENSOR_EVENT + items: + type: string + additionalServices: + type: array + description: The list of additional services that may be associated with + the package. Presence of any element indicates that the package has that + service. + example: + - ADULT_SIGNATURE_REQUIRED + - SIGNATURE_REQUIRED + - ADDITIONAL_HANDLING + - CARBON_NEUTRAL + - UPS_PREMIER_SILVER + - UPS_PREMIER_GOLD + - UPS_PREMIER_PLATINUM + items: + type: string + alternateTrackingNumber: + type: array + items: + "$ref": "#/components/schemas/AlternateTrackingNumber" + currentStatus: + "$ref": "#/components/schemas/Status" + deliveryDate: + type: array + items: + "$ref": "#/components/schemas/DeliveryDate" + deliveryInformation: + "$ref": "#/components/schemas/DeliveryInformation" + deliveryTime: + "$ref": "#/components/schemas/DeliveryTime" + dimension: + "$ref": "#/components/schemas/Dimension" + isSmartPackage: + type: boolean + description: 'Indicator of whether the package is a smart package' + milestones: + type: array + description: milestones + items: + "$ref": "#/components/schemas/Milestones" + packageAddress: + type: array + items: + "$ref": "#/components/schemas/PackageAddress" + packageCount: + type: integer + description: The total number of packages in the shipment. Note that this + number may be greater than the number of returned packages in the response. + In such cases subsequent calls are needed to get additional packages. + format: int32 + example: 2 + paymentInformation: + type: array + items: + "$ref": "#/components/schemas/PaymentInformation" + referenceNumber: + type: array + items: + "$ref": "#/components/schemas/ReferenceNumber" + service: + "$ref": "#/components/schemas/Service" + statusCode: + type: string + statusDescription: + type: string + description: 'The activity status description. Note: this field will be + translated based on the locale provided in the request.' + suppressionIndicators: + type: array + description: 'Contains values which signify that certain data should be + suppressed or hidden. Valid values: Tracking activity details should be + hidden. Note: this is mainly intended for use by UPS.com applications.' + example: DETAIL + items: + type: string + trackingNumber: + type: string + ucixStatus: + type: string + description: 'This indicator provides UCIX (UPS Customer Information Exchange) status + Valid values: ''O'' means open. ''C'' means closed.' + weight: + "$ref": "#/components/schemas/Weight" + PackageAddress: + title: PackageAddress + type: object + description: The container array that has all the addresses associated with + the package, such as the ship from (shipper), ship to (consignee), and delivery + addresses + properties: + address: + "$ref": "#/components/schemas/Address" + attentionName: + type: string + description: The specific name of an individual associated with the address + segment. + name: + type: string + description: Ship-to name. + example: Sears + type: + type: string + description: The type of address. + example: ORIGIN/DESTINATION + PaymentInformation: + title: PaymentInformation + type: object + description: The container array that has all the payment information associated + with the package, such as 'Collect on Delivery payment'. + properties: + amount: + type: string + description: 'The payment amount. This value will contain the amount in + dollars and cents, separated by a period (.) Example: ''1025.50''.9' + example: '243.5' + currency: + type: string + description: The payment currency code (see API codes for possible values). + example: EUR + id: + type: string + description: The payment internal ID. This may be used in other systems + to retrieve additional information on the payment. + example: 3S35571M1L381K5O0P316L0M1R2E6H14 + paid: + type: boolean + description: 'The indication for whether the payment is paid or not. Valid + values: ''true'' the payment is paid. ''false'' the payment is not paid.' + example: false + paymentMethod: + type: string + description: The applicable payment methods. + example: C0, C1, ... C9 + type: + type: string + description: The payment type. + example: ICOD/COD + ReferenceNumber: + title: ReferenceNumber + type: object + description: The list of reference numbers associated with the package. + properties: + number: + type: string + description: The reference number. + example: ShipRef123 + type: + type: string + description: The type of reference number. Specifies how the reference number + is associated with the package. + example: SHIPMENT + Response: + title: Response + type: object + properties: + response: + "$ref": "#/components/schemas/ErrorResponse" + ErrorResponse: + title: Response + type: object + properties: + errors: + type: array + items: + "$ref": "#/components/schemas/Error" + Service: + title: Service + type: object + description: The container which has the package service information. + properties: + code: + type: string + description: The service name code. + example: '518' + description: + type: string + description: The service name description. Note that this field will be + translated based on the locale provided in the request. + example: UPS Ground + levelCode: + type: string + description: levelCode + example: '011' + Shipment: + title: Shipment + type: object + properties: + inquiryNumber: + type: string + description: inquiryNumber + example: 1Z023E2X0214323462 + package: + type: array + items: + "$ref": "#/components/schemas/Package" + userRelation: + type: array + description: The relationship of the user to the package(s) in the shipment. + No value means that the user has no relationship to the package. Note + that this check is only done when the request contains the 'Username' + and package rights checking is performed. Valid values:
'MYC_HOME' + - My Choice for Home
'MYC_BUS_OUTBOUND' - My Choice for Business + Outbound
'MYC_BUS_INBOUND' - My Choice for Business Inbound
'SHIPPER' + - Shipper + example: MYCHOICE_HOME + items: + type: string + warnings: + type: array + items: + "$ref": "#/components/schemas/Warning" + Signature: + title: Signature + type: object + description: Container with all the signature information associated to the + package being delivered. + properties: + image: + type: string + description: 'The base64 encoded string representation of the signature + image. Note: This is considered sensitive data and may only be returned + for a user that has rights to the package.' + example: encoding Base64 + Status: + title: Status + type: object + description: The container which has the current package status + properties: + code: + type: string + description: The current status code. + example: SR + description: + type: string + description: The current status description. Note that this field will be + translated based on the locale provided in the request. + example: Your package was released by the customs agency. + simplifiedTextDescription: + type: string + description: The current status in simplified text. This is a supplementary + description providing additional information on the status of the package. + Note that this field will be translated based on the locale provided in + the request. + example: Delivered + statusCode: + type: string + description: The activity package detail status code see API Codes for possible + values. + example: '003' + type: + type: string + description: The activity status type. + example: X + SubMilestone: + title: SubMilestone + type: object + description: The sub-milestone container containing information on a child milestone. + Will be present only if a child milestone exists. + properties: + category: + type: string + description: The sub-milestone category. + TrackApiResponse: + title: TrackApiResponse + type: object + properties: + trackResponse: + "$ref": "#/components/schemas/TrackResponse" + TrackResponse: + title: TrackResponse + type: object + properties: + shipment: + type: array + items: + "$ref": "#/components/schemas/Shipment" + Warning: + title: Warning + type: object + properties: + code: + type: string + message: + type: string + Weight: + title: Weight + type: object + description: The weight container for the package. + properties: + unitOfMeasurement: + type: string + description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. + ''KGS'' - kilograms.' + weight: + type: string + description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. + ''KGS'' - kilograms.' diff --git a/TradeDirect.yaml b/TradeDirect.yaml index e0d45a0..eb4dca4 100644 --- a/TradeDirect.yaml +++ b/TradeDirect.yaml @@ -1,1455 +1,1455 @@ -openapi: 3.1.0 -info: - title: TradeDirect Shipments API v1 - version: "1.0" - description: |- - The TradeDirect Shipments API facilitates the management of external trade shipments within the TradeDirect system, providing robust endpoints for creating, managing, and finalizing international and domestic shipments. This includes deleting master, small package, and LTL shipments, as well as closing out master shipments to ensure seamless trade operations. - - # Key Benefits Value - - Streamlined External Trade Management: Simplify the process of creating and managing international and domestic shipments with a unified API. - - Secure Access: OAuth2 and JWT-based authentication ensure secure and reliable API usage for global trade operations. - - Flexible Shipment Handling: Provides the ability to delete small package and LTL shipments, ensuring efficient management of shipment records across borders. - - Comprehensive Shipment Closure: Enables closing out master shipments, ensuring proper finalization of shipment processes for external trade. - # Reference - - Errors - - -servers: - - url: "https://onlinetools.ups.com/api/ship/tradedirect/{version}" - variables: - version: - description: "Initial version for TradeDirect Shipment" - default: v1 - enum: - - v1 -paths: - /master-shipments/{usi-number}: - delete: - tags: - - TradeDirect - summary: Delete master shipment - description: "This API allows users to delete a master shipment identified by a unique shipment identifier (USI) and the shipper's account number. The master shipment and its associated child shipments will be permanently removed." - operationId: deleteMasterShipment - responses: - '204': - description: Master shipment deleted successfully - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - '400': - description: Missing or Invalid parameter - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - requiredFieldsMissing: - value: - "response": - "errors": - - "code": "400001" - "message": "Missing or Invalid parameter: {field name}" - '401': - description: Invalid Authentication Information - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "250002" - "message": "Invalid Authentication Information." - '404': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Resource not found: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '500': - description: Internal Server Error - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - InternalError: - value: - "response": - errors: - - code: "500000" - message: "We're sorry, the system is unavailable. Please try again later." - parameters: - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - - name: usi-number - in: path - required: true - description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. - schema: - type: string - example: "578299028T" - pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" - - name: shipper_account_number - in: query - required: true - description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. - schema: - type: string - description: The UPS account number of the shipper to be used to clouseout shipment. - example: "1234WW" - pattern: "^[A-Z0-9]{6}$" - - name: transId - in: header - required: true - schema: - type: string - example: XZ345445668 - description: An identifier unique to the request. - - name: transactionSrc - in: header - required: true - schema: - type: string - example: XOLT - description: Identifies the client/source application that is calling. - /master-shipments/{usi-number}/child-shipments/{tracking-number}: - delete: - tags: - - TradeDirect - summary: Delete small package shipment - description: "Deletes a small package child shipment identified by a unique shipment identifier (USI) representing the master shipment and the shipment's tracking number." - operationId: deleteChildShipment - responses: - '204': - description: child shipment deleted successfully - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - '400': - description: Missing or Invalid parameter - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - requiredFieldsMissing: - value: - "response": - "errors": - - "code": "400001" - "message": "Missing or Invalid parameter: {field name}" - '401': - description: Invalid Authentication Information - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "250002" - "message": "Invalid Authentication Information." - '404': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '500': - description: Internal Server Error - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - InternalError: - value: - "response": - errors: - - code: "500000" - message: "We're sorry, the system is unavailable. Please try again later." - parameters: - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - - name: usi-number - in: path - required: true - description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. - schema: - type: string - example: "578299028T" - pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" - - name: tracking-number - in: path - required: true - schema: - type: string - pattern: "^[A-Z0-9]{18}$" - description: "UPS Tracking Number" - example: "1Z1388YY0316063678" - - name: transId - in: header - required: true - schema: - type: string - example: XZ345445668 - - name: transactionSrc - in: header - required: true - schema: - type: string - description: Identifies the client/source application that is calling. - example: XOLT - /master-shipments/{usi-number}/closeout: - post: - tags: - - TradeDirect - operationId: closeoutMasterShipment - summary: Closeout a Master Shipment - description: Transitions a master shipment to a closed state, finalizing its processing. Identified by a unique shipment identifier (USI). - parameters: - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - - name: usi-number - in: path - required: true - description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. - schema: - type: string - example: 578299028T - pattern: ^(?:[0-9]{10}|[0-9]{9}T)$ - - name: transId - in: header - required: true - schema: - type: string - example: XZ345445668 - - name: transactionSrc - in: header - required: true - schema: - type: string - description: Identifies the client/source application that is calling. - example: XOLT - requestBody: - description: Request payload containing shipment details required to close out a master shipment. - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CloseoutRequest' - example: - shipment: - shipper: - accountNumber: 1234WW - packages: - - numberOfIdenticalUnits: 1 - handlingUnits: - type: BOXES - dimensions: - length: 48.0 - width: 40.0 - height: 36.0 - unitOfMeasurement: IN - packageWeight: - weight: 10.0 - unitOfMeasurement: LBS - freightClass: 150 - transportationService: - airService: 1 - groundService: 1 - responses: - '200': - description: Closeout performed on the provided master shipment successfully. - content: - application/json: - schema: - $ref: '#/components/schemas/CloseoutResponse' - example: - invoiceLabelResponse: - files: - - data: base64encodedstring - fileFormat: PDF - referenceId: INV123456 - bolLabelResponse: - files: - - data: baseencodedstring - fileFormat: PDF - referenceId: BOL123456 - palletLabelResponses: - files: - - opTyp: PDF - lblNmbr: PLT123456 - lblData: base64encodedstring - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - '207': - description: Closeout performed on the provided master that is partial success. - content: - application/json: - schema: - allOf: - - type: object - properties: - message: - type: string - description: A message providing additional information about the response. - example: "Closeout operation completed with warnings." - - $ref: '#/components/schemas/CloseoutResponse' - example: - message: "Movement has been closed successfully." - invoiceLabelResponse: - warning: "Use Document API to generate missing documents." - bolLabelResponse: - files: - - data: "base64encodedstring" - fileFormat: "PDF" - referenceId: "BOL123456" - palletLabelResponses: - files: - - opTyp: "PDF" - lblNmbr: "PLT123456" - lblData: "base64encodedstring" - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - '400': - description: Missing or Invalid parameter - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - requiredFieldsMissing: - value: - "response": - "errors": - - "code": "400001" - "message": "Missing or Invalid parameter: {field name}" - '401': - description: Invalid Authentication Information - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "250002" - "message": "Invalid Authentication Information." - '404': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '422': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '500': - description: Internal Server Error - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - InternalError: - value: - "response": - errors: - - code: "500000" - message: "We're sorry, the system is unavailable. Please try again later." - /master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}: - delete: - tags: - - TradeDirect - operationId: deleteLtlChildShipment - summary: Delete Less Than Truckload (LTL) child shipment - description: "Deletes a Less Than Truckload (LTL) child shipment identified by a unique shipment identifier (USI) and a sub pro number." - parameters: - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - - name: usi-number - in: path - description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. - required: true - schema: - type: string - example: "578299028T" - pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" - - name: sub-pro-number - in: path - description: A unique tracking number used for individual, smaller shipments within a larger Less-Than-Truckload (LTL) or Truckload (TL) freight shipment - required: true - schema: - type: string - example: "SBP12345" - - name: transId - in: header - required: true - schema: - type: string - example: XZ345445668 - - name: transactionSrc - in: header - required: true - schema: - type: string - description: Identifies the client/source application that is calling. - example: XOLT - responses: - '204': - description: LTL Child Shipment Deleted Successfully - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - '400': - description: Missing or Invalid parameter - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - requiredFieldsMissing: - value: - "response": - "errors": - - "code": "400001" - "message": "Missing or Invalid parameter: {field name}" - '401': - description: Invalid Authentication Information - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "250002" - "message": "Invalid Authentication Information." - '404': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '500': - description: Internal Server Error - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - InternalError: - value: - "response": - errors: - - code: "500000" - message: "We're sorry, the system is unavailable. Please try again later." - /master-shipments/documents: - post: - tags: - - TradeDirect - operationId: documentLabelPlayback - summary: Genereate Documents and Labels for LTL Shipments and Closeout - description: "Generates documents and labels for master/ltl shipments identified by a unique shipment identifier (USI)." - parameters: - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - - name: transId - in: header - required: true - schema: - type: string - example: XZ345445668 - - name: transactionSrc - in: header - required: true - schema: - type: string - description: Identifies the client/source application that is calling. - example: XOLT - requestBody: - description: Request payload containing shipment details required to generate documents - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentRequest' - responses: - '200': - description: Documents generated successfully for provided USI. See base64-data-samples document for data sample. - content: - application/json: - schema: - $ref: '#/components/schemas/DocumentResponse' - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - '400': - description: Missing or Invalid parameter - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - requiredFieldsMissing: - value: - "response": - "errors": - - code: Application Error Code - message: Malformed JSON request - - code: Application Error Code - message: Missing {Filed Name} - '401': - description: Invalid Authentication Information - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - "response": - "errors": - - "code": "250002" - "message": "Invalid Authentication Information." - '404': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Resource not found: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '422': - description: Resource not found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Resource not found: - value: - "response": - "errors": - - "code": "404" - "message": "The requested resource was not found" - '500': - description: Internal Server Error - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - InternalError: - value: - "response": - errors: - - code: "500000" - message: "We're sorry, the system is unavailable. Please try again later." -components: - headers: - BkndTransId: - description: The backend transaction id. - schema: - type: string - example: 383f7d397a48 - transId: - description: An identifier unique to the request. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]{3,36}$ - minLength: 3 - maxLength: 36 - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - description: Identifies the client/source application that is calling. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]{1,36}$ - minLength: 1 - maxLength: 36 - example: UPS.com - Content-Type: - description: The Content-Type header provides the client with the actual content/media type of the returned content. - schema: - type: string - example: application/json - APIErrorCode: - description: The API error code. - schema: - type: string - example: UJ0001 - APIErrorMsg: - description: The API error message. - schema: - type: string - example: Invalid token or token is not present. - schemas: - CloseoutRequest: - type: object - required: - - shipment - properties: - shipment: - type: object - description: Contains all the details of the shipment. - required: - - shipper - properties: - shipper: - type: object - description: Contains the account number to be used in closeout request. - required: - - accountNumber - properties: - accountNumber: - type: string - description: The UPS account number of the shipper to be used to clouseout shipment. - example: "1234WW" - pattern: "^[A-Z0-9]{6}$" - packages: - type: array - description: The list of packages in the shipment. - items: - $ref: "#/components/schemas/Package" - minItems: 0 - maxItems: 200 - CloseoutResponse: - type: object - required: - - invoiceLabelResponse - - bolLabelResponse - - palletLabelResponses - properties: - invoiceLabelResponse: - description: Contains the response details for the generated invoice label, including the format and data of the generated document. - allOf: - - $ref: '#/components/schemas/DocGenerationResponse' - bolLabelResponse: - description: Contains the response details for the generated Bill of Lading (BOL) label, including the format and data of the generated document. - allOf: - - $ref: '#/components/schemas/DocGenerationResponse' - palletLabelResponses: - description: A list of responses for the generated pallet labels, each containing details such as the label number and the base64 encoded data. - allOf: - - $ref: '#/components/schemas/LabelResponse' - DocGenerationResponse: - description: Contains the details of the generated document files, such as the invoices, bill of lading and pallet labels. - type: object - properties: - warning: - $ref: '#/components/schemas/WarningMessage' - files: - type: array - description: A list of generated document files. - items: - $ref: '#/components/schemas/DocGenerationFile' - additionalProperties: false - oneOf: - - required: [warning] - - required: [files] - DocGenerationFile: - type: object - required: - - data - - fileFormat - - referenceId - description: Contains the details of a generated document file. - properties: - data: - type: string - description: The base64 encoded data of the generated document. - example: "ZWF0aW9uRG...4KZW5" - fileFormat: - type: string - description: The format of the generated document file. - example: "PDF" - referenceId: - type: string - description: The unique reference identifier for the generated document. - example: "DOC123456" - additionalProperties: false - Package: - type: object - required: - - numberOfIdenticalUnits - - handlingUnits - properties: - numberOfIdenticalUnits: - type: integer - example: 1 - description: Number of identical units in the package/ltl. - minimum: 1 - maximum: 200 - handlingUnits: - $ref: "#/components/schemas/HandlingUnits" - HandlingUnits: - type: object - description: Used to provide information about the handling units in the package/ltl. - required: - - type - - dimensions - - packageWeight - - freightClass - - transportationService - properties: - type: - type: string - example: "BOXES" - description: The type of handling unit, such as boxes, crates, or pallets, used to describe how the shipment is packaged and handled. - enum: - - BAGS - - BOXES - - CARTONS - - CRATES - - DRUMS - - PALLET_SKIDS - - ROLLS - - TUBES - dimensions: - $ref: "#/components/schemas/Dimensions" - packageWeight: - $ref: "#/components/schemas/PackageWeight" - freightClass: - type: number - example: 150 - description: | - Freight class of the handling unit. - | Code | Description | - | :--: | :--------------------------------------------------------------------------------------: | - | 50 | over 50 lbs - Fits on standard shrink-wrapped 4X4 pallet, very durable | - | 55 | 35-50 pounds - Bricks, cement, mortar, hardwood flooring | - | 60 | 30-35 pounds - Car accessories & car parts | - | 65 | 22.5-30 pounds - Car accessories & car parts, bottled beverages, books in boxes | - | 70 | 15 to 22.5 pounds - Car accessories & car parts, food items, automobile engines | - | 77.5 | 13.5 to 15 pounds - Tires, bathroom fixtures | - | 85 | 12-13.5 pounds - Crated machinery, cast iron stoves | - | 92.5 | 10.5-12 pounds - Computers, monitors, refrigerators | - | 100 | 9-10.5 pounds - Boat covers, car covers, canvas, wine cases, caskets | - | 110 | 8-9 pounds - Cabinets, framed artwork, table saw | - | 125 | 7-8 pounds - Small Household appliances | - | 150 | 6-7 pounds - Auto sheet metal parts, bookcases | - | 175 | 5-6 pounds - Clothing, couches stuffed furniture | - | 200 | 4-5 pounds - Auto sheet metal parts, aircraft parts, aluminum table, packaged mattresses | - | 250 | 3-4 pounds - Bamboo furniture, mattress and box spring, plasma TV | - | 300 | 2-3 pounds - Wood cabinets, tables, chairs setup, model boats | - | 400 | 1-2 pounds - Deer antlers | - | 500 | Less than 1 lbs - Bags of gold dust, ping pong balls | - enum: - - 50 # over 50 lbs - Fits on standard shrink-wrapped 4X4 pallet, very durable - - 55 # 35-50 pounds - Bricks, cement, mortar, hardwood flooring - - 60 # 30-35 pounds - Car accessories & car parts - - 65 # 22.5-30 pounds - Car accessories & car parts, bottled beverages, books in boxes - - 70 # 15 to 22.5 pounds - Car accessories & car parts, food items, automobile engines - - 77.5 # 13.5 to 15 pounds - Tires, bathroom fixtures - - 85 # 12-13.5 pounds - Crated machinery, cast iron stoves - - 92.5 # 10.5-12 pounds - Computers, monitors, refrigerators - - 100 # 9-10.5 pounds - Boat covers, car covers, canvas, wine cases, caskets - - 110 # 8-9 pounds - Cabinets, framed artwork, table saw - - 125 # 7-8 pounds - Small Household appliances - - 150 # 6-7 pounds - Auto sheet metal parts, bookcases - - 175 # 5-6 pounds - Clothing, couches stuffed furniture - - 200 # 4-5 pounds - Auto sheet metal parts, aircraft parts, aluminum table, packaged mattresses - - 250 # 3-4 pounds - Bamboo furniture, mattress and box spring, plasma TV - - 300 # 2-3 pounds - Wood cabinets, tables, chairs setup, model boats - - 400 # 1-2 pounds - Deer antlers - - 500 # Less than 1 lbs - Bags of gold dust, ping pong balls - transportationService: - type: object - description: Specifies the transportation service options for the handling unit, including the number of packages for air and ground services. - required: - - airService - - groundService - properties: - airService: - type: integer - example: 1 - description: Number of packages for air service. If groundService is 0, this must be at least 1. - minimum: 0 - maximum: 999 - groundService: - type: integer - example: 1 - description: Number of packages for ground service. If airService is 0, this must be at least 1. - minimum: 0 - maximum: 999 - PackageWeight: - type: object - required: - - weight - - unitOfMeasurement - description: Weight for the handling unit. - properties: - weight: - type: number - example: 10.0 - description: Weight of the package/ltl. - minimum: 0.01 - maximum: 5000.00 - unitOfMeasurement: - type: string - description: | - Unit of measurement of the weight. - | Code | Description | - | :--: | :-- | - | KGS | Kilograms | - | LBS | Pounds | - enum: - - KGS # Kilograms - - LBS # Pounds - example: KGS - Dimensions: - type: object - description: Dimensions for the handling unit. - required: - - length - - width - - height - - unitOfMeasurement - properties: - length: - type: number - example: 48.0 - description: Length of the package/ltl. - minimum: 1.00 - maximum: 99.99 - width: - type: number - example: 40.0 - description: Width of the package/ltl. - minimum: 1.00 - maximum: 99.99 - height: - type: number - example: 36.0 - description: Height of the package/ltl. - minimum: 1.00 - maximum: 99.99 - unitOfMeasurement: - type: string - description: | - The code associated with unit of measurement. The requested code must be valid for the shipper country or territory. - | Code | Description | - | :--: | :-- | - | IN | Inches | - | CM | Centimeters | - example: IN - enum: - - IN # Inches - - CM # Centimeters - LabelResponse: - type: object - description: Contains either a warning message or the label response files. - properties: - warning: - $ref: '#/components/schemas/WarningMessage' - files: - type: array - description: A list of generated Label files. - items: - $ref: '#/components/schemas/LabelDetails' - oneOf: - - required: [warning] - - required: [files] - LabelDetails: - type: object - required: - - opTyp - - lblNmbr - - lblData - description: Contains the response details for a label generation request. - properties: - opTyp: - type: string - description: | - Image format type for the label requested by customer. - | Code | Description | - | :----: | :-----------: | - | ZPL | ZPL format | - | EPL | EPL format | - | STARPL | STARPL format | - | SPL | SPL format | - | PNG | PNG format | - | PDF | PDF format | - | GIF | GIF format | - enum: - - ZPL # ZPL format - - EPL # EPL format - - STARPL # STARPL format - - SPL # SPL format - - PNG # PNG format - - PDF # PDF format - - GIF # GIF format - example: PDF - lblNmbr: - type: string - description: The unique label number assigned to the generated label. - example: "PLT123456" - pattern: "^[A-Z0-9]+$" - lblData: - type: string - description: The base64 encoded data of the generated label. - example: "ZWF0aW9uRG...4KZW5" - DocumentRequest: - type: object - description: Request payload containing shipment details required to generate documents - required: - - requestedDoc - - docFormat - - usiNumber - - shipperAccountNumber - properties: - requestedDoc: - type: string - description: | - The type of document requested for generation. - | Code | Description | - | :----: | :-----------------------------: | - | CCI | Consolidated Commercial Invoice | - | CBOL | Consolidated Bill of Lading | - | BOL | Bill of Lading | - | PLT | Pallet Label | - | PKGPLT | Package Pallet Label | - enum: - - CCI # Consolidated Commercial Invoice - - CBOL # Consolidated Bill of Lading - - BOL # Bill of Lading - - PLT # Pallet Label - - PKGPLT # Package Pallet Label - example: BOL - docFormat: - type: string - description: | - Image format type for the label requested by customer. - | Code | Description | - | :----: | :-----------: | - | ZPL | ZPL format | - | EPL | EPL format | - | STARPL | STARPL format | - | SPL | SPL format | - | PNG | PNG format | - | PDF | PDF format | - | GIF | GIF format | - enum: - - ZPL # ZPL format - - EPL # EPL format - - STARPL # STARPL format - - SPL # SPL format - - PNG # PNG format - - PDF # PDF format - - GIF # GIF format - example: PDF - usiNumber: - type: string - description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. - example: "578299028T" - pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" - shipperAccountNumber: - type: string - description: The UPS account number of the shipper that was used in clouseout shipment. - example: "1234WW" - pattern: "^[A-Z0-9]{6}$" - subproNumber: - type: string - description: A unique tracking number used for LTL shipments. - example: "NYJ4X51A034G4JB6NX0C" - pattern: "^[A-Z0-9]{15,20}$" - example: - requestedDoc: BOL - docFormat: PDF - usiNumber: 578299028T - shipperAccountNumber: 1234WW - DocumentResponse: - type: object - description: Response payload containing the generated documents - properties: - documents: - type: object - description: Contains the generated documents - properties: - cci: - type: string - description: Contains the generated Consolidated Commercial Invoice (CCI) document. Document will be PDF format and base64 encoded. See base64-data-samples document for sample. - example: "ZWF0aW9uRG...4KZW5" - cbol: - type: string - description: Contains the generated Consolidated Bill of Lading (CBOL) document. Document will be PDF format and base64 encoded. See base64-data-samples document for sample. - example: "ZWF0aW9uRG...4KZW5" - bol: - type: string - description: Contains the generated Bill of Lading (BOL) document. Document will be PDF format and base64 encoded. See base64-data-samples document for sample. - example: "ZWF0aW9uRG...4KZW5" - plt: - type: array - description: Contains the generated Pallet Label (PLT) documents. Labels will contain format requested by client and be base64 encoded. See base64-data-samples document for sample. - items: - type: string - example: [ZWF0aW9uRG...4KZW5, ZWF0aW9uRG...4KZW5] - pkgplt: - type: array - description: Contains the generated Packge Pallet Labels (PKGPLT) documents. Labels will contain format requested by client and be base64 encoded. See base64-data-samples document for sample. - items: - type: string - example: [ZWF0aW9uRG...4KZW5, ZWF0aW9uRG...4KZW5] - oneOf: - - required: [cci] - - required: [cbol] - - required: [bol] - - required: [plt] - - required: [pgkplt] - example: - documents: - cci: "3MtNcTKd2VKWu0...br62U" - WarningMessage: - type: string - description: A warning message that may be returned if the document is not generated successfully. - example: "Use Document API to generate missing documents." - ErrorResponse: - type: object - description: response container - required: - - response - properties: - response: - type: object - description: errors container - required: - - errors - properties: - errors: - type: array - description: error payload - array containing one or more Errors - items: - $ref: '#/components/schemas/Error' - Error: - type: object - description: The error entity that contains the code and description of an error. - required: - - code - - message - properties: - code: - type: string - description: The error code. - example: "00400" - message: - type: string - description: The error message. - example: "Bad ChildRequest" - securitySchemes: - oauth2: - type: "oauth2" - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token - scopes: { } -security: - - oauth2: [] \ No newline at end of file +openapi: 3.1.0 +info: + title: TradeDirect Shipments API v1 + version: "1.0" + description: |- + The TradeDirect Shipments API facilitates the management of external trade shipments within the TradeDirect system, providing robust endpoints for creating, managing, and finalizing international and domestic shipments. This includes deleting master, small package, and LTL shipments, as well as closing out master shipments to ensure seamless trade operations. + + # Key Benefits Value + - Streamlined External Trade Management: Simplify the process of creating and managing international and domestic shipments with a unified API. + - Secure Access: OAuth2 and JWT-based authentication ensure secure and reliable API usage for global trade operations. + - Flexible Shipment Handling: Provides the ability to delete small package and LTL shipments, ensuring efficient management of shipment records across borders. + - Comprehensive Shipment Closure: Enables closing out master shipments, ensuring proper finalization of shipment processes for external trade. + # Reference + - Errors + + +servers: + - url: "https://onlinetools.ups.com/api/ship/tradedirect/{version}" + variables: + version: + description: "Initial version for TradeDirect Shipment" + default: v1 + enum: + - v1 +paths: + /master-shipments/{usi-number}: + delete: + tags: + - TradeDirect + summary: Delete master shipment + description: "This API allows users to delete a master shipment identified by a unique shipment identifier (USI) and the shipper's account number. The master shipment and its associated child shipments will be permanently removed." + operationId: deleteMasterShipment + responses: + '204': + description: Master shipment deleted successfully + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + '400': + description: Missing or Invalid parameter + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + requiredFieldsMissing: + value: + "response": + "errors": + - "code": "400001" + "message": "Missing or Invalid parameter: {field name}" + '401': + description: Invalid Authentication Information + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "250002" + "message": "Invalid Authentication Information." + '404': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Resource not found: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '500': + description: Internal Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + InternalError: + value: + "response": + errors: + - code: "500000" + message: "We're sorry, the system is unavailable. Please try again later." + parameters: + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + - name: usi-number + in: path + required: true + description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. + schema: + type: string + example: "578299028T" + pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" + - name: shipper_account_number + in: query + required: true + description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. + schema: + type: string + description: The UPS account number of the shipper to be used to clouseout shipment. + example: "1234WW" + pattern: "^[A-Z0-9]{6}$" + - name: transId + in: header + required: true + schema: + type: string + example: XZ345445668 + description: An identifier unique to the request. + - name: transactionSrc + in: header + required: true + schema: + type: string + example: XOLT + description: Identifies the client/source application that is calling. + /master-shipments/{usi-number}/child-shipments/{tracking-number}: + delete: + tags: + - TradeDirect + summary: Delete small package shipment + description: "Deletes a small package child shipment identified by a unique shipment identifier (USI) representing the master shipment and the shipment's tracking number." + operationId: deleteChildShipment + responses: + '204': + description: child shipment deleted successfully + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + '400': + description: Missing or Invalid parameter + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + requiredFieldsMissing: + value: + "response": + "errors": + - "code": "400001" + "message": "Missing or Invalid parameter: {field name}" + '401': + description: Invalid Authentication Information + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "250002" + "message": "Invalid Authentication Information." + '404': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '500': + description: Internal Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + InternalError: + value: + "response": + errors: + - code: "500000" + message: "We're sorry, the system is unavailable. Please try again later." + parameters: + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + - name: usi-number + in: path + required: true + description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. + schema: + type: string + example: "578299028T" + pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" + - name: tracking-number + in: path + required: true + schema: + type: string + pattern: "^[A-Z0-9]{18}$" + description: "UPS Tracking Number" + example: "1Z1388YY0316063678" + - name: transId + in: header + required: true + schema: + type: string + example: XZ345445668 + - name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the client/source application that is calling. + example: XOLT + /master-shipments/{usi-number}/closeout: + post: + tags: + - TradeDirect + operationId: closeoutMasterShipment + summary: Closeout a Master Shipment + description: Transitions a master shipment to a closed state, finalizing its processing. Identified by a unique shipment identifier (USI). + parameters: + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + - name: usi-number + in: path + required: true + description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. + schema: + type: string + example: 578299028T + pattern: ^(?:[0-9]{10}|[0-9]{9}T)$ + - name: transId + in: header + required: true + schema: + type: string + example: XZ345445668 + - name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the client/source application that is calling. + example: XOLT + requestBody: + description: Request payload containing shipment details required to close out a master shipment. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CloseoutRequest' + example: + shipment: + shipper: + accountNumber: 1234WW + packages: + - numberOfIdenticalUnits: 1 + handlingUnits: + type: BOXES + dimensions: + length: 48.0 + width: 40.0 + height: 36.0 + unitOfMeasurement: IN + packageWeight: + weight: 10.0 + unitOfMeasurement: LBS + freightClass: 150 + transportationService: + airService: 1 + groundService: 1 + responses: + '200': + description: Closeout performed on the provided master shipment successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/CloseoutResponse' + example: + invoiceLabelResponse: + files: + - data: base64encodedstring + fileFormat: PDF + referenceId: INV123456 + bolLabelResponse: + files: + - data: baseencodedstring + fileFormat: PDF + referenceId: BOL123456 + palletLabelResponses: + files: + - opTyp: PDF + lblNmbr: PLT123456 + lblData: base64encodedstring + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + '207': + description: Closeout performed on the provided master that is partial success. + content: + application/json: + schema: + allOf: + - type: object + properties: + message: + type: string + description: A message providing additional information about the response. + example: "Closeout operation completed with warnings." + - $ref: '#/components/schemas/CloseoutResponse' + example: + message: "Movement has been closed successfully." + invoiceLabelResponse: + warning: "Use Document API to generate missing documents." + bolLabelResponse: + files: + - data: "base64encodedstring" + fileFormat: "PDF" + referenceId: "BOL123456" + palletLabelResponses: + files: + - opTyp: "PDF" + lblNmbr: "PLT123456" + lblData: "base64encodedstring" + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + '400': + description: Missing or Invalid parameter + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + requiredFieldsMissing: + value: + "response": + "errors": + - "code": "400001" + "message": "Missing or Invalid parameter: {field name}" + '401': + description: Invalid Authentication Information + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "250002" + "message": "Invalid Authentication Information." + '404': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '422': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '500': + description: Internal Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + InternalError: + value: + "response": + errors: + - code: "500000" + message: "We're sorry, the system is unavailable. Please try again later." + /master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}: + delete: + tags: + - TradeDirect + operationId: deleteLtlChildShipment + summary: Delete Less Than Truckload (LTL) child shipment + description: "Deletes a Less Than Truckload (LTL) child shipment identified by a unique shipment identifier (USI) and a sub pro number." + parameters: + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + - name: usi-number + in: path + description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. + required: true + schema: + type: string + example: "578299028T" + pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" + - name: sub-pro-number + in: path + description: A unique tracking number used for individual, smaller shipments within a larger Less-Than-Truckload (LTL) or Truckload (TL) freight shipment + required: true + schema: + type: string + example: "SBP12345" + - name: transId + in: header + required: true + schema: + type: string + example: XZ345445668 + - name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the client/source application that is calling. + example: XOLT + responses: + '204': + description: LTL Child Shipment Deleted Successfully + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + '400': + description: Missing or Invalid parameter + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + requiredFieldsMissing: + value: + "response": + "errors": + - "code": "400001" + "message": "Missing or Invalid parameter: {field name}" + '401': + description: Invalid Authentication Information + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "250002" + "message": "Invalid Authentication Information." + '404': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '500': + description: Internal Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + InternalError: + value: + "response": + errors: + - code: "500000" + message: "We're sorry, the system is unavailable. Please try again later." + /master-shipments/documents: + post: + tags: + - TradeDirect + operationId: documentLabelPlayback + summary: Genereate Documents and Labels for LTL Shipments and Closeout + description: "Generates documents and labels for master/ltl shipments identified by a unique shipment identifier (USI)." + parameters: + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + - name: transId + in: header + required: true + schema: + type: string + example: XZ345445668 + - name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the client/source application that is calling. + example: XOLT + requestBody: + description: Request payload containing shipment details required to generate documents + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentRequest' + responses: + '200': + description: Documents generated successfully for provided USI. See base64-data-samples document for data sample. + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentResponse' + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + '400': + description: Missing or Invalid parameter + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + requiredFieldsMissing: + value: + "response": + "errors": + - code: Application Error Code + message: Malformed JSON request + - code: Application Error Code + message: Missing {Filed Name} + '401': + description: Invalid Authentication Information + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + "response": + "errors": + - "code": "250002" + "message": "Invalid Authentication Information." + '404': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Resource not found: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '422': + description: Resource not found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Resource not found: + value: + "response": + "errors": + - "code": "404" + "message": "The requested resource was not found" + '500': + description: Internal Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + InternalError: + value: + "response": + errors: + - code: "500000" + message: "We're sorry, the system is unavailable. Please try again later." +components: + headers: + BkndTransId: + description: The backend transaction id. + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]{3,36}$ + minLength: 3 + maxLength: 36 + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]{1,36}$ + minLength: 1 + maxLength: 36 + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + schema: + type: string + example: Invalid token or token is not present. + schemas: + CloseoutRequest: + type: object + required: + - shipment + properties: + shipment: + type: object + description: Contains all the details of the shipment. + required: + - shipper + properties: + shipper: + type: object + description: Contains the account number to be used in closeout request. + required: + - accountNumber + properties: + accountNumber: + type: string + description: The UPS account number of the shipper to be used to clouseout shipment. + example: "1234WW" + pattern: "^[A-Z0-9]{6}$" + packages: + type: array + description: The list of packages in the shipment. + items: + $ref: "#/components/schemas/Package" + minItems: 0 + maxItems: 200 + CloseoutResponse: + type: object + required: + - invoiceLabelResponse + - bolLabelResponse + - palletLabelResponses + properties: + invoiceLabelResponse: + description: Contains the response details for the generated invoice label, including the format and data of the generated document. + allOf: + - $ref: '#/components/schemas/DocGenerationResponse' + bolLabelResponse: + description: Contains the response details for the generated Bill of Lading (BOL) label, including the format and data of the generated document. + allOf: + - $ref: '#/components/schemas/DocGenerationResponse' + palletLabelResponses: + description: A list of responses for the generated pallet labels, each containing details such as the label number and the base64 encoded data. + allOf: + - $ref: '#/components/schemas/LabelResponse' + DocGenerationResponse: + description: Contains the details of the generated document files, such as the invoices, bill of lading and pallet labels. + type: object + properties: + warning: + $ref: '#/components/schemas/WarningMessage' + files: + type: array + description: A list of generated document files. + items: + $ref: '#/components/schemas/DocGenerationFile' + additionalProperties: false + oneOf: + - required: [warning] + - required: [files] + DocGenerationFile: + type: object + required: + - data + - fileFormat + - referenceId + description: Contains the details of a generated document file. + properties: + data: + type: string + description: The base64 encoded data of the generated document. + example: "ZWF0aW9uRG...4KZW5" + fileFormat: + type: string + description: The format of the generated document file. + example: "PDF" + referenceId: + type: string + description: The unique reference identifier for the generated document. + example: "DOC123456" + additionalProperties: false + Package: + type: object + required: + - numberOfIdenticalUnits + - handlingUnits + properties: + numberOfIdenticalUnits: + type: integer + example: 1 + description: Number of identical units in the package/ltl. + minimum: 1 + maximum: 200 + handlingUnits: + $ref: "#/components/schemas/HandlingUnits" + HandlingUnits: + type: object + description: Used to provide information about the handling units in the package/ltl. + required: + - type + - dimensions + - packageWeight + - freightClass + - transportationService + properties: + type: + type: string + example: "BOXES" + description: The type of handling unit, such as boxes, crates, or pallets, used to describe how the shipment is packaged and handled. + enum: + - BAGS + - BOXES + - CARTONS + - CRATES + - DRUMS + - PALLET_SKIDS + - ROLLS + - TUBES + dimensions: + $ref: "#/components/schemas/Dimensions" + packageWeight: + $ref: "#/components/schemas/PackageWeight" + freightClass: + type: number + example: 150 + description: | + Freight class of the handling unit. + | Code | Description | + | :--: | :--------------------------------------------------------------------------------------: | + | 50 | over 50 lbs - Fits on standard shrink-wrapped 4X4 pallet, very durable | + | 55 | 35-50 pounds - Bricks, cement, mortar, hardwood flooring | + | 60 | 30-35 pounds - Car accessories & car parts | + | 65 | 22.5-30 pounds - Car accessories & car parts, bottled beverages, books in boxes | + | 70 | 15 to 22.5 pounds - Car accessories & car parts, food items, automobile engines | + | 77.5 | 13.5 to 15 pounds - Tires, bathroom fixtures | + | 85 | 12-13.5 pounds - Crated machinery, cast iron stoves | + | 92.5 | 10.5-12 pounds - Computers, monitors, refrigerators | + | 100 | 9-10.5 pounds - Boat covers, car covers, canvas, wine cases, caskets | + | 110 | 8-9 pounds - Cabinets, framed artwork, table saw | + | 125 | 7-8 pounds - Small Household appliances | + | 150 | 6-7 pounds - Auto sheet metal parts, bookcases | + | 175 | 5-6 pounds - Clothing, couches stuffed furniture | + | 200 | 4-5 pounds - Auto sheet metal parts, aircraft parts, aluminum table, packaged mattresses | + | 250 | 3-4 pounds - Bamboo furniture, mattress and box spring, plasma TV | + | 300 | 2-3 pounds - Wood cabinets, tables, chairs setup, model boats | + | 400 | 1-2 pounds - Deer antlers | + | 500 | Less than 1 lbs - Bags of gold dust, ping pong balls | + enum: + - 50 # over 50 lbs - Fits on standard shrink-wrapped 4X4 pallet, very durable + - 55 # 35-50 pounds - Bricks, cement, mortar, hardwood flooring + - 60 # 30-35 pounds - Car accessories & car parts + - 65 # 22.5-30 pounds - Car accessories & car parts, bottled beverages, books in boxes + - 70 # 15 to 22.5 pounds - Car accessories & car parts, food items, automobile engines + - 77.5 # 13.5 to 15 pounds - Tires, bathroom fixtures + - 85 # 12-13.5 pounds - Crated machinery, cast iron stoves + - 92.5 # 10.5-12 pounds - Computers, monitors, refrigerators + - 100 # 9-10.5 pounds - Boat covers, car covers, canvas, wine cases, caskets + - 110 # 8-9 pounds - Cabinets, framed artwork, table saw + - 125 # 7-8 pounds - Small Household appliances + - 150 # 6-7 pounds - Auto sheet metal parts, bookcases + - 175 # 5-6 pounds - Clothing, couches stuffed furniture + - 200 # 4-5 pounds - Auto sheet metal parts, aircraft parts, aluminum table, packaged mattresses + - 250 # 3-4 pounds - Bamboo furniture, mattress and box spring, plasma TV + - 300 # 2-3 pounds - Wood cabinets, tables, chairs setup, model boats + - 400 # 1-2 pounds - Deer antlers + - 500 # Less than 1 lbs - Bags of gold dust, ping pong balls + transportationService: + type: object + description: Specifies the transportation service options for the handling unit, including the number of packages for air and ground services. + required: + - airService + - groundService + properties: + airService: + type: integer + example: 1 + description: Number of packages for air service. If groundService is 0, this must be at least 1. + minimum: 0 + maximum: 999 + groundService: + type: integer + example: 1 + description: Number of packages for ground service. If airService is 0, this must be at least 1. + minimum: 0 + maximum: 999 + PackageWeight: + type: object + required: + - weight + - unitOfMeasurement + description: Weight for the handling unit. + properties: + weight: + type: number + example: 10.0 + description: Weight of the package/ltl. + minimum: 0.01 + maximum: 5000.00 + unitOfMeasurement: + type: string + description: | + Unit of measurement of the weight. + | Code | Description | + | :--: | :-- | + | KGS | Kilograms | + | LBS | Pounds | + enum: + - KGS # Kilograms + - LBS # Pounds + example: KGS + Dimensions: + type: object + description: Dimensions for the handling unit. + required: + - length + - width + - height + - unitOfMeasurement + properties: + length: + type: number + example: 48.0 + description: Length of the package/ltl. + minimum: 1.00 + maximum: 99.99 + width: + type: number + example: 40.0 + description: Width of the package/ltl. + minimum: 1.00 + maximum: 99.99 + height: + type: number + example: 36.0 + description: Height of the package/ltl. + minimum: 1.00 + maximum: 99.99 + unitOfMeasurement: + type: string + description: | + The code associated with unit of measurement. The requested code must be valid for the shipper country or territory. + | Code | Description | + | :--: | :-- | + | IN | Inches | + | CM | Centimeters | + example: IN + enum: + - IN # Inches + - CM # Centimeters + LabelResponse: + type: object + description: Contains either a warning message or the label response files. + properties: + warning: + $ref: '#/components/schemas/WarningMessage' + files: + type: array + description: A list of generated Label files. + items: + $ref: '#/components/schemas/LabelDetails' + oneOf: + - required: [warning] + - required: [files] + LabelDetails: + type: object + required: + - opTyp + - lblNmbr + - lblData + description: Contains the response details for a label generation request. + properties: + opTyp: + type: string + description: | + Image format type for the label requested by customer. + | Code | Description | + | :----: | :-----------: | + | ZPL | ZPL format | + | EPL | EPL format | + | STARPL | STARPL format | + | SPL | SPL format | + | PNG | PNG format | + | PDF | PDF format | + | GIF | GIF format | + enum: + - ZPL # ZPL format + - EPL # EPL format + - STARPL # STARPL format + - SPL # SPL format + - PNG # PNG format + - PDF # PDF format + - GIF # GIF format + example: PDF + lblNmbr: + type: string + description: The unique label number assigned to the generated label. + example: "PLT123456" + pattern: "^[A-Z0-9]+$" + lblData: + type: string + description: The base64 encoded data of the generated label. + example: "ZWF0aW9uRG...4KZW5" + DocumentRequest: + type: object + description: Request payload containing shipment details required to generate documents + required: + - requestedDoc + - docFormat + - usiNumber + - shipperAccountNumber + properties: + requestedDoc: + type: string + description: | + The type of document requested for generation. + | Code | Description | + | :----: | :-----------------------------: | + | CCI | Consolidated Commercial Invoice | + | CBOL | Consolidated Bill of Lading | + | BOL | Bill of Lading | + | PLT | Pallet Label | + | PKGPLT | Package Pallet Label | + enum: + - CCI # Consolidated Commercial Invoice + - CBOL # Consolidated Bill of Lading + - BOL # Bill of Lading + - PLT # Pallet Label + - PKGPLT # Package Pallet Label + example: BOL + docFormat: + type: string + description: | + Image format type for the label requested by customer. + | Code | Description | + | :----: | :-----------: | + | ZPL | ZPL format | + | EPL | EPL format | + | STARPL | STARPL format | + | SPL | SPL format | + | PNG | PNG format | + | PDF | PDF format | + | GIF | GIF format | + enum: + - ZPL # ZPL format + - EPL # EPL format + - STARPL # STARPL format + - SPL # SPL format + - PNG # PNG format + - PDF # PDF format + - GIF # GIF format + example: PDF + usiNumber: + type: string + description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments. + example: "578299028T" + pattern: "^(?:[0-9]{10}|[0-9]{9}T)$" + shipperAccountNumber: + type: string + description: The UPS account number of the shipper that was used in clouseout shipment. + example: "1234WW" + pattern: "^[A-Z0-9]{6}$" + subproNumber: + type: string + description: A unique tracking number used for LTL shipments. + example: "NYJ4X51A034G4JB6NX0C" + pattern: "^[A-Z0-9]{15,20}$" + example: + requestedDoc: BOL + docFormat: PDF + usiNumber: 578299028T + shipperAccountNumber: 1234WW + DocumentResponse: + type: object + description: Response payload containing the generated documents + properties: + documents: + type: object + description: Contains the generated documents + properties: + cci: + type: string + description: Contains the generated Consolidated Commercial Invoice (CCI) document. Document will be PDF format and base64 encoded. See base64-data-samples document for sample. + example: "ZWF0aW9uRG...4KZW5" + cbol: + type: string + description: Contains the generated Consolidated Bill of Lading (CBOL) document. Document will be PDF format and base64 encoded. See base64-data-samples document for sample. + example: "ZWF0aW9uRG...4KZW5" + bol: + type: string + description: Contains the generated Bill of Lading (BOL) document. Document will be PDF format and base64 encoded. See base64-data-samples document for sample. + example: "ZWF0aW9uRG...4KZW5" + plt: + type: array + description: Contains the generated Pallet Label (PLT) documents. Labels will contain format requested by client and be base64 encoded. See base64-data-samples document for sample. + items: + type: string + example: [ZWF0aW9uRG...4KZW5, ZWF0aW9uRG...4KZW5] + pkgplt: + type: array + description: Contains the generated Packge Pallet Labels (PKGPLT) documents. Labels will contain format requested by client and be base64 encoded. See base64-data-samples document for sample. + items: + type: string + example: [ZWF0aW9uRG...4KZW5, ZWF0aW9uRG...4KZW5] + oneOf: + - required: [cci] + - required: [cbol] + - required: [bol] + - required: [plt] + - required: [pgkplt] + example: + documents: + cci: "3MtNcTKd2VKWu0...br62U" + WarningMessage: + type: string + description: A warning message that may be returned if the document is not generated successfully. + example: "Use Document API to generate missing documents." + ErrorResponse: + type: object + description: response container + required: + - response + properties: + response: + type: object + description: errors container + required: + - errors + properties: + errors: + type: array + description: error payload - array containing one or more Errors + items: + $ref: '#/components/schemas/Error' + Error: + type: object + description: The error entity that contains the code and description of an error. + required: + - code + - message + properties: + code: + type: string + description: The error code. + example: "00400" + message: + type: string + description: The error message. + example: "Bad ChildRequest" + securitySchemes: + oauth2: + type: "oauth2" + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token + scopes: { } +security: + - oauth2: [] diff --git a/UPSExportAssure.yaml b/UPSExportAssure.yaml index f2c9edc..5a5818e 100644 --- a/UPSExportAssure.yaml +++ b/UPSExportAssure.yaml @@ -1,2028 +1,2028 @@ -openapi: 3.1.0 - -info: - title: Export Assure API - Cross-Border Trade Guidance-v1 - 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - - Run In Postman - - Open in GitHub - - - ## Key Features - - ### 1. Basic Description Guidance (Free Feature) - - This feature helps you avoid commonly used, invalid shipment descriptions to avoid hold-ups at customs. For comprehensive description guidance, please refer the Interactive Commodity Description API. Basic Description Guidance includes: - - - Checking your commodity description against commonly used descriptions that typically result in a customs delay. - - Provide basic guidance for improving an invalid commodity description. - - ### 2. Power of Attorney (POA) Requirements - - Understanding legal permissions is key for obeying international trade laws. This feature: - - - Reviews commodity details for POA requirements. - - Determines when a POA is needed for customs clearance. - - Proactively notifies user of POA requirement to help avoid customs delays. - - ### 3. UPS Prohibited Goods Guidance (Free Feature) - - 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. - - Note 2: evaluateImportExportRequirements MUST be set to true in order to use Feature #4 - - - ### 4. Commodity Compliance Guidance (Premium Feature) - - This premium feature checks for any restrictions or prohibitions for the specific commodity you are shipping (including any forms needed to clear customs) for the country you are shipping to. A chargeable event is when guidance is provided, including that no restrictions and prohibitions are found. Commodity Compliance Guidance requires a full, destination country specific tariff code to provide guidance. If you do not have this for each product in each country you ship to, you can use the Export Assure: Interactive Commodity Description API to determine this. Included in Commodity Compliance Guidance is: - - Details on what commodities can be shipped to and from specific locations, including restrictions based on the country of origin of the good. - - 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: - - OAuth2: [] - -servers: - - url: https://wwwcie.ups.com/api/brokerage/{version} - description: Production CIE - External Interface - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/brokerage/{version} - description: Production - External Interface - variables: - version: - default: v1 - enum: - - v1 -paths: - /importexport/exportassure: - post: - operationId: submitExportAssure - tags: - - Export Assure - summary: Submit shipment details for compliance guidance - parameters: - - $ref: '#/components/parameters/AccountNumber' - - $ref: '#/components/parameters/TransactionSrc' - - $ref: '#/components/parameters/Content-Type' - - $ref: '#/components/parameters/Accept' - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - - description: | - 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. - - To request a specific operation, set the respective value for that property to true: - - evaluateDescriptions to request basic description guidance for the shipment (free) - - evaluatePoaRequirements to request POA requirements for the shipment (free) - - evaluateImportExportRequirements to request UPS Prohibited Goods Guidance only (free) - - evaluateAdvancedImportExportRequirements to request regulatory requirements, shipping restrictions, and required international forms (premium) - Examples: - - To request only Description Guidance, set evaluateDescriptions: true and provide relevant description properties. - - To request all three free operations, set evaluateDescriptions: true, evaluatePoaRequirements: true, evaluateImportExportRequirements: true, and include all required properties for all operations. - - 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: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ExportAssureRequest" - examples: - descriptionGuidanceRequestExample: - $ref: "#/components/examples/sample-description-guidance-request" - poaGuidanceRequestExample: - $ref: '#/components/examples/sample-poa-guidance-request' - importExportComplianceRequestExample: - $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" - content: - application/json: - schema: - $ref: '#/components/schemas/ExportAssureResponse' - examples: - descriptionGuidanceResponseExample: - $ref: "#/components/examples/sample-description-guidance-response" - poaGuidanceResponseExample: - $ref: '#/components/examples/sample-poa-guidance-response' - importExportComplianceResponseExample: - $ref: "#/components/examples/sample-import-export-compliance-response" - allGuidanceResponseExample: - $ref: "#/components/examples/sample-all-guidance-response" - cieResponseExample: - $ref: "#/components/examples/cie-success-response" - - "207": - description: Multi-Status. This is an example where inquiry was made for multiple compliance areas but not all succeeded. - headers: - application/json: - schema: - $ref: "#/components/schemas/BackendErrorResponseHeaders" - content: - application/json: - schema: - $ref: '#/components/schemas/ExportAssurePartialResponse' - examples: - samplePartialResponse: - $ref: "#/components/examples/sample-partial-response" - '400': - description: Bad Request - headers: - application/json: - schema: - $ref: "#/components/schemas/BackendErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - example: - response: - errors: - - code: "EA_POA_04" - message: Country code is not valid - field: evaluateImportExportRequirements - value: 'NB' - type: POA - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - '401': - description: Unauthorized - headers: - application/json: - schema: - $ref: "#/components/schemas/GatewayErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - example: - response: - errors: - - code: "UJ0001" - message: Invalid token or token is not present - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - '404': - description: Not Found - headers: - application/json: - schema: - $ref: "#/components/schemas/GatewayErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - example: - response: - errors: - - code: "404" - message: The requested resource was not found - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - '405': - description: Method Not Allowed - headers: - application/json: - schema: - $ref: "#/components/schemas/GatewayErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - example: - response: - errors: - - code: "405" - message: The requested method is not allowed for this resource - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - "415": - description: Not Acceptable - headers: - application/json: - schema: - $ref: "#/components/schemas/GatewayErrorResponseHeaders" - '500': - description: Internal Server Error - headers: - application/json: - schema: - $ref: "#/components/schemas/BackendErrorResponseHeaders" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - example: - response: - errors: - - code: "500" - message: Internal server error - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - -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 - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - - schemas: - AccountNumber: - description: UPS account number - type: - - string - - "null" - maxLength: 10 - pattern: '^[a-zA-Z0-9]*$' - examples: - - "985123" - - "766554" - - "446332" - - CommodityId: - description: The commodity ID returned in the Import Export Compliance report. - type: string - maxLength: 50 - pattern: ^[\s\S]*$ - examples: - - "28b210b9-e686-4617-8cf4-9973e3ed4087" - - "8f971462-5e68-469a-809f-637a12af1305" - - ComplianceDetails: - description: This object contains details of specific compliance requirements and controls that are applicable to the shipment, based on whether it is for import or export purposes. - type: object - properties: - categoryType: - description: Whether the compliance assessment regards imports or exports - type: string - minLength: 6 - maxLength: 6 - enum: - - Import - - Export - controlTypes: - type: array - minItems: 1 - items: - $ref: "#/components/schemas/ControlTypes" - additionalProperties: false - required: - - categoryType - - controlTypes - - ControlDetails: - 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. - - **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: - - Controlling Authority - - Free Trade Agreement - controlDetailDescription: - description: A detailed description of the control measure, translated for the user as required. - type: string - maxLength: 4000 - pattern: '^[\s\S]*$' - examples: - - Trade Agreement between the United States and Canada (USMCA) - - Caribbean Basin Economic Recovery Act - additionalProperties: false - required: - - controlDetailName - - controlDetailDescription - - ControlTypes: - description: This object includes specific type of customs controls applicable to a shipment. - 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. - type: string - minLength: 1 - maxLength: 100 - pattern: ^[\s\S]*$ - 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. - type: string - maxLength: 50 - pattern: ^[\s\S]*$ - examples: - - DOC - - FTA - isRequired: - description: Whether shipment compliance with a specific control type is required - type: string - maxLength: 10 - enum: - - "Yes" - - Maybe - - Applicable - controlTypeMessage: - description: Additional guidance or instructions based on the specific control type condition. - type: string - minLength: 1 - maxLength: 4000 - pattern: ^[\s\S]*$ - examples: - - Import Certificate may be required - - Free Trade Agreement may be applicable - controlDetails: - description: An array that contains a list of control types and codes - type: array - minItems: 1 - items: - $ref: "#/components/schemas/ControlDetails" - additionalProperties: false - required: - - controlType - - controlTypeCode - - controlTypeMessage - - controlDetails - - CountryCodes: - description: The two-letter identification code for countries. - type: string - minLength: 2 - maxLength: 2 - pattern: ^[a-zA-Z0-9]{2}$ - examples: - - AU - - US - - UK - - FR - - JP - - CurrencyCodes: - description: |- - The three-letter code that represents the currency used to value the items in the shipment. - - | Supported enum values | - | :--------------------------- | - | `ARS`
Argentine Peso | - | `AUD`
Australian Dollar | - | `BRL`
Brazilian Real | - | `CAD`
Canadian Dollar | - | `CHF`
Swiss Franc | - | `CLP`
Chilean Peso | - | `CNY`
Chinese Yuan | - | `CRC`
Costa Rican Colon | - | `DKK`
Danish Krone | - | `DOP`
Dominican Peso | - | `EUR`
Euro | - | `GBP`
Great Britain Pound | - | `HKD`
Hong Kong Dollar | - | `INR`
India Rupee | - | `JPY`
Japanese Yen | - | `KRW`
Korean Won | - | `MXN`
Mexican Peso | - | `MYR`
Malaysian Ringgit | - | `NOK`
Norwegian Kroner | - | `NZD`
New Zealand Dollar | - | `PEN`
Peruvian Nuevo Sol | - | `PHP`
Philippine Peso | - | `PLN`
Polish Zloty | - | `SEK`
Swedish Krona | - | `SGD`
Singapore Dollar | - | `THB`
Thai Baht | - | `TWD`
Taiwan Dollar | - | `USD`
US Dollar | - | `VEB`
Venezuelan Bolivar | - type: string - minLength: 3 - maxLength: 3 - pattern: ^[a-zA-Z0-9]{3}$ - enum: - - ARS - - AUD - - BRL - - CAD - - CHF - - CLP - - CNY - - CRC - - DKK - - DOP - - EUR - - GBP - - HKD - - INR - - JPY - - KRW - - MXN - - MYR - - NOK - - NZD - - PEN - - PHP - - PLN - - SEK - - SGD - - THB - - TWD - - USD - - VEB - - DescriptionGuidanceResponse: - description: This object contains the system's results to a request for Description Guidance - type: object - properties: - isMatched: - description: Whether the description guidance service has matched a keyword from the shipment description - type: boolean - default: false - examples: - - true - - false - message: - description: A message with guidance on how to improve the shipment description - type: string - pattern: ^[\s\S]*$ - examples: - - DVD Player - - Stereo - sourceListName: - description: A list of terminology used to describe items from a particular regional source - type: string - maxLength: 250 - pattern: ^[\s\S]*$ - examples: - - USA - - France - - Germany - matchedKeyword: - description: The keyword(s) from the shipment description that matched the system criteria - type: string - maxLength: 250 - pattern: ^[\s\S]*$ - examples: - - goods - - clothing - - perishables - - ErrorResponse: - description: This object is the primary container for error responses. - type: object - properties: - response: - $ref: "#/components/schemas/ErrorResponseWrapper" - perfStats: - $ref: "#/components/schemas/ALPerfStats" - required: - - response - - perfStats - - ErrorResponseWrapper: - description: This object contains an array of error codes. - type: object - properties: - errors: - type: array - items: - $ref: '#/components/schemas/ErrorCode' - required: - - errors - - ErrorCode: - description: This object contains error codes, error descriptions and other error properties. - type: object - properties: - code: - description: The error code. - type: string - pattern: '^[a-zA-Z0-9\-_\.]+$' - examples: - - 400 - - 401 - - 404 - description: - description: Description of the error. - 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: - - 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: - - evaluateImportExportRequirements - - evaluatePoaRequirements - - evaluateImportExportRequirements - value: - description: The value that caused the error - type: string - pattern: ^[\s\S]*$ - examples: - - US - - EU - - NB - type: - description: |- - Specific operation the error message is relevant to. - - | Supported enum values | - | :------------------------------------- | - | `DG`
Description Guidance | - | `POA`
Power of Attorney Requirement | - | `IEC`
Import Export Compliance | - type: string - minLength: 2 - maxLength: 3 - enum: - - DG - - IEC - - POA - additionalProperties: false - - EvaluationCriteria: - description: |- - Criteria for evaluating POA requirements for both importer and exporter. Supported values: - - | Supported enum values | - | :-------------------------------------------------------------------------------------------------------------- | - | `NonConditional`
Standard evaluation without specific conditional criteria | - | `Description`
Evaluation based on the detailed description of the commodity | - | `FTA`
Free Trade Agreement. Evaluation considers Free Trade Agreement stipulations applicable to the shipment. | - | `Value`
Evaluation based on the monetary value of the commodities | - | `HTS`
Harmonized Tariff Schedule. Evaluation uses HTS codes for tariff classification and compliance | - | `Quantity`
Evaluation focuses on the quantity of the goods being shipped | - | `Weight`
Evaluation based on the weight of the shipment | - type: string - enum: - - NonConditional - - Description - - FTA - - Value - - HTS - - Quantity - - Weight - - HTS PGA - minLength: 3 - maxLength: 14 - pattern: ^[a-zA-Z0-9\-_\s:]+$ - - ExportAssureRequest: - description: This object is the primary request structure for the Export Assure API. - type: object - properties: - transID: - description: The unique, reference identifier that correlates an API request with its response - type: string - maxLength: 50 - pattern: ^[\s\S]*$ - examples: - - 10d622cc-a453-4054-bb62-ed71e6fc2239 - - 798fe81e-2f28-430d-96fd-d45f0c7fe36a - evaluateDescriptions: - description: Whether the user has requested description guidance - type: boolean - default: true - examples: - - true - - false - evaluatePoaRequirements: - description: Whether the user has requested Power of Attorney (POA) requirements - type: boolean - default: true - examples: - - true - - false - evaluateAdvancedImportExportRequirements: - description: Whether the user has requested an Advanced Import/Export Compliance review - type: boolean - default: false - examples: - - true - - false - evaluateImportExportRequirements: - description: Whether the user has requested an Import/Export Compliance review - type: boolean - default: true - examples: - - true - - false - shipment: - $ref: "#/components/schemas/ShipmentRequest" - additionalProperties: false - required: - - transID - - shipment - - ExportAssureResponse: - description: This object is the primary request container for the Export Assure API. - type: object - properties: - transID: - $ref: '#/components/schemas/TransactionID' - shipment: - $ref: "#/components/schemas/ShipmentResponse" - perfStats: - $ref: "#/components/schemas/ALPerfStats" - additionalProperties: false - required: - - transID - - shipment - - perfStats - ExportAssurePartialResponse: - description: This object is the primary response container for the Export Assure API. - type: object - properties: - transID: - $ref: '#/components/schemas/TransactionID' - shipment: - $ref: "#/components/schemas/ShipmentResponse" - response: - $ref: "#/components/schemas/ErrorResponseWrapper" - perfStats: - $ref: "#/components/schemas/ALPerfStats" - additionalProperties: false - required: - - transID - - shipment - - response - - perfStats - HsCode: - description: The [Harmonized System (HS) code](https://www.trade.gov/harmonized-system-hs-codes). Used commonly throughout the export process for goods, the Harmonized System is a standardized numerical method of classifying traded products. It is used by customs authorities to identify products when assessing duties and taxes. - type: string - maxLength: 13 - pattern: ^[0-9.]{4,13}$ - examples: - - "3605.00.00.00" - - "3605000000" - - "3925.90.00.00" - - "3925900000" - - ImportExportShipmentLevelResponse: - description: This object contains properties which describe the shipment's compliance with laws and regulations. - type: object - properties: - shipmentValue: - type: number - description: The total monetary value of all items included in the shipment - format: double - maximum: 999999999999.99 - examples: - - 1500.25 - - 456.99 - - 9977.00 - shipmentCurrencyCode: - description: The three-letter code of the currency used to value the items in the shipment. - $ref: '#/components/schemas/CurrencyCodes' - translationLocale: - $ref: "#/components/schemas/TranslationLocale" - hasShipmentWarnings: - description: Whether there are shipment-level warning. Shipment-level warnings include issues related to documentation and shipment packaging. - type: boolean - examples: - - true - - false - hasCommodityWarnings: - description: Whether there are compliance-related warnings or issues at the commodity level within the shipment. A `true` value indicates potential compliance concerns that require the shipper's attention. - type: boolean - examples: - - true - - false - commodityWarningsMessage: - description: The warning message returned when the `hasCommodityWarnings` flag is set to true - type: string - pattern: ^[\s\S]*$ - examples: - - Your shipment may have additional clearance considerations - - Some shipment items may be prohibited from import to the EU - isShipmentOverGiftValueThreshold: - type: boolean - description: Whether the total value of the shipment exceeds the allowable threshold for categorizing it as a gift - examples: - - true - - false - shipmentOverGiftValueThresholdMessage: - description: The message returned if the shipment's value surpasses the threshold for gift categorization - type: string - pattern: ^[\s\S]*$ - examples: - - "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided" - - "Your shipment may incur additional charges due to shipment value." - isShipmentOverGiftWeightThreshold: - description: Whether the total weight of the shipment exceeds the weight limit for being classified as a gift - type: boolean - examples: - - true - - false - shipmentOverGiftWeightThresholdMessage: - description: A message explaining the implications if the shipment's weight goes beyond the threshold for gift categorization, guiding users in understanding customs considerations. - type: string - pattern: ^[\s\S]*$ - examples: - - "Your shipment may not be considered as a gift by Customs authorities due to the shipment weight provided" - - "Your shipment may incur additional charges due to shipment weight." - additionalProperties: false - required: - - shipmentCurrencyCode - - hasShipmentWarnings - - hasCommodityWarnings - - isShipmentOverGiftValueThreshold - - isShipmentOverGiftWeightThreshold - - ImportExportItemLevelResponse: - description: This object includes details of the Import Export Compliance assessment. - type: object - properties: - isUpsProhibited: - description: Whether UPS prohibits shipment of the item - type: boolean - examples: - - true - - false - upsProhibitedMessage: - description: A message explaining the reason for any prohibited shipment - oneOf: - - type: 'null' - - type: string - pattern: ^[\s\S]*$ - examples: - - US federal law prohibits shipment of this item from the US. - - The EU prohibits import of this item. - isTranslatedIndicator: - description: Whether shipment details have been translated from the language of the origin country to the user's language - type: boolean - examples: - - true - - false - complianceOutput: - description: This array includes the output of the compliance review, including customs category and control codes. - type: array - minItems: 0 - items: - $ref: "#/components/schemas/ComplianceDetails" - additionalProperties: false - required: - - isUpsProhibited - - isTranslatedIndicator - - PowerOfAttorneyResponse: - description: This object includes details of the Power of Attorney (POA) requirements for the shipment. - type: object - properties: - importerPoaRequiredFlag: - description: Whether Power of Attorney (POA) is required for the importer - type: boolean - examples: - - true - - false - importerEvaluationCriteria: - $ref: "#/components/schemas/EvaluationCriteria" - importerPoaOnFileIndicator: - description: Whether the importer already has a POA on file - type: - - string - - "null" - maxLength: 3 - enum: - - "Yes" - - "No" - - null - importerCommodityId: - description: The first commodity in the shipment that necessitates an importer POA - $ref: '#/components/schemas/CommodityId' - importerCommodityDescription: - description: A description of the commodity regarding what led to the POA requirement for the importer - type: string - pattern: ^[\s\S]*$ - examples: - - EQUIPMENT - - COMPUTERS - - BICYCLES - exporterPoaRequiredFlag: - description: Whether the exporter is required to provide a POA for customs clearance. - type: boolean - examples: - - true - - false - exporterEvaluationCriteria: - description: This schema includes details of whether a POA is required for the exporter. - $ref: "#/components/schemas/EvaluationCriteria" - exporterPoaOnFileIndicator: - description: Whether the exporter has a POA already on file - type: - - string - - "null" - maxLength: 3 - enum: - - "Yes" - - "No" - - null - exporterCommodityId: - description: The first commodity in the shipment that necessitated an exporter POA - $ref: '#/components/schemas/CommodityId' - exporterCommodityDescription: - description: The commodity that triggers the POA requirement for the exporter - type: string - pattern: ^[\s\S]*$ - examples: - - Dynamite - exporterOnlineFormFlag: - description: Whether there is an online form available for the exporter to complete their POA documentation - type: boolean - examples: - - true - - false - exporterDocuSignTemplateId: - description: The ID of the DocuSign template, which the exporter can use for electronic completion of the POA. - type: string - maxLength: 100 - pattern: ^[a-zA-Z0-9\-_\s:]+$ - examples: - - f215a2b8-8fad-4610-b06e-76877ec3016c - - 8f971462-5e68-469a-809f-637a12af1305 - required: - - importerPoaRequiredFlag - - exporterPoaRequiredFlag - - exporterOnlineFormFlag - - ShipmentRequest: - description: This object contains all necessary details about a shipment for compliance evaluation. - type: object - properties: - importerName: - description: The name of the importer - type: string - pattern: ^[\s\S]*$ - maxLength: 100 - examples: - - Ford - - Acme - importerCity: - description: The city where the importer is located. Required if both importer's account number and importer's zip code are not provided and POA evaluation is requested. - type: string - maxLength: 100 - pattern: ^[\s\S]*$ - examples: - - Detroit - - Paris - - Amsterdam - - New York - importerZipcode: - description: The postal code of the importer's location. Required when the importer's account number and city are not specified and POA evaluation is requested. - type: string - pattern: ^[a-zA-Z0-9\-\s]+$ - examples: - - "48204" - - "46664" - importerAccountNumber: - description: The UPS account number of the importer - type: - - string - - "null" - pattern: '^[a-zA-Z0-9]*$' - minLength: 6 - maxLength: 10 - examples: - - "985123" - - "766554" - - "446332" - exporterName: - description: The name of the exporter. Required when the exporter's UPS account number is not available and POA requirements are under review. - type: string - pattern: ^[\s\S]*$ - maxLength: 100 - examples: - - Lear - - Acme - exporterCity: - description: The city from which the exporter operates. Required if exporter's account number and zip code are not given and POA evaluation is requested. - type: string - maxLength: 100 - pattern: ^[\s\S]*$ - examples: - - Windsor - - Paris - - Amsterdam - exporterZipcode: - description: The postal code of the exporter's location. Required when exporter's account number and city are not provided and POA evaluation is requested. - type: string - pattern: ^[a-zA-Z0-9\-\s]+$ - examples: - - "20836" - - "43322" - exporterAccountNumber: - description: The UPS account number of the exporter - type: string - pattern: '^[a-zA-Z0-9]*$' - maxLength: 20 - examples: - - "998562" - - "767839" - - "332532" - id: - description: The Shipment ID included on the Import Export compliance report. - $ref: '#/components/schemas/ShipmentId' - importCountryCode: - description: The [two-letter country code]() representing the destination country for the shipment - $ref: '#/components/schemas/CountryCodes' - exportCountryCode: - description: The [two-letter country code]() of the shipment's origin - $ref: '#/components/schemas/CountryCodes' - translationLocale: - description: The language and country-based preferences of the user. This includes translated texts, currency type, and unit of measurements. - $ref: "#/components/schemas/TranslationLocale" - transModes: - description: |- - Mode of transportation for the shipment. - - | Supported enum values | - |---------------------------------------------| - | `INT_AIR`
International Air Freight | - | `INT_OCEAN`
International Ocean Freight | - | `INT_RAIL`
International Rail Freight | - | `INT_TRUCK`
International Truck Freight | - | `DOM_AIR`
Domestic Air Freight | - | `DOM_OCEAN`
Domestic Ocean Freight | - | `DOM_RAIL`
Domestic Rail Freight | - | `DOM_TRUCK`
Domestic Truck Freight | - type: string - minLength: 7 - maxLength: 20 - enum: - - INT_AIR - - INT_OCEAN - - INT_RAIL - - INT_TRUCK - - DOM_AIR - - DOM_OCEAN - - DOM_RAIL - - DOM_TRUCK - shipmentType: - description: |- - Shipment type. - - | Supported enum values | - | :--------------------------------------------------------------------------------------------------- | - | `GIFT`
Items sent as gifts, typically for personal reasons. | - | `COMM`
Commercial goods or commodities, usually for business transactions. Sale, sample, repair. | - | `OTHR`
Return, Other, and Intercompany Data, Anything else not supported. | - | `PERS`
Personal items, often for relocation or personal use | - type: string - minLength: 4 - maxLength: 4 - enum: - - GIFT - - COMM - - OTHR - - PERS - shipmentDescription: - description: Description of the contents of the shipment. This description is required if the `evaluateDescriptions` flag is set to true. - type: string - maxLength: 2147483647 - pattern: ^[\s\S]*$ - examples: - - goods - - electronics - - machinery - grossWeight: - description: The gross weight of the entire Shipment. If this field is not specified, `grossWeightUnit` must be `null`. - type: number - format: decimal - maximum: 999999999999.99 - pattern: ^(\d{1,12})(\.\d{1,2})?$ - examples: - - 10.6 - - 25.6 - - 155.99 - grossWeightUnit: - description: Gross weight unit. Only required if there is a value for `grossWeight`; If `grossWeight` is not specified, this value must equal `null`. - type: - - string - - "null" - default: null - maxLength: 2 - enum: - - KG - - LB - - null - shipmentItems: - type: array - minItems: 1 - maxItems: 150 - items: - $ref: "#/components/schemas/ShipmentItemsRequest" - additionalProperties: false - required: - - id - - importCountryCode - - exportCountryCode - - shipmentType - - grossWeightUnit - - shipmentItems - - ShipmentResponse: - description: This object contains metadata about the shipment and includes the response objects for each of the three operations. - type: object - properties: - id: - $ref: '#/components/schemas/ShipmentId' - hasCommodityWarnings: - description: Whether there are compliance-related warnings or issues at the commodity level within the shipment. A `true` value indicates potential compliance concerns that require the shipper's attention. - type: boolean - examples: - - true - - false - descriptionGuidance: - $ref: "#/components/schemas/DescriptionGuidanceResponse" - poaCompliance: - $ref: "#/components/schemas/PowerOfAttorneyResponse" - importExportCompliance: - $ref: "#/components/schemas/ImportExportShipmentLevelResponse" - shipmentItems: - type: array - minItems: 1 - items: - $ref: "#/components/schemas/ShipmentItemsResponse" - additionalProperties: false - required: - - id - - hasCommodityWarnings - - shipmentItems - - ShipmentId: - description: A unique identifier assigned to the shipment as part of the API's compliance review process. - type: string - maxLength: 50 - pattern: ^(?!-)[0-9a-zA-Z-]{1,50}(?English | - | `DE`
Germany | - | `PL`
Polish | - | `FR`
French | - | `IT`
Italian | - | `NL`
Dutch | - | `ES`
Spanish | - | `ZH`
Simplified Chinese | - type: string - minLength: 2 - maxLength: 2 - enum: - - EN - - DE - - PL - - FR - - IT - - NL - - ES - - ZH - default: EN - - ALPerfStats: - type: object - properties: - absLayerTime: - type: string - description: Time taken through the abstraction layer in milliseconds. - examples: - - "13440" - - "44324" - fulfillTime: - type: string - description: Request completed time. - examples: - - Sun Nov 19 10:42:46.145 -05:00 2023 - - Mon Nov 20 12:16:26.600 -05:00 2023 - receiptTime: - type: string - description: Request receipt time - examples: - - Sun Nov 19 10:42:32.705 -05:00 2023 - - Mon Nov 20 12:12:26.600 -05:00 2023 - additionalProperties: false - required: - - absLayerTime - - fulfillTime - - receiptTime - - SuccessResponseHeaders: - description: The headers that are returned for all error responses. - type: object - required: - - x-request-id - - BkndTransId - properties: - x-request-id: - description: The APIGEE transaction id. - type: string - example: d774b047-e945-4db6-8468-ea4e65fa61c4 - BkndTransId: - description: The backend transaction id. - type: string - example: UJ0001 - x-api-success-count: - description: Indicate the number of charges for the API call. - type: string - example: '1' - - GatewayErrorResponseHeaders: - description: The headers returned from the gateway - type: object - required: - - x-request-id - properties: - x-request-id: - type: string - description: The gateway transaction id. - example: d774b047-e945-4db6-8468-ea4e65fa61c4 - - BackendErrorResponseHeaders: - description: The headers that are returned from the backend and gateway - $ref: '#/components/schemas/GatewayErrorResponseHeaders' - required: - - bkndtransid - - apierrorcode - - apierrormsg - properties: - bkndtransid: - description: The backend transaction id. - type: string - apierrorcode: - description: The API error code. - type: string - example: UJ0001 - apierrormsg: - description: The API error message. - type: string - example: Invalid token or token is not present. - - parameters: - AccountNumber: - in: header - name: accountNumber - description: UPS account number for shipper or user - required: false - schema: - $ref: '#/components/schemas/AccountNumber' - TransactionSrc: - in: header - name: transactionSrc - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - Accept: - in: header - name: Accept - required: true - description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. - schema: - type: string - Content-Type: - in: header - name: Content-Type - required: true - description: The Content-Type header provides the client with the actual content/media type of the returned content. - schema: - type: string - - examples: - sample-description-guidance-request: - summary: Description Guidance Request - value: - transID: c5d87df5-ac58-4ff7-9f96-103debe66496 - evaluateDescriptions: true - evaluatePoaRequirements: false - evaluateImportExportRequirements: false - shipment: - id: 47cb07b6-69f1-4ded-95ff-953fee2667de - importCountryCode: CA - exportCountryCode: US - translationLocale: EN - transModes: INT_AIR - shipmentType: GIFT - shipmentDescription: gifts - grossWeight: 15 - grossWeightUnit: KG - shipmentItems: - - commodityId: 47cb07b6-69f1-4ded-95ff-953fee2667de - eccn: EAR99 - hsCode: 6109.10.0004 - description: t-shirts - originCountryCode: US - amountValue: 1200 - currencyCode: USD - quantity: 5 - UOM: Dozen - - commodityId: 47cb07b6-69f1-4ded-95ff-953fee2667de - eccn: EAR99 - hsCode: 6109.10.0042 - description: t-shirts - originCountryCode: US - amountValue: 2400 - currencyCode: USD - quantity: 10 - UOM: Dozen - sample-poa-guidance-request: - summary: POA Guidance Request - value: - transID: c5d87df5-ac58-4ff7-9f96-103debe66496 - evaluateDescriptions: false - evaluatePoaRequirements: false - evaluateImportExportRequirements: true - shipment: - importerName: Ford - importerCity: Detroit - importerZipcode: "48204" - exporterName: Lear - exporterCity: Windsor - exporterZipcode: "56325" - exporterAccountNumber: "9687452" - importerAccountNumber: "9952736" - id: "47cb07b6-69f1-4ded-95ff-953fee2667de" - importCountryCode: "CA" - exportCountryCode: "US" - translationLocale: "EN" - transModes: "INT_AIR" - shipmentType: "COMM" - shipmentDescription: "gifts" - grossWeight: 15 - grossWeightUnit: "KG" - shipmentItems: - - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" - eccn: "EAR99" - hsCode: "6109.10.0004" - description: "t-shirts" - originCountryCode: "US" - amountValue: 1200 - currencyCode: "USD" - quantity: 5 - UOM: "Dozen" - - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" - eccn: "EAR99" - hsCode: "6109.10.0042" - description: "t-shirts" - originCountryCode: "CU" - amountValue: 2400 - currencyCode: "USD" - quantity: 10 - UOM: "Dozen" - sample-import-export-compliance-request: - summary: Import Export Compliance Request - value: - transID: c5d87df5-ac58-4ff7-9f96-103debe66496 - evaluateDescriptions: false - evaluatePoaRequirements: false - evaluateImportExportRequirements: true - shipment: - id: "47cb07b6-69f1-4ded-95ff-953fee2667de" - importCountryCode: "CA" - exportCountryCode: "US" - translationLocale: "EN" - transModes: "INT_AIR" - shipmentType: "COMM" - grossWeight: 15 - grossWeightUnit: "KG" - shipmentItems: - - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" - eccn: "EAR99" - hsCode: "6109.10.0004" - description: "t-shirts" - originCountryCode: "US" - amountValue: 1200 - currencyCode: "USD" - quantity: 5 - UOM: "Dozen" - - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" - eccn: "EAR99" - hsCode: "6109.10.0042" - description: "t-shirts" - originCountryCode: "CU" - amountValue: 2400 - currencyCode: "USD" - quantity: 10 - UOM: "Dozen" - sample-all-guidance-request: - summary: All Guidance Request - value: - transID: "c5d87df5-ac58-4ff7-9f96-103debe66496" - evaluateDescriptions: true - evaluatePoaRequirements: true - evaluateImportExportRequirements: true - shipment: - importerName: "Ford" - importerCity: "Detroit" - importerZipcode: "48204" - exporterName: "Lear" - exporterCity: "Windsor" - exporterZipcode: "56325" - exporterAccountNumber: "9687452" - importerAccountNumber: "9952736" - id: "47cb07b6-69f1-4ded-95ff-953fee2667de" - importCountryCode: "CA" - exportCountryCode: "US" - translationLocale: "EN" - transModes: "INT_AIR" - shipmentType: "COMM" - shipmentDescription: "shirts" - grossWeight: 15 - grossWeightUnit: "KG" - shipmentItems: - - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" - eccn: "EAR99" - hsCode: "6109.10.0004" - description: "t-shirts" - originCountryCode: "US" - amountValue: 1200 - currencyCode: "USD" - quantity: 5 - UOM: "Dozen" - - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" - eccn: "EAR99" - hsCode: "6109.10.0042" - description: "t-shirts" - originCountryCode: "CU" - amountValue: 2400 - currencyCode: "USD" - quantity: 10 - UOM: "Dozen" - sample-description-guidance-response: - summary: Description Guidance Response - value: - transID: 28b210b9-e686-4617-8cf4-9973e3ed4087 - shipment: - id: "a5de8df8-0ada-45d6-ae36-b7dbc4d6f127" - hasCommodityWarnings: true - descriptionGuidance: - isMatched: true - message: "Men's and women's cotton sport shirts" - sourceListName: "global" - matchedKeyword: "Gift" - poaCompliance: - importerPoaRequiredFlag: true - importerEvaluationCriteria: "Description" - importerPoaOnFileIndicator: "Yes" - importerCommodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" - importerCommodityDescription: 't-shirts' - exporterPoaRequiredFlag: true - exporterEvaluationCriteria: "Description" - exporterPoaOnFileIndicator: "Yes" - exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' - exporterCommodityDescription: 't-shirts' - exporterOnlineFormFlag: true - exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" - importExportCompliance: - shipmentValue: 3600 - shipmentCurrencyCode: "USD" - translationLocale: "EN" - hasShipmentWarnings: true - hasCommodityWarnings: true - commodityWarningsMessage: "Your shipment may have compliance considerations; see below for additional detail" - isShipmentOverGiftValueThreshold: true - shipmentOverGiftValueThresholdMessage: "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided" - isShipmentOverGiftWeightThreshold: false - shipmentOverGiftWeightThresholdMessage: '' - shipmentItems: - - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" - hsCode: "6109.10.0004" - description: "t-shirts" - - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" - hsCode: "6109.10.0042" - description: "t-shirts" - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - sample-poa-guidance-response: - summary: POA Guidance Response - value: - transID: "28b210b9-e686-4617-8cf4-9973e3ed4087" - shipment: - id: "47cb07b6-69f1-4ded-95ff-953fee2667de" - hasCommodityWarnings: true - descriptionGuidance: - isMatched: false - message: "" - sourceListName: "global" - matchedKeyword: "Gift" - importExportCompliance: - shipmentValue: 3600 - shipmentCurrencyCode: "USD" - translationLocale: "EN" - hasShipmentWarnings: true - hasCommodityWarnings: true - isShipmentOverGiftValueThreshold: true - shipmentOverGiftValueThresholdMessage: "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided." - isShipmentOverGiftWeightThreshold: false - shipmentOverGiftWeightThresholdMessage: '' - commodityWarningsMessage: "Your shipment may have compliance considerations see below for additional detail" - poaCompliance: - importerPoaRequiredFlag: true - importerEvaluationCriteria: "Description" - importerPoaOnFileIndicator: "Yes" - importerCommodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" - importerCommodityDescription: 't-shirts' - exporterPoaRequiredFlag: true - exporterEvaluationCriteria: 'Description' - exporterPoaOnFileIndicator: "Yes" - exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' - exporterCommodityDescription: 't-shirts' - exporterOnlineFormFlag: true - exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" - shipmentItems: - - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" - hsCode: "6109.10.0004" - description: "t-shirts" - - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" - hsCode: "6109.10.0042" - description: "t-shirts" - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - sample-import-export-compliance-response: - summary: Import Export Compliance Response - value: - transID: "28b210b9-e686-4617-8cf4-9973e3ed4087" - shipment: - id: "47cb07b6-69f1-4ded-95ff-953fee2667de" - hasCommodityWarnings: true - importExportCompliance: - shipmentValue: 3600 - shipmentCurrencyCode: "USD" - translationLocale: "EN" - hasShipmentWarnings: true - hasCommodityWarnings: true - isShipmentOverGiftValueThreshold: true - shipmentOverGiftValueThresholdMessage: Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided. - isShipmentOverGiftWeightThreshold: false - shipmentOverGiftWeightThresholdMessage: '' - commodityWarningsMessage: "Your shipment may have compliance considerations see below for additional detail" - shipmentItems: - - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" - hsCode: "6109.10.0004" - description: t-shirts - importExportCompliance: - isUpsProhibited: false - upsProhibitedMessage: '' - isTranslatedIndicator: false - complianceOutput: - - categoryType: "Export" - controlTypes: - - controlType: "Embargo/Sanction" - controlTypeCode: "Embargo/Sanction" - isRequired: 'Yes' - controlTypeMessage: "Embargo/Sanction required" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." - - controlType: "Document" - controlTypeCode: "DOC" - isRequired: "Maybe" - controlTypeMessage: "Document may be required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Miscellaneous Controls - Notification" - controlTypeCode: "Miscellaneous Controls" - isRequired: "Maybe" - controlTypeMessage: "Miscellaneous controls may be required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Free Trade Agreement" - controlTypeCode: "FTA" - isRequired: "Maybe" - controlTypeMessage: "Free Trade Agreement may be Applicable" - controlDetails: - - controlDetailName: '' - controlDetailDescription: Caribbean Basin Economic Recovery Act - - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" - hsCode: "6109.10.0042" - description: "t-shirts" - importExportCompliance: - isUpsProhibited: false - upsProhibitedMessage: '' - isTranslatedIndicator: false - complianceOutput: - - categoryType: "Export" - controlTypes: - - controlType: "Embargo/Sanction" - controlTypeCode: "Embargo/Sanction" - isRequired: 'Yes' - controlTypeMessage: "Embargo/Sanction required" - controlDetails: - - controlDetailName: 'f' - controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." - - controlType: "Document" - controlTypeCode: "DOC" - isRequired: "Maybe" - controlTypeMessage: "Document maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Miscellaneous Controls - Notification" - controlTypeCode: "Miscellaneous Controls" - isRequired: "Maybe" - controlTypeMessage: "Miscellaneous Controls Maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Free Trade Agreement" - controlTypeCode: "FTA" - isRequired: "Maybe" - controlTypeMessage: "Free Trade Agreement Maybe Applicable" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "Caribbean Basin Economic Recovery Act" - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - sample-all-guidance-response: - summary: All Guidance Response - value: - transID: "28b210b9-e686-4617-8cf4-9973e3ed4087" - shipment: - id: "47cb07b6-69f1-4ded-95ff-953fee2667de" - hasCommodityWarnings: true - importExportCompliance: - shipmentValue: 3600 - shipmentCurrencyCode: "USD" - translationLocale: "EN" - hasShipmentWarnings: true - hasCommodityWarnings: true - isShipmentOverGiftValueThreshold: true - shipmentOverGiftValueThresholdMessage: "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided." - isShipmentOverGiftWeightThreshold: false - shipmentOverGiftWeightThresholdMessage: '' - commodityWarningsMessage: "Your shipment may have compliance considerations see below for additional detail" - descriptionGuidance: - isMatched: true - message: "Men's and women's cotton sport shirts" - sourceListName: global - matchedKeyword: "Gift" - poaCompliance: - importerPoaRequiredFlag: true - importerEvaluationCriteria: "Description" - importerPoaOnFileIndicator: "Yes" - importerCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' - importerCommodityDescription: 't-shirts' - exporterPoaRequiredFlag: true - exporterEvaluationCriteria: 'Description' - exporterPoaOnFileIndicator: "Yes" - exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' - exporterCommodityDescription: 't-shirts' - exporterOnlineFormFlag: true - exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" - shipmentItems: - - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" - hsCode: "6109.10.0004" - description: "t-shirts" - importExportCompliance: - isUpsProhibited: false - upsProhibitedMessage: '' - isTranslatedIndicator: false - complianceOutput: - - categoryType: "Export" - controlTypes: - - controlType: "Embargo/Sanction" - controlTypeCode: "Embargo/Sanction" - isRequired: 'Yes' - controlTypeMessage: "Embargo/Sanction required" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." - - controlType: "Document" - controlTypeCode: "DOC" - isRequired: "Maybe" - controlTypeMessage: "Document maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Miscellaneous Controls - Notification" - controlTypeCode: "Miscellaneous Controls" - isRequired: "Maybe" - controlTypeMessage: "Miscellaneous Controls Maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Free Trade Agreement" - controlTypeCode: "FTA" - isRequired: "Maybe" - controlTypeMessage: "Free Trade Agreement Maybe Applicable" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "Caribbean Basin Economic Recovery Act" - - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" - hsCode: "6109.10.0042" - description: "t-shirts" - importExportCompliance: - isUpsProhibited: false - upsProhibitedMessage: '' - isTranslatedIndicator: false - complianceOutput: - - categoryType: "Export" - controlTypes: - - controlType: "Embargo/Sanction" - controlTypeCode: "Embargo/Sanction" - isRequired: "Yes" - controlTypeMessage: "Embargo/Sanction required" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." - - controlType: "Document" - controlTypeCode: "DOC" - isRequired: "Maybe" - controlTypeMessage: "Document maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Miscellaneous Controls - Notification" - controlTypeCode: "Miscellaneous Controls" - isRequired: "Maybe" - controlTypeMessage: "Miscellaneous Controls Maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Free Trade Agreement" - controlTypeCode: "FTA" - isRequired: "Maybe" - controlTypeMessage: "Free Trade Agreement Maybe Applicable" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "Caribbean Basin Economic Recovery Act" - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - sample-partial-response: - summary: "Example of a partial success transaction" - value: - transID: "WSCM003769601129231354517251D4CF" - shipment: - id: "WSEXPID20231129135451752" - hasCommodityWarnings: true - descriptionGuidance: - isMatched: true - message: "DVD Player Stereo" - sourceListName: "US origin" - matchedKeyword: "GOODS" - poaCompliance: - importerPoaRequiredFlag: true - importerEvaluationCriteria: "Description" - importerPoaOnFileIndicator: "Yes" - importerCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' - importerCommodityDescription: 't-shirts' - exporterPoaRequiredFlag: true - exporterEvaluationCriteria: 'Description' - exporterPoaOnFileIndicator: "Yes" - exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' - exporterCommodityDescription: 't-shirts' - exporterOnlineFormFlag: true - exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" - importExportCompliance: - shipmentValue: 2365 - shipmentCurrencyCode: "USD" - translationLocale: "EN" - hasShipmentWarnings: false - hasCommodityWarnings: false - commodityWarningsMessage: "sample message" - isShipmentOverGiftValueThreshold: false - shipmentOverGiftValueThresholdMessage: "sample message" - isShipmentOverGiftWeightThreshold: false - shipmentOverGiftWeightThresholdMessage: "sample message" - shipmentItems: - - commodityId: "1" - hsCode: "900150" - description: "DESCRIPTION" - descriptionGuidance: - isMatched: true - message: "provide a color and size" - sourceListName: "Global" - matchedKeyword: "DESCRIPTION" - importExportCompliance: - isUpsProhibited: false - upsProhibitedMessage: '' - isTranslatedIndicator: false - complianceOutput: - - categoryType: "Export" - controlTypes: - - controlType: "Embargo/Sanction" - controlTypeCode: "Embargo/Sanction" - isRequired: 'Yes' - controlTypeMessage: "Embargo/Sanction required" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." - - controlType: "Document" - controlTypeCode: "DOC" - isRequired: "Maybe" - controlTypeMessage: "Document maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Miscellaneous Controls - Notification" - controlTypeCode: "Miscellaneous Controls" - isRequired: "Maybe" - controlTypeMessage: "Miscellaneous Controls Maybe required" - controlDetails: - - controlDetailName: "DocuSignFormId" - controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" - - controlType: "Free Trade Agreement" - controlTypeCode: "FTA" - isRequired: "Maybe" - controlTypeMessage: "Free Trade Agreement Maybe Applicable" - controlDetails: - - controlDetailName: '' - controlDetailDescription: "Caribbean Basin Economic Recovery Act" - response: - errors: - - code: "105.305" - description: INVALID_FIELD_VALUE - field: shipment.shipmentItems[0].UOM - message: UOM is not valid - value: Liter - type: POA - perfStats: - absLayerTime: "575" - fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 - receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 - - cie-success-response: - summary: "Example of a CIE success transaction" - value: - transID: "1234" - shipment: - id: "1234" - hasCommodityWarnings: true - descriptionGuidance: - isMatched: true - message: DVD Player Stereo - sourceListName: US destination - matchedKeyword: GOODS - poaCompliance: - importerPoaRequiredFlag: true - importerEvaluationCriteria: HTS PGA - importerPoaOnFileIndicator: No - importerCommodityId: Test102 - importerCommodityDescription: EQUIPMENTS - exporterPoaRequiredFlag: false - exporterEvaluationCriteria: Value - exporterPoaOnFileIndicator: Yes - exporterCommodityId: order_2 - exporterCommodityDescription: computers - exporterOnlineFormFlag: false - exporterDocuSignTemplateId: 3c499118-346d-41d8-99db-faf852b77888 - importExportCompliance: - shipmentValue: 2.00 - shipmentCurrencyCode: USD - translationLocale: EN - hasShipmentWarnings: true - hasCommodityWarnings: true - commodityWarningsMessage: Your shipment may have additional clearance considerations see below for detail - isShipmentOverGiftValueThreshold: true - shipmentOverGiftValueThresholdMessage: Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided. - isShipmentOverGiftWeightThreshold: true - shipmentOverGiftWeightThresholdMessage: Your shipment may not be considered as a gift by Customs authorities due to the shipment weight provided. - shipmentItems: - - commodityId: Test101 - hsCode: "2106909999" - description: tshirt - descriptionGuidance: - isMatched: true - message: Men's Shirts Lingerie Girls' Vests Boys' Jackets - sourceListName: Global - matchedKeyword: tshirt - importExportCompliance: - isUpsProhibited: false - upsProhibitedMessage: null - isTranslatedIndicator: false - complianceOutput: - - categoryType: Import - controlTypes: - - controlType: Free Trade Agreement - controlTypeCode: FTA - isRequired: Maybe - controlTypeMessage: Free Trade Agreement may apply - controlDetails: - - controlDetailName: Controlling Authority - controlDetailDescription: Country A - Country B Comprehensive Economic and Trade Agreement - perfStats: - absLayerTime: "2322" - fulfillTime: Tue Mar 19 12:29:16.523 -04:00 2024 - receiptTime: Tue Mar 19 12:29:14.201 -04:00 2024 \ No newline at end of file +openapi: 3.1.0 + +info: + title: Export Assure API - Cross-Border Trade Guidance-v1 + 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + + Run In Postman + + Open in GitHub + + + ## Key Features + + ### 1. Basic Description Guidance (Free Feature) + + This feature helps you avoid commonly used, invalid shipment descriptions to avoid hold-ups at customs. For comprehensive description guidance, please refer the Interactive Commodity Description API. Basic Description Guidance includes: + + - Checking your commodity description against commonly used descriptions that typically result in a customs delay. + - Provide basic guidance for improving an invalid commodity description. + + ### 2. Power of Attorney (POA) Requirements + + Understanding legal permissions is key for obeying international trade laws. This feature: + + - Reviews commodity details for POA requirements. + - Determines when a POA is needed for customs clearance. + - Proactively notifies user of POA requirement to help avoid customs delays. + + ### 3. UPS Prohibited Goods Guidance (Free Feature) + + 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. + - Note 2: evaluateImportExportRequirements MUST be set to true in order to use Feature #4 + + + ### 4. Commodity Compliance Guidance (Premium Feature) + + This premium feature checks for any restrictions or prohibitions for the specific commodity you are shipping (including any forms needed to clear customs) for the country you are shipping to. A chargeable event is when guidance is provided, including that no restrictions and prohibitions are found. Commodity Compliance Guidance requires a full, destination country specific tariff code to provide guidance. If you do not have this for each product in each country you ship to, you can use the Export Assure: Interactive Commodity Description API to determine this. Included in Commodity Compliance Guidance is: + - Details on what commodities can be shipped to and from specific locations, including restrictions based on the country of origin of the good. + - 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: + - OAuth2: [] + +servers: + - url: https://wwwcie.ups.com/api/brokerage/{version} + description: Production CIE - External Interface + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/brokerage/{version} + description: Production - External Interface + variables: + version: + default: v1 + enum: + - v1 +paths: + /importexport/exportassure: + post: + operationId: submitExportAssure + tags: + - Export Assure + summary: Submit shipment details for compliance guidance + parameters: + - $ref: '#/components/parameters/AccountNumber' + - $ref: '#/components/parameters/TransactionSrc' + - $ref: '#/components/parameters/Content-Type' + - $ref: '#/components/parameters/Accept' + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + + description: | + 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. + + To request a specific operation, set the respective value for that property to true: + - evaluateDescriptions to request basic description guidance for the shipment (free) + - evaluatePoaRequirements to request POA requirements for the shipment (free) + - evaluateImportExportRequirements to request UPS Prohibited Goods Guidance only (free) + - evaluateAdvancedImportExportRequirements to request regulatory requirements, shipping restrictions, and required international forms (premium) + Examples: + - To request only Description Guidance, set evaluateDescriptions: true and provide relevant description properties. + - To request all three free operations, set evaluateDescriptions: true, evaluatePoaRequirements: true, evaluateImportExportRequirements: true, and include all required properties for all operations. + - 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: [] + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ExportAssureRequest" + examples: + descriptionGuidanceRequestExample: + $ref: "#/components/examples/sample-description-guidance-request" + poaGuidanceRequestExample: + $ref: '#/components/examples/sample-poa-guidance-request' + importExportComplianceRequestExample: + $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" + content: + application/json: + schema: + $ref: '#/components/schemas/ExportAssureResponse' + examples: + descriptionGuidanceResponseExample: + $ref: "#/components/examples/sample-description-guidance-response" + poaGuidanceResponseExample: + $ref: '#/components/examples/sample-poa-guidance-response' + importExportComplianceResponseExample: + $ref: "#/components/examples/sample-import-export-compliance-response" + allGuidanceResponseExample: + $ref: "#/components/examples/sample-all-guidance-response" + cieResponseExample: + $ref: "#/components/examples/cie-success-response" + + "207": + description: Multi-Status. This is an example where inquiry was made for multiple compliance areas but not all succeeded. + headers: + application/json: + schema: + $ref: "#/components/schemas/BackendErrorResponseHeaders" + content: + application/json: + schema: + $ref: '#/components/schemas/ExportAssurePartialResponse' + examples: + samplePartialResponse: + $ref: "#/components/examples/sample-partial-response" + '400': + description: Bad Request + headers: + application/json: + schema: + $ref: "#/components/schemas/BackendErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + example: + response: + errors: + - code: "EA_POA_04" + message: Country code is not valid + field: evaluateImportExportRequirements + value: 'NB' + type: POA + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + '401': + description: Unauthorized + headers: + application/json: + schema: + $ref: "#/components/schemas/GatewayErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + example: + response: + errors: + - code: "UJ0001" + message: Invalid token or token is not present + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + '404': + description: Not Found + headers: + application/json: + schema: + $ref: "#/components/schemas/GatewayErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + example: + response: + errors: + - code: "404" + message: The requested resource was not found + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + '405': + description: Method Not Allowed + headers: + application/json: + schema: + $ref: "#/components/schemas/GatewayErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + example: + response: + errors: + - code: "405" + message: The requested method is not allowed for this resource + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + "415": + description: Not Acceptable + headers: + application/json: + schema: + $ref: "#/components/schemas/GatewayErrorResponseHeaders" + '500': + description: Internal Server Error + headers: + application/json: + schema: + $ref: "#/components/schemas/BackendErrorResponseHeaders" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + example: + response: + errors: + - code: "500" + message: Internal server error + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + +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 + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + + schemas: + AccountNumber: + description: UPS account number + type: + - string + - "null" + maxLength: 10 + pattern: '^[a-zA-Z0-9]*$' + examples: + - "985123" + - "766554" + - "446332" + + CommodityId: + description: The commodity ID returned in the Import Export Compliance report. + type: string + maxLength: 50 + pattern: ^[\s\S]*$ + examples: + - "28b210b9-e686-4617-8cf4-9973e3ed4087" + - "8f971462-5e68-469a-809f-637a12af1305" + + ComplianceDetails: + description: This object contains details of specific compliance requirements and controls that are applicable to the shipment, based on whether it is for import or export purposes. + type: object + properties: + categoryType: + description: Whether the compliance assessment regards imports or exports + type: string + minLength: 6 + maxLength: 6 + enum: + - Import + - Export + controlTypes: + type: array + minItems: 1 + items: + $ref: "#/components/schemas/ControlTypes" + additionalProperties: false + required: + - categoryType + - controlTypes + + ControlDetails: + 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. + + **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: + - Controlling Authority + - Free Trade Agreement + controlDetailDescription: + description: A detailed description of the control measure, translated for the user as required. + type: string + maxLength: 4000 + pattern: '^[\s\S]*$' + examples: + - Trade Agreement between the United States and Canada (USMCA) + - Caribbean Basin Economic Recovery Act + additionalProperties: false + required: + - controlDetailName + - controlDetailDescription + + ControlTypes: + description: This object includes specific type of customs controls applicable to a shipment. + 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. + type: string + minLength: 1 + maxLength: 100 + pattern: ^[\s\S]*$ + 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. + type: string + maxLength: 50 + pattern: ^[\s\S]*$ + examples: + - DOC + - FTA + isRequired: + description: Whether shipment compliance with a specific control type is required + type: string + maxLength: 10 + enum: + - "Yes" + - Maybe + - Applicable + controlTypeMessage: + description: Additional guidance or instructions based on the specific control type condition. + type: string + minLength: 1 + maxLength: 4000 + pattern: ^[\s\S]*$ + examples: + - Import Certificate may be required + - Free Trade Agreement may be applicable + controlDetails: + description: An array that contains a list of control types and codes + type: array + minItems: 1 + items: + $ref: "#/components/schemas/ControlDetails" + additionalProperties: false + required: + - controlType + - controlTypeCode + - controlTypeMessage + - controlDetails + + CountryCodes: + description: The two-letter identification code for countries. + type: string + minLength: 2 + maxLength: 2 + pattern: ^[a-zA-Z0-9]{2}$ + examples: + - AU + - US + - UK + - FR + - JP + + CurrencyCodes: + description: |- + The three-letter code that represents the currency used to value the items in the shipment. + + | Supported enum values | + | :--------------------------- | + | `ARS`
Argentine Peso | + | `AUD`
Australian Dollar | + | `BRL`
Brazilian Real | + | `CAD`
Canadian Dollar | + | `CHF`
Swiss Franc | + | `CLP`
Chilean Peso | + | `CNY`
Chinese Yuan | + | `CRC`
Costa Rican Colon | + | `DKK`
Danish Krone | + | `DOP`
Dominican Peso | + | `EUR`
Euro | + | `GBP`
Great Britain Pound | + | `HKD`
Hong Kong Dollar | + | `INR`
India Rupee | + | `JPY`
Japanese Yen | + | `KRW`
Korean Won | + | `MXN`
Mexican Peso | + | `MYR`
Malaysian Ringgit | + | `NOK`
Norwegian Kroner | + | `NZD`
New Zealand Dollar | + | `PEN`
Peruvian Nuevo Sol | + | `PHP`
Philippine Peso | + | `PLN`
Polish Zloty | + | `SEK`
Swedish Krona | + | `SGD`
Singapore Dollar | + | `THB`
Thai Baht | + | `TWD`
Taiwan Dollar | + | `USD`
US Dollar | + | `VEB`
Venezuelan Bolivar | + type: string + minLength: 3 + maxLength: 3 + pattern: ^[a-zA-Z0-9]{3}$ + enum: + - ARS + - AUD + - BRL + - CAD + - CHF + - CLP + - CNY + - CRC + - DKK + - DOP + - EUR + - GBP + - HKD + - INR + - JPY + - KRW + - MXN + - MYR + - NOK + - NZD + - PEN + - PHP + - PLN + - SEK + - SGD + - THB + - TWD + - USD + - VEB + + DescriptionGuidanceResponse: + description: This object contains the system's results to a request for Description Guidance + type: object + properties: + isMatched: + description: Whether the description guidance service has matched a keyword from the shipment description + type: boolean + default: false + examples: + - true + - false + message: + description: A message with guidance on how to improve the shipment description + type: string + pattern: ^[\s\S]*$ + examples: + - DVD Player + - Stereo + sourceListName: + description: A list of terminology used to describe items from a particular regional source + type: string + maxLength: 250 + pattern: ^[\s\S]*$ + examples: + - USA + - France + - Germany + matchedKeyword: + description: The keyword(s) from the shipment description that matched the system criteria + type: string + maxLength: 250 + pattern: ^[\s\S]*$ + examples: + - goods + - clothing + - perishables + + ErrorResponse: + description: This object is the primary container for error responses. + type: object + properties: + response: + $ref: "#/components/schemas/ErrorResponseWrapper" + perfStats: + $ref: "#/components/schemas/ALPerfStats" + required: + - response + - perfStats + + ErrorResponseWrapper: + description: This object contains an array of error codes. + type: object + properties: + errors: + type: array + items: + $ref: '#/components/schemas/ErrorCode' + required: + - errors + + ErrorCode: + description: This object contains error codes, error descriptions and other error properties. + type: object + properties: + code: + description: The error code. + type: string + pattern: '^[a-zA-Z0-9\-_\.]+$' + examples: + - 400 + - 401 + - 404 + description: + description: Description of the error. + 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: + - 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: + - evaluateImportExportRequirements + - evaluatePoaRequirements + - evaluateImportExportRequirements + value: + description: The value that caused the error + type: string + pattern: ^[\s\S]*$ + examples: + - US + - EU + - NB + type: + description: |- + Specific operation the error message is relevant to. + + | Supported enum values | + | :------------------------------------- | + | `DG`
Description Guidance | + | `POA`
Power of Attorney Requirement | + | `IEC`
Import Export Compliance | + type: string + minLength: 2 + maxLength: 3 + enum: + - DG + - IEC + - POA + additionalProperties: false + + EvaluationCriteria: + description: |- + Criteria for evaluating POA requirements for both importer and exporter. Supported values: + + | Supported enum values | + | :-------------------------------------------------------------------------------------------------------------- | + | `NonConditional`
Standard evaluation without specific conditional criteria | + | `Description`
Evaluation based on the detailed description of the commodity | + | `FTA`
Free Trade Agreement. Evaluation considers Free Trade Agreement stipulations applicable to the shipment. | + | `Value`
Evaluation based on the monetary value of the commodities | + | `HTS`
Harmonized Tariff Schedule. Evaluation uses HTS codes for tariff classification and compliance | + | `Quantity`
Evaluation focuses on the quantity of the goods being shipped | + | `Weight`
Evaluation based on the weight of the shipment | + type: string + enum: + - NonConditional + - Description + - FTA + - Value + - HTS + - Quantity + - Weight + - HTS PGA + minLength: 3 + maxLength: 14 + pattern: ^[a-zA-Z0-9\-_\s:]+$ + + ExportAssureRequest: + description: This object is the primary request structure for the Export Assure API. + type: object + properties: + transID: + description: The unique, reference identifier that correlates an API request with its response + type: string + maxLength: 50 + pattern: ^[\s\S]*$ + examples: + - 10d622cc-a453-4054-bb62-ed71e6fc2239 + - 798fe81e-2f28-430d-96fd-d45f0c7fe36a + evaluateDescriptions: + description: Whether the user has requested description guidance + type: boolean + default: true + examples: + - true + - false + evaluatePoaRequirements: + description: Whether the user has requested Power of Attorney (POA) requirements + type: boolean + default: true + examples: + - true + - false + evaluateAdvancedImportExportRequirements: + description: Whether the user has requested an Advanced Import/Export Compliance review + type: boolean + default: false + examples: + - true + - false + evaluateImportExportRequirements: + description: Whether the user has requested an Import/Export Compliance review + type: boolean + default: true + examples: + - true + - false + shipment: + $ref: "#/components/schemas/ShipmentRequest" + additionalProperties: false + required: + - transID + - shipment + + ExportAssureResponse: + description: This object is the primary request container for the Export Assure API. + type: object + properties: + transID: + $ref: '#/components/schemas/TransactionID' + shipment: + $ref: "#/components/schemas/ShipmentResponse" + perfStats: + $ref: "#/components/schemas/ALPerfStats" + additionalProperties: false + required: + - transID + - shipment + - perfStats + ExportAssurePartialResponse: + description: This object is the primary response container for the Export Assure API. + type: object + properties: + transID: + $ref: '#/components/schemas/TransactionID' + shipment: + $ref: "#/components/schemas/ShipmentResponse" + response: + $ref: "#/components/schemas/ErrorResponseWrapper" + perfStats: + $ref: "#/components/schemas/ALPerfStats" + additionalProperties: false + required: + - transID + - shipment + - response + - perfStats + HsCode: + description: The [Harmonized System (HS) code](https://www.trade.gov/harmonized-system-hs-codes). Used commonly throughout the export process for goods, the Harmonized System is a standardized numerical method of classifying traded products. It is used by customs authorities to identify products when assessing duties and taxes. + type: string + maxLength: 13 + pattern: ^[0-9.]{4,13}$ + examples: + - "3605.00.00.00" + - "3605000000" + - "3925.90.00.00" + - "3925900000" + + ImportExportShipmentLevelResponse: + description: This object contains properties which describe the shipment's compliance with laws and regulations. + type: object + properties: + shipmentValue: + type: number + description: The total monetary value of all items included in the shipment + format: double + maximum: 999999999999.99 + examples: + - 1500.25 + - 456.99 + - 9977.00 + shipmentCurrencyCode: + description: The three-letter code of the currency used to value the items in the shipment. + $ref: '#/components/schemas/CurrencyCodes' + translationLocale: + $ref: "#/components/schemas/TranslationLocale" + hasShipmentWarnings: + description: Whether there are shipment-level warning. Shipment-level warnings include issues related to documentation and shipment packaging. + type: boolean + examples: + - true + - false + hasCommodityWarnings: + description: Whether there are compliance-related warnings or issues at the commodity level within the shipment. A `true` value indicates potential compliance concerns that require the shipper's attention. + type: boolean + examples: + - true + - false + commodityWarningsMessage: + description: The warning message returned when the `hasCommodityWarnings` flag is set to true + type: string + pattern: ^[\s\S]*$ + examples: + - Your shipment may have additional clearance considerations + - Some shipment items may be prohibited from import to the EU + isShipmentOverGiftValueThreshold: + type: boolean + description: Whether the total value of the shipment exceeds the allowable threshold for categorizing it as a gift + examples: + - true + - false + shipmentOverGiftValueThresholdMessage: + description: The message returned if the shipment's value surpasses the threshold for gift categorization + type: string + pattern: ^[\s\S]*$ + examples: + - "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided" + - "Your shipment may incur additional charges due to shipment value." + isShipmentOverGiftWeightThreshold: + description: Whether the total weight of the shipment exceeds the weight limit for being classified as a gift + type: boolean + examples: + - true + - false + shipmentOverGiftWeightThresholdMessage: + description: A message explaining the implications if the shipment's weight goes beyond the threshold for gift categorization, guiding users in understanding customs considerations. + type: string + pattern: ^[\s\S]*$ + examples: + - "Your shipment may not be considered as a gift by Customs authorities due to the shipment weight provided" + - "Your shipment may incur additional charges due to shipment weight." + additionalProperties: false + required: + - shipmentCurrencyCode + - hasShipmentWarnings + - hasCommodityWarnings + - isShipmentOverGiftValueThreshold + - isShipmentOverGiftWeightThreshold + + ImportExportItemLevelResponse: + description: This object includes details of the Import Export Compliance assessment. + type: object + properties: + isUpsProhibited: + description: Whether UPS prohibits shipment of the item + type: boolean + examples: + - true + - false + upsProhibitedMessage: + description: A message explaining the reason for any prohibited shipment + oneOf: + - type: 'null' + - type: string + pattern: ^[\s\S]*$ + examples: + - US federal law prohibits shipment of this item from the US. + - The EU prohibits import of this item. + isTranslatedIndicator: + description: Whether shipment details have been translated from the language of the origin country to the user's language + type: boolean + examples: + - true + - false + complianceOutput: + description: This array includes the output of the compliance review, including customs category and control codes. + type: array + minItems: 0 + items: + $ref: "#/components/schemas/ComplianceDetails" + additionalProperties: false + required: + - isUpsProhibited + - isTranslatedIndicator + + PowerOfAttorneyResponse: + description: This object includes details of the Power of Attorney (POA) requirements for the shipment. + type: object + properties: + importerPoaRequiredFlag: + description: Whether Power of Attorney (POA) is required for the importer + type: boolean + examples: + - true + - false + importerEvaluationCriteria: + $ref: "#/components/schemas/EvaluationCriteria" + importerPoaOnFileIndicator: + description: Whether the importer already has a POA on file + type: + - string + - "null" + maxLength: 3 + enum: + - "Yes" + - "No" + - null + importerCommodityId: + description: The first commodity in the shipment that necessitates an importer POA + $ref: '#/components/schemas/CommodityId' + importerCommodityDescription: + description: A description of the commodity regarding what led to the POA requirement for the importer + type: string + pattern: ^[\s\S]*$ + examples: + - EQUIPMENT + - COMPUTERS + - BICYCLES + exporterPoaRequiredFlag: + description: Whether the exporter is required to provide a POA for customs clearance. + type: boolean + examples: + - true + - false + exporterEvaluationCriteria: + description: This schema includes details of whether a POA is required for the exporter. + $ref: "#/components/schemas/EvaluationCriteria" + exporterPoaOnFileIndicator: + description: Whether the exporter has a POA already on file + type: + - string + - "null" + maxLength: 3 + enum: + - "Yes" + - "No" + - null + exporterCommodityId: + description: The first commodity in the shipment that necessitated an exporter POA + $ref: '#/components/schemas/CommodityId' + exporterCommodityDescription: + description: The commodity that triggers the POA requirement for the exporter + type: string + pattern: ^[\s\S]*$ + examples: + - Dynamite + exporterOnlineFormFlag: + description: Whether there is an online form available for the exporter to complete their POA documentation + type: boolean + examples: + - true + - false + exporterDocuSignTemplateId: + description: The ID of the DocuSign template, which the exporter can use for electronic completion of the POA. + type: string + maxLength: 100 + pattern: ^[a-zA-Z0-9\-_\s:]+$ + examples: + - f215a2b8-8fad-4610-b06e-76877ec3016c + - 8f971462-5e68-469a-809f-637a12af1305 + required: + - importerPoaRequiredFlag + - exporterPoaRequiredFlag + - exporterOnlineFormFlag + + ShipmentRequest: + description: This object contains all necessary details about a shipment for compliance evaluation. + type: object + properties: + importerName: + description: The name of the importer + type: string + pattern: ^[\s\S]*$ + maxLength: 100 + examples: + - Ford + - Acme + importerCity: + description: The city where the importer is located. Required if both importer's account number and importer's zip code are not provided and POA evaluation is requested. + type: string + maxLength: 100 + pattern: ^[\s\S]*$ + examples: + - Detroit + - Paris + - Amsterdam + - New York + importerZipcode: + description: The postal code of the importer's location. Required when the importer's account number and city are not specified and POA evaluation is requested. + type: string + pattern: ^[a-zA-Z0-9\-\s]+$ + examples: + - "48204" + - "46664" + importerAccountNumber: + description: The UPS account number of the importer + type: + - string + - "null" + pattern: '^[a-zA-Z0-9]*$' + minLength: 6 + maxLength: 10 + examples: + - "985123" + - "766554" + - "446332" + exporterName: + description: The name of the exporter. Required when the exporter's UPS account number is not available and POA requirements are under review. + type: string + pattern: ^[\s\S]*$ + maxLength: 100 + examples: + - Lear + - Acme + exporterCity: + description: The city from which the exporter operates. Required if exporter's account number and zip code are not given and POA evaluation is requested. + type: string + maxLength: 100 + pattern: ^[\s\S]*$ + examples: + - Windsor + - Paris + - Amsterdam + exporterZipcode: + description: The postal code of the exporter's location. Required when exporter's account number and city are not provided and POA evaluation is requested. + type: string + pattern: ^[a-zA-Z0-9\-\s]+$ + examples: + - "20836" + - "43322" + exporterAccountNumber: + description: The UPS account number of the exporter + type: string + pattern: '^[a-zA-Z0-9]*$' + maxLength: 20 + examples: + - "998562" + - "767839" + - "332532" + id: + description: The Shipment ID included on the Import Export compliance report. + $ref: '#/components/schemas/ShipmentId' + importCountryCode: + description: The [two-letter country code]() representing the destination country for the shipment + $ref: '#/components/schemas/CountryCodes' + exportCountryCode: + description: The [two-letter country code]() of the shipment's origin + $ref: '#/components/schemas/CountryCodes' + translationLocale: + description: The language and country-based preferences of the user. This includes translated texts, currency type, and unit of measurements. + $ref: "#/components/schemas/TranslationLocale" + transModes: + description: |- + Mode of transportation for the shipment. + + | Supported enum values | + |---------------------------------------------| + | `INT_AIR`
International Air Freight | + | `INT_OCEAN`
International Ocean Freight | + | `INT_RAIL`
International Rail Freight | + | `INT_TRUCK`
International Truck Freight | + | `DOM_AIR`
Domestic Air Freight | + | `DOM_OCEAN`
Domestic Ocean Freight | + | `DOM_RAIL`
Domestic Rail Freight | + | `DOM_TRUCK`
Domestic Truck Freight | + type: string + minLength: 7 + maxLength: 20 + enum: + - INT_AIR + - INT_OCEAN + - INT_RAIL + - INT_TRUCK + - DOM_AIR + - DOM_OCEAN + - DOM_RAIL + - DOM_TRUCK + shipmentType: + description: |- + Shipment type. + + | Supported enum values | + | :--------------------------------------------------------------------------------------------------- | + | `GIFT`
Items sent as gifts, typically for personal reasons. | + | `COMM`
Commercial goods or commodities, usually for business transactions. Sale, sample, repair. | + | `OTHR`
Return, Other, and Intercompany Data, Anything else not supported. | + | `PERS`
Personal items, often for relocation or personal use | + type: string + minLength: 4 + maxLength: 4 + enum: + - GIFT + - COMM + - OTHR + - PERS + shipmentDescription: + description: Description of the contents of the shipment. This description is required if the `evaluateDescriptions` flag is set to true. + type: string + maxLength: 2147483647 + pattern: ^[\s\S]*$ + examples: + - goods + - electronics + - machinery + grossWeight: + description: The gross weight of the entire Shipment. If this field is not specified, `grossWeightUnit` must be `null`. + type: number + format: decimal + maximum: 999999999999.99 + pattern: ^(\d{1,12})(\.\d{1,2})?$ + examples: + - 10.6 + - 25.6 + - 155.99 + grossWeightUnit: + description: Gross weight unit. Only required if there is a value for `grossWeight`; If `grossWeight` is not specified, this value must equal `null`. + type: + - string + - "null" + default: null + maxLength: 2 + enum: + - KG + - LB + - null + shipmentItems: + type: array + minItems: 1 + maxItems: 150 + items: + $ref: "#/components/schemas/ShipmentItemsRequest" + additionalProperties: false + required: + - id + - importCountryCode + - exportCountryCode + - shipmentType + - grossWeightUnit + - shipmentItems + + ShipmentResponse: + description: This object contains metadata about the shipment and includes the response objects for each of the three operations. + type: object + properties: + id: + $ref: '#/components/schemas/ShipmentId' + hasCommodityWarnings: + description: Whether there are compliance-related warnings or issues at the commodity level within the shipment. A `true` value indicates potential compliance concerns that require the shipper's attention. + type: boolean + examples: + - true + - false + descriptionGuidance: + $ref: "#/components/schemas/DescriptionGuidanceResponse" + poaCompliance: + $ref: "#/components/schemas/PowerOfAttorneyResponse" + importExportCompliance: + $ref: "#/components/schemas/ImportExportShipmentLevelResponse" + shipmentItems: + type: array + minItems: 1 + items: + $ref: "#/components/schemas/ShipmentItemsResponse" + additionalProperties: false + required: + - id + - hasCommodityWarnings + - shipmentItems + + ShipmentId: + description: A unique identifier assigned to the shipment as part of the API's compliance review process. + type: string + maxLength: 50 + pattern: ^(?!-)[0-9a-zA-Z-]{1,50}(?English | + | `DE`
Germany | + | `PL`
Polish | + | `FR`
French | + | `IT`
Italian | + | `NL`
Dutch | + | `ES`
Spanish | + | `ZH`
Simplified Chinese | + type: string + minLength: 2 + maxLength: 2 + enum: + - EN + - DE + - PL + - FR + - IT + - NL + - ES + - ZH + default: EN + + ALPerfStats: + type: object + properties: + absLayerTime: + type: string + description: Time taken through the abstraction layer in milliseconds. + examples: + - "13440" + - "44324" + fulfillTime: + type: string + description: Request completed time. + examples: + - Sun Nov 19 10:42:46.145 -05:00 2023 + - Mon Nov 20 12:16:26.600 -05:00 2023 + receiptTime: + type: string + description: Request receipt time + examples: + - Sun Nov 19 10:42:32.705 -05:00 2023 + - Mon Nov 20 12:12:26.600 -05:00 2023 + additionalProperties: false + required: + - absLayerTime + - fulfillTime + - receiptTime + + SuccessResponseHeaders: + description: The headers that are returned for all error responses. + type: object + required: + - x-request-id + - BkndTransId + properties: + x-request-id: + description: The APIGEE transaction id. + type: string + example: d774b047-e945-4db6-8468-ea4e65fa61c4 + BkndTransId: + description: The backend transaction id. + type: string + example: UJ0001 + x-api-success-count: + description: Indicate the number of charges for the API call. + type: string + example: '1' + + GatewayErrorResponseHeaders: + description: The headers returned from the gateway + type: object + required: + - x-request-id + properties: + x-request-id: + type: string + description: The gateway transaction id. + example: d774b047-e945-4db6-8468-ea4e65fa61c4 + + BackendErrorResponseHeaders: + description: The headers that are returned from the backend and gateway + $ref: '#/components/schemas/GatewayErrorResponseHeaders' + required: + - bkndtransid + - apierrorcode + - apierrormsg + properties: + bkndtransid: + description: The backend transaction id. + type: string + apierrorcode: + description: The API error code. + type: string + example: UJ0001 + apierrormsg: + description: The API error message. + type: string + example: Invalid token or token is not present. + + parameters: + AccountNumber: + in: header + name: accountNumber + description: UPS account number for shipper or user + required: false + schema: + $ref: '#/components/schemas/AccountNumber' + TransactionSrc: + in: header + name: transactionSrc + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + Accept: + in: header + name: Accept + required: true + description: The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand. + schema: + type: string + Content-Type: + in: header + name: Content-Type + required: true + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + + examples: + sample-description-guidance-request: + summary: Description Guidance Request + value: + transID: c5d87df5-ac58-4ff7-9f96-103debe66496 + evaluateDescriptions: true + evaluatePoaRequirements: false + evaluateImportExportRequirements: false + shipment: + id: 47cb07b6-69f1-4ded-95ff-953fee2667de + importCountryCode: CA + exportCountryCode: US + translationLocale: EN + transModes: INT_AIR + shipmentType: GIFT + shipmentDescription: gifts + grossWeight: 15 + grossWeightUnit: KG + shipmentItems: + - commodityId: 47cb07b6-69f1-4ded-95ff-953fee2667de + eccn: EAR99 + hsCode: 6109.10.0004 + description: t-shirts + originCountryCode: US + amountValue: 1200 + currencyCode: USD + quantity: 5 + UOM: Dozen + - commodityId: 47cb07b6-69f1-4ded-95ff-953fee2667de + eccn: EAR99 + hsCode: 6109.10.0042 + description: t-shirts + originCountryCode: US + amountValue: 2400 + currencyCode: USD + quantity: 10 + UOM: Dozen + sample-poa-guidance-request: + summary: POA Guidance Request + value: + transID: c5d87df5-ac58-4ff7-9f96-103debe66496 + evaluateDescriptions: false + evaluatePoaRequirements: false + evaluateImportExportRequirements: true + shipment: + importerName: Ford + importerCity: Detroit + importerZipcode: "48204" + exporterName: Lear + exporterCity: Windsor + exporterZipcode: "56325" + exporterAccountNumber: "9687452" + importerAccountNumber: "9952736" + id: "47cb07b6-69f1-4ded-95ff-953fee2667de" + importCountryCode: "CA" + exportCountryCode: "US" + translationLocale: "EN" + transModes: "INT_AIR" + shipmentType: "COMM" + shipmentDescription: "gifts" + grossWeight: 15 + grossWeightUnit: "KG" + shipmentItems: + - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" + eccn: "EAR99" + hsCode: "6109.10.0004" + description: "t-shirts" + originCountryCode: "US" + amountValue: 1200 + currencyCode: "USD" + quantity: 5 + UOM: "Dozen" + - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" + eccn: "EAR99" + hsCode: "6109.10.0042" + description: "t-shirts" + originCountryCode: "CU" + amountValue: 2400 + currencyCode: "USD" + quantity: 10 + UOM: "Dozen" + sample-import-export-compliance-request: + summary: Import Export Compliance Request + value: + transID: c5d87df5-ac58-4ff7-9f96-103debe66496 + evaluateDescriptions: false + evaluatePoaRequirements: false + evaluateImportExportRequirements: true + shipment: + id: "47cb07b6-69f1-4ded-95ff-953fee2667de" + importCountryCode: "CA" + exportCountryCode: "US" + translationLocale: "EN" + transModes: "INT_AIR" + shipmentType: "COMM" + grossWeight: 15 + grossWeightUnit: "KG" + shipmentItems: + - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" + eccn: "EAR99" + hsCode: "6109.10.0004" + description: "t-shirts" + originCountryCode: "US" + amountValue: 1200 + currencyCode: "USD" + quantity: 5 + UOM: "Dozen" + - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" + eccn: "EAR99" + hsCode: "6109.10.0042" + description: "t-shirts" + originCountryCode: "CU" + amountValue: 2400 + currencyCode: "USD" + quantity: 10 + UOM: "Dozen" + sample-all-guidance-request: + summary: All Guidance Request + value: + transID: "c5d87df5-ac58-4ff7-9f96-103debe66496" + evaluateDescriptions: true + evaluatePoaRequirements: true + evaluateImportExportRequirements: true + shipment: + importerName: "Ford" + importerCity: "Detroit" + importerZipcode: "48204" + exporterName: "Lear" + exporterCity: "Windsor" + exporterZipcode: "56325" + exporterAccountNumber: "9687452" + importerAccountNumber: "9952736" + id: "47cb07b6-69f1-4ded-95ff-953fee2667de" + importCountryCode: "CA" + exportCountryCode: "US" + translationLocale: "EN" + transModes: "INT_AIR" + shipmentType: "COMM" + shipmentDescription: "shirts" + grossWeight: 15 + grossWeightUnit: "KG" + shipmentItems: + - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" + eccn: "EAR99" + hsCode: "6109.10.0004" + description: "t-shirts" + originCountryCode: "US" + amountValue: 1200 + currencyCode: "USD" + quantity: 5 + UOM: "Dozen" + - commodityId: "47cb07b6-69f1-4ded-95ff-953fee2667de" + eccn: "EAR99" + hsCode: "6109.10.0042" + description: "t-shirts" + originCountryCode: "CU" + amountValue: 2400 + currencyCode: "USD" + quantity: 10 + UOM: "Dozen" + sample-description-guidance-response: + summary: Description Guidance Response + value: + transID: 28b210b9-e686-4617-8cf4-9973e3ed4087 + shipment: + id: "a5de8df8-0ada-45d6-ae36-b7dbc4d6f127" + hasCommodityWarnings: true + descriptionGuidance: + isMatched: true + message: "Men's and women's cotton sport shirts" + sourceListName: "global" + matchedKeyword: "Gift" + poaCompliance: + importerPoaRequiredFlag: true + importerEvaluationCriteria: "Description" + importerPoaOnFileIndicator: "Yes" + importerCommodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" + importerCommodityDescription: 't-shirts' + exporterPoaRequiredFlag: true + exporterEvaluationCriteria: "Description" + exporterPoaOnFileIndicator: "Yes" + exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' + exporterCommodityDescription: 't-shirts' + exporterOnlineFormFlag: true + exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" + importExportCompliance: + shipmentValue: 3600 + shipmentCurrencyCode: "USD" + translationLocale: "EN" + hasShipmentWarnings: true + hasCommodityWarnings: true + commodityWarningsMessage: "Your shipment may have compliance considerations; see below for additional detail" + isShipmentOverGiftValueThreshold: true + shipmentOverGiftValueThresholdMessage: "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided" + isShipmentOverGiftWeightThreshold: false + shipmentOverGiftWeightThresholdMessage: '' + shipmentItems: + - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" + hsCode: "6109.10.0004" + description: "t-shirts" + - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" + hsCode: "6109.10.0042" + description: "t-shirts" + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + sample-poa-guidance-response: + summary: POA Guidance Response + value: + transID: "28b210b9-e686-4617-8cf4-9973e3ed4087" + shipment: + id: "47cb07b6-69f1-4ded-95ff-953fee2667de" + hasCommodityWarnings: true + descriptionGuidance: + isMatched: false + message: "" + sourceListName: "global" + matchedKeyword: "Gift" + importExportCompliance: + shipmentValue: 3600 + shipmentCurrencyCode: "USD" + translationLocale: "EN" + hasShipmentWarnings: true + hasCommodityWarnings: true + isShipmentOverGiftValueThreshold: true + shipmentOverGiftValueThresholdMessage: "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided." + isShipmentOverGiftWeightThreshold: false + shipmentOverGiftWeightThresholdMessage: '' + commodityWarningsMessage: "Your shipment may have compliance considerations see below for additional detail" + poaCompliance: + importerPoaRequiredFlag: true + importerEvaluationCriteria: "Description" + importerPoaOnFileIndicator: "Yes" + importerCommodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" + importerCommodityDescription: 't-shirts' + exporterPoaRequiredFlag: true + exporterEvaluationCriteria: 'Description' + exporterPoaOnFileIndicator: "Yes" + exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' + exporterCommodityDescription: 't-shirts' + exporterOnlineFormFlag: true + exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" + shipmentItems: + - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" + hsCode: "6109.10.0004" + description: "t-shirts" + - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" + hsCode: "6109.10.0042" + description: "t-shirts" + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + sample-import-export-compliance-response: + summary: Import Export Compliance Response + value: + transID: "28b210b9-e686-4617-8cf4-9973e3ed4087" + shipment: + id: "47cb07b6-69f1-4ded-95ff-953fee2667de" + hasCommodityWarnings: true + importExportCompliance: + shipmentValue: 3600 + shipmentCurrencyCode: "USD" + translationLocale: "EN" + hasShipmentWarnings: true + hasCommodityWarnings: true + isShipmentOverGiftValueThreshold: true + shipmentOverGiftValueThresholdMessage: Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided. + isShipmentOverGiftWeightThreshold: false + shipmentOverGiftWeightThresholdMessage: '' + commodityWarningsMessage: "Your shipment may have compliance considerations see below for additional detail" + shipmentItems: + - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" + hsCode: "6109.10.0004" + description: t-shirts + importExportCompliance: + isUpsProhibited: false + upsProhibitedMessage: '' + isTranslatedIndicator: false + complianceOutput: + - categoryType: "Export" + controlTypes: + - controlType: "Embargo/Sanction" + controlTypeCode: "Embargo/Sanction" + isRequired: 'Yes' + controlTypeMessage: "Embargo/Sanction required" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." + - controlType: "Document" + controlTypeCode: "DOC" + isRequired: "Maybe" + controlTypeMessage: "Document may be required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Miscellaneous Controls - Notification" + controlTypeCode: "Miscellaneous Controls" + isRequired: "Maybe" + controlTypeMessage: "Miscellaneous controls may be required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Free Trade Agreement" + controlTypeCode: "FTA" + isRequired: "Maybe" + controlTypeMessage: "Free Trade Agreement may be Applicable" + controlDetails: + - controlDetailName: '' + controlDetailDescription: Caribbean Basin Economic Recovery Act + - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" + hsCode: "6109.10.0042" + description: "t-shirts" + importExportCompliance: + isUpsProhibited: false + upsProhibitedMessage: '' + isTranslatedIndicator: false + complianceOutput: + - categoryType: "Export" + controlTypes: + - controlType: "Embargo/Sanction" + controlTypeCode: "Embargo/Sanction" + isRequired: 'Yes' + controlTypeMessage: "Embargo/Sanction required" + controlDetails: + - controlDetailName: 'f' + controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." + - controlType: "Document" + controlTypeCode: "DOC" + isRequired: "Maybe" + controlTypeMessage: "Document maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Miscellaneous Controls - Notification" + controlTypeCode: "Miscellaneous Controls" + isRequired: "Maybe" + controlTypeMessage: "Miscellaneous Controls Maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Free Trade Agreement" + controlTypeCode: "FTA" + isRequired: "Maybe" + controlTypeMessage: "Free Trade Agreement Maybe Applicable" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "Caribbean Basin Economic Recovery Act" + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + sample-all-guidance-response: + summary: All Guidance Response + value: + transID: "28b210b9-e686-4617-8cf4-9973e3ed4087" + shipment: + id: "47cb07b6-69f1-4ded-95ff-953fee2667de" + hasCommodityWarnings: true + importExportCompliance: + shipmentValue: 3600 + shipmentCurrencyCode: "USD" + translationLocale: "EN" + hasShipmentWarnings: true + hasCommodityWarnings: true + isShipmentOverGiftValueThreshold: true + shipmentOverGiftValueThresholdMessage: "Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided." + isShipmentOverGiftWeightThreshold: false + shipmentOverGiftWeightThresholdMessage: '' + commodityWarningsMessage: "Your shipment may have compliance considerations see below for additional detail" + descriptionGuidance: + isMatched: true + message: "Men's and women's cotton sport shirts" + sourceListName: global + matchedKeyword: "Gift" + poaCompliance: + importerPoaRequiredFlag: true + importerEvaluationCriteria: "Description" + importerPoaOnFileIndicator: "Yes" + importerCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' + importerCommodityDescription: 't-shirts' + exporterPoaRequiredFlag: true + exporterEvaluationCriteria: 'Description' + exporterPoaOnFileIndicator: "Yes" + exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' + exporterCommodityDescription: 't-shirts' + exporterOnlineFormFlag: true + exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" + shipmentItems: + - commodityId: "8e369c86-6c1f-4fbd-bd0c-55de5107e5ff" + hsCode: "6109.10.0004" + description: "t-shirts" + importExportCompliance: + isUpsProhibited: false + upsProhibitedMessage: '' + isTranslatedIndicator: false + complianceOutput: + - categoryType: "Export" + controlTypes: + - controlType: "Embargo/Sanction" + controlTypeCode: "Embargo/Sanction" + isRequired: 'Yes' + controlTypeMessage: "Embargo/Sanction required" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." + - controlType: "Document" + controlTypeCode: "DOC" + isRequired: "Maybe" + controlTypeMessage: "Document maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Miscellaneous Controls - Notification" + controlTypeCode: "Miscellaneous Controls" + isRequired: "Maybe" + controlTypeMessage: "Miscellaneous Controls Maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Free Trade Agreement" + controlTypeCode: "FTA" + isRequired: "Maybe" + controlTypeMessage: "Free Trade Agreement Maybe Applicable" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "Caribbean Basin Economic Recovery Act" + - commodityId: "6604a366-0371-4e4f-9bf8-5595b016365e" + hsCode: "6109.10.0042" + description: "t-shirts" + importExportCompliance: + isUpsProhibited: false + upsProhibitedMessage: '' + isTranslatedIndicator: false + complianceOutput: + - categoryType: "Export" + controlTypes: + - controlType: "Embargo/Sanction" + controlTypeCode: "Embargo/Sanction" + isRequired: "Yes" + controlTypeMessage: "Embargo/Sanction required" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." + - controlType: "Document" + controlTypeCode: "DOC" + isRequired: "Maybe" + controlTypeMessage: "Document maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Miscellaneous Controls - Notification" + controlTypeCode: "Miscellaneous Controls" + isRequired: "Maybe" + controlTypeMessage: "Miscellaneous Controls Maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Free Trade Agreement" + controlTypeCode: "FTA" + isRequired: "Maybe" + controlTypeMessage: "Free Trade Agreement Maybe Applicable" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "Caribbean Basin Economic Recovery Act" + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + sample-partial-response: + summary: "Example of a partial success transaction" + value: + transID: "WSCM003769601129231354517251D4CF" + shipment: + id: "WSEXPID20231129135451752" + hasCommodityWarnings: true + descriptionGuidance: + isMatched: true + message: "DVD Player Stereo" + sourceListName: "US origin" + matchedKeyword: "GOODS" + poaCompliance: + importerPoaRequiredFlag: true + importerEvaluationCriteria: "Description" + importerPoaOnFileIndicator: "Yes" + importerCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' + importerCommodityDescription: 't-shirts' + exporterPoaRequiredFlag: true + exporterEvaluationCriteria: 'Description' + exporterPoaOnFileIndicator: "Yes" + exporterCommodityId: '8e369c86-6c1f-4fbd-bd0c-55de5107e5ff' + exporterCommodityDescription: 't-shirts' + exporterOnlineFormFlag: true + exporterDocuSignTemplateId: "c0375e04-0c6e-4e56-b01d-30b2f4b613bd" + importExportCompliance: + shipmentValue: 2365 + shipmentCurrencyCode: "USD" + translationLocale: "EN" + hasShipmentWarnings: false + hasCommodityWarnings: false + commodityWarningsMessage: "sample message" + isShipmentOverGiftValueThreshold: false + shipmentOverGiftValueThresholdMessage: "sample message" + isShipmentOverGiftWeightThreshold: false + shipmentOverGiftWeightThresholdMessage: "sample message" + shipmentItems: + - commodityId: "1" + hsCode: "900150" + description: "DESCRIPTION" + descriptionGuidance: + isMatched: true + message: "provide a color and size" + sourceListName: "Global" + matchedKeyword: "DESCRIPTION" + importExportCompliance: + isUpsProhibited: false + upsProhibitedMessage: '' + isTranslatedIndicator: false + complianceOutput: + - categoryType: "Export" + controlTypes: + - controlType: "Embargo/Sanction" + controlTypeCode: "Embargo/Sanction" + isRequired: 'Yes' + controlTypeMessage: "Embargo/Sanction required" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "United States Embargo - Office of Foreign Assets Control:Goods or services of Cuban origin may not be imported into the United States either directly or through third countries, such as Canada or Mexico. The exceptions are: publications, artwork, or other informational materials. This embargo supersedes any other regulations. Reference source: Electronic Code of Federal Regulations Title 31 Part 515." + - controlType: "Document" + controlTypeCode: "DOC" + isRequired: "Maybe" + controlTypeMessage: "Document maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Miscellaneous Controls - Notification" + controlTypeCode: "Miscellaneous Controls" + isRequired: "Maybe" + controlTypeMessage: "Miscellaneous Controls Maybe required" + controlDetails: + - controlDetailName: "DocuSignFormId" + controlDetailDescription: "Trade Agreement between the United States and Canada (USMCA)" + - controlType: "Free Trade Agreement" + controlTypeCode: "FTA" + isRequired: "Maybe" + controlTypeMessage: "Free Trade Agreement Maybe Applicable" + controlDetails: + - controlDetailName: '' + controlDetailDescription: "Caribbean Basin Economic Recovery Act" + response: + errors: + - code: "105.305" + description: INVALID_FIELD_VALUE + field: shipment.shipmentItems[0].UOM + message: UOM is not valid + value: Liter + type: POA + perfStats: + absLayerTime: "575" + fulfillTime: Sun Mar 10 20:14:35.906 -04:00 2024 + receiptTime: Sun Mar 10 20:14:35.331 -04:00 2024 + + cie-success-response: + summary: "Example of a CIE success transaction" + value: + transID: "1234" + shipment: + id: "1234" + hasCommodityWarnings: true + descriptionGuidance: + isMatched: true + message: DVD Player Stereo + sourceListName: US destination + matchedKeyword: GOODS + poaCompliance: + importerPoaRequiredFlag: true + importerEvaluationCriteria: HTS PGA + importerPoaOnFileIndicator: No + importerCommodityId: Test102 + importerCommodityDescription: EQUIPMENTS + exporterPoaRequiredFlag: false + exporterEvaluationCriteria: Value + exporterPoaOnFileIndicator: Yes + exporterCommodityId: order_2 + exporterCommodityDescription: computers + exporterOnlineFormFlag: false + exporterDocuSignTemplateId: 3c499118-346d-41d8-99db-faf852b77888 + importExportCompliance: + shipmentValue: 2.00 + shipmentCurrencyCode: USD + translationLocale: EN + hasShipmentWarnings: true + hasCommodityWarnings: true + commodityWarningsMessage: Your shipment may have additional clearance considerations see below for detail + isShipmentOverGiftValueThreshold: true + shipmentOverGiftValueThresholdMessage: Your shipment may not be considered as a gift by Customs authorities due to the shipment value provided. + isShipmentOverGiftWeightThreshold: true + shipmentOverGiftWeightThresholdMessage: Your shipment may not be considered as a gift by Customs authorities due to the shipment weight provided. + shipmentItems: + - commodityId: Test101 + hsCode: "2106909999" + description: tshirt + descriptionGuidance: + isMatched: true + message: Men's Shirts Lingerie Girls' Vests Boys' Jackets + sourceListName: Global + matchedKeyword: tshirt + importExportCompliance: + isUpsProhibited: false + upsProhibitedMessage: null + isTranslatedIndicator: false + complianceOutput: + - categoryType: Import + controlTypes: + - controlType: Free Trade Agreement + controlTypeCode: FTA + isRequired: Maybe + controlTypeMessage: Free Trade Agreement may apply + controlDetails: + - controlDetailName: Controlling Authority + controlDetailDescription: Country A - Country B Comprehensive Economic and Trade Agreement + perfStats: + absLayerTime: "2322" + fulfillTime: Tue Mar 19 12:29:16.523 -04:00 2024 + receiptTime: Tue Mar 19 12:29:14.201 -04:00 2024 diff --git a/UPSTrackAlert-Ready.yaml b/UPSTrackAlert-Ready.yaml index fdc31c8..001694a 100644 --- a/UPSTrackAlert-Ready.yaml +++ b/UPSTrackAlert-Ready.yaml @@ -1,732 +1,731 @@ -openapi: 3.1.0 -info: - title: UPS Track Alert API - description: | - - # Product Info - - The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. - 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, please visit the Product Info page. -
- - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - -
- - Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub. - - - Run In Postman - - Open in GitHub - - - # Business Values - - - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. - - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. - - **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. - - # Reference - - Appendix - - Track Alert Best Practices - - # FAQs - - - **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. - - - **What type of packages does Track Alert support? - > Track Alert supports UPS packages that have a 1Z tracking number. - - - **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. - - - **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. - - - **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. - - - **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), - 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 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. - - - **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 - 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) - activity location city - activity location state/province - activity location postal code (this field is blank until the delivery event occurs) - activity location country - activity status type - activity status code - activity status description - activity status description code - local activity date - local activity time - GMT activity date - GMT activity time - delivery start time (example '150000') - delivery end time (example '170000') - delivery time description (example 'estimated delivery window' or 'end of day') - 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.) - - # Overview - When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. - - Successful responses may or may not include warnings. - 1. **Without warnings** - Indicates the request has been processed as anticipated. - 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. - - The severity of an error may be transient or hard. - 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. - 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. - - The following error codes can apply to all APIs. - - # Error Codes - - | **Code** | **HTTP Code** | **Severity** | **Description** | - | :--: | :---: | :---: | :-- | - | UJ0001 | 401 | Hard | Invalid token or token is not present | - | 405 | 405 | Hard | Method Not Allowed. | - | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | - | 10007 | 400 | Hard | Requested Content Type is not supported | - | 250002 | 401 | Hard | Invalid authentication information. | - | 251004 | 401 | Hard | Bearer Token expired (oauth) | - | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | - | VSS002 | 400 | Hard | Missing transId | - | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | - | VSS004 | 400 | Hard | Missing transactionSrc | - | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | - | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | - | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | - | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | - | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | - | VSS215 | 400 | Hard | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. | - | VSS220 | 400 | Hard | 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 | Hard | Locale is required. The Subscription request has been rejected. | - | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | - | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | - | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | - | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | - | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | - | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | - | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | - | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | - - -servers: - - url: https://wwwcie.ups.com/api/track/{version} - description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/track/{version} - description: UPS Production OAuth. - variables: - version: - default: v1 - enum: - - v1 -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. - - 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 - summary: API to create subscriptions by tracking numbers. - operationId: processSubscriptionTypeForTrackingNumber - security: - - OAuth2: [] - parameters: - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceRequest' - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceResponse' - examples: - PartialSuccessExample: - description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. - value: - validTrackingNumbers: - - 1Z12345678912345560 - invalidTrackingNumbers: - - 1Z1234567$8 - CompleteSuccessExample: - description: Example response that contains valid tracking numbers for which subscription created. - value: - validTrackingNumbers: - - 1Z12345678912345560 - '400': - description: Invalid Request - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - response: - errors: - - code: VSS300 - message: Locale is required. The Subscription request has been rejected. - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: UJ0001 - message: Invalid token or token is not present. - '404': - description: URL does not exist or resource not found. - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "404" - message: The requested resource was not found. - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '405': - description: Method Not Allowed - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "405" - message: The requested method is not allowed for this resource. - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: "10004" - message: Internal Server Error -webhooks: - TrackingEvent: - post: - summary: Tracking Event - description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. - tags: - - UPS Track Alert - parameters: - - name: credential - in: header - description: It is an opaque string meant for client authentication. Shared in Subscription request. - required: true - schema: - type: string - - name: User-Agent - in: header - description: Represents Track Alert application with value 'UPSPubSubTrackingService'. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackingEventRequest' - examples: - '1': - summary: Manifest (label created or billing information received) message - value: - activityLocation: - city: '' - country: US - postalCode: '' - stateProvince: '' - activityStatus: - code: MP - description: Shipment Ready for UPS - descriptionCode: '003' - type: M - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: '' - gmtActivityDate: '20240422' - gmtActivityTime: '041230' - localActivityDate: '20240422' - localActivityTime: '091230' - scheduledDeliveryDate: '' - trackingNumber: " 1ZABCXYZ0112346789" - '2': - summary: UPS has your package message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: OR - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '012901' - localActivityDate: '20240422' - localActivityTime: '212901' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - '3': - summary: On the way (arrival or departure from a UPS building) message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: DP - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '025400' - localActivityDate: '20240422' - localActivityTime: '225400' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - '4': - summary: Preparing for delivery message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '003052' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '043052' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - '5': - summary: Preparing for delivery/loaded on vehicle message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '063936' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '103936' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - '6': - summary: Out for delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '091519' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: OT - description: Out for Delivery - descriptionCode: '021' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '131519' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - '7': - summary: Delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '095004' - activityLocation: - city: CHARLOTTE - stateProvince: NC - postalCode: '28209' - country: US - activityStatus: - type: D - code: FS - description: Delivered - scheduledDeliveryDate: '20191014' - gmtActivityDate: '20240423' - gmtActivityTime: '135004' - actualDeliveryDate: '20240423' - actualDeliveryTime: '095004' - responses: - '200': - description: Return a 200 status to indicate that the data was received successfully -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - "Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - Destination: - type: object - description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. - required: - - url - - credentialType - - credential - properties: - url: - type: string - format: url - description: | - It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. - If this endpoint is not continuously available, incoming events will be lost. - example: "https://your-webhook-url.com" - credentialType: - type: string - description: It is an open-entry field that indicates type of credentials supported by the client. - example: Bearer - credential: - type: string - description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. - TrackSubsServiceRequest: - required: - - locale - - trackingNumberList - - destination - type: object - properties: - locale: - type: string - description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. - pattern: '^[a-z]{2}_[A-Z]{2}$' - example: en_US - countryCode: - type: string - description: Represents the country code. This field is reserved for future use. - example: US - trackingNumberList: - type: array - description: Represents list of tracking numbers in request. - maxItems: 100 - example: - - 1ZCIETST0111111114 - - 1ZCIETST0422222228 - items: - type: string - pattern: '^1Z[0-9A-Z]{16}$' - description: Represents tracking numbers starting with '1Z', followed by 16 alphanummeric characters in request. - destination: - $ref: '#/components/schemas/Destination' - ErrorMessage: - type: object - description: The error response containing any errors that occurred - properties: - code: - type: string - description: The error code. - example: VSS300 - message: - type: string - description: The error message. - example: Locale is required. The Subscription request has been rejected. - TrackSubsServiceResponse: - type: object - properties: - validTrackingNumbers: - type: array - description: List of tracking numbers with successful subscription created. - items: - type: string - example: - - 1Z1234567891234556 - - 1ZABCDEFH91234556 - invalidTrackingNumbers: - type: array - description: List of tracking numbers associated with errors preventing subscription creation. - items: - type: string - example: - - 1Z1234567$8 - TrackSubsServiceErrorResponse: - type: object - properties: - response: - $ref: '#/components/schemas/ErrorResponse' - invalidTrackingNumbers: - $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" - required: - - response - ErrorResponse: - type: object - properties: - errors: - type: array - description: The error response containing any errors that occurred. - items: - $ref: '#/components/schemas/ErrorMessage' - TrackingEventRequest: - required: - - trackingNumber - - activityStatus - type: object - description: Package event update payload. - properties: - trackingNumber: - type: string - description: The package's tracking number. - pattern: '^1Z[0-9A-Z]{16}$' - example: 1Z1234567891234556 - localActivityDate: - type: string - description: 'The localized date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - localActivityTime: - type: string - description: 'The localized time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - activityLocation: - "$ref": "#/components/schemas/ActivityLocation" - activityStatus: - "$ref": "#/components/schemas/ActivityStatus" - scheduledDeliveryDate: - type: string - description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryDate: - type: string - description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryTime: - type: string - description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - gmtActivityDate: - type: string - description: 'The GMT date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - gmtActivityTime: - type: string - description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryStartTime: - type: string - description: 'The start time of a delivery. Format: HHMMSS (24 hr).' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryEndTime: - type: string - description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryTimeDescription: - type: string - description: The date of this delivery detail. - ActivityLocation: - type: object - description: The container which has the current package activity location. - properties: - city: - type: string - description: The physical address city. - example: Alpharetta - stateProvince: - type: string - description: The physical address state or province. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: GA - postalCode: - type: string - description: The physical address postal code (This field is blank until the delivery event occurs). - minLength: 5 - maxLength: 9 - pattern: ^\d{5}(?:[-\s]\d{4})?$ - examples: - - "30004" - - "30004-4616" - country: - type: string - description: The physical address country. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2} - example: US - ActivityStatus: - type: object - description: The container which has the current package activity status. - properties: - type: - type: string - 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 | - code: - type: string - description: The current activity status code. See the 'Status Codes' document for more details. - description: - type: string - description: The current activity status description. - +openapi: 3.1.0 +info: + title: UPS Track Alert API + description: | + + # Product Info + + The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. + 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, please visit the Product Info page. +
+ + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + +
+ + Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub. + + + Run In Postman + + Open in GitHub + + + # Business Values + + - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. + - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. + - **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. + + # Reference + - Appendix + - Track Alert Best Practices + + # FAQs + + - **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. + + - **What type of packages does Track Alert support? + > Track Alert supports UPS packages that have a 1Z tracking number. + + - **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. + + - **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. + + - **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. + + - **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), + 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 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. + + - **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 + 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) + activity location city + activity location state/province + activity location postal code (this field is blank until the delivery event occurs) + activity location country + activity status type + activity status code + activity status description + activity status description code + local activity date + local activity time + GMT activity date + GMT activity time + delivery start time (example '150000') + delivery end time (example '170000') + delivery time description (example 'estimated delivery window' or 'end of day') + 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.) + + # Overview + When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. + + Successful responses may or may not include warnings. + 1. **Without warnings** - Indicates the request has been processed as anticipated. + 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. + + The severity of an error may be transient or hard. + 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. + 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. + + The following error codes can apply to all APIs. + + # Error Codes + + | **Code** | **HTTP Code** | **Severity** | **Description** | + | :--: | :---: | :---: | :-- | + | UJ0001 | 401 | Hard | Invalid token or token is not present | + | 405 | 405 | Hard | Method Not Allowed. | + | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | + | 10007 | 400 | Hard | Requested Content Type is not supported | + | 250002 | 401 | Hard | Invalid authentication information. | + | 251004 | 401 | Hard | Bearer Token expired (oauth) | + | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | + | VSS002 | 400 | Hard | Missing transId | + | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | + | VSS004 | 400 | Hard | Missing transactionSrc | + | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | + | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | + | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | + | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | + | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | + | VSS215 | 400 | Hard | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. | + | VSS220 | 400 | Hard | 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 | Hard | Locale is required. The Subscription request has been rejected. | + | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | + | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | + | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | + | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | + | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | + | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | + | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | + | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | + + +servers: + - url: https://wwwcie.ups.com/api/track/{version} + description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/track/{version} + description: UPS Production OAuth. + variables: + version: + default: v1 + enum: + - v1 +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. + + 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 + summary: API to create subscriptions by tracking numbers. + operationId: processSubscriptionTypeForTrackingNumber + security: + - OAuth2: [] + parameters: + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceRequest' + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceResponse' + examples: + PartialSuccessExample: + description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. + value: + validTrackingNumbers: + - 1Z12345678912345560 + invalidTrackingNumbers: + - 1Z1234567$8 + CompleteSuccessExample: + description: Example response that contains valid tracking numbers for which subscription created. + value: + validTrackingNumbers: + - 1Z12345678912345560 + '400': + description: Invalid Request + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + response: + errors: + - code: VSS300 + message: Locale is required. The Subscription request has been rejected. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: UJ0001 + message: Invalid token or token is not present. + '404': + description: URL does not exist or resource not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "404" + message: The requested resource was not found. + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '405': + description: Method Not Allowed + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "405" + message: The requested method is not allowed for this resource. + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: "10004" + message: Internal Server Error +webhooks: + TrackingEvent: + post: + summary: Tracking Event + description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. + tags: + - UPS Track Alert + parameters: + - name: credential + in: header + description: It is an opaque string meant for client authentication. Shared in Subscription request. + required: true + schema: + type: string + - name: User-Agent + in: header + description: Represents Track Alert application with value 'UPSPubSubTrackingService'. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackingEventRequest' + examples: + '1': + summary: Manifest (label created or billing information received) message + value: + activityLocation: + city: '' + country: US + postalCode: '' + stateProvince: '' + activityStatus: + code: MP + description: Shipment Ready for UPS + descriptionCode: '003' + type: M + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: '' + gmtActivityDate: '20240422' + gmtActivityTime: '041230' + localActivityDate: '20240422' + localActivityTime: '091230' + scheduledDeliveryDate: '' + trackingNumber: " 1ZABCXYZ0112346789" + '2': + summary: UPS has your package message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: OR + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '012901' + localActivityDate: '20240422' + localActivityTime: '212901' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + '3': + summary: On the way (arrival or departure from a UPS building) message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: DP + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '025400' + localActivityDate: '20240422' + localActivityTime: '225400' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + '4': + summary: Preparing for delivery message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '003052' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '043052' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + '5': + summary: Preparing for delivery/loaded on vehicle message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '063936' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '103936' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + '6': + summary: Out for delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '091519' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: OT + description: Out for Delivery + descriptionCode: '021' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '131519' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + '7': + summary: Delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '095004' + activityLocation: + city: CHARLOTTE + stateProvince: NC + postalCode: '28209' + country: US + activityStatus: + type: D + code: FS + description: Delivered + scheduledDeliveryDate: '20191014' + gmtActivityDate: '20240423' + gmtActivityTime: '135004' + actualDeliveryDate: '20240423' + actualDeliveryTime: '095004' + responses: + '200': + description: Return a 200 status to indicate that the data was received successfully +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + "Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + Destination: + type: object + description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. + required: + - url + - credentialType + - credential + properties: + url: + type: string + format: url + description: | + It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. + If this endpoint is not continuously available, incoming events will be lost. + example: "https://your-webhook-url.com" + credentialType: + type: string + description: It is an open-entry field that indicates type of credentials supported by the client. + example: Bearer + credential: + type: string + description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. + TrackSubsServiceRequest: + required: + - locale + - trackingNumberList + - destination + type: object + properties: + locale: + type: string + description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. + pattern: '^[a-z]{2}_[A-Z]{2}$' + example: en_US + countryCode: + type: string + description: Represents the country code. This field is reserved for future use. + example: US + trackingNumberList: + type: array + description: Represents list of tracking numbers in request. + maxItems: 100 + example: + - 1ZCIETST0111111114 + - 1ZCIETST0422222228 + items: + type: string + pattern: '^1Z[0-9A-Z]{16}$' + description: Represents tracking numbers starting with '1Z', followed by 16 alphanummeric characters in request. + destination: + $ref: '#/components/schemas/Destination' + ErrorMessage: + type: object + description: The error response containing any errors that occurred + properties: + code: + type: string + description: The error code. + example: VSS300 + message: + type: string + description: The error message. + example: Locale is required. The Subscription request has been rejected. + TrackSubsServiceResponse: + type: object + properties: + validTrackingNumbers: + type: array + description: List of tracking numbers with successful subscription created. + items: + type: string + example: + - 1Z1234567891234556 + - 1ZABCDEFH91234556 + invalidTrackingNumbers: + type: array + description: List of tracking numbers associated with errors preventing subscription creation. + items: + type: string + example: + - 1Z1234567$8 + TrackSubsServiceErrorResponse: + type: object + properties: + response: + $ref: '#/components/schemas/ErrorResponse' + invalidTrackingNumbers: + $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" + required: + - response + ErrorResponse: + type: object + properties: + errors: + type: array + description: The error response containing any errors that occurred. + items: + $ref: '#/components/schemas/ErrorMessage' + TrackingEventRequest: + required: + - trackingNumber + - activityStatus + type: object + description: Package event update payload. + properties: + trackingNumber: + type: string + description: The package's tracking number. + pattern: '^1Z[0-9A-Z]{16}$' + example: 1Z1234567891234556 + localActivityDate: + type: string + description: 'The localized date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + localActivityTime: + type: string + description: 'The localized time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + activityLocation: + "$ref": "#/components/schemas/ActivityLocation" + activityStatus: + "$ref": "#/components/schemas/ActivityStatus" + scheduledDeliveryDate: + type: string + description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryDate: + type: string + description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryTime: + type: string + description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + gmtActivityDate: + type: string + description: 'The GMT date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + gmtActivityTime: + type: string + description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryStartTime: + type: string + description: 'The start time of a delivery. Format: HHMMSS (24 hr).' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryEndTime: + type: string + description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryTimeDescription: + type: string + description: The date of this delivery detail. + ActivityLocation: + type: object + description: The container which has the current package activity location. + properties: + city: + type: string + description: The physical address city. + example: Alpharetta + stateProvince: + type: string + description: The physical address state or province. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: GA + postalCode: + type: string + description: The physical address postal code (This field is blank until the delivery event occurs). + minLength: 5 + maxLength: 9 + pattern: ^\d{5}(?:[-\s]\d{4})?$ + examples: + - "30004" + - "30004-4616" + country: + type: string + description: The physical address country. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2} + example: US + ActivityStatus: + type: object + description: The container which has the current package activity status. + properties: + type: + type: string + 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 | + code: + type: string + description: The current activity status code. See the 'Status Codes' document for more details. + description: + type: string + description: The current activity status description. diff --git a/UPSTrackAlert.yaml b/UPSTrackAlert.yaml index e417351..0972059 100644 --- a/UPSTrackAlert.yaml +++ b/UPSTrackAlert.yaml @@ -1,730 +1,729 @@ -openapi: 3.1.0 -info: - title: UPS Track Alert API - description: | - - # Product Info - - The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. - 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, please visit the Product Info page. -

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - - # Business Values - - - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. - - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. - - **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. - - # Reference - - Appendix - - Track Alert Best Practices - - # FAQs - - - **How does it work once I am setup as a user?** - > You submit up to 100 UPS 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 tracking number for the next 14 days. This saves you the effort of polling UPS to determine what is the current status of your package. - - - **What type of packages does Track Alert support? - > Track Alert supports UPS packages that have a 1Z tracking number, as well as Roadie packages (1R tracking numbers). - - - **How do I check if a subscription to a tracking number was successful?** - > Once tracking number(s) is submitted to Track Alert, you will receive a response confirming successful and unsuccessful tracking numbers. - - - **I stopped receiving event messages after 2 weeks and my package hasn’t been delivered. Why?** - > Each tracking number subscription is valid for 14 days. If the package has not been delivered within 14 days, you must resubscribe to the tracking number 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. - - - **How many tracking numbers can a subscriber subscribe to in one request?** - > You can subscribe to up to 100 tracking numbers in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful tracking numbers. - - - **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), - 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 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. - - - **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: - 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) - activity location city - activity location state/province - activity location postal code (this field is blank until the delivery event occurs) - activity location country - activity status type - activity status code - activity status description - activity status description code - local activity date - local activity time - GMT activity date - GMT activity time - delivery start time (example '150000') - delivery end time (example '170000') - delivery time description (example 'estimated delivery window' or 'end of day') - delivery photo (this field is only available for enhanced users) - - - **Can I test this process?** - > Yes, there are two test tracking numbers that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test tracking numbers are 1ZCIETST0111111114 and 1ZCIETST0422222228. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these tracking numbers as often as you like. (no stress testing please.) - - # Overview - When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. - - Successful responses may or may not include warnings. - 1. **Without warnings** - Indicates the request has been processed as anticipated. - 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. - - The severity of an error may be transient or hard. - 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. - 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. - - The following error codes can apply to all APIs. - - # Error Codes - - | **Code** | **HTTP Code** | **Severity** | **Description** | - | :--: | :---: | :---: | :-- | - | UJ0001 | 401 | Hard | Invalid token or token is not present | - | 405 | 405 | Hard | Method Not Allowed. | - | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | - | 10007 | 400 | Hard | Requested Content Type is not supported | - | 250002 | 401 | Hard | Invalid authentication information. | - | 251004 | 401 | Hard | Bearer Token expired (oauth) | - | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | - | VSS002 | 400 | Hard | Missing transId | - | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | - | VSS004 | 400 | Hard | Missing transactionSrc | - | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | - | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | - | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | - | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | - | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | - | VSS215 | 400 | Hard | The tracking number that was submitted is not a valid CIE tracking number and has been rejected. | - | VSS220 | 400 | Hard | You have submitted over 100 tracking numbers which is not allowed. The entire submission of tracking numbers has been rejected. Please resubmit your request again using groups of no more than 100 tracking numbers. | - | VSS300 | 400 | Hard | Locale is required. The Subscription request has been rejected. | - | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | - | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | - | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | - | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | - | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | - | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | - | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | - | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | - - -servers: - - url: https://wwwcie.ups.com/api/track/{version} - description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/track/{version} - description: UPS Production OAuth. - variables: - version: - default: v1 - enum: - - v1 -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. - - 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 - summary: API to create subscriptions by tracking numbers. - operationId: processSubscriptionTypeForTrackingNumber - security: - - OAuth2: [] - parameters: - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceRequest' - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceResponse' - examples: - PartialSuccessExample: - description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. - value: - validTrackingNumbers: - - 1Z12345678912345560 - invalidTrackingNumbers: - - 1Z1234567$8 - CompleteSuccessExample: - description: Example response that contains valid tracking numbers for which subscription created. - value: - validTrackingNumbers: - - 1Z12345678912345560 - '400': - description: Invalid Request - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - response: - errors: - - code: VSS300 - message: Locale is required. The Subscription request has been rejected. - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: UJ0001 - message: Invalid token or token is not present. - '404': - description: URL does not exist or resource not found. - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "404" - message: The requested resource was not found. - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '405': - description: Method Not Allowed - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "405" - message: The requested method is not allowed for this resource. - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: "10004" - message: Internal Server Error -webhooks: - TrackingEvent: - post: - summary: Tracking Event - description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. - tags: - - UPS Track Alert - parameters: - - name: credential - in: header - description: It is an opaque string meant for client authentication. Shared in Subscription request. - required: true - schema: - type: string - - name: User-Agent - in: header - description: Represents Track Alert application with value 'UPSPubSubTrackingService'. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackingEventRequest' - examples: - '1': - summary: Manifest (label created or billing information received) message - value: - activityLocation: - city: '' - country: US - postalCode: '' - stateProvince: '' - activityStatus: - code: MP - description: Shipment Ready for UPS - descriptionCode: '003' - type: M - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: '' - gmtActivityDate: '20240422' - gmtActivityTime: '041230' - localActivityDate: '20240422' - localActivityTime: '091230' - scheduledDeliveryDate: '' - trackingNumber: " 1ZABCXYZ0112346789" - '2': - summary: UPS has your package message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: OR - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '012901' - localActivityDate: '20240422' - localActivityTime: '212901' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - '3': - summary: On the way (arrival or departure from a UPS building) message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: DP - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '025400' - localActivityDate: '20240422' - localActivityTime: '225400' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - '4': - summary: Preparing for delivery message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '003052' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '043052' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - '5': - summary: Preparing for delivery/loaded on vehicle message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '063936' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '103936' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - '6': - summary: Out for delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '091519' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: OT - description: Out for Delivery - descriptionCode: '021' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '131519' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - '7': - summary: Delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '095004' - activityLocation: - city: CHARLOTTE - stateProvince: NC - postalCode: '28209' - country: US - activityStatus: - type: D - code: FS - description: Delivered - scheduledDeliveryDate: '20191014' - gmtActivityDate: '20240423' - gmtActivityTime: '135004' - actualDeliveryDate: '20240423' - actualDeliveryTime: '095004' - responses: - '200': - description: Return a 200 status to indicate that the data was received successfully -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - "Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - Destination: - type: object - description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. - required: - - url - - credentialType - - credential - properties: - url: - type: string - format: url - description: | - It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. - If this endpoint is not continuously available, incoming events will be lost. - example: "https://your-webhook-url.com" - credentialType: - type: string - description: It is an open-entry field that indicates type of credentials supported by the client. - example: Bearer - credential: - type: string - description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. - TrackSubsServiceRequest: - required: - - locale - - trackingNumberList - - destination - type: object - properties: - locale: - type: string - description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. - pattern: '^[a-z]{2}_[A-Z]{2}$' - example: en_US - countryCode: - type: string - description: Represents the country code. This field is reserved for future use. - example: US - trackingNumberList: - type: array - description: Represents list of tracking numbers in request. - maxItems: 100 - example: - - 1ZCIETST0111111114 - - 1ZCIETST0422222228 - items: - type: string - pattern: '^1Z[0-9A-Z]{16}$|^1R[0-9A-Z]{14}$|^1R[0-9A-Z]{26}$' - description: Represents tracking numbers starting with '1Z', followed by 16 alphanummeric characters in request, as well as tracking numbers starting with '1R', followed by 14 or 26 alphanumeric characters. - destination: - $ref: '#/components/schemas/Destination' - ErrorMessage: - type: object - description: The error response containing any errors that occurred - properties: - code: - type: string - description: The error code. - example: VSS300 - message: - type: string - description: The error message. - example: Locale is required. The Subscription request has been rejected. - TrackSubsServiceResponse: - type: object - properties: - validTrackingNumbers: - type: array - description: List of tracking numbers with successful subscription created. - items: - type: string - example: - - 1Z1234567891234556 - - 1ZABCDEFH91234556 - invalidTrackingNumbers: - type: array - description: List of tracking numbers associated with errors preventing subscription creation. - items: - type: string - example: - - 1Z1234567$8 - TrackSubsServiceErrorResponse: - type: object - properties: - response: - $ref: '#/components/schemas/ErrorResponse' - invalidTrackingNumbers: - $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" - required: - - response - ErrorResponse: - type: object - properties: - errors: - type: array - description: The error response containing any errors that occurred. - items: - $ref: '#/components/schemas/ErrorMessage' - TrackingEventRequest: - required: - - trackingNumber - - activityStatus - type: object - description: Package event update payload. - properties: - trackingNumber: - type: string - description: The package's tracking number. - pattern: '^1Z[0-9A-Z]{16}$' - example: 1Z1234567891234556 - localActivityDate: - type: string - description: 'The localized date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - localActivityTime: - type: string - description: 'The localized time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - activityLocation: - "$ref": "#/components/schemas/ActivityLocation" - activityStatus: - "$ref": "#/components/schemas/ActivityStatus" - scheduledDeliveryDate: - type: string - description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryDate: - type: string - description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryTime: - type: string - description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - gmtActivityDate: - type: string - description: 'The GMT date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - gmtActivityTime: - type: string - description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - gmtOffset: - type: string - description: "A field that shows how local time was calculated. In the format (-/+)HH.MM (24 hr)" - minLength: 6 - maxLength: 6 - pattern: ^[+-]([01]\d|2[0-3])\.[0-5]\d$ - example: "-04.00" - deliveryStartTime: - type: string - description: 'The start time of a delivery. Format: HHMMSS (24 hr).' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryEndTime: - type: string - description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryTimeDescription: - type: string - description: The date of this delivery detail. - ActivityLocation: - type: object - description: The container which has the current package activity location. - properties: - city: - type: string - description: The physical address city. - example: Alpharetta - stateProvince: - type: string - description: The physical address state or province. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: GA - postalCode: - type: string - description: The physical address postal code (This field is blank until the delivery event occurs). - minLength: 5 - maxLength: 9 - pattern: ^\d{5}(?:[-\s]\d{4})?$ - examples: - - "30004" - - "30004-4616" - country: - type: string - description: The physical address country. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2} - example: US - ActivityStatus: - type: object - description: The container which has the current package activity status. - properties: - type: - type: string - 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 | - code: - type: string - description: The current activity status code. See the 'Status Codes' document for more details. - description: - type: string - description: The current activity status description. - +openapi: 3.1.0 +info: + title: UPS Track Alert API + description: | + + # Product Info + + The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. + 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, please visit the Product Info page. +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + + # Business Values + + - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. + - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. + - **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. + + # Reference + - Appendix + - Track Alert Best Practices + + # FAQs + + - **How does it work once I am setup as a user?** + > You submit up to 100 UPS 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 tracking number for the next 14 days. This saves you the effort of polling UPS to determine what is the current status of your package. + + - **What type of packages does Track Alert support? + > Track Alert supports UPS packages that have a 1Z tracking number, as well as Roadie packages (1R tracking numbers). + + - **How do I check if a subscription to a tracking number was successful?** + > Once tracking number(s) is submitted to Track Alert, you will receive a response confirming successful and unsuccessful tracking numbers. + + - **I stopped receiving event messages after 2 weeks and my package hasn’t been delivered. Why?** + > Each tracking number subscription is valid for 14 days. If the package has not been delivered within 14 days, you must resubscribe to the tracking number 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. + + - **How many tracking numbers can a subscriber subscribe to in one request?** + > You can subscribe to up to 100 tracking numbers in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful tracking numbers. + + - **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), + 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 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. + + - **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: + 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) + activity location city + activity location state/province + activity location postal code (this field is blank until the delivery event occurs) + activity location country + activity status type + activity status code + activity status description + activity status description code + local activity date + local activity time + GMT activity date + GMT activity time + delivery start time (example '150000') + delivery end time (example '170000') + delivery time description (example 'estimated delivery window' or 'end of day') + delivery photo (this field is only available for enhanced users) + + - **Can I test this process?** + > Yes, there are two test tracking numbers that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test tracking numbers are 1ZCIETST0111111114 and 1ZCIETST0422222228. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these tracking numbers as often as you like. (no stress testing please.) + + # Overview + When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. + + Successful responses may or may not include warnings. + 1. **Without warnings** - Indicates the request has been processed as anticipated. + 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. + + The severity of an error may be transient or hard. + 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. + 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. + + The following error codes can apply to all APIs. + + # Error Codes + + | **Code** | **HTTP Code** | **Severity** | **Description** | + | :--: | :---: | :---: | :-- | + | UJ0001 | 401 | Hard | Invalid token or token is not present | + | 405 | 405 | Hard | Method Not Allowed. | + | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | + | 10007 | 400 | Hard | Requested Content Type is not supported | + | 250002 | 401 | Hard | Invalid authentication information. | + | 251004 | 401 | Hard | Bearer Token expired (oauth) | + | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | + | VSS002 | 400 | Hard | Missing transId | + | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | + | VSS004 | 400 | Hard | Missing transactionSrc | + | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | + | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | + | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | + | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | + | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | + | VSS215 | 400 | Hard | The tracking number that was submitted is not a valid CIE tracking number and has been rejected. | + | VSS220 | 400 | Hard | You have submitted over 100 tracking numbers which is not allowed. The entire submission of tracking numbers has been rejected. Please resubmit your request again using groups of no more than 100 tracking numbers. | + | VSS300 | 400 | Hard | Locale is required. The Subscription request has been rejected. | + | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | + | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | + | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | + | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | + | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | + | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | + | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | + | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | + + +servers: + - url: https://wwwcie.ups.com/api/track/{version} + description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/track/{version} + description: UPS Production OAuth. + variables: + version: + default: v1 + enum: + - v1 +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. + + 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 + summary: API to create subscriptions by tracking numbers. + operationId: processSubscriptionTypeForTrackingNumber + security: + - OAuth2: [] + parameters: + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceRequest' + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceResponse' + examples: + PartialSuccessExample: + description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. + value: + validTrackingNumbers: + - 1Z12345678912345560 + invalidTrackingNumbers: + - 1Z1234567$8 + CompleteSuccessExample: + description: Example response that contains valid tracking numbers for which subscription created. + value: + validTrackingNumbers: + - 1Z12345678912345560 + '400': + description: Invalid Request + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + response: + errors: + - code: VSS300 + message: Locale is required. The Subscription request has been rejected. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: UJ0001 + message: Invalid token or token is not present. + '404': + description: URL does not exist or resource not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "404" + message: The requested resource was not found. + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '405': + description: Method Not Allowed + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "405" + message: The requested method is not allowed for this resource. + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: "10004" + message: Internal Server Error +webhooks: + TrackingEvent: + post: + summary: Tracking Event + description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. + tags: + - UPS Track Alert + parameters: + - name: credential + in: header + description: It is an opaque string meant for client authentication. Shared in Subscription request. + required: true + schema: + type: string + - name: User-Agent + in: header + description: Represents Track Alert application with value 'UPSPubSubTrackingService'. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackingEventRequest' + examples: + '1': + summary: Manifest (label created or billing information received) message + value: + activityLocation: + city: '' + country: US + postalCode: '' + stateProvince: '' + activityStatus: + code: MP + description: Shipment Ready for UPS + descriptionCode: '003' + type: M + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: '' + gmtActivityDate: '20240422' + gmtActivityTime: '041230' + localActivityDate: '20240422' + localActivityTime: '091230' + scheduledDeliveryDate: '' + trackingNumber: " 1ZABCXYZ0112346789" + '2': + summary: UPS has your package message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: OR + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '012901' + localActivityDate: '20240422' + localActivityTime: '212901' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + '3': + summary: On the way (arrival or departure from a UPS building) message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: DP + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '025400' + localActivityDate: '20240422' + localActivityTime: '225400' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + '4': + summary: Preparing for delivery message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '003052' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '043052' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + '5': + summary: Preparing for delivery/loaded on vehicle message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '063936' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '103936' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + '6': + summary: Out for delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '091519' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: OT + description: Out for Delivery + descriptionCode: '021' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '131519' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + '7': + summary: Delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '095004' + activityLocation: + city: CHARLOTTE + stateProvince: NC + postalCode: '28209' + country: US + activityStatus: + type: D + code: FS + description: Delivered + scheduledDeliveryDate: '20191014' + gmtActivityDate: '20240423' + gmtActivityTime: '135004' + actualDeliveryDate: '20240423' + actualDeliveryTime: '095004' + responses: + '200': + description: Return a 200 status to indicate that the data was received successfully +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + "Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + Destination: + type: object + description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. + required: + - url + - credentialType + - credential + properties: + url: + type: string + format: url + description: | + It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. + If this endpoint is not continuously available, incoming events will be lost. + example: "https://your-webhook-url.com" + credentialType: + type: string + description: It is an open-entry field that indicates type of credentials supported by the client. + example: Bearer + credential: + type: string + description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. + TrackSubsServiceRequest: + required: + - locale + - trackingNumberList + - destination + type: object + properties: + locale: + type: string + description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. + pattern: '^[a-z]{2}_[A-Z]{2}$' + example: en_US + countryCode: + type: string + description: Represents the country code. This field is reserved for future use. + example: US + trackingNumberList: + type: array + description: Represents list of tracking numbers in request. + maxItems: 100 + example: + - 1ZCIETST0111111114 + - 1ZCIETST0422222228 + items: + type: string + pattern: '^1Z[0-9A-Z]{16}$|^1R[0-9A-Z]{14}$|^1R[0-9A-Z]{26}$' + description: Represents tracking numbers starting with '1Z', followed by 16 alphanummeric characters in request, as well as tracking numbers starting with '1R', followed by 14 or 26 alphanumeric characters. + destination: + $ref: '#/components/schemas/Destination' + ErrorMessage: + type: object + description: The error response containing any errors that occurred + properties: + code: + type: string + description: The error code. + example: VSS300 + message: + type: string + description: The error message. + example: Locale is required. The Subscription request has been rejected. + TrackSubsServiceResponse: + type: object + properties: + validTrackingNumbers: + type: array + description: List of tracking numbers with successful subscription created. + items: + type: string + example: + - 1Z1234567891234556 + - 1ZABCDEFH91234556 + invalidTrackingNumbers: + type: array + description: List of tracking numbers associated with errors preventing subscription creation. + items: + type: string + example: + - 1Z1234567$8 + TrackSubsServiceErrorResponse: + type: object + properties: + response: + $ref: '#/components/schemas/ErrorResponse' + invalidTrackingNumbers: + $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" + required: + - response + ErrorResponse: + type: object + properties: + errors: + type: array + description: The error response containing any errors that occurred. + items: + $ref: '#/components/schemas/ErrorMessage' + TrackingEventRequest: + required: + - trackingNumber + - activityStatus + type: object + description: Package event update payload. + properties: + trackingNumber: + type: string + description: The package's tracking number. + pattern: '^1Z[0-9A-Z]{16}$' + example: 1Z1234567891234556 + localActivityDate: + type: string + description: 'The localized date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + localActivityTime: + type: string + description: 'The localized time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + activityLocation: + "$ref": "#/components/schemas/ActivityLocation" + activityStatus: + "$ref": "#/components/schemas/ActivityStatus" + scheduledDeliveryDate: + type: string + description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryDate: + type: string + description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryTime: + type: string + description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + gmtActivityDate: + type: string + description: 'The GMT date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + gmtActivityTime: + type: string + description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + gmtOffset: + type: string + description: "A field that shows how local time was calculated. In the format (-/+)HH.MM (24 hr)" + minLength: 6 + maxLength: 6 + pattern: ^[+-]([01]\d|2[0-3])\.[0-5]\d$ + example: "-04.00" + deliveryStartTime: + type: string + description: 'The start time of a delivery. Format: HHMMSS (24 hr).' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryEndTime: + type: string + description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryTimeDescription: + type: string + description: The date of this delivery detail. + ActivityLocation: + type: object + description: The container which has the current package activity location. + properties: + city: + type: string + description: The physical address city. + example: Alpharetta + stateProvince: + type: string + description: The physical address state or province. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: GA + postalCode: + type: string + description: The physical address postal code (This field is blank until the delivery event occurs). + minLength: 5 + maxLength: 9 + pattern: ^\d{5}(?:[-\s]\d{4})?$ + examples: + - "30004" + - "30004-4616" + country: + type: string + description: The physical address country. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2} + example: US + ActivityStatus: + type: object + description: The container which has the current package activity status. + properties: + type: + type: string + 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 | + code: + type: string + description: The current activity status code. See the 'Status Codes' document for more details. + description: + type: string + description: The current activity status description. diff --git a/UPSTrackAlertEnhanced-Ready.yaml b/UPSTrackAlertEnhanced-Ready.yaml index 08cbf0f..3b41563 100644 --- a/UPSTrackAlertEnhanced-Ready.yaml +++ b/UPSTrackAlertEnhanced-Ready.yaml @@ -1,779 +1,778 @@ -openapi: 3.1.0 -info: - title: UPS Track Alert API with Photo - description: | - - # Product Info - - The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. - 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. -
- - Simplify your workflow with the API Request Generator and create your custom request body in just seconds. - - - API Request Generator - -
- - Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub. - - - Run In Postman - - Open in GitHub - - - # Business Values - - - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. - - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. - - **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. - - # Reference - - Appendix - - Track Alert Best Practices - - # FAQs - - - **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. - - - **When can I expect a delivery photo?** - > Delivery photos are only available with residential deliveries, in package release areas, and with packages that were driver released. Additional event with the delivery photo will be sent, if and when the photo is made available. - - - **What type of packages does Track Alert support? - > Track Alert supports UPS packages that have a 1Z tracking number. - - - **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. - - - **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. - - - **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. - - - **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), - 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 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. - - - **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 - 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) - activity location city - activity location state/province - activity location postal code (this field is blank until the delivery event occurs) - activity location country - activity status type - activity status code - activity status description - activity status description code - local activity date - local activity time - GMT activity date - GMT activity time - delivery start time (example '150000') - delivery end time (example '170000') - delivery time description (example 'estimated delivery window' or 'end of day') - delivery photo - received by - - - **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.) - - - **I subscribed to Track Alert with Photo. Why did I not receive the photo?** - > Only residential deliveries where the package was driver released are eligible for delivery photo. This means that if the package was delivered to a commercial building, the package was handed to a person, or if a signature was collected, no delivery photo will be available. In addition, Track Alert with Photo performs a 'party to the package' check to ensure the user is authorized to view the photo. The account number must be associated with the user's ClientID. - - # Overview - When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. - - Successful responses may or may not include warnings. - 1. **Without warnings** - Indicates the request has been processed as anticipated. - 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. - - The severity of an error may be transient or hard. - 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. - 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. - - The following error codes can apply to all APIs. - - # Error Codes - | **Code** | **HTTP Code** | **Severity** | **Description** | - | :--: | :---: | :---: | :-- | - | UJ0001 | 401 | Hard | Invalid token or token is not present | - | 405 | 405 | Hard | Method Not Allowed. | - | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | - | 10007 | 400 | Hard | Requested Content Type is not supported | - | 250002 | 401 | Hard | Invalid authentication information. | - | 251004 | 401 | Hard | Bearer Token expired (oauth) | - | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | - | VSS002 | 400 | Hard | Missing transId | - | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | - | VSS004 | 400 | Hard | Missing transactionSrc | - | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | - | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | - | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | - | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | - | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | - | VSS215 | 400 | Hard | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. | - | VSS220 | 400 | Hard | 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 | Hard | Locale is required. The Subscription request has been rejected. | - | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | - | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | - | VSS414 | 400 | Hard | Event preference is missing or invalid, The Subscription request has been rejected. | - | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | - | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | - | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | - | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | - | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | - | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | - - -servers: - - url: https://wwwcie.ups.com/api/track/{version} - description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/track/{version} - description: UPS Production OAuth. - variables: - version: - default: v1 - enum: - - v1 -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. - - 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. - operationId: processSubscriptionTypeForTrackingNumber - security: - - OAuth2: [] - parameters: - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceRequest' - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceResponse' - examples: - PartialSuccessExample: - description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. - value: - validTrackingNumbers: - - 1Z12345678912345560 - invalidTrackingNumbers: - - 1Z1234567$8 - CompleteSuccessExample: - description: Example response that contains valid tracking numbers for which subscription created. - value: - validTrackingNumbers: - - 1Z12345678912345560 - '400': - description: Invalid Request - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - response: - errors: - - code: VSS300 - message: Locale is required. The Subscription request has been rejected. - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: UJ0001 - message: Invalid token or token is not present. - '404': - description: URL does not exist or resource not found. - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "404" - message: The requested resource was not found. - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '405': - description: Method Not Allowed - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "405" - message: The requested method is not allowed for this resource. - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: "10004" - message: Internal Server Error -webhooks: - TrackingEventEnhanced: - post: - summary: Tracking Event - description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. - tags: - - UPS Track Alert with Photo - parameters: - - name: credential - in: header - description: It is an opaque string meant for client authentication. Shared in Subscription request. - required: true - schema: - type: string - - name: User-Agent - in: header - description: Represents Track Alert application with value 'UPSPubSubTrackingService'. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackingEventRequest' - examples: - '1': - summary: Manifest (label created or billing information received) message - value: - activityLocation: - city: '' - country: US - postalCode: '' - stateProvince: '' - activityStatus: - code: MP - description: Shipment Ready for UPS - descriptionCode: '003' - type: M - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: '' - gmtActivityDate: '20240422' - gmtActivityTime: '041230' - localActivityDate: '20240422' - localActivityTime: '091230' - scheduledDeliveryDate: '' - trackingNumber: " 1ZABCXYZ0112346789" - receivedBy: '' - '2': - summary: UPS has your package message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: OR - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '012901' - localActivityDate: '20240422' - localActivityTime: '212901' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - receivedBy: '' - '3': - summary: On the way (arrival or departure from a UPS building) message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: DP - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '025400' - localActivityDate: '20240422' - localActivityTime: '225400' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - receivedBy: '' - deliveryPhoto: '' - '4': - summary: Preparing for delivery message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '003052' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '043052' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - receivedBy: '' - deliveryPhoto: '' - '5': - summary: Preparing for delivery/loaded on vehicle message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '063936' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '103936' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - receivedBy: '' - deliveryPhoto: '' - '6': - summary: Out for delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '091519' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: OT - description: Out for Delivery - descriptionCode: '021' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '131519' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - receivedBy: '' - deliveryPhoto: '' - '7': - summary: Delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '095004' - activityLocation: - city: CHARLOTTE - stateProvince: NC - postalCode: '28209' - country: US - activityStatus: - type: D - code: FS - description: Delivered - scheduledDeliveryDate: '20191014' - gmtActivityDate: '20240423' - gmtActivityTime: '135004' - actualDeliveryDate: '20240423' - actualDeliveryTime: '095004' - receivedBy: 'John' - deliveryPhoto: '' - responses: - '200': - description: Return a 200 status to indicate that the data was received successfully -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - "Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - Destination: - type: object - description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. - required: - - url - - credentialType - - credential - properties: - url: - type: string - format: url - description: | - It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. - If this endpoint is not continuously available, incoming events will be lost. - example: "https://your-webhook-url.com" - credentialType: - type: string - description: It is an open-entry field that indicates type of credentials supported by the client. - example: Bearer - credential: - type: string - description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. - TrackSubsServiceRequest: - required: - - locale - - trackingNumberList - - destination - type: object - properties: - locale: - type: string - description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. - pattern: '^[a-z]{2}_[A-Z]{2}$' - example: en_US - countryCode: - type: string - description: Represents the country code. This field is reserved for future use. - example: US - trackingNumberList: - type: array - description: Represents list of tracking numbers in request. - maxItems: 100 - example: - - 1ZCIETST0111111114 - - 1ZCIETST0422222228 - - 1ZCIEPIC0111111116 - items: - type: string - pattern: '^1Z[0-9A-Z]{16}$' - description: Represents tracking numbers starting with '1Z', followed by 16 alphanummeric characters in request. - eventPreferences: - type: array - description: | - Represents scan/event preferences for the subscription endpoint. If no value is provided in this array - then all activity types will be sent. - minItems: 1 - maxItems: 4 - items: - type: string - description: package activity identifier - oneOf: - - const: D - title: Delivery - description: Includes updates and delivery photo - - const: I - title: In-Progress - - const: M - title: Manifest - - const: X - title: Exception - description: Includes updates - destination: - $ref: '#/components/schemas/Destination' - ErrorMessage: - type: object - description: The error response containing any errors that occurred - properties: - code: - type: string - description: The error code. - example: VSS300 - message: - type: string - description: The error message. - example: Locale is required. The Subscription request has been rejected. - TrackSubsServiceResponse: - type: object - properties: - validTrackingNumbers: - type: array - description: List of tracking numbers with successful subscription created. - items: - type: string - example: - - 1Z1234567891234556 - - 1ZABCDEFH91234556 - invalidTrackingNumbers: - type: array - description: List of tracking numbers associated with errors preventing subscription creation. - items: - type: string - example: - - 1Z1234567$8 - TrackSubsServiceErrorResponse: - type: object - properties: - response: - $ref: '#/components/schemas/ErrorResponse' - invalidTrackingNumbers: - $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" - required: - - response - ErrorResponse: - type: object - properties: - errors: - type: array - description: The error response containing any errors that occurred. - items: - $ref: '#/components/schemas/ErrorMessage' - TrackingEventRequest: - required: - - trackingNumber - - activityStatus - type: object - description: Package event update payload. - properties: - trackingNumber: - type: string - description: The package's tracking number. - pattern: '^1Z[0-9A-Z]{16}$' - example: 1Z1234567891234556 - localActivityDate: - type: string - description: 'The localized date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - localActivityTime: - type: string - description: 'The localized time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - activityLocation: - "$ref": "#/components/schemas/ActivityLocation" - activityStatus: - "$ref": "#/components/schemas/ActivityStatus" - scheduledDeliveryDate: - type: string - description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryDate: - type: string - description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryTime: - type: string - description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - gmtActivityDate: - type: string - description: 'The GMT date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - gmtActivityTime: - type: string - description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryStartTime: - type: string - description: 'The start time of a delivery. Format: HHMMSS (24 hr).' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryEndTime: - type: string - description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryTimeDescription: - type: string - description: The date of this delivery detail. - deliveryPhoto: - type: string - description: Base64 encoded image of the delivery photo (This field is blank until the delivery photo is made available for enhanced subscriptions). - receivedBy: - type: string - description: Clarified signature provided with delivery, when available. - ActivityLocation: - type: object - description: The container which has the current package activity location. - properties: - city: - type: string - description: The physical address city. - example: Alpharetta - stateProvince: - type: string - description: The physical address state or province. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: GA - postalCode: - type: string - description: The physical address postal code (This field is blank until the delivery event occurs). - minLength: 5 - maxLength: 9 - pattern: ^\d{5}(?:[-\s]\d{4})?$ - examples: - - "30004" - - "30004-4616" - country: - type: string - description: The physical address country. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2} - example: US - ActivityStatus: - type: object - description: The container which has the current package activity status. - properties: - type: - type: string - 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 | - code: - type: string - description: The current activity status code. See the 'Status Codes' document for more details. - description: - type: string - description: The current activity status description. - +openapi: 3.1.0 +info: + title: UPS Track Alert API with Photo + description: | + + # Product Info + + The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. + 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. +
+ + Simplify your workflow with the API Request Generator and create your custom request body in just seconds. + + + API Request Generator + +
+ + Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub. + + + Run In Postman + + Open in GitHub + + + # Business Values + + - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. + - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. + - **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. + + # Reference + - Appendix + - Track Alert Best Practices + + # FAQs + + - **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. + + - **When can I expect a delivery photo?** + > Delivery photos are only available with residential deliveries, in package release areas, and with packages that were driver released. Additional event with the delivery photo will be sent, if and when the photo is made available. + + - **What type of packages does Track Alert support? + > Track Alert supports UPS packages that have a 1Z tracking number. + + - **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. + + - **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. + + - **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. + + - **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), + 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 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. + + - **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 + 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) + activity location city + activity location state/province + activity location postal code (this field is blank until the delivery event occurs) + activity location country + activity status type + activity status code + activity status description + activity status description code + local activity date + local activity time + GMT activity date + GMT activity time + delivery start time (example '150000') + delivery end time (example '170000') + delivery time description (example 'estimated delivery window' or 'end of day') + delivery photo + received by + + - **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.) + + - **I subscribed to Track Alert with Photo. Why did I not receive the photo?** + > Only residential deliveries where the package was driver released are eligible for delivery photo. This means that if the package was delivered to a commercial building, the package was handed to a person, or if a signature was collected, no delivery photo will be available. In addition, Track Alert with Photo performs a 'party to the package' check to ensure the user is authorized to view the photo. The account number must be associated with the user's ClientID. + + # Overview + When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. + + Successful responses may or may not include warnings. + 1. **Without warnings** - Indicates the request has been processed as anticipated. + 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. + + The severity of an error may be transient or hard. + 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. + 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. + + The following error codes can apply to all APIs. + + # Error Codes + | **Code** | **HTTP Code** | **Severity** | **Description** | + | :--: | :---: | :---: | :-- | + | UJ0001 | 401 | Hard | Invalid token or token is not present | + | 405 | 405 | Hard | Method Not Allowed. | + | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | + | 10007 | 400 | Hard | Requested Content Type is not supported | + | 250002 | 401 | Hard | Invalid authentication information. | + | 251004 | 401 | Hard | Bearer Token expired (oauth) | + | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | + | VSS002 | 400 | Hard | Missing transId | + | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | + | VSS004 | 400 | Hard | Missing transactionSrc | + | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | + | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | + | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | + | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | + | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | + | VSS215 | 400 | Hard | The 1Z tracking number that was submitted is not a valid CIE 1Z and has been rejected. | + | VSS220 | 400 | Hard | 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 | Hard | Locale is required. The Subscription request has been rejected. | + | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | + | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | + | VSS414 | 400 | Hard | Event preference is missing or invalid, The Subscription request has been rejected. | + | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | + | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | + | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | + | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | + | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | + | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | + + +servers: + - url: https://wwwcie.ups.com/api/track/{version} + description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/track/{version} + description: UPS Production OAuth. + variables: + version: + default: v1 + enum: + - v1 +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. + + 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. + operationId: processSubscriptionTypeForTrackingNumber + security: + - OAuth2: [] + parameters: + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceRequest' + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceResponse' + examples: + PartialSuccessExample: + description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. + value: + validTrackingNumbers: + - 1Z12345678912345560 + invalidTrackingNumbers: + - 1Z1234567$8 + CompleteSuccessExample: + description: Example response that contains valid tracking numbers for which subscription created. + value: + validTrackingNumbers: + - 1Z12345678912345560 + '400': + description: Invalid Request + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + response: + errors: + - code: VSS300 + message: Locale is required. The Subscription request has been rejected. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: UJ0001 + message: Invalid token or token is not present. + '404': + description: URL does not exist or resource not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "404" + message: The requested resource was not found. + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '405': + description: Method Not Allowed + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "405" + message: The requested method is not allowed for this resource. + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: "10004" + message: Internal Server Error +webhooks: + TrackingEventEnhanced: + post: + summary: Tracking Event + description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. + tags: + - UPS Track Alert with Photo + parameters: + - name: credential + in: header + description: It is an opaque string meant for client authentication. Shared in Subscription request. + required: true + schema: + type: string + - name: User-Agent + in: header + description: Represents Track Alert application with value 'UPSPubSubTrackingService'. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackingEventRequest' + examples: + '1': + summary: Manifest (label created or billing information received) message + value: + activityLocation: + city: '' + country: US + postalCode: '' + stateProvince: '' + activityStatus: + code: MP + description: Shipment Ready for UPS + descriptionCode: '003' + type: M + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: '' + gmtActivityDate: '20240422' + gmtActivityTime: '041230' + localActivityDate: '20240422' + localActivityTime: '091230' + scheduledDeliveryDate: '' + trackingNumber: " 1ZABCXYZ0112346789" + receivedBy: '' + '2': + summary: UPS has your package message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: OR + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '012901' + localActivityDate: '20240422' + localActivityTime: '212901' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + receivedBy: '' + '3': + summary: On the way (arrival or departure from a UPS building) message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: DP + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '025400' + localActivityDate: '20240422' + localActivityTime: '225400' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + receivedBy: '' + deliveryPhoto: '' + '4': + summary: Preparing for delivery message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '003052' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '043052' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + receivedBy: '' + deliveryPhoto: '' + '5': + summary: Preparing for delivery/loaded on vehicle message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '063936' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '103936' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + receivedBy: '' + deliveryPhoto: '' + '6': + summary: Out for delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '091519' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: OT + description: Out for Delivery + descriptionCode: '021' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '131519' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + receivedBy: '' + deliveryPhoto: '' + '7': + summary: Delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '095004' + activityLocation: + city: CHARLOTTE + stateProvince: NC + postalCode: '28209' + country: US + activityStatus: + type: D + code: FS + description: Delivered + scheduledDeliveryDate: '20191014' + gmtActivityDate: '20240423' + gmtActivityTime: '135004' + actualDeliveryDate: '20240423' + actualDeliveryTime: '095004' + receivedBy: 'John' + deliveryPhoto: '' + responses: + '200': + description: Return a 200 status to indicate that the data was received successfully +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + "Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + Destination: + type: object + description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. + required: + - url + - credentialType + - credential + properties: + url: + type: string + format: url + description: | + It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. + If this endpoint is not continuously available, incoming events will be lost. + example: "https://your-webhook-url.com" + credentialType: + type: string + description: It is an open-entry field that indicates type of credentials supported by the client. + example: Bearer + credential: + type: string + description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. + TrackSubsServiceRequest: + required: + - locale + - trackingNumberList + - destination + type: object + properties: + locale: + type: string + description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. + pattern: '^[a-z]{2}_[A-Z]{2}$' + example: en_US + countryCode: + type: string + description: Represents the country code. This field is reserved for future use. + example: US + trackingNumberList: + type: array + description: Represents list of tracking numbers in request. + maxItems: 100 + example: + - 1ZCIETST0111111114 + - 1ZCIETST0422222228 + - 1ZCIEPIC0111111116 + items: + type: string + pattern: '^1Z[0-9A-Z]{16}$' + description: Represents tracking numbers starting with '1Z', followed by 16 alphanummeric characters in request. + eventPreferences: + type: array + description: | + Represents scan/event preferences for the subscription endpoint. If no value is provided in this array + then all activity types will be sent. + minItems: 1 + maxItems: 4 + items: + type: string + description: package activity identifier + oneOf: + - const: D + title: Delivery + description: Includes updates and delivery photo + - const: I + title: In-Progress + - const: M + title: Manifest + - const: X + title: Exception + description: Includes updates + destination: + $ref: '#/components/schemas/Destination' + ErrorMessage: + type: object + description: The error response containing any errors that occurred + properties: + code: + type: string + description: The error code. + example: VSS300 + message: + type: string + description: The error message. + example: Locale is required. The Subscription request has been rejected. + TrackSubsServiceResponse: + type: object + properties: + validTrackingNumbers: + type: array + description: List of tracking numbers with successful subscription created. + items: + type: string + example: + - 1Z1234567891234556 + - 1ZABCDEFH91234556 + invalidTrackingNumbers: + type: array + description: List of tracking numbers associated with errors preventing subscription creation. + items: + type: string + example: + - 1Z1234567$8 + TrackSubsServiceErrorResponse: + type: object + properties: + response: + $ref: '#/components/schemas/ErrorResponse' + invalidTrackingNumbers: + $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" + required: + - response + ErrorResponse: + type: object + properties: + errors: + type: array + description: The error response containing any errors that occurred. + items: + $ref: '#/components/schemas/ErrorMessage' + TrackingEventRequest: + required: + - trackingNumber + - activityStatus + type: object + description: Package event update payload. + properties: + trackingNumber: + type: string + description: The package's tracking number. + pattern: '^1Z[0-9A-Z]{16}$' + example: 1Z1234567891234556 + localActivityDate: + type: string + description: 'The localized date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + localActivityTime: + type: string + description: 'The localized time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + activityLocation: + "$ref": "#/components/schemas/ActivityLocation" + activityStatus: + "$ref": "#/components/schemas/ActivityStatus" + scheduledDeliveryDate: + type: string + description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryDate: + type: string + description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryTime: + type: string + description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + gmtActivityDate: + type: string + description: 'The GMT date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + gmtActivityTime: + type: string + description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryStartTime: + type: string + description: 'The start time of a delivery. Format: HHMMSS (24 hr).' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryEndTime: + type: string + description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryTimeDescription: + type: string + description: The date of this delivery detail. + deliveryPhoto: + type: string + description: Base64 encoded image of the delivery photo (This field is blank until the delivery photo is made available for enhanced subscriptions). + receivedBy: + type: string + description: Clarified signature provided with delivery, when available. + ActivityLocation: + type: object + description: The container which has the current package activity location. + properties: + city: + type: string + description: The physical address city. + example: Alpharetta + stateProvince: + type: string + description: The physical address state or province. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: GA + postalCode: + type: string + description: The physical address postal code (This field is blank until the delivery event occurs). + minLength: 5 + maxLength: 9 + pattern: ^\d{5}(?:[-\s]\d{4})?$ + examples: + - "30004" + - "30004-4616" + country: + type: string + description: The physical address country. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2} + example: US + ActivityStatus: + type: object + description: The container which has the current package activity status. + properties: + type: + type: string + 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 | + code: + type: string + description: The current activity status code. See the 'Status Codes' document for more details. + description: + type: string + description: The current activity status description. diff --git a/UPSTrackAlertEnhanced.yaml b/UPSTrackAlertEnhanced.yaml index 01b23fc..7735562 100644 --- a/UPSTrackAlertEnhanced.yaml +++ b/UPSTrackAlertEnhanced.yaml @@ -1,778 +1,777 @@ -openapi: 3.1.0 -info: - title: UPS Track Alert API with Photo - description: | - - # Product Info - - The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. - 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

- - - Run In Postman - - Open in GitHub - - - # Business Values - - - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. - - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. - - **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. - - # Reference - - Appendix - - Track Alert Best Practices - - # FAQs - - - **How does it work once I am setup as a user?** - > You submit up to 100 UPS 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. - - - **When can I expect a delivery photo?** - > Delivery photos are only available with residential deliveries, in package release areas, and with packages that were driver released. Additional event with the delivery photo will be sent, if and when the photo is made available. - - - **What type of packages does Track Alert support? - > Track Alert supports UPS packages that have a 1Z tracking number, as well as Roadie packages (1R tracking numbers). - - - **How do I check if a subscription to a tracking number was successful?** - > Once tracking number(s) is submitted to Track Alert, you will receive a response confirming successful and unsuccessful tracking numbers. - - - **I stopped receiving event messages after 2 weeks and my package hasn’t been delivered. Why?** - > Each tracking number subscription is valid for 14 days. If the package has not been delivered within 14 days, you must resubscribe to the tracking number 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. - - - **How many tracking numbers can a subscriber subscribe to in one request?** - > You can subscribe to up to 100 tracking numbers in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful tracking numbers. - - - **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), - 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 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. - - - **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: - 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) - activity location city - activity location state/province - activity location postal code (this field is blank until the delivery event occurs) - activity location country - activity status type - activity status code - activity status description - activity status description code - local activity date - local activity time - GMT activity date - GMT activity time - delivery start time (example '150000') - delivery end time (example '170000') - delivery time description (example 'estimated delivery window' or 'end of day') - delivery photo - received by - - - **Can I test this process?** - > Yes, there are two test tracking numbers that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test tracking numbers are 1ZCIETST0111111114, 1ZCIETST0422222228, and 1ZCIEPIC0111111116. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these tracking numbers as often as you like. (no stress testing please.) - - - **I subscribed to Track Alert with Photo. Why did I not receive the photo?** - > Only residential deliveries where the package was driver released are eligible for delivery photo. This means that if the package was delivered to a commercial building, the package was handed to a person, or if a signature was collected, no delivery photo will be available. In addition, Track Alert with Photo performs a 'party to the package' check to ensure the user is authorized to view the photo. The account number must be associated with the user's ClientID. - - # Overview - When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. - - Successful responses may or may not include warnings. - 1. **Without warnings** - Indicates the request has been processed as anticipated. - 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. - - The severity of an error may be transient or hard. - 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. - 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. - - The following error codes can apply to all APIs. - - # Error Codes - | **Code** | **HTTP Code** | **Severity** | **Description** | - | :--: | :---: | :---: | :-- | - | UJ0001 | 401 | Hard | Invalid token or token is not present | - | 405 | 405 | Hard | Method Not Allowed. | - | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | - | 10007 | 400 | Hard | Requested Content Type is not supported | - | 250002 | 401 | Hard | Invalid authentication information. | - | 251004 | 401 | Hard | Bearer Token expired (oauth) | - | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | - | VSS002 | 400 | Hard | Missing transId | - | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | - | VSS004 | 400 | Hard | Missing transactionSrc | - | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | - | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | - | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | - | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | - | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | - | VSS215 | 400 | Hard | The tracking number that was submitted is not a valid CIE tracking number and has been rejected. | - | VSS220 | 400 | Hard | You have submitted over 100 tracking numbers which is not allowed. The entire submission of tracking numbers has been rejected. Please resubmit your request again using groups of no more than 100 tracking numbers. | - | VSS300 | 400 | Hard | Locale is required. The Subscription request has been rejected. | - | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | - | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | - | VSS414 | 400 | Hard | Event preference is missing or invalid, The Subscription request has been rejected. | - | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | - | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | - | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | - | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | - | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | - | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | - - -servers: - - url: https://wwwcie.ups.com/api/track/{version} - description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. - variables: - version: - default: v1 - enum: - - v1 - - url: https://onlinetools.ups.com/api/track/{version} - description: UPS Production OAuth. - variables: - version: - default: v1 - enum: - - v1 -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. - - 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. - operationId: processSubscriptionTypeForTrackingNumber - security: - - OAuth2: [] - parameters: - - name: transId - in: header - description: An identifier unique to the request. - required: true - schema: - type: string - - name: transactionSrc - in: header - description: Identifies the client/source application that is calling. - required: true - schema: - type: string - - name: version - in: path - description: version - required: true - schema: - type: string - default: v1 - enum: - - v1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceRequest' - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceResponse' - examples: - PartialSuccessExample: - description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. - value: - validTrackingNumbers: - - 1Z12345678912345560 - invalidTrackingNumbers: - - 1Z1234567$8 - CompleteSuccessExample: - description: Example response that contains valid tracking numbers for which subscription created. - value: - validTrackingNumbers: - - 1Z12345678912345560 - '400': - description: Invalid Request - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - response: - errors: - - code: VSS300 - message: Locale is required. The Subscription request has been rejected. - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: UJ0001 - message: Invalid token or token is not present. - '404': - description: URL does not exist or resource not found. - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "404" - message: The requested resource was not found. - '403': - description: Blocked Merchant - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '405': - description: Method Not Allowed - content: - application/json: - schema: - $ref: '#/components/schemas/Response' - example: - errors: - - code: "405" - message: The requested method is not allowed for this resource. - '429': - description: Rate Limit Exceeded - content: - application/json: - schema: - "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/TrackSubsServiceErrorResponse' - example: - errors: - - code: "10004" - message: Internal Server Error -webhooks: - TrackingEventEnhanced: - post: - summary: Tracking Event - description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. - tags: - - UPS Track Alert with Photo - parameters: - - name: credential - in: header - description: It is an opaque string meant for client authentication. Shared in Subscription request. - required: true - schema: - type: string - - name: User-Agent - in: header - description: Represents Track Alert application with value 'UPSPubSubTrackingService'. - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrackingEventRequest' - examples: - '1': - summary: Manifest (label created or billing information received) message - value: - activityLocation: - city: '' - country: US - postalCode: '' - stateProvince: '' - activityStatus: - code: MP - description: Shipment Ready for UPS - descriptionCode: '003' - type: M - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: '' - gmtActivityDate: '20240422' - gmtActivityTime: '041230' - localActivityDate: '20240422' - localActivityTime: '091230' - scheduledDeliveryDate: '' - trackingNumber: " 1ZABCXYZ0112346789" - receivedBy: '' - '2': - summary: UPS has your package message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: OR - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryPhoto: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '012901' - localActivityDate: '20240422' - localActivityTime: '212901' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - receivedBy: '' - '3': - summary: On the way (arrival or departure from a UPS building) message - value: - activityLocation: - city: Hickory - country: US - postalCode: '' - stateProvince: NC - activityStatus: - code: DP - description: On the Way - descriptionCode: '005' - type: I - actualDeliveryDate: '' - actualDeliveryTime: '' - deliveryEndTime: '' - deliveryStartTime: '' - deliveryTimeDescription: end of day - gmtActivityDate: '20240423' - gmtActivityTime: '025400' - localActivityDate: '20240422' - localActivityTime: '225400' - scheduledDeliveryDate: '20240423' - trackingNumber: 1ZABCXYZ0112346789 - receivedBy: '' - deliveryPhoto: '' - '4': - summary: Preparing for delivery message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '003052' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '043052' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - receivedBy: '' - deliveryPhoto: '' - '5': - summary: Preparing for delivery/loaded on vehicle message - value: - trackingNumber: 1ZABCXYZ0112346789 - localActivityDate: '20240423' - localActivityTime: '063936' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: YP - description: Preparing for Delivery - descriptionCode: '071' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '103936' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - receivedBy: '' - deliveryPhoto: '' - '6': - summary: Out for delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '091519' - activityLocation: - city: Charlotte - stateProvince: NC - postalCode: '' - country: US - activityStatus: - type: I - code: OT - description: Out for Delivery - descriptionCode: '021' - scheduledDeliveryDate: '20240423' - actualDeliveryDate: '' - actualDeliveryTime: '' - gmtActivityDate: '20240423' - gmtActivityTime: '131519' - deliveryStartTime: '' - deliveryEndTime: '' - deliveryTimeDescription: end of day - receivedBy: '' - deliveryPhoto: '' - '7': - summary: Delivery message - value: - trackingNumber: 1Z204W4R0308071865 - localActivityDate: '20240423' - localActivityTime: '095004' - activityLocation: - city: CHARLOTTE - stateProvince: NC - postalCode: '28209' - country: US - activityStatus: - type: D - code: FS - description: Delivered - descriptionCode: '011' - scheduledDeliveryDate: '20191014' - gmtActivityDate: '20240423' - gmtActivityTime: '135004' - actualDeliveryDate: '20240423' - actualDeliveryTime: '095004' - receivedBy: 'John' - deliveryPhoto: '' - responses: - '200': - description: Return a 200 status to indicate that the data was received successfully -components: - securitySchemes: - OAuth2: - type: oauth2 - description: | - "Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret. - 3. Select \"Request Token\" - 4. Enter any additional information in the Body and Parameters sections. - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - schemas: - Destination: - type: object - description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. - required: - - url - - credentialType - - credential - properties: - url: - type: string - format: url - description: | - It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. - If this endpoint is not continuously available, incoming events will be lost. - example: "https://your-webhook-url.com" - credentialType: - type: string - description: It is an open-entry field that indicates type of credentials supported by the client. - example: Bearer - credential: - type: string - description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. - TrackSubsServiceRequest: - required: - - locale - - trackingNumberList - - destination - type: object - properties: - locale: - type: string - description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. - pattern: '^[a-z]{2}_[A-Z]{2}$' - example: en_US - countryCode: - type: string - description: Represents the country code. This field is reserved for future use. - example: US - trackingNumberList: - type: array - description: Represents list of tracking numbers in request. - maxItems: 100 - example: - - 1ZCIETST0111111114 - - 1ZCIETST0422222228 - - 1ZCIEPIC0111111116 - items: - type: string - pattern: '^1Z[0-9A-Z]{16}$|^1R[0-9A-Z]{14}$|^1R[0-9A-Z]{26}$' - description: Represents tracking numbers starting with '1Z', followed by 16 alphanumeric characters in request, as well as tracking numbers starting with '1R', followed by 14 or 26 alphanumeric characters. - eventPreferences: - type: array - description: | - Represents scan/event preferences for the subscription endpoint. If no value is provided in this array - then all activity types will be sent. - minItems: 1 - maxItems: 4 - items: - type: string - description: package activity identifier - oneOf: - - const: D - title: Delivery - description: Includes updates and delivery photo - - const: I - title: In-Progress - - const: M - title: Manifest - - const: X - title: Exception - description: Includes updates - destination: - $ref: '#/components/schemas/Destination' - ErrorMessage: - type: object - description: The error response containing any errors that occurred - properties: - code: - type: string - description: The error code. - example: VSS300 - message: - type: string - description: The error message. - example: Locale is required. The Subscription request has been rejected. - TrackSubsServiceResponse: - type: object - properties: - validTrackingNumbers: - type: array - description: List of tracking numbers with successful subscription created. - items: - type: string - example: - - 1Z1234567891234556 - - 1ZABCDEFH91234556 - invalidTrackingNumbers: - type: array - description: List of tracking numbers associated with errors preventing subscription creation. - items: - type: string - example: - - 1Z1234567$8 - TrackSubsServiceErrorResponse: - type: object - properties: - response: - $ref: '#/components/schemas/ErrorResponse' - invalidTrackingNumbers: - $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" - required: - - response - ErrorResponse: - type: object - properties: - errors: - type: array - description: The error response containing any errors that occurred. - items: - $ref: '#/components/schemas/ErrorMessage' - TrackingEventRequest: - required: - - trackingNumber - - activityStatus - type: object - description: Package event update payload. - properties: - trackingNumber: - type: string - description: The package's tracking number. - pattern: '^1Z[0-9A-Z]{16}$' - example: 1Z1234567891234556 - localActivityDate: - type: string - description: 'The localized date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - localActivityTime: - type: string - description: 'The localized time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - activityLocation: - "$ref": "#/components/schemas/ActivityLocation" - activityStatus: - "$ref": "#/components/schemas/ActivityStatus" - scheduledDeliveryDate: - type: string - description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryDate: - type: string - description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - actualDeliveryTime: - type: string - description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - gmtActivityDate: - type: string - description: 'The GMT date of the activity. Format: YYYYMMDD' - minLength: 8 - maxLength: 8 - pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ - example: "20191014" - gmtActivityTime: - type: string - description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - gmtOffset: - type: string - description: "A field that shows how local time was calculated. In the format (-/+)HH.MM (24 hr)" - minLength: 6 - maxLength: 6 - pattern: ^[+-]([01]\d|2[0-3])\.[0-5]\d$ - example: "-04.00" - deliveryStartTime: - type: string - description: 'The start time of a delivery. Format: HHMMSS (24 hr).' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryEndTime: - type: string - description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' - minLength: 6 - maxLength: 6 - pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ - example: "235959" - deliveryTimeDescription: - type: string - description: The date of this delivery detail. - deliveryPhoto: - type: string - description: Base64 encoded image of the delivery photo (This field is blank until the delivery photo is made available for enhanced subscriptions). - receivedBy: - type: string - description: Clarified signature provided with delivery, when available. - ActivityLocation: - type: object - description: The container which has the current package activity location. - properties: - city: - type: string - description: The physical address city. - example: Alpharetta - stateProvince: - type: string - description: The physical address state or province. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: GA - postalCode: - type: string - description: The physical address postal code (This field is blank until the delivery event occurs). - minLength: 5 - maxLength: 9 - pattern: ^\d{5}(?:[-\s]\d{4})?$ - examples: - - "30004" - - "30004-4616" - country: - type: string - description: The physical address country. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2} - example: US - ActivityStatus: - type: object - description: The container which has the current package activity status. - properties: - type: - type: string - 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 | - code: - type: string - description: The current activity status code. See the 'Status Codes' document for more details. - description: - type: string - description: The current activity status description. - +openapi: 3.1.0 +info: + title: UPS Track Alert API with Photo + description: | + + # Product Info + + The UPS Track Alert API provides best in-class package tracking visibility with near real time event updates for an improved customer experience and stream line logistic management. + 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 and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

+ + + Run In Postman + + Open in GitHub + + + # Business Values + + - **Enhanced Customer Experience**: Near real-time tracking information increases transparency, leading to higher customer satisfaction and trust. + - **Operational Efficiency**: Eliminates the necessity for continuous polling, thus saving resources and improving system responsiveness. + - **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. + + # Reference + - Appendix + - Track Alert Best Practices + + # FAQs + + - **How does it work once I am setup as a user?** + > You submit up to 100 UPS 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. + + - **When can I expect a delivery photo?** + > Delivery photos are only available with residential deliveries, in package release areas, and with packages that were driver released. Additional event with the delivery photo will be sent, if and when the photo is made available. + + - **What type of packages does Track Alert support? + > Track Alert supports UPS packages that have a 1Z tracking number, as well as Roadie packages (1R tracking numbers). + + - **How do I check if a subscription to a tracking number was successful?** + > Once tracking number(s) is submitted to Track Alert, you will receive a response confirming successful and unsuccessful tracking numbers. + + - **I stopped receiving event messages after 2 weeks and my package hasn’t been delivered. Why?** + > Each tracking number subscription is valid for 14 days. If the package has not been delivered within 14 days, you must resubscribe to the tracking number 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. + + - **How many tracking numbers can a subscriber subscribe to in one request?** + > You can subscribe to up to 100 tracking numbers in each submission to the API. A reply message will be sent via the API with details showing successful and unsuccessful tracking numbers. + + - **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), + 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 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. + + - **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: + 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) + activity location city + activity location state/province + activity location postal code (this field is blank until the delivery event occurs) + activity location country + activity status type + activity status code + activity status description + activity status description code + local activity date + local activity time + GMT activity date + GMT activity time + delivery start time (example '150000') + delivery end time (example '170000') + delivery time description (example 'estimated delivery window' or 'end of day') + delivery photo + received by + + - **Can I test this process?** + > Yes, there are two test tracking numbers that you can submit, and resubmit that will send several events spaced 1 second apart. Those two test tracking numbers are 1ZCIETST0111111114, 1ZCIETST0422222228, and 1ZCIEPIC0111111116. Please ensure to use UPS Production CIE(https://wwwcie.ups.com/api/track/{version}). You can submit these tracking numbers as often as you like. (no stress testing please.) + + - **I subscribed to Track Alert with Photo. Why did I not receive the photo?** + > Only residential deliveries where the package was driver released are eligible for delivery photo. This means that if the package was delivered to a commercial building, the package was handed to a person, or if a signature was collected, no delivery photo will be available. In addition, Track Alert with Photo performs a 'party to the package' check to ensure the user is authorized to view the photo. The account number must be associated with the user's ClientID. + + # Overview + When the UPS system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response. + + Successful responses may or may not include warnings. + 1. **Without warnings** - Indicates the request has been processed as anticipated. + 2. **With warnings** - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user. + + The severity of an error may be transient or hard. + 1. **Transient error** - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time. + 2. **Hard error** - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing. + + The following error codes can apply to all APIs. + + # Error Codes + | **Code** | **HTTP Code** | **Severity** | **Description** | + | :--: | :---: | :---: | :-- | + | UJ0001 | 401 | Hard | Invalid token or token is not present | + | 405 | 405 | Hard | Method Not Allowed. | + | 10004 | 500 | Transient | Something went wrong while processing your request, please try again later | + | 10007 | 400 | Hard | Requested Content Type is not supported | + | 250002 | 401 | Hard | Invalid authentication information. | + | 251004 | 401 | Hard | Bearer Token expired (oauth) | + | VSS000 | 400 | Hard | Invalid request and The Subscription request has been rejected. | + | VSS002 | 400 | Hard | Missing transId | + | VSS003 | 400 | Hard | Please enter a valid Transaction ID, The Subscription request has been rejected. | + | VSS004 | 400 | Hard | Missing transactionSrc | + | VSS006 | 400 | Hard | Please enter a valid Transaction SRC, The Subscription request has been rejected. | + | VSS100 | 500 | Transient | We're sorry, the system is temporarily unavailable. Please try again later. | + | VSS110 | 400 | Hard | Subscription request is empty or not present. The Subscription request has been rejected. | + | VSS200 | 400 | Hard | Tracking Number List is required. The Subscription request has been rejected. | + | VSS210 | 400 | Hard | The Subscription request should have at least one valid tracking number. The Subscription request has been rejected. | + | VSS215 | 400 | Hard | The tracking number that was submitted is not a valid CIE tracking number and has been rejected. | + | VSS220 | 400 | Hard | You have submitted over 100 tracking numbers which is not allowed. The entire submission of tracking numbers has been rejected. Please resubmit your request again using groups of no more than 100 tracking numbers. | + | VSS300 | 400 | Hard | Locale is required. The Subscription request has been rejected. | + | VSS310 | 400 | Hard | Please enter a valid locale. The Subscription request has been rejected | + | VSS400 | 400 | Hard | Please enter a valid country code. The Subscription request has been rejected. | + | VSS414 | 400 | Hard | Event preference is missing or invalid, The Subscription request has been rejected. | + | VSS500 | 400 | Hard | Destination is required. The Subscription request has been rejected | + | VSS600 | 400 | Hard | URL is empty or not present. The Subscription request has been rejected. | + | VSS610 | 400 | Hard | URL is too long. The Subscription request has been rejected. | + | VSS700 | 400 | Hard | Credential is empty or not present. The Subscription request has been rejected. | + | VSS800 | 400 | Hard | CredentialType is empty or not present. The Subscription request has been rejected. | + | VSS930 | 400 | Hard | Type is missing or invalid, The Subscription request has been rejected. | + + +servers: + - url: https://wwwcie.ups.com/api/track/{version} + description: UPS Production CIE OAuth. This is for integration testing only and it will not create any subscription. + variables: + version: + default: v1 + enum: + - v1 + - url: https://onlinetools.ups.com/api/track/{version} + description: UPS Production OAuth. + variables: + version: + default: v1 + enum: + - v1 +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. + + 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. + operationId: processSubscriptionTypeForTrackingNumber + security: + - OAuth2: [] + parameters: + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + - name: version + in: path + description: version + required: true + schema: + type: string + default: v1 + enum: + - v1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceRequest' + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceResponse' + examples: + PartialSuccessExample: + description: Example response that contains valid tracking number for which subscription created and invalid tracking numbers. + value: + validTrackingNumbers: + - 1Z12345678912345560 + invalidTrackingNumbers: + - 1Z1234567$8 + CompleteSuccessExample: + description: Example response that contains valid tracking numbers for which subscription created. + value: + validTrackingNumbers: + - 1Z12345678912345560 + '400': + description: Invalid Request + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + response: + errors: + - code: VSS300 + message: Locale is required. The Subscription request has been rejected. + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: UJ0001 + message: Invalid token or token is not present. + '404': + description: URL does not exist or resource not found. + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "404" + message: The requested resource was not found. + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '405': + description: Method Not Allowed + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + example: + errors: + - code: "405" + message: The requested method is not allowed for this resource. + '429': + description: Rate Limit Exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/TrackSubsServiceErrorResponse" + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/TrackSubsServiceErrorResponse' + example: + errors: + - code: "10004" + message: Internal Server Error +webhooks: + TrackingEventEnhanced: + post: + summary: Tracking Event + description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. + tags: + - UPS Track Alert with Photo + parameters: + - name: credential + in: header + description: It is an opaque string meant for client authentication. Shared in Subscription request. + required: true + schema: + type: string + - name: User-Agent + in: header + description: Represents Track Alert application with value 'UPSPubSubTrackingService'. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrackingEventRequest' + examples: + '1': + summary: Manifest (label created or billing information received) message + value: + activityLocation: + city: '' + country: US + postalCode: '' + stateProvince: '' + activityStatus: + code: MP + description: Shipment Ready for UPS + descriptionCode: '003' + type: M + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: '' + gmtActivityDate: '20240422' + gmtActivityTime: '041230' + localActivityDate: '20240422' + localActivityTime: '091230' + scheduledDeliveryDate: '' + trackingNumber: " 1ZABCXYZ0112346789" + receivedBy: '' + '2': + summary: UPS has your package message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: OR + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryPhoto: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '012901' + localActivityDate: '20240422' + localActivityTime: '212901' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + receivedBy: '' + '3': + summary: On the way (arrival or departure from a UPS building) message + value: + activityLocation: + city: Hickory + country: US + postalCode: '' + stateProvince: NC + activityStatus: + code: DP + description: On the Way + descriptionCode: '005' + type: I + actualDeliveryDate: '' + actualDeliveryTime: '' + deliveryEndTime: '' + deliveryStartTime: '' + deliveryTimeDescription: end of day + gmtActivityDate: '20240423' + gmtActivityTime: '025400' + localActivityDate: '20240422' + localActivityTime: '225400' + scheduledDeliveryDate: '20240423' + trackingNumber: 1ZABCXYZ0112346789 + receivedBy: '' + deliveryPhoto: '' + '4': + summary: Preparing for delivery message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '003052' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '043052' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + receivedBy: '' + deliveryPhoto: '' + '5': + summary: Preparing for delivery/loaded on vehicle message + value: + trackingNumber: 1ZABCXYZ0112346789 + localActivityDate: '20240423' + localActivityTime: '063936' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: YP + description: Preparing for Delivery + descriptionCode: '071' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '103936' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + receivedBy: '' + deliveryPhoto: '' + '6': + summary: Out for delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '091519' + activityLocation: + city: Charlotte + stateProvince: NC + postalCode: '' + country: US + activityStatus: + type: I + code: OT + description: Out for Delivery + descriptionCode: '021' + scheduledDeliveryDate: '20240423' + actualDeliveryDate: '' + actualDeliveryTime: '' + gmtActivityDate: '20240423' + gmtActivityTime: '131519' + deliveryStartTime: '' + deliveryEndTime: '' + deliveryTimeDescription: end of day + receivedBy: '' + deliveryPhoto: '' + '7': + summary: Delivery message + value: + trackingNumber: 1Z204W4R0308071865 + localActivityDate: '20240423' + localActivityTime: '095004' + activityLocation: + city: CHARLOTTE + stateProvince: NC + postalCode: '28209' + country: US + activityStatus: + type: D + code: FS + description: Delivered + descriptionCode: '011' + scheduledDeliveryDate: '20191014' + gmtActivityDate: '20240423' + gmtActivityTime: '135004' + actualDeliveryDate: '20240423' + actualDeliveryTime: '095004' + receivedBy: 'John' + deliveryPhoto: '' + responses: + '200': + description: Return a 200 status to indicate that the data was received successfully +components: + securitySchemes: + OAuth2: + type: oauth2 + description: | + "Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret. + 3. Select \"Request Token\" + 4. Enter any additional information in the Body and Parameters sections. + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + schemas: + Destination: + type: object + description: The destination container related to the clients endpoint API. To which messages would be sent on an event on the package. + required: + - url + - credentialType + - credential + properties: + url: + type: string + format: url + description: | + It is an HTTPS-based callback end point that is exposed by the client to receive event notification. This endpoint must be operational around the clock to ensure no event notifications are missed. + If this endpoint is not continuously available, incoming events will be lost. + example: "https://your-webhook-url.com" + credentialType: + type: string + description: It is an open-entry field that indicates type of credentials supported by the client. + example: Bearer + credential: + type: string + description: It is an opaque string meant for client authentication. If for any reason this credential changes then any event notification will fail until a new subscription is made. + TrackSubsServiceRequest: + required: + - locale + - trackingNumberList + - destination + type: object + properties: + locale: + type: string + description: Locale setting is composed of language code and country code, separated by an underscore. Currently only english US(en_US) is accepted. + pattern: '^[a-z]{2}_[A-Z]{2}$' + example: en_US + countryCode: + type: string + description: Represents the country code. This field is reserved for future use. + example: US + trackingNumberList: + type: array + description: Represents list of tracking numbers in request. + maxItems: 100 + example: + - 1ZCIETST0111111114 + - 1ZCIETST0422222228 + - 1ZCIEPIC0111111116 + items: + type: string + pattern: '^1Z[0-9A-Z]{16}$|^1R[0-9A-Z]{14}$|^1R[0-9A-Z]{26}$' + description: Represents tracking numbers starting with '1Z', followed by 16 alphanumeric characters in request, as well as tracking numbers starting with '1R', followed by 14 or 26 alphanumeric characters. + eventPreferences: + type: array + description: | + Represents scan/event preferences for the subscription endpoint. If no value is provided in this array + then all activity types will be sent. + minItems: 1 + maxItems: 4 + items: + type: string + description: package activity identifier + oneOf: + - const: D + title: Delivery + description: Includes updates and delivery photo + - const: I + title: In-Progress + - const: M + title: Manifest + - const: X + title: Exception + description: Includes updates + destination: + $ref: '#/components/schemas/Destination' + ErrorMessage: + type: object + description: The error response containing any errors that occurred + properties: + code: + type: string + description: The error code. + example: VSS300 + message: + type: string + description: The error message. + example: Locale is required. The Subscription request has been rejected. + TrackSubsServiceResponse: + type: object + properties: + validTrackingNumbers: + type: array + description: List of tracking numbers with successful subscription created. + items: + type: string + example: + - 1Z1234567891234556 + - 1ZABCDEFH91234556 + invalidTrackingNumbers: + type: array + description: List of tracking numbers associated with errors preventing subscription creation. + items: + type: string + example: + - 1Z1234567$8 + TrackSubsServiceErrorResponse: + type: object + properties: + response: + $ref: '#/components/schemas/ErrorResponse' + invalidTrackingNumbers: + $ref: "#/components/schemas/TrackSubsServiceResponse/properties/invalidTrackingNumbers" + required: + - response + ErrorResponse: + type: object + properties: + errors: + type: array + description: The error response containing any errors that occurred. + items: + $ref: '#/components/schemas/ErrorMessage' + TrackingEventRequest: + required: + - trackingNumber + - activityStatus + type: object + description: Package event update payload. + properties: + trackingNumber: + type: string + description: The package's tracking number. + pattern: '^1Z[0-9A-Z]{16}$' + example: 1Z1234567891234556 + localActivityDate: + type: string + description: 'The localized date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + localActivityTime: + type: string + description: 'The localized time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + activityLocation: + "$ref": "#/components/schemas/ActivityLocation" + activityStatus: + "$ref": "#/components/schemas/ActivityStatus" + scheduledDeliveryDate: + type: string + description: 'Original scheduled delivery date of the package. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryDate: + type: string + description: 'Actual delivery date of the package. Format: YYYYMMDD (This field is blank until the delivery event occurs)' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + actualDeliveryTime: + type: string + description: 'Actual delivery time of the package. Format: HHMMSS (24 hr) (This field is blank until the delivery event occurs)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + gmtActivityDate: + type: string + description: 'The GMT date of the activity. Format: YYYYMMDD' + minLength: 8 + maxLength: 8 + pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$ + example: "20191014" + gmtActivityTime: + type: string + description: 'The GMT time of the activity. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + gmtOffset: + type: string + description: "A field that shows how local time was calculated. In the format (-/+)HH.MM (24 hr)" + minLength: 6 + maxLength: 6 + pattern: ^[+-]([01]\d|2[0-3])\.[0-5]\d$ + example: "-04.00" + deliveryStartTime: + type: string + description: 'The start time of a delivery. Format: HHMMSS (24 hr).' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryEndTime: + type: string + description: 'The end time of a window or the committed time or the delivered time. Format: HHMMSS (24 hr)' + minLength: 6 + maxLength: 6 + pattern: ^([01]?\d|2[0-3])([0-5]?\d){2}$ + example: "235959" + deliveryTimeDescription: + type: string + description: The date of this delivery detail. + deliveryPhoto: + type: string + description: Base64 encoded image of the delivery photo (This field is blank until the delivery photo is made available for enhanced subscriptions). + receivedBy: + type: string + description: Clarified signature provided with delivery, when available. + ActivityLocation: + type: object + description: The container which has the current package activity location. + properties: + city: + type: string + description: The physical address city. + example: Alpharetta + stateProvince: + type: string + description: The physical address state or province. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: GA + postalCode: + type: string + description: The physical address postal code (This field is blank until the delivery event occurs). + minLength: 5 + maxLength: 9 + pattern: ^\d{5}(?:[-\s]\d{4})?$ + examples: + - "30004" + - "30004-4616" + country: + type: string + description: The physical address country. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2} + example: US + ActivityStatus: + type: object + description: The container which has the current package activity status. + properties: + type: + type: string + 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 | + code: + type: string + description: The current activity status code. See the 'Status Codes' document for more details. + description: + type: string + description: The current activity status description. diff --git a/WorldEaseShipmentManagement.yaml b/WorldEaseShipmentManagement.yaml index 3a68c31..aae5501 100644 --- a/WorldEaseShipmentManagement.yaml +++ b/WorldEaseShipmentManagement.yaml @@ -1,458 +1,458 @@ -openapi: 3.1.0 -info: - title: WorldEase Shipment Management API v1 - description: | - ## Purpose - The WorldEase Shipment Management API facilitates the consolidation of packages into a single shipment to reduce the brokerage fees and streamline international shipping processes. It offers users the ability to manage the shipment lifecycle including aggregating individual packages, closing out shipments once consolidation is completed and managing master and child shipments with options to delete as necessary. -tags: - - name: World Ease Shipment Management - Shipment - description: For endpoint that allows user to finalize the close out shipments - - 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: - description: Indicates WorldEase Shipment Management API to display the new release features - default: v1 - enum: - - v1 - - url: "https://onlinetools.ups.com/api/ship/{version}" - description: "Production" - variables: - version: - description: Indicates WorldEase Shipment Management API to display the new release features - default: v1 - enum: - - v1 - -paths: - /master-shipment/closeout/{shipment-gccn}: - post: - tags: - - 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: - - name: shipment-gccn - in: path - required: true - description: The unique identifier of the shipment to close Out. It also known as GCCN. - schema: - type: string - maxLength: 11 - pattern: '^[A-Za-z0-9]{11}$' - - name: transId - in: header - required: true - schema: - $ref: "#/components/schemas/CustomTransactionId" - - name: transactionSrc - in: header - required: true - schema: - $ref: "#/components/schemas/CustomTransactionSrc" - - name: version - in: path - description: Indicates WorldEase Shipment Management API to display the new release features - required: true - schema: - type: string - default: v1 - enum: - - v1 - - security: - - OAuth2: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostRequest' - examples: - CloseOutRequest: - value: - shipperAccountNumber: "ISUS01" - responses: - '202': - description: "Request accepted" - content: - application/json: - schema: - $ref: '#/components/schemas/PostResponse' - examples: - CloseOutResponse: - value: - transId: "4ce27ff5-8e17-4797-a8c1-089796db" - label: - opTyp: "PNG" - lblNmbr: "MVpJU1VTMDE2NzIzODc4Mjc3" - lblData: "asdfhkjuiovrtyuiopfghjkxcv" - - - - '400': - description: "Missing required values or incorrect values or validation fails" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - BadGCCNExample: - value: - errors: - - code: "20007" - message: "Missing GCCN" - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - errors: - - code: "250002" - message: "Invalid Authentication Information" - - '404': - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - GCCNNotFound: - value: - errors: - - code: "20008" - message: "GCCN Not Found" - AccountNumberNotFound: - value: - errors: - - code: "20008" - message: "Shipper Account Number Not Found" - - - /master-shipment/{shipment-gccn}: - delete: - tags: - - World Ease Shipment Management - Shipment - operationId: "deleteMasterShipment" - summary: "Deletes the master shipment" - description: " Deletes the specified master shipment from the system. Once deleted system cannot be recovered" - 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: - type: string - maxLength: 11 - pattern: '^[A-Za-z0-9]{11}$' - - name: transId - in: header - required: true - schema: - $ref: "#/components/schemas/CustomTransactionId" - - name: transactionSrc - in: header - required: true - schema: - $ref: "#/components/schemas/CustomTransactionSrc" - - name: version - in: path - description: Indicates WorldEase Shipment Management API to display the new release features - required: true - schema: - type: string - default: v1 - enum: - - v1 - security: - - OAuth2: [] - - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PostRequest' - examples: - DeleteRequest: - value: - shipperAccountNumber: "ISUS01" - responses: - '200': - description: "Successful Operation" - content: - application/json: - schema: - $ref: '#/components/schemas/deleteResponse' - examples: - WeDeleteResponseSummary: - 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: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - BadGCCNExample: - value: - errors: - - code: "20007" - message: "Missing GCCN" - - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - errors: - - code: "250002" - message: "Invalid Authentication Information" - '404': - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - GCCNNotFound: - value: - errors: - - code: "20008" - message: "GCCN Not Found" - AccountNumberNotFound: - value: - errors: - - code: "20008" - message: "Shipper Account Number Not Found" - - - /child-shipment/{shipment-gccn}/{tracking-number}: - delete: - tags: - - World Ease Shipment Management - Shipment - operationId: "deleteChildShipment" - summary: "Delete the child shipment " - description: " This is used to delete the child shipment record from the database" - 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: - type: string - maxLength: 11 - pattern: '^[A-Za-z0-9]{11}$' - - name: trackingNumber - 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 - - name: transId - in: header - required: true - schema: - $ref: "#/components/schemas/CustomTransactionId" - - name: transactionSrc - in: header - required: true - schema: - $ref: "#/components/schemas/CustomTransactionSrc" - - name: version - in: path - description: Indicates WorldEase Shipment Management API to display the new release features - required: true - schema: - type: string - default: v1 - enum: - - v1 - - - security: - - OAuth2: [] - - - responses: - '200': - description: "Successful Operation" - content: - application/json: - schema: - $ref: '#/components/schemas/deleteResponse' - examples: - WeDeleteResponseSummary: - 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: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - BadGCCNExample: - value: - errors: - - code: "20007" - message: "Missing GCCN" - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - Invalid Token: - value: - errors: - - code: "250002" - message: "Invalid Authentication Information" - - '404': - description: Not Found - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - examples: - GCCNNotFound: - value: - errors: - - code: "20008" - message: "GCCN Not Found" - TrackingNumberNotFound: - value: - 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" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - - schemas: - - - PostRequest: - type: "object" - required: - - shipperAccountNumber - properties: - 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: - - transId - - label - properties: - transId: - $ref: "#/components/schemas/CustomTransactionId" - label: - type: "object" - description: "This will contain master shipment label" - properties: - opTyp: - type: 'string' - enum: [PNG, GIF, PDF, ZPL, EPL, STAR, SPL] - description: "The is the output type in which label is generated " - lblNmbr: - type: "string" - description: "The label number assigned to this label" - lblData: - type: "string" - description: "Base64 encoded label image" - - - deleteResponse: - type: "object" - required: - - code - - message - properties: - code: - type: "string" - description: "Identifies the success or failure of the transaction. 1 = Successful" - message: - type: "string" - description: "Succesful text message" - - - - ErrorResponse: - description: Error response entity - type: object - required: - - errors - properties: - errors: - type: array - description: error payload - array containing one or more Errors - items: - $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 " - - - CustomTransactionId: - description: Client generated id which is treated as the Transaction ID - type: string - minLength: 32 - maxLength: 32 - pattern: '^[a-fA-F0-9\-]+$' - example: - 4ce27ff5-8e17-4797-a8c1-089796db - - CustomTransactionSrc: - description: An identifier of the client/source application that is making the request.Length 512 - type: string - maxLength: 512 - example: - SAM +openapi: 3.1.0 +info: + title: WorldEase Shipment Management API v1 + description: | + ## Purpose + The WorldEase Shipment Management API facilitates the consolidation of packages into a single shipment to reduce the brokerage fees and streamline international shipping processes. It offers users the ability to manage the shipment lifecycle including aggregating individual packages, closing out shipments once consolidation is completed and managing master and child shipments with options to delete as necessary. +tags: + - name: World Ease Shipment Management - Shipment + description: For endpoint that allows user to finalize the close out shipments + - 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: + description: Indicates WorldEase Shipment Management API to display the new release features + default: v1 + enum: + - v1 + - url: "https://onlinetools.ups.com/api/ship/{version}" + description: "Production" + variables: + version: + description: Indicates WorldEase Shipment Management API to display the new release features + default: v1 + enum: + - v1 + +paths: + /master-shipment/closeout/{shipment-gccn}: + post: + tags: + - 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: + - name: shipment-gccn + in: path + required: true + description: The unique identifier of the shipment to close Out. It also known as GCCN. + schema: + type: string + maxLength: 11 + pattern: '^[A-Za-z0-9]{11}$' + - name: transId + in: header + required: true + schema: + $ref: "#/components/schemas/CustomTransactionId" + - name: transactionSrc + in: header + required: true + schema: + $ref: "#/components/schemas/CustomTransactionSrc" + - name: version + in: path + description: Indicates WorldEase Shipment Management API to display the new release features + required: true + schema: + type: string + default: v1 + enum: + - v1 + + security: + - OAuth2: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostRequest' + examples: + CloseOutRequest: + value: + shipperAccountNumber: "ISUS01" + responses: + '202': + description: "Request accepted" + content: + application/json: + schema: + $ref: '#/components/schemas/PostResponse' + examples: + CloseOutResponse: + value: + transId: "4ce27ff5-8e17-4797-a8c1-089796db" + label: + opTyp: "PNG" + lblNmbr: "MVpJU1VTMDE2NzIzODc4Mjc3" + lblData: "asdfhkjuiovrtyuiopfghjkxcv" + + + + '400': + description: "Missing required values or incorrect values or validation fails" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + BadGCCNExample: + value: + errors: + - code: "20007" + message: "Missing GCCN" + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + errors: + - code: "250002" + message: "Invalid Authentication Information" + + '404': + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + GCCNNotFound: + value: + errors: + - code: "20008" + message: "GCCN Not Found" + AccountNumberNotFound: + value: + errors: + - code: "20008" + message: "Shipper Account Number Not Found" + + + /master-shipment/{shipment-gccn}: + delete: + tags: + - World Ease Shipment Management - Shipment + operationId: "deleteMasterShipment" + summary: "Deletes the master shipment" + description: " Deletes the specified master shipment from the system. Once deleted system cannot be recovered" + 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: + type: string + maxLength: 11 + pattern: '^[A-Za-z0-9]{11}$' + - name: transId + in: header + required: true + schema: + $ref: "#/components/schemas/CustomTransactionId" + - name: transactionSrc + in: header + required: true + schema: + $ref: "#/components/schemas/CustomTransactionSrc" + - name: version + in: path + description: Indicates WorldEase Shipment Management API to display the new release features + required: true + schema: + type: string + default: v1 + enum: + - v1 + security: + - OAuth2: [] + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostRequest' + examples: + DeleteRequest: + value: + shipperAccountNumber: "ISUS01" + responses: + '200': + description: "Successful Operation" + content: + application/json: + schema: + $ref: '#/components/schemas/deleteResponse' + examples: + WeDeleteResponseSummary: + 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: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + BadGCCNExample: + value: + errors: + - code: "20007" + message: "Missing GCCN" + + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + errors: + - code: "250002" + message: "Invalid Authentication Information" + '404': + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + GCCNNotFound: + value: + errors: + - code: "20008" + message: "GCCN Not Found" + AccountNumberNotFound: + value: + errors: + - code: "20008" + message: "Shipper Account Number Not Found" + + + /child-shipment/{shipment-gccn}/{tracking-number}: + delete: + tags: + - World Ease Shipment Management - Shipment + operationId: "deleteChildShipment" + summary: "Delete the child shipment " + description: " This is used to delete the child shipment record from the database" + 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: + type: string + maxLength: 11 + pattern: '^[A-Za-z0-9]{11}$' + - name: trackingNumber + 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 + - name: transId + in: header + required: true + schema: + $ref: "#/components/schemas/CustomTransactionId" + - name: transactionSrc + in: header + required: true + schema: + $ref: "#/components/schemas/CustomTransactionSrc" + - name: version + in: path + description: Indicates WorldEase Shipment Management API to display the new release features + required: true + schema: + type: string + default: v1 + enum: + - v1 + + + security: + - OAuth2: [] + + + responses: + '200': + description: "Successful Operation" + content: + application/json: + schema: + $ref: '#/components/schemas/deleteResponse' + examples: + WeDeleteResponseSummary: + 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: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + BadGCCNExample: + value: + errors: + - code: "20007" + message: "Missing GCCN" + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Invalid Token: + value: + errors: + - code: "250002" + message: "Invalid Authentication Information" + + '404': + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + GCCNNotFound: + value: + errors: + - code: "20008" + message: "GCCN Not Found" + TrackingNumberNotFound: + value: + 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" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + + schemas: + + + PostRequest: + type: "object" + required: + - shipperAccountNumber + properties: + 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: + - transId + - label + properties: + transId: + $ref: "#/components/schemas/CustomTransactionId" + label: + type: "object" + description: "This will contain master shipment label" + properties: + opTyp: + type: 'string' + enum: [PNG, GIF, PDF, ZPL, EPL, STAR, SPL] + description: "The is the output type in which label is generated " + lblNmbr: + type: "string" + description: "The label number assigned to this label" + lblData: + type: "string" + description: "Base64 encoded label image" + + + deleteResponse: + type: "object" + required: + - code + - message + properties: + code: + type: "string" + description: "Identifies the success or failure of the transaction. 1 = Successful" + message: + type: "string" + description: "Succesful text message" + + + + ErrorResponse: + description: Error response entity + type: object + required: + - errors + properties: + errors: + type: array + description: error payload - array containing one or more Errors + items: + $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 " + + + CustomTransactionId: + description: Client generated id which is treated as the Transaction ID + type: string + minLength: 32 + maxLength: 32 + pattern: '^[a-fA-F0-9\-]+$' + example: + 4ce27ff5-8e17-4797-a8c1-089796db + + CustomTransactionSrc: + description: An identifier of the client/source application that is making the request.Length 512 + type: string + maxLength: 512 + example: + SAM diff --git a/mainspec1.yaml b/mainspec1.yaml index 1dcfa1a..29dda00 100644 --- a/mainspec1.yaml +++ b/mainspec1.yaml @@ -1,227 +1,227 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - - name: Delivery Defense - description: - $ref: "DeliveryDefense.yaml#/info/description" - - name: Delivery Intercept - description: - $ref: "DeliveryIntercept.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Commerce Guard - description: - $ref: "CommerceGuard.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/deliveryintercept/{version}/charges/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" - "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" - "/deliveryintercept/{version}/redirect/address/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" - "/deliveryintercept/{version}/willcall/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" - "/deliveryintercept/{version}/return/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" - "/deliveryintercept/{version}/reschedule/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" - "/deliveryintercept/{version}/cancel/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" - "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" - "/commerce-guard/{version}/verify": - "$ref": "CommerceGuard.yaml#/paths/~1commerce-guard~1{version}~1verify" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file +openapi: 3.1.0 +info: + title: '' + description: '' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: UPS Track Alert + description: + $ref: "UPSTrackAlert.yaml#/info/description" + - name: UPS Track Alert with Photo + description: + $ref: "UPSTrackAlertEnhanced.yaml#/info/description" + - name: Delivery Defense + description: + $ref: "DeliveryDefense.yaml#/info/description" + - name: Delivery Intercept + description: + $ref: "DeliveryIntercept.yaml#/info/description" + - name: Export Assure + description: + $ref: "UPSExportAssure.yaml#/info/description" + - name: Interactive Description + description: + $ref: "InteractiveDescriptionGuidance.yaml#/info/description" + - name: Address Validation + description: + $ref: "AddressValidation.yaml#/info/description" + - name: Commerce Guard + description: + $ref: "CommerceGuard.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: TradeDirect + description: + $ref: "TradeDirect.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" + "/ship/tradedirect/{version}/master-shipments/documents": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "/track/{version}/subscription/enhanced/package": + "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" + "/deliveryintercept/{version}/charges/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" + "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" + "/deliveryintercept/{version}/redirect/address/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" + "/deliveryintercept/{version}/willcall/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" + "/deliveryintercept/{version}/return/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" + "/deliveryintercept/{version}/reschedule/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" + "/deliveryintercept/{version}/cancel/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" + "/deliverydefense/external/v1.0/address/score": + "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" + "/brokerage/{version}/importexport/exportassure": + "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" + "/export-assure/{version}/interactive": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" + "/export-assure/{version}/interactive/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" + "/export-assure/{version}/interactive/feedback/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" + #"/brokerage/{version}/content/glc/request-quote": + # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" + "/track/{version}/subscription/standard/package": + "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" + "/commerce-guard/{version}/verify": + "$ref": "CommerceGuard.yaml#/paths/~1commerce-guard~1{version}~1verify" +webhooks: + TrackingEvent: + "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" + TrackingEventEnhanced: + "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec2.yaml b/mainspec2.yaml index 0a4cd02..d61e03d 100644 --- a/mainspec2.yaml +++ b/mainspec2.yaml @@ -1,198 +1,198 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file +openapi: 3.1.0 +info: + title: '' + description: '' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: UPS Track Alert + description: + $ref: "UPSTrackAlert.yaml#/info/description" + - name: UPS Track Alert with Photo + description: + $ref: "UPSTrackAlertEnhanced.yaml#/info/description" + - name: Export Assure + description: + $ref: "UPSExportAssure.yaml#/info/description" + - name: Interactive Description + description: + $ref: "InteractiveDescriptionGuidance.yaml#/info/description" + - name: Address Validation + description: + $ref: "AddressValidation.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: TradeDirect + description: + $ref: "TradeDirect.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" + "/ship/tradedirect/{version}/master-shipments/documents": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "/track/{version}/subscription/enhanced/package": + "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" + "/brokerage/{version}/importexport/exportassure": + "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" + "/export-assure/{version}/interactive": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" + "/export-assure/{version}/interactive/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" + "/export-assure/{version}/interactive/feedback/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" + "/track/{version}/subscription/standard/package": + "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" +webhooks: + TrackingEvent: + "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" + TrackingEventEnhanced: + "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec3.yaml b/mainspec3.yaml index e747a11..586f36b 100644 --- a/mainspec3.yaml +++ b/mainspec3.yaml @@ -1,171 +1,171 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file +openapi: 3.1.0 +info: + title: '' + description: '' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: Address Validation + description: + $ref: "AddressValidation.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: TradeDirect + description: + $ref: "TradeDirect.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" + "/ship/tradedirect/{version}/master-shipments/documents": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + #"/brokerage/{version}/content/glc/request-quote": + # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec4.yaml b/mainspec4.yaml index 62a7aa2..b7747ba 100644 --- a/mainspec4.yaml +++ b/mainspec4.yaml @@ -1,187 +1,187 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert-Ready.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation-Ready.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods-Ready.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost-Ready.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless-Ready.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification-Ready.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView-Ready.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking-Ready.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file +openapi: 3.1.0 +info: + title: '' + description: '' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: UPS Track Alert + description: + $ref: "UPSTrackAlert-Ready.yaml#/info/description" + - name: UPS Track Alert with Photo + description: + $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" + - name: Export Assure + description: + $ref: "UPSExportAssure.yaml#/info/description" + - name: Interactive Description + description: + $ref: "InteractiveDescriptionGuidance.yaml#/info/description" + - name: Address Validation + description: + $ref: "AddressValidation-Ready.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods-Ready.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost-Ready.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode-Ready.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials-Ready.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless-Ready.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification-Ready.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView-Ready.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking-Ready.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "/track/{version}/subscription/enhanced/package": + "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" + "/brokerage/{version}/importexport/exportassure": + "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" + "/export-assure/{version}/interactive": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" + "/export-assure/{version}/interactive/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" + "/export-assure/{version}/interactive/feedback/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" + #"/brokerage/{version}/content/glc/request-quote": + # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" + "/track/{version}/subscription/standard/package": + "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" +webhooks: + TrackingEvent: + "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" + TrackingEventEnhanced: + "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec5.yaml b/mainspec5.yaml index 4b1c8f6..61e6a2c 100644 --- a/mainspec5.yaml +++ b/mainspec5.yaml @@ -1,158 +1,158 @@ -openapi: 3.1.0 -info: - title: '' - description: ' ' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: Address Validation - description: - $ref: "AddressValidation-Ready.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods-Ready.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost-Ready.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless-Ready.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification-Ready.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView-Ready.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking-Ready.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file +openapi: 3.1.0 +info: + title: '' + description: ' ' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: Address Validation + description: + $ref: "AddressValidation-Ready.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods-Ready.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost-Ready.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode-Ready.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials-Ready.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless-Ready.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification-Ready.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView-Ready.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking-Ready.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + #"/brokerage/{version}/content/glc/request-quote": + # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec6.yaml b/mainspec6.yaml index fdad7b9..23c5bc9 100644 --- a/mainspec6.yaml +++ b/mainspec6.yaml @@ -1,210 +1,210 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert-Ready.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" - - name: Delivery Defense - description: - $ref: "DeliveryDefense-Ready.yaml#/info/description" - - name: Delivery Intercept - description: - $ref: "DeliveryIntercept.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation-Ready.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods-Ready.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost-Ready.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless-Ready.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification-Ready.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView-Ready.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking-Ready.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/deliveryintercept/{version}/charges/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" - "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" - "/deliveryintercept/{version}/redirect/address/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" - "/deliveryintercept/{version}/willcall/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" - "/deliveryintercept/{version}/return/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" - "/deliveryintercept/{version}/reschedule/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" - "/deliveryintercept/{version}/cancel/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" - "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense-Ready.yaml#/paths/~1address~1score" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' +openapi: 3.1.0 +info: + title: '' + description: '' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: UPS Track Alert + description: + $ref: "UPSTrackAlert-Ready.yaml#/info/description" + - name: UPS Track Alert with Photo + description: + $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" + - name: Delivery Defense + description: + $ref: "DeliveryDefense-Ready.yaml#/info/description" + - name: Delivery Intercept + description: + $ref: "DeliveryIntercept.yaml#/info/description" + - name: Export Assure + description: + $ref: "UPSExportAssure.yaml#/info/description" + - name: Interactive Description + description: + $ref: "InteractiveDescriptionGuidance.yaml#/info/description" + - name: Address Validation + description: + $ref: "AddressValidation-Ready.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods-Ready.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost-Ready.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode-Ready.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials-Ready.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless-Ready.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification-Ready.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView-Ready.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking-Ready.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "/track/{version}/subscription/enhanced/package": + "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" + "/deliveryintercept/{version}/charges/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" + "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" + "/deliveryintercept/{version}/redirect/address/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" + "/deliveryintercept/{version}/willcall/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" + "/deliveryintercept/{version}/return/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" + "/deliveryintercept/{version}/reschedule/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" + "/deliveryintercept/{version}/cancel/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" + "/deliverydefense/external/v1.0/address/score": + "$ref": "DeliveryDefense-Ready.yaml#/paths/~1address~1score" + "/brokerage/{version}/importexport/exportassure": + "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" + "/export-assure/{version}/interactive": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" + "/export-assure/{version}/interactive/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" + "/export-assure/{version}/interactive/feedback/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" + #"/brokerage/{version}/content/glc/request-quote": + # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" + "/track/{version}/subscription/standard/package": + "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" +webhooks: + TrackingEvent: + "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" + TrackingEventEnhanced: + "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec7.yaml b/mainspec7.yaml index 35f5e5c..09868dd 100644 --- a/mainspec7.yaml +++ b/mainspec7.yaml @@ -1,220 +1,220 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - - name: Delivery Defense - description: - $ref: "DeliveryDefense.yaml#/info/description" - - name: Delivery Intercept - description: - $ref: "DeliveryIntercept.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/deliveryintercept/{version}/charges/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" - "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" - "/deliveryintercept/{version}/redirect/address/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" - "/deliveryintercept/{version}/willcall/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" - "/deliveryintercept/{version}/return/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" - "/deliveryintercept/{version}/reschedule/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" - "/deliveryintercept/{version}/cancel/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" - "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file +openapi: 3.1.0 +info: + title: '' + description: '' + version: '' +servers: + - url: https://wwwcie.ups.com/api + description: Customer Integration Environment + - url: https://onlinetools.ups.com/api + description: Production +tags: + - name: UPS Track Alert + description: + $ref: "UPSTrackAlert.yaml#/info/description" + - name: UPS Track Alert with Photo + description: + $ref: "UPSTrackAlertEnhanced.yaml#/info/description" + - name: Delivery Defense + description: + $ref: "DeliveryDefense.yaml#/info/description" + - name: Delivery Intercept + description: + $ref: "DeliveryIntercept.yaml#/info/description" + - name: Export Assure + description: + $ref: "UPSExportAssure.yaml#/info/description" + - name: Interactive Description + description: + $ref: "InteractiveDescriptionGuidance.yaml#/info/description" + - name: Address Validation + description: + $ref: "AddressValidation.yaml#/info/description" + - name: Dangerous Goods + description: + $ref: "DangerousGoods.yaml#/info/description" + #- name: Global Checkout + # description: + # $ref: "GlobalCheckout.yaml#/info/description" + - name: Landed Cost + description: + $ref: "LandedCost.yaml#/info/description" + - name: Locator + description: + $ref: "Locator.yaml#/info/description" + - name: OAuth Auth Code + description: + $ref: "OAuthAuthCode.yaml#/info/description" + - name: OAuth Client Credentials + description: + $ref: "OAuthClientCredentials.yaml#/info/description" + - name: Paperless + description: + $ref: "Paperless.yaml#/info/description" + - name: Pickup + description: + $ref: "Pickup.yaml#/info/description" + - name: Pre-Notification + description: + $ref: "PreNotification.yaml#/info/description" + - name: Quantum View + description: + $ref: "QuantumView.yaml#/info/description" + - name: Rating + description: + $ref: "Rating.yaml#/info/description" + - name: Shipping + description: + $ref: "Shipping.yaml#/info/description" + - name: TradeDirect + description: + $ref: "TradeDirect.yaml#/info/description" + - name: Time in Transit + description: + $ref: "TimeInTransit.yaml#/info/description" + - name: Tracking + description: + $ref: "Tracking.yaml#/info/description" + - name: World Ease Shipment Management - Shipment + description: + $ref: "WorldEaseShipmentManagement.yaml#/info/description" +paths: + "/addressvalidation/{version}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "/addressvalidation/{deprecatedVersion}/{requestoption}": + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "/dangerousgoods/{version}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "/dangerousgoods/{version}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/landedcost/{version}/quotes": + "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" + "/locations/{version}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" + "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": + "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" + "/v1/oauth/authorize": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" + "/v1/oauth/token": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" + "/v1/oauth/refresh": + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" + "/security/v1/oauth/token": + "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" + "/paperlessdocuments/{version}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "/paperlessdocuments/{version}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "/paperlessdocuments/{version}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "/paperlessdocuments/{deprecatedVersion}/upload": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "/paperlessdocuments/{deprecatedVersion}/image": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "/shipments/{version}/pickup/{pickuptype}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" + "/shipments/{version}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" + "/pickupcreation/{version}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" + "/pickup/{version}/countries/{countrycode}": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" + "/pickup/{version}/servicecenterlocations": + "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" + "/shipments/{deprecatedVersion}/pickup/{CancelBy}": + "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" + "/pickupcreation/{deprecatedVersion}/pickup": + "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" + "/dangerousgoods/{version}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "/dangerousgoods/{deprecatedVersion}/prenotification": + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "/quantumview/{version}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" + "/quantumview/{deprecatedVersion}/events": + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "/rating/{version}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" + "/rating/{deprecatedVersion}/{requestoption}": + "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" + "/shipments/{version}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" + "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" + "/labels/{version}/recovery": + "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" + "/shipments/{deprecatedVersion}/ship": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" + "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": + "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" + "/ship/tradedirect/{version}/master-shipments/documents": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" + "/shipments/{version}/transittimes": + "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" + "/track/v1/details/{inquiryNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "/track/v1/reference/details/{referenceNumber}": + "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "/track/{version}/subscription/enhanced/package": + "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" + "/deliveryintercept/{version}/charges/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" + "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" + "/deliveryintercept/{version}/redirect/address/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" + "/deliveryintercept/{version}/willcall/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" + "/deliveryintercept/{version}/return/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" + "/deliveryintercept/{version}/reschedule/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" + "/deliveryintercept/{version}/cancel/{tracking_number}": + "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" + "/deliverydefense/external/v1.0/address/score": + "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" + "/brokerage/{version}/importexport/exportassure": + "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" + "/export-assure/{version}/interactive": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" + "/export-assure/{version}/interactive/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" + "/export-assure/{version}/interactive/feedback/{sessionId}": + "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" + "/ship/{version}/master-shipment/closeout/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" + "/ship/{version}/master-shipment/{shipment-gccn}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" + "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": + "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" + "/track/{version}/subscription/standard/package": + "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" +webhooks: + TrackingEvent: + "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" + TrackingEventEnhanced: + "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" +components: + securitySchemes: + OAuth2: + $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' + BasicAuth: + $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' + BasicAuthGenerate: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' + BasicAuthRefresh: + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh'