Skip to navigation

returns a guaranteed landed cost quote

This endpoint requests guaranteed quotes for landed cost duties and taxes.

Authentication

AuthorizationBearer

“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”

Headers

transIdstringRequired
An identifier unique to the request.
transactionSrcstringRequired

Identifies the client/source application that is calling.

AcceptstringRequired
The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand.
registration-idstringOptionalformat: "^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$"
The Customer Registration Identifier used to validate the shipper account. If not passed then it will be obtained with the OAuth token's UUID.

Request

This endpoint expects an object.
shipperCurrencyCodestringRequiredformat: "^[A-Z]{3}$"=3 characters

Shipper’s currency code adhering to ISO 4217 standard. Click here for more information.

shipperAccountNumberstringRequired=6 characters
The Shipper's UPS Account Number.
shipmentobjectRequired
buyerCurrencyCodestringOptionalformat: "^[A-Z]{3}$"=3 characters

Buyer’s currency code adhering to ISO 4217 standard. Click here for more information.

serviceLevelCodeenumOptional

The code for the UPS Service associated with the shipment. Click here for more information.

referenceNumberstringOptional<=512 characters
A unique identifier used by clients for internal tracking.

Response headers

application/jsonstringOptional

Response

Request successful
quoteIdstring<=32 characters
unique quote id.
quoteCreationTimestampstringformat: "datetime"=24 characters

Timestamp for quote generation(UTC).

quoteExpirationDatedate

Date after which the quote is no longer valid. yyyy-mm-dd format.

gcTotallist of objects
array for buyer and billing Global checkout total items.
referenceNumberstringOptional<=512 characters
A reference for customer internal tracking from the request .

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error