API Documentation
Sign upLogin

Create a quote

post
https://sandbox.api.mothership.com/beta/quotes

This endpoint allows a user to pass in shipment details and create a quote. This response will return the available rates with respective prices, and also return a quote ID that can be used in the Create Shipment endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Quote data

pickup
object
required

Object containing pickup (shipper) location information. Must contain either placeId or address.

delivery
object
required

Object containing delivery (consignee) location information. Must contain either placeId or address.

float
≥ 5000
Defaults to 25000

Timeout (in milliseconds) for rates to be returned. Default is 25000ms. Some carriers take longer than others to return rates, so a lower rateResponseTimeoutMs may result in fewer rates being returned. Certain platforms, like Shopify, have a strict timeout time, so a lower rateResponseTimeoutMs may be necessary for your use-case. Use with caution.

  • If you are unsure, leave this field blank.
  • If you are experiencing issues with rates not being returned, you may want to increase this value.
  • This value is the time taken to retrieve the rate. If you have a hard limit on the time to wait for a response, you should set a timeout on the request itself. NOTE - If set, the minimum value is 5000ms (5 seconds)
freight
array of objects
required
length ≥ 1

Array of freight information. Each array element represents a different line item of freight

freight*
required

Date and time of day that this shipment will be ready to be picked up. Object consisting of date and time where date has a format of "YYYY-MM-DD"and time has a 24-hour time format, such as "0900".
For example: {"date": "2024-01-30", "time": "0900"}

boolean
Defaults to true

If false, will not apply any available credits on the shipper account to this quote

integer
101 to 250000

Declared freight value in USD. This adds Freight Protect to your quote, you do not have to pass this value if you want to rely on the carrier's default insurance coverage.

Response

Updated 2 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago