{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ac40fece-48a8-4fb7-b0a0-649ec70aa709","name":"Starshipit API","description":"Looking to build an integration? Our API allows you to incorporate the intelligence of Starshipit into your platform with minimal integration effort. Built by developers for developers.\n\nStarshipit provides a simple, but powerful shipping API for you to easily create orders, generate labels, display rates, manage orders and more.\n\n# Getting Started\n\nHere’s a quick rundown of what you need to know about working with the Starshipit API.\n\n## What do I need to start?\n\n1. Starshipit account, Starshipit API key and Subscription Key\n2. At least one enabled courier in your Starshipit account\n    \n\n**Starshipit account:** You’ll need to sign up for a Starshipit account to get an API key. You’ll also need to enable at least one courier to be able to use the rates at checkout request.\n\n**Starshipit API key:** To make requests to the API, an authentication token is required. To view your API key log in to your Starshipit account, then go to Settings > API. You can generate a new token here. This is the StarShipIT-Api-Key.\n\n**Subscription key:** To make requests to the API, a subscription key is required. To generate your subscription key log in to your Starshipit account, then go to Settings > API. You can generate a new subscription key here. This is the Ocp-Apim-Subscription-Key.\n\n# API Rate Limits\n\nOur Developer subscription allows you to make two requests per second.\n\nOur Production subscription allows you to make twenty requests per second. This subscription requires approval.\n\nIf you exceed these rates, you'll receive a ‘429 Too Many Requests’ error.\n\n# Use Cases\n\n#### Shipping using Starshipit API with the Starshipit interface:\n\n<img src=\"https://content.pstmn.io/3c2983f3-331c-4235-ba86-8a4be494242e/QVBJIHdpdGggdGhlIFN0YXJzaGlwaXQgaW50ZXJmYWNlIDEgKDEpLnBuZw==\">\n\n1. Push orders into Starshipit via [Create Order API (a)](#abcadf5c-9793-47b3-a2cb-d650c666d84d) from your eCommerce, inventory, warehouse management or other platform.\n2. Staff log in to Starshipit and fulfil orders from the Starshipit interface.\n3. Staff manifest orders using the Starshipit interface.\n4. (Optional) Using Starshipit [Webhooks (b)](#1400272c-4c43-4740-9190-17684beee0fc) retrieve your tracking numbers from Starshipit.\n    \n\n#### Shipping using Starshipit API with a third-party or no interface\n\n<img src=\"https://content.pstmn.io/856039ed-8ad8-4f47-b590-1a310a094ad2/QVBJIHdpdGggYSB0aGlyZC1wYXJ0eSBXTVMgSW50ZXJmYWNlIDEucG5n\">\n\n1. Push orders into Starshipit via [Create Order API (a)](#abcadf5c-9793-47b3-a2cb-d650c666d84d) from your eCommerce, inventory, warehouse management or other platform.\n2. Trigger label generation via the [Create Label Print API (b)](#b6bc3576-a43f-4992-86d8-8fdf57f872f6). This will return the label file(s), and the tracking numbers associated with the shipment. Customer can update their orders/shipments in their platform with tracking.\n3. Manifest shipments via the Starshipit [Manifest Orders API (c)](#4774c2b5-22a9-41ba-848c-fc0b872b1a39).\n    \n\n**Example of a 3PL using a WMS without its own eCommerce platform integrations**\n\n1. Orders are imported into Starshipit using one of our pre-built integrations.\n2. WMS imports order details from Starshipit via our [Get Order API (a)](#0aef707f-e2f5-493a-a382-8235c00c9c18).\n3. Users pick order and make any necessary changes in their WMS (e.g. change weight).\n4. The order is edited in Starshipit via our [Update Order API (b)](#fffefde7-2198-4e38-ae33-283792fd8321).\n5. From the WMS the user can print a courier label by using the [Create Label API (c)](#b6bc3576-a43f-4992-86d8-8fdf57f872f6) call which will return a label.\n6. Manifest Shipments via the Starshipit [Manifest Orders API (d)](#4774c2b5-22a9-41ba-848c-fc0b872b1a39).\n7. Tracking info can then be retrieved from Starshipit using the [Tracking Details API (e)](#a655a3b4-ea39-42c4-acb4-d868ad40dc47) call.\n    \n\n# Best Practices\n\n## Batch requests where possible\n\nTo optimize the performance and efficiency of API interactions, batch your requests whenever possible. For example, instead of sending individual requests for each order, use the `Update Orders` or `Create Orders` endpoints to update or create multiple orders in a single request.\n\n# Filters\n\nSome requests allow you to filter the orders returned.\n\nThis parameter is specified in the following format:\n\n\\[FILTER_COLUMN\\]:::\\[VALUE\\]\n\nMultiple filters can be specified, please seperate these by comma ','. For example, a legal filter can look like:\n\nOrder:::12345,State:::NSW\n\nSource:::Shopify\n\nSome filters can be pre-fixed with '!' to return orders that do not meet the condition. For example, !Country:::Australia will return all orders not from Australia.\n\n| FILTER_COLUMN | Description | Type / format | Example Filter Value |\n| --- | --- | --- | --- |\n| Order | Filter for a specific order number | String | Order:::1419 |\n| Name | Filter for a specific 'To Name' | String | Name:::John Smith |\n| Address | Filter for valid addresses | 'valid' | Address:::valid |\n| Date | Filter for shipped_date, if order_status is shipped. | \\[OPERATOR\\]\\[DATE_STRING\\]  <br>  <br>Allowed OPERATORs:  <br>\\>=  <br>\\>  <br><=  <br><  <br>  <br>DATE_STRING format:  <br>dd MMM yyyy  <br>MMM yyyy  <br>  <br>If the OPERATOR is not specified, the date is exactly matched. | Date:::>=MAY 2024  <br>  <br>Date:::19 MAY 2024  <br>  <br>Date:::<=5 JUN 2023 |\n| Source | Filter for integration source. Integrations are specified by ID, account specific integration ID or by name, and multiple can be specified by seperating by semi-colon ';'. | String or Int | Source:::25  <br>Source:::25;26  <br>Source:::123456  <br>Source:::Shopify |\n| State | Filter orders by state. If you wish to filter by multiple states, you must specify the State filter for each. | String | Source:::NSW  <br>  <br>Source:::NSW,Source:::VIC |\n| Country | Filter orders by country. If you wish to filter by multiple countries, you must specify the Country filter for each. | String | Country:::Australia  <br>Country:::Australia,Country:::New Zealand |\n| Carrier | Filter orders by carrier. If you wish to filter by multiple carriers, you must specify the Carrier filter for each. | String | Carrier:::StarTrack |\n| Service | Filter orders by carrier service / product. If you wish to filter by multiple services, you must specify the Service filter for each. | String | Service:::EXP |\n| Status | Filter orders by Order Status. If you wish to filter by multiple Order Statuses, you must specify the Status filter for each. | String \\[Delivered, In Transit\\] | Status:::Delivered |\n| SKU | Filter orders by SKU. If you wish to filter by multiple SKUs, you must specify the SKU filter for each. | String | SKU:::ABC123 |\n| SingleSKU | Filter orders by SKU, where orders only contain a single SKU. If using this filter, only orders with single SKUs that match the filter will be returned.  <br>If you wish to filter by multiple single SKUs, you must specify the Single SKU filter for each. | String | SingleSKU:::ABC123 |\n| Writeback | FIlter orders by Writeback status. | String | Writeback:::Up to date |\n| Weight | Filter orders by weight | \\[OPERATOR\\]\\[INTEGER\\]  <br>  <br>Allowed OPERATORs:  <br>\\>=  <br>\\>  <br><=  <br><  <br>  <br>If no OPERATOR is specified, the weight is exactly matched. | Weight:::>=5  <br>  <br>Weight:::5 |\n| ShippingMethod | Filter orders by Shipping Method. If you wish to filter by multiple Shipping Methods, you must specify the Shipping Method filter for each. | String | ShippingMethod:::AusPost Express Intl |\n| ShippingDescription | Filter orders by Shipping Description. If you wish to filter by multiple Shipping Descriptions, you must specify the Shipping Description filter for each. | String | ShippingDescription:::Express |\n| Tag | Filter orders by Tag. If you wish to filter by multiple Tags, you must specify the Tag filter for each. | String | Tag:::Urgent |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7606649","collectionId":"ac40fece-48a8-4fb7-b0a0-649ec70aa709","publishedId":"TVRg69NS","public":true,"publicUrl":"https://api-docs.starshipit.com","privateUrl":"https://go.postman.co/documentation/7606649-ac40fece-48a8-4fb7-b0a0-649ec70aa709","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"007BFF"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-19T03:55:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1a3a31158579ba76287a267f89476cedbb67831e563aa64f3a666f6225590e98","favicon":"https://res.cloudinary.com/postman/image/upload/v1658205097/team/hdvn1dlvtzwkhz107mku.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.starshipit.com/view/metadata/TVRg69NS"}