Get rates for a package
POST
/shipments/quote
const url = 'https://shipjay.com/api/v1/shipments/quote';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"to":{"name":"example","company":"example","street1":"example","street2":"example","city":"example","state":"example","zip":"example","country":"US","phone":"example","email":"[email protected]"},"from_address_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","parcel":{"packaging_type":"box","length_in":1,"width_in":1,"height_in":1,"weight_oz":1},"options":{"insurance_cents":1,"signature":false,"media_mail":false,"irregular":false,"hazmat":"LIMITED_QUANTITY","is_return":false,"reference1":"example","reference2":"example","label_size":"4x6","label_format":"PDF"},"customs":{"contents_type":"merchandise","signer":"example","items":[{"description":"example","hs_tariff_number":"example","origin_country":"US","quantity":1,"value_cents":1,"weight_oz":1}],"sender_tax_id":{"id":"example","type":"IOSS"},"recipient_tax_id":{"id":"example","type":"IOSS"}},"email_recipients":[],"order_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","batch_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","verify_address":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://shipjay.com/api/v1/shipments/quote \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "to": { "name": "example", "company": "example", "street1": "example", "street2": "example", "city": "example", "state": "example", "zip": "example", "country": "US", "phone": "example", "email": "[email protected]" }, "from_address_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "parcel": { "packaging_type": "box", "length_in": 1, "width_in": 1, "height_in": 1, "weight_oz": 1 }, "options": { "insurance_cents": 1, "signature": false, "media_mail": false, "irregular": false, "hazmat": "LIMITED_QUANTITY", "is_return": false, "reference1": "example", "reference2": "example", "label_size": "4x6", "label_format": "PDF" }, "customs": { "contents_type": "merchandise", "signer": "example", "items": [ { "description": "example", "hs_tariff_number": "example", "origin_country": "US", "quantity": 1, "value_cents": 1, "weight_oz": 1 } ], "sender_tax_id": { "id": "example", "type": "IOSS" }, "recipient_tax_id": { "id": "example", "type": "IOSS" } }, "email_recipients": [], "order_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "batch_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "verify_address": true }'Rates every enabled carrier and returns the prices the organization pays. The shipment is saved as rated and can be bought with POST /shipments/{id}/buy for ten minutes. Shipping rules are applied: rates a rule removes are not returned.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
to
required
object
name
required
string
company
string
street1
required
string
street2
string
city
required
string
state
required
string
zip
required
string
country
string
phone
string
email
string format: email
from_address_id
required
string format: uuid
parcel
required
object
packaging_type
required
string
length_in
number
width_in
number
height_in
number
weight_oz
required
number
options
object
insurance_cents
integer
signature
boolean
media_mail
boolean
irregular
boolean
hazmat
string
is_return
boolean
reference1
string
reference2
string
label_size
string
label_format
string
customs
object
contents_type
string
signer
required
string
items
required
Array<object>
object
description
required
string
hs_tariff_number
string
origin_country
string
quantity
required
integer
value_cents
required
integer
weight_oz
required
number
sender_tax_id
object
id
required
string
type
required
string
recipient_tax_id
object
id
required
string
type
required
string
email_recipients
Array<string>
order_id
string format: uuid
batch_id
string format: uuid
verify_address
boolean
Responses
Section titled “Responses”Success.
Media typeapplication/json
Any of:
object
status
required
string
shipment_id
required
string
zone
required
number | null
rates
required
Array<object>
object
id
required
string
carrier
required
string
service
required
string
currency
required
string
price_cents
required
What the organization pays for this rate.
integer
delivery_days
required
number | null
delivery_date
required
string | null
guaranteed
required
boolean
badges
required
Array<string>
suggested_rate_id
required
The rate a shipping rule chose, if any.
string | null
suggested_by_rule
required
string | null
applied_rules
required
Array<object>
object
ruleId
required
string
name
required
string
phase
required
string
effects
required
Array<string>
partial
required
True when some carriers did not answer, so the list may be shorter than usual.
boolean
expires_in_seconds
required
number
Example
{ "status": "quoted", "rates": [ { "badges": [ "cheapest" ] } ]}Missing or invalid API key.
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
object
key
additional properties
any
request_id
required
string
Example
{ "error": { "code": "validation" }}The key lacks the required permission, or the account is suspended.
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
object
key
additional properties
any
request_id
required
string
Example
{ "error": { "code": "validation" }}The resource does not exist.
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
object
key
additional properties
any
request_id
required
string
Example
{ "error": { "code": "validation" }}The request is not valid. error.details.issues lists the problems.
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
object
key
additional properties
any
request_id
required
string
Example
{ "error": { "code": "validation" }}Too many requests. Wait Retry-After seconds.
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
object
key
additional properties
any
request_id
required
string
Example
{ "error": { "code": "validation" }}© 2026 Ship Jay. All rights reserved. Created & Developed by WCWS Internet