FulfillmentPackages
Get Rates
Get shipping rates for a package
Requirements
- Package must have valid shipping addresses and dimensions
- For
FULFILLMENT_ORDERpackages: You must own the fulfillment order lock to access rates - For
WORK_ORDERandSTANDALONEpackages: No lock ownership required
Response Format
Returns available rates sorted by price (cheapest first) plus any carrier errors encountered. Each rate includes carrier details, service information, pricing, and estimated delivery time.
Authorization
api_key x-access-token<token>
In: header
Path Parameters
package_id*string
UUID of the package to get rates for
Query Parameters
show_all_rates?boolean
Return every enabled rate instead of only the package's rate shop or selected service
Default
falseResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/packages/string/rates"{ "rates": [ { "carrier_id": "string", "carrier_integration_id": "string", "carrier_name": "string", "service_name": "string", "service_id": "string", "estimated_days": 0, "currency": "string", "amount": 0.1, "delivery_date_guaranteed": true, "delivery_date": "string", "carrier_account_label": "string", "provider_carrier_account_id": "string", "carrier_account_id": "string", "provider_rate_id": "string" } ], "errors": [ { "error": "string", "carrier_integration_id": "string" } ]}