uShip Protection Plan via API

AI Tools

uShip in-home delivery partners are able to request a protection plan prior to checkout via the API. After entering the coverage amount, you will receive the itemized premiums that can be included in the respective listing. This field is not required and partners are able to exclude, increase or decrease the amount of coverage.

Once you include an protection plan value over the API, it will pre-populate that at checkout if you are manually finalizing your listing.

Obtaining Protection Plan Price

Partners can retrieve the protection plan cost by including the coverage amount they would like in their fixed price request. For the itemin your request you can include the optional coverage amount and receive a distinct premium in the response.

The response will return the name your price amount (nyp), the total price(name your price + uShip fee) and the premium.

Fields	Description
price	The cost of shipping plus the uShip service fee.
nypAmount	The amount it would cost to ship and clear our marketplace.
priceCorrelationId	This value is used to improve our price algorithm and should be included as a reference number with all listings.
premium.amount	The premium required based on your desired coverage level
coverageAmount.amount	The amount of coverage you would like for this shipment.
commodity	List of commodities found here - Commodities
originCountryCode	ISO Code for origin country
destinationCountryCode	ISO code for destination country

{ "destinationPostalCode":"08260", "originPostalCode":"04093", "items":[ { "heightInMeters":0.83, "lengthInMeters":1.37, "unitCount":1, "weightInGrams":81646, "widthInMeters":0.5 } ], "source":"partnername", "commodity": "Furniture", "originCountryCode": "US", "destinationCountryCode": "US", "insurance": { "coverageAmount": { "amount": 4000.00, "currencyType": "USD", "commodity": "Furniture" } } }

200 OK { "price": 267.46999999999997, "nypAmount": 242.48, "priceCorrelationId": "caf51641-63e3-421a-994f-ddb745459659", "insurance": { "premium": { "amount": 51.0, "currencyType": "USD" }, "coverageAmount": { "amount": 4000.00, "currencyType": "USD" } } }

Including Coverage in Listing

Partners can include this itemized protection plan coverage in their listing creation. Include the coverage amount from the pricing call as well as the price + premium amountas the namedPrice amount to fully cover the cost of shipping, uShip fee, and protection plan premium.

{ "title":"Required (Furniture Listing) Title", "description":"Provide optional details about the furniture listing.", "route":{ "items":[ { "address":{ "streetAddress":"10155 Montague St", "alternateStreetAddress":"Building 2, Suite 100", "majorMunicipality":"Tampa", "postalCode":"33626", "stateProvince":"FL", "country":"US", "latitude":28.056858, "longitude":-82.605871, "type":"Residence", "timeZone":"America/New_York" }, "timeFrame":{ "earliestArrival":"2014/08/08", "latestArrival":"2014/08/10", "timeFrameType":"between" }, "contact":{ "name":"Jeremy Clinton", "companyName":"Furniture LLC", "phoneNumber":"25678345678", "email":"google@gmail.com", "firstName":"Cody", "lastName":"Holdin" } }, { "address":{ "streetAddress":"1614 E Riverside Dr", "majorMunicipality":"Austin", "postalCode":"78741", "stateProvince":"TX", "country":"US", "latitude":30.234123, "longitude":-97.718296, "type":"BusinessWithLoadingDockOrForklift", "timeFrame":"America/Chicago" }, "timeFrame":{ "earliestArrival":"2014/08/11", "latestArrival":"2014/08/12", "timeFrameType":"before" }, "contact":{ "name":"Mark Campbell", "companyName":"Furniture LLC", "phoneNumber":"25678905678", "email":"mark@gmail.com", "firstName":"Mark", "lastName":"Campbell" } } ] }, "pricing":{ "namedPrice":{ "amount":344.99, "currencyType":"USD" } }, "insurance":{ "coverageAmount":{ "amount":4000, "currencyType":"USD" } }, "items":[ { "Title":"Title of the specific item especially if there are multiple items.", "Commodity":"Furniture", "widthInMeters":1.524, "lengthInMeters":1.397, "heightInMeters":1.041, "weightInGrams":38100, "unitCount":2, "Description":"Details about the furniture item." } ], "attributes":{ "crated":true, "stackable":true, "palletized":true }, "serviceTypes":[ "BlanketWrap" ], "referenceNumbers":[ { "number":"6a8a7b9d-68e3-4ebc-9f26-4b3bfa7688b5", "type":10 //don"'t change type text, 10 designates price correlation id }] }

201 Created // Listing ID is available in the Location response header

Troubleshooting

Please review the limitations below if you are seeing a 400 error.

Unsupported commodity: Protection plan coverage is currently only available for the Furniture commodity.
Unsupported currency: Protection plan coverage is currently only available for USD.
Coverage Amount Outside of Range: Partners are able to negotiate their own minimum and maximum coverage amounts. If you enter a number more than your policy's maximum amount, the policy maximum will be purchased rather than showing an error and declining the coverage.

Last updated on