LTL Accept a Rate: Reference
A Shipping Customer accepts a rate he or she selected from the list of published rates. Call the Create User method to accept a rate for a listing or a rate request.
To use this endpoint, meet the following criteria
- The rate must not be expired.
- The currency for the rate, insurance, and the user setting must match.
- The Shipping Customer must have a valid payment method on file.
Sample JSON Request
{ "terrapass": true, "insurance": { "coverage": { "amount": 123, "currencyType": "USD" } }, "paymentMethodId": "12345AB6-78C9-12DE-34FG-56789123H45I", "postpay": true}Response
Success Status: 201 Created
Response Header
Location header example: https://api.ushipsandbox.com/v2/listings/276760166
Listing may be retrieved by making call: GET https://api.uship.com/v2/listings/{listingId}
API Reference
| Field | Type | Description | Sample Valid Values |
|---|---|---|---|
| terrapass | Boolean | The TerraPass Certified Green Provider Program is a way to offer carbon-balanced shipping and offset or reduce emissions altogether. To learn more, visit http://www.uship.com/terrapass and http://www.terrapass.com/cb-partners/uship/. uShip charges a flat fee of $1.99 to offset the shipment's carbon footprint.
| true |
| insurance | Container | Wrapper for the cargo insurance fields that protect the shipment from loss or damage. If the insurance fields are null, the API assumes that the Shipping Customer declined cargo insurance. | - |
| coverage | Container | Wrapper for the coverage fields. Specified if a Shipping Customer elects cargo insurance. | - |
| amount | Decimal | The value of the Shipping Customer's item(s) or the amount he or she wishes to cover. | 10000 |
| currencyType | String | Obtain a list of 3-letter ISO4217 standard values currently supported by the uShip API via GET Currencies Lookup API https://api.uship.com/v2/lookups/currencies/. | "GBP" |
| paymentMethodId | String | Obtain the unique 36-character payment method identifier via GET https://api.uship.com/v2/paymentmethods?topLevelCommodity=ltl. | "12345AB6-78C9-12DE-34FG-56789123H45I" |
| postPay | Boolean | A Shipping Customer must be both eligible to use and set PostPay (true) to use it. A valid credit card is the only form of payment for PostPay. See [LTL Freight Terminology](LTL Freight Terminology) to learn more about the payment options and PostPay eligibility.
| false |