Skip to main content

Postman collection

Download the collection and import it into Postman or Bruno:

Download public-api-v1.postman_collection.json

Collection variables (edit before running):

VariableDescription
baseUrlAPI host: https://api.saveonexpress.ca (production) or https://api.dev.saveonexpress.ca (development)
apiKeyinex_api_{32 hex}
carrierCodeSet from Carriers (first carrier code)
serviceCodeSet from Carriers (first non-default service)
rateResponseIdSet automatically after Rate (or paste manually)
orderIdSet automatically after Ship
labelTypeDefault PDF; updated from ship/list labels
packagingTypeIdSet from Packaging types (first Generic custom box)

Use the Carriers folder to discover carrierCode and serviceCode for Rate. The Rate folder includes POST Rate (sort by delivery date) for testing sort. Use the Flow (run in order) folder for packaging types → carriers → rate → ship → labels → track → cancel. The Cancel folder can be used on its own when you already have an orderId. For label download, enable Automatically follow redirects in Postman settings if you want the client to fetch the S3 file after 302. Tracking links come from Ship (metadata.trackingUrl).