{"templateId":"markdown","versions":[{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/getting-started/postman","default":false,"active":false,"folderId":"58c9a61d"},{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/docs/getting-started/postman","default":true,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/getting-started/postman","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Postman Collection","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"postman-collection","__idx":0},"children":["Postman Collection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://getpostman.com"},"children":["Postman"]}," is a free, cross-platform app that makes it easy to experiment with APIs in a friendly interface. ShipStation's official Postman collection helps you get started quickly with the ShipStation API V2."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.getpostman.com/downloads/"},"children":["download Postman here"]},". It's available for Mac, Windows, Linux, and Chrome OS."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"TIP"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get your API key before you start:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ShipStation Platform customers"]},": generate one from your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://ship.shipstation.com/#/settings/api"},"children":["API Settings page"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ShipStation API customers"]}," (formerly ShipEngine): find yours in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://api-portal.shipstation.com/"},"children":["ShipStation API dashboard"]},"."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"shipstation-api-v2-collection","__idx":1},"children":["ShipStation API V2 Collection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.postman.com/shipstationapi"},"children":["ShipStation API Public Workspace"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"instructions","__idx":2},"children":["Instructions"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open the workspace"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Click the link above to open the collection."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fork or import"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Fork the collection into your own workspace, or import it directly, to start making requests."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Key"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Set your API key (see above) as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API-Key"]}," value in the collection or environment variables."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send Requests"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Explore the folders for each resource (Shipments, Labels, Carriers, etc.) and send requests directly from Postman."]}]}]}]},"headings":[{"value":"Postman Collection","id":"postman-collection","depth":1},{"value":"ShipStation API V2 Collection","id":"shipstation-api-v2-collection","depth":2},{"value":"Instructions","id":"instructions","depth":3}],"frontmatter":{"seo":{"title":"Postman Collection"}},"lastModified":"2026-09-16T07:29:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/docs/getting-started/postman","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}