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.
\nStarshipit provides a simple, but powerful shipping API for you to easily create orders, generate labels, display rates, manage orders and more.
\nHere’s a quick rundown of what you need to know about working with the Starshipit API.
\nStarshipit 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.
\nStarshipit 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.
\nSubscription 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.
\nOur Developer subscription allows you to make two requests per second.
\nOur Production subscription allows you to make twenty requests per second. This subscription requires approval.
\nIf you exceed these rates, you'll receive a ‘429 Too Many Requests’ error.
\nExample of a 3PL using a WMS without its own eCommerce platform integrations
\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.
Some requests allow you to filter the orders returned.
\nThis parameter is specified in the following format:
\n[FILTER_COLUMN]:::[VALUE]
\nMultiple filters can be specified, please seperate these by comma ','. For example, a legal filter can look like:
\nOrder:::12345,State:::NSW
\nSource:::Shopify
\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","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"API Rate Limits","slug":"api-rate-limits"},{"content":"Use Cases","slug":"use-cases"},{"content":"Best Practices","slug":"best-practices"},{"content":"Filters","slug":"filters"}],"owner":"7606649","collectionId":"ac40fece-48a8-4fb7-b0a0-649ec70aa709","publishedId":"TVRg69NS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"007BFF"},"publishDate":"2022-07-19T03:55:41.000Z"},"item":[{"name":"Orders","item":[{"name":"List Orders (Unshipped)","id":"6dd10a47-8403-4c7e-9b3f-32bf9986d8f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/unshipped","description":"Get a list of all unshipped orders (default: orders updated in the last 24 hours)
\n(optional) Show orders created after date in UTC (date-time in RFC3339 format)
\n","type":"text/plain"},"key":"since_order_date","value":"2026-04-21T07:57:31.374Z"},{"disabled":true,"description":{"content":"(optional) Show orders recently updated after date in UTC (date-time in RFC3339 format)
\n","type":"text/plain"},"key":"since_last_updated","value":"2026-04-21T07:57:31.375Z"},{"disabled":true,"description":{"content":"(optional) Show all unshipped order_ids only
\n","type":"text/plain"},"key":"ids_only","value":"false"},{"disabled":true,"description":{"content":"(optional) Amount of results (default: 50) (maximum: 250)
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"(optional) Page to show (default: 1)
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"59fa2f3d-6901-42f6-a4cc-c82be6da5fdb","name":"List Orders (Unshipped)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","description":"Api key in your Starshipit account under Settings > API > API Key","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key","type":"text"}],"url":{"raw":"https://api.starshipit.com/api/orders/unshipped","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","unshipped"],"query":[{"key":"since_order_date","value":"2026-04-21T07:57:31.375Z","description":"(optional) Show orders created after date in UTC (date-time in RFC3339 format)","disabled":true},{"key":"since_last_updated","value":"2026-04-21T07:57:31.375Z","description":"(optional) Show orders recently updated after date in UTC (date-time in RFC3339 format)","disabled":true},{"key":"ids_only","value":"false","description":"(optional) Show all unshipped order_ids only","type":"text","disabled":true},{"key":"limit","value":"50","description":"(optional) Amount of results (default: 50) (maximum: 250)","disabled":true},{"key":"page","value":"1","description":"(optional) Page to show (default: 1)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"13846"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Jul 2024 03:40:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"order_id\": 440482182,\n \"order_date\": \"2024-06-16T23:41:13\",\n \"order_number\": \"#1148-1\",\n \"reference\": \"#1148\",\n \"carrier\": \"DHL\",\n \"carrier_name\": \"DHL Express\",\n \"carrier_service_code\": \"WPX\",\n \"signature_required\": false,\n \"dangerous_goods\": false,\n \"currency\": \"NZD\",\n \"sender_details\": {\n \"name\": \"Frank's Flowers\",\n \"email\": \"frank@flowers.com\",\n \"phone\": \"0215671234\",\n \"building\": \"Building A\",\n \"company\": \"Frank's Flowers\",\n \"street\": \"10 Rose Street\",\n \"suburb\": \"redfern\",\n \"city\": \"redfern\",\n \"state\": \"NSW\",\n \"post_code\": \"2016\",\n \"country\": \"Australia\",\n \"tax_numbers\": []\n },\n \"destination\": {\n \"name\": \"John Smith\",\n \"email\": \"john@smith.com\",\n \"phone\": \"0225671289\",\n \"building\": \"1A\",\n \"company\": \"John Smith Tools\",\n \"street\": \"10 Federal Street\",\n \"city\": \"Auckland\",\n \"state\": \"Auckland\",\n \"post_code\": \"1010\",\n \"country\": \"New Zealand\",\n \"delivery_instructions\": \"\",\n \"tax_numbers\": []\n },\n \"items\": [\n {\n \"item_id\": 1286216642,\n \"description\": \"Rose\",\n \"sku\": \"\",\n \"country_of_origin\": \"AU\",\n \"quantity\": 1,\n \"quantity_to_ship\": 1,\n \"weight\": 0.88,\n \"height\": 0,\n \"width\": 0,\n \"length\": 0,\n \"value\": 0,\n \"stock_on_hand\": 0\n }\n ],\n \"packages\": [\n {\n \"package_id\": 553567691,\n \"weight\": 1,\n \"height\": 0.1,\n \"width\": 0.1,\n \"length\": 0.1,\n \"packaging_type\": \"\"\n }\n ],\n \"metadatas\": [\n {\n \"metafield_key\": \"ADDRESSVALIDATED\",\n \"value\": \"True\",\n \"required\": false\n },\n {\n \"metafield_key\": \"SOURCE\",\n \"value\": \"Shopify\",\n \"required\": false\n },\n {\n \"metafield_key\": \"DTP\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"INSURANCE\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"INSURANCEVALUE\",\n \"value\": \"0.00\",\n \"required\": false\n },\n {\n \"metafield_key\": \"GREENSERVICE\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"ADULT_SIGNATURE\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"ATL\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"BATTERY\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"SATURDAY\",\n \"value\": \"False\",\n \"required\": false\n },\n {\n \"metafield_key\": \"CUSTOMSINCOTERM\",\n \"value\": \"Not Set\",\n \"required\": false\n },\n {\n \"metafield_key\": \"CUSTOMSEXPORTREASON\",\n \"value\": \"Not Set\",\n \"required\": false\n },\n {\n \"metafield_key\": \"CUSTOMSDUTYACCOUNTNUMBER\",\n \"value\": \"\",\n \"required\": false\n }\n ],\n \"declared_value\": 0,\n \"archived\": false,\n \"manifest_number\": 0,\n \"address_validation\": \"NotChecked\",\n \"create_return\": false,\n \"dtp\": false,\n \"add_insurance\": false,\n \"insurance_value\": 0,\n \"plt\": false,\n \"type\": \"Outgoing\",\n \"platform\": \"Manual\",\n \"status\": \"Unshipped\"\n }\n ],\n \"total_pages\": 1,\n \"success\": true\n}"},{"id":"0b10bfc0-033b-4089-b7ff-dc24c9d7ddb8","name":"ids_only","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/unshipped?ids_only=true","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","unshipped"],"query":[{"key":"since_order_date","value":"2026-04-21T07:57:31.375Z","description":"(optional) Show orders created after date in UTC (date-time in RFC3339 format)","disabled":true},{"key":"since_last_updated","value":"2026-04-21T07:57:31.375Z","description":"(optional) Show orders recently updated after date in UTC (date-time in RFC3339 format)","disabled":true},{"key":"ids_only","value":"true","description":"(optional) Show all unshipped order_ids only"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1488"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 27 May 2024 06:40:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"order_ids\": [\n 400000000,\n 400000001,\n 400000002\n ],\n \"total_pages\": 1,\n \"success\": true\n}"},{"id":"48bb1ddb-daea-47f6-b125-569c937ccb3f","name":"Unauthenticated","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/unshipped","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","unshipped"],"query":[{"key":"since_order_date","value":"2026-04-21T07:57:31.375Z","description":"(optional) Show orders created after date in UTC (date-time in RFC3339 format)","disabled":true},{"key":"since_last_updated","value":"2026-04-21T07:57:31.375Z","description":"(optional) Show orders recently updated after date in UTC (date-time in RFC3339 format)","disabled":true},{"key":"ids_only","value":"false","description":"(optional) Show all unshipped order_ids only","type":"text","disabled":true},{"key":"limit","value":"50","description":"(optional) Amount of results (default: 50) (maximum: 250)","type":"text","disabled":true},{"key":"page","value":"1","description":"(optional) Page to show (default: 1)","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"45"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 27 May 2024 07:00:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 403,\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"6dd10a47-8403-4c7e-9b3f-32bf9986d8f3"},{"name":"List Orders (Printed or Unmanifested)","id":"bc249299-e979-4003-becc-27ba61dcf214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","description":"Api key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"url":"https://api.starshipit.com/api/orders/shipments?status=recently_printed","description":"Get recently printed or unmanifested orders
\nShow shipments created after date in UTC (date-time in RFC3339 format)
\n","type":"text/plain"},"key":"since_created_date","value":"2026-04-21T07:57:31.375Z"},{"description":{"content":"The status of the shipments to return
\n","type":"text/plain"},"key":"status","value":"recently_printed"},{"disabled":true,"description":{"content":"Amount of results (default: 50) (maximum: 250)
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Page to show (default: 1)
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"ba0356ef-59ff-4508-a0d6-a7b2bc7eeb35","name":"List Orders (Printed)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","description":"Api key in your Starshipit account under Settings > API > API Key","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key","type":"text"}],"url":{"raw":"https://api.starshipit.com/api/orders/shipments?since_created_date=2020-11-03&status=recently_printed","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","shipments"],"query":[{"key":"since_created_date","value":"2020-11-03"},{"key":"status","value":"recently_printed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\":\"recently_printed\",\r\n \"orders\": [\r\n {\r\n \"order_id\": 1020304051,\r\n \"order_number\": \"10001\",\r\n \"date\": \"2020-11-03T08:10:11.4460327Z\",\r\n \"name\": \"John Smith\",\r\n \"carrier_name\": \"Australia Post\",\r\n \"carrier_service_code\": \"7B05\",\r\n \"tracking_numbers\": [\r\n \"QQQ001156301000960302\"\r\n ],\r\n \"country\": \"Australia\"\r\n }\r\n ],\r\n \"total_pages\": 1,\r\n \"success\": true \r\n}"}],"_postman_id":"bc249299-e979-4003-becc-27ba61dcf214"},{"name":"List Orders (Shipped)","id":"abbdf631-21c8-472b-b2e7-b1b68b01f6d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/shipped","description":"Get a list of all shipped orders (default: orders updated in the last 24 hours)
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/delivered?order_ref=12345","description":"Get a list of all delivered orders with a given order reference
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/summary?order_status=shipped","description":"Get a summary of orders by status
\norder status to show order summary of.
\n","type":"text/plain"},"key":"order_status","value":"shipped"},{"disabled":true,"description":{"content":"Order field to sort by.
\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"sort direction.
\n","type":"text/plain"},"key":"sort_direction","value":""},{"disabled":true,"description":{"content":"Filter the orders returned in the order summary by various filters.
\nThis parameter is specified in the following format:
\nMultiple filters can be specified, please seperate these by comma ','.
\nSee the Filters section below for accepted filter values.
\n","type":"text/plain"},"key":"filter","value":""},{"disabled":true,"description":{"content":"page number.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"number of results to return (default: 500, maximum: 500)
\n","type":"text/plain"},"key":"page_size","value":""}],"variable":[]}},"response":[{"id":"d4cbe4dc-debc-4675-bdba-fbbe9b9c2cab","name":"List Orders Summary","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/summary?order_status=shipped","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","summary"],"query":[{"key":"order_status","value":"shipped"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"5308"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2024 01:08:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"order_id\": 400000001,\n \"order_number\": \"1419\",\n \"contact_name\": \"Test test\",\n \"country\": \"Australia\",\n \"state\": \"NSW\",\n \"order_type\": \"Outgoing\",\n \"platform\": \"WooCommerce\",\n \"integration_id\": 25,\n \"order_status\": 10,\n \"carrier\": \"MyPostBusiness\",\n \"product\": \"B20\",\n \"weight\": 0,\n \"weight_unit\": \"kg\",\n \"valid_address\": true,\n \"quantity\": \"\",\n \"skus\": \"\",\n \"items\": \"\",\n \"soh\": \"\",\n \"manifest_number\": 2630833,\n \"manifest_sent\": true,\n \"writeback_status\": \"Up to date\",\n \"order_date\": \"2024-04-14T23:44:45\",\n \"shipped_date\": \"2024-04-18T04:43:49.9777195\"\n }\n ],\n \"order_counts\": {\n \"unprinted_count\": 248,\n \"printed_count\": 62,\n \"shipped_count\": 68,\n \"archived_count\": 956,\n \"archived_unshipped_count\": 0,\n \"archived_shipped_count\": 956,\n \"unprinted_invalidaddress_count\": 14,\n \"return_count\": 17\n },\n \"success\": true\n}"},{"id":"ec30aee4-97a6-4fae-bafd-3c40cb3b1f39","name":"Complex filtering example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/summary?order_status=shipped&filter=order:::%231129,Platform:::Shopify,State:::NSW,Status:::Delivered,Address:::valid,Date:::>=APR 2024","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","summary"],"query":[{"key":"order_status","value":"shipped","description":"order status to show order summary of."},{"key":"sort","value":"","description":"Order field to sort by.","disabled":true},{"key":"sort_direction","value":"","description":"sort direction.","disabled":true},{"key":"filter","value":"order:::#1129,Platform:::Shopify,State:::NSW,Status:::Delivered,Address:::valid,Date:::>=APR 2024","description":"Filter the orders returned in the order summary by various filters. \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 ','. \n \nSee the Filters section below for accepted filter values.","type":"text"},{"key":"page","value":"","description":"page number.","type":"text","disabled":true},{"key":"page_size","value":"","description":"number of results to return (default: 500, maximum: 500)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"559"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2024 06:15:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"order_id\": 424687615,\n \"order_number\": \"#1129\",\n \"contact_name\": \"test test\",\n \"country\": \"Australia\",\n \"state\": \"NSW\",\n \"order_type\": \"Outgoing\",\n \"platform\": \"Shopify\",\n \"integration_id\": 557383,\n \"order_status\": \"Delivered\",\n \"carrier\": \"PlainLabel\",\n \"product\": \"Plain Label\",\n \"weight\": 0,\n \"weight_unit\": \"kg\",\n \"valid_address\": true,\n \"quantity\": \"\",\n \"skus\": \"\",\n \"items\": \"\",\n \"soh\": \"\",\n \"manifest_number\": 0,\n \"manifest_sent\": true,\n \"writeback_status\": \"Up to date\",\n \"tracking_status\": \"Delivered\",\n \"order_date\": \"2024-04-23T22:45:48\",\n \"shipped_date\": \"2024-04-29T02:04:16.5098323\"\n }\n ],\n \"order_counts\": {\n \"unprinted_count\": 248,\n \"printed_count\": 62,\n \"shipped_count\": 68,\n \"archived_count\": 956,\n \"archived_unshipped_count\": 0,\n \"archived_shipped_count\": 956,\n \"unprinted_invalidaddress_count\": 14,\n \"return_count\": 17\n },\n \"success\": true\n}"}],"_postman_id":"c1e28347-54b6-4224-bca7-449469790840"},{"name":"Search Orders","id":"7615c4c5-893b-4085-aa67-5d1d34297654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/search?phrase=John Smith","description":"Search printed order by order number, tracking number or name of the order
\nAmount of results (default: 50) (maximum: 250)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Page to show (default: 1)
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Returns a list of orders based on the order status (default: All)
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"In. conjunction with the phrase parameter, which field to search. If \"All\", it will search 'order number', 'tracking number', 'theirRef' and 'name'
\n","type":"text/plain"},"key":"fields","value":""},{"disabled":true,"description":{"content":"If set to true, orders from child accounts will be returned (default: false)
\n","type":"text/plain"},"key":"include_child_accounts","value":null},{"key":"phrase","value":"John Smith"}],"variable":[]}},"response":[{"id":"271cacf4-65f7-440e-969f-3ed343b7f59b","name":"Search Orders by order number","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/search?phrase=12345&limit=10&page=1","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","search"],"query":[{"key":"phrase","value":"12345"},{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"orders\": [\r\n {\r\n \"order_id\": 10001,\r\n \"order_date\": \"2020-04-29T22:46:59.6374472Z\",\r\n \"order_number\": \"12345\",\r\n \"name\": \"John Smith\",\r\n \"carrier_name\": \"Australia Post\",\r\n \"tracking_number\": \"A123456\",\r\n \"country\": \"Australia\"\r\n }\r\n ],\r\n \"total_pages\": 1,\r\n \"success\": true\r\n}"},{"id":"931513cc-1b29-4c77-984b-b7d0e454f34d","name":"Search Orders by tracking number","originalRequest":{"method":"GET","header":[{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.starshipit.com/api/orders/search?phrase=A123456&limit=10&page=1","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","search"],"query":[{"key":"phrase","value":"A123456"},{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"orders\": [\r\n {\r\n \"order_id\": 10001,\r\n \"order_date\": \"2020-04-29T22:46:59.6374472Z\",\r\n \"order_number\": \"12345\",\r\n \"name\": \"John Smith\",\r\n \"carrier_name\": \"Australia Post\",\r\n \"tracking_number\": \"A123456\",\r\n \"country\": \"Australia\"\r\n }\r\n ],\r\n \"total_pages\": 1,\r\n \"success\": true\r\n}"},{"id":"ced75ae5-4725-40e2-ae1f-95a9e80784c0","name":"Search Orders by name","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/search?phrase=John Smith&limit=10&page=1","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","search"],"query":[{"key":"phrase","value":"John Smith"},{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"orders\": [\r\n {\r\n \"order_id\": 10001,\r\n \"order_date\": \"2020-04-29T22:46:59.6374472Z\",\r\n \"order_number\": \"12345\",\r\n \"name\": \"John Smith\",\r\n \"carrier_name\": \"Australia Post\",\r\n \"tracking_number\": \"QQQ001156301000960302\",\r\n \"country\": \"Australia\"\r\n }\r\n ],\r\n \"total_pages\": 1,\r\n \"success\": true\r\n}"},{"id":"e103be65-582c-4c96-b760-6a56a260fc77","name":"Search Orders by order id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key which provides access to this API. Found in your Profile.","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/search?phrase=161690700&limit=10&page=1","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","search"],"query":[{"key":"phrase","value":"161690700"},{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"orders\": [\r\n {\r\n \"order_id\": 10001,\r\n \"order_date\": \"2020-04-29T22:46:59.6374472Z\",\r\n \"order_number\": \"12345\",\r\n \"name\": \"John Smith\",\r\n \"carrier_name\": \"Australia Post\",\r\n \"tracking_number\": \"A123456\",\r\n \"country\": \"Australia\"\r\n }\r\n ],\r\n \"total_pages\": 1,\r\n \"success\": true\r\n}"}],"_postman_id":"7615c4c5-893b-4085-aa67-5d1d34297654"},{"name":"Get Order(s)","id":"0aef707f-e2f5-493a-a382-8235c00c9c18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"StarShipIT-Api-Key","value":"","description":"Api key in your Starshipit account under Settings > API > API Key
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n"}],"url":"https://api.starshipit.com/api/orders","description":"Get order details by either order_id or order_number. If neither order_id or order_number is provided, this endpoint can be used to return multiple orders that match the criteria.
\nThe unique numeric identifier for the order
\n","type":"text/plain"},"key":"order_id","value":""},{"disabled":true,"description":{"content":"The identifier of the order pulled from source e-Commerce platform
\n","type":"text/plain"},"key":"order_number","value":""},{"disabled":true,"key":"status","value":"Shipped"},{"disabled":true,"key":"filter","value":null},{"disabled":true,"key":"include","value":""},{"disabled":true,"description":{"content":"Order field to sort by.
\n","type":"text/plain"},"key":"sort_column","value":null},{"disabled":true,"key":"sort_direction","value":""},{"disabled":true,"key":"page_number","value":null}],"variable":[]}},"response":[{"id":"d9f76f51-5275-41ac-a143-4e0830c89ab8","name":"Get Order by order id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders?order_id=1020304051","protocol":"https","host":["api","starshipit","com"],"path":["api","orders"],"query":[{"key":"order_id","value":"1020304051","description":"The unique numeric identifier for the order"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"order\":{\r\n \"order_id\":1020304051,\r\n \"order_date\":\"2020-04-29T22:46:59.7155669Z\",\r\n \"order_number\":\"10001\",\r\n \"reference\":\"Online Order\",\r\n \"carrier\":\"AusPost\",\r\n \"carrier_name\":\"Australia Post\",\r\n \"carrier_service_code\":\"7B05\",\r\n \"shipping_method\":\"Express Shipping\",\r\n \"signature_required\":false,\r\n \"dangerous_goods\":false,\r\n \"destination\":{\r\n \"name\":\"John Smith\",\r\n \"phone\":\"0290988227\",\r\n \"street\":\"20 George Street\",\r\n \"suburb\":\"Sydney\",\r\n \"state\":\"NSW\",\r\n \"post_code\":\"2000\",\r\n \"country\":\"Australia\",\r\n \"delivery_instructions\":\"Leave at door\"\r\n },\r\n \"items\":[\r\n {\r\n \"item_id\":1065580746,\r\n \"description\":\"Mobile Phone\",\r\n \"sku\":\"MOBILE\",\r\n \"quantity\":1,\r\n \"quantity_to_ship\":0,\r\n \"weight\":0.65,\r\n \"value\":125\r\n },\r\n {\r\n \"item_id\":1065580747,\r\n \"description\":\"Mobile Case (Black)\",\r\n \"sku\":\"MOBILE-CASE-BLK\",\r\n \"quantity\":1,\r\n \"quantity_to_ship\":0,\r\n \"weight\":0.05,\r\n \"value\":20\r\n }\r\n ],\r\n \"packages\":[\r\n {\r\n \"package_id\":1035548017,\r\n \"weight\":0.7,\r\n \"height\":0.04,\r\n \"width\":0.08,\r\n \"length\":0.12\r\n }\r\n ],\r\n \"declared_value\":0\r\n },\r\n \"success\":true\r\n}"},{"id":"def81ba9-9841-4fc4-8dd5-a705e6e24b70","name":"Get Order by order number","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders?order_number=10001","protocol":"https","host":["api","starshipit","com"],"path":["api","orders"],"query":[{"key":"order_number","value":"10001","description":"(optional) The identifier of the order pulled from source e-Commerce platform"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"order\":{\r\n \"order_id\":1020304051,\r\n \"order_date\":\"2020-04-29T22:46:59.7155669Z\",\r\n \"order_number\":\"10001\",\r\n \"reference\":\"Online Order\",\r\n \"carrier\":\"AusPost\",\r\n \"carrier_name\":\"Australia Post\",\r\n \"carrier_service_code\":\"7B05\",\r\n \"shipping_method\":\"Express Shipping\",\r\n \"signature_required\":false,\r\n \"dangerous_goods\":false,\r\n \"destination\":{\r\n \"name\":\"John Smith\",\r\n \"phone\":\"0290988227\",\r\n \"street\":\"20 George Street\",\r\n \"suburb\":\"Sydney\",\r\n \"state\":\"NSW\",\r\n \"post_code\":\"2000\",\r\n \"country\":\"Australia\",\r\n \"delivery_instructions\":\"Leave at door\"\r\n },\r\n \"items\":[\r\n {\r\n \"item_id\":1065580746,\r\n \"description\":\"Mobile Phone\",\r\n \"sku\":\"MOBILE\",\r\n \"quantity\":1,\r\n \"quantity_to_ship\":0,\r\n \"weight\":0.65,\r\n \"value\":125\r\n },\r\n {\r\n \"item_id\":1065580747,\r\n \"description\":\"Mobile Case (Black)\",\r\n \"sku\":\"MOBILE-CASE-BLK\",\r\n \"quantity\":1,\r\n \"quantity_to_ship\":0,\r\n \"weight\":0.05,\r\n \"value\":20\r\n }\r\n ],\r\n \"packages\":[\r\n {\r\n \"package_id\":1035548017,\r\n \"weight\":0.7,\r\n \"height\":0.04,\r\n \"width\":0.08,\r\n \"length\":0.12\r\n }\r\n ],\r\n \"declared_value\":0\r\n },\r\n \"success\":true\r\n}"},{"id":"14dfbb2d-a252-4700-b7f5-dbe2969f447b","name":"Get Printed Orders w/ Shipping Price","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"StarShipIT-Api-Key","value":"","description":"Api key in your Starshipit account under Settings > API > API Key"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key"}],"url":{"raw":"https://api.starshipit.com/api/orders?status=Printed&include=Shipping_Price&include=Shipment_Attributes","protocol":"https","host":["api","starshipit","com"],"path":["api","orders"],"query":[{"key":"order_id","value":"","description":"The unique numeric identifier for the order","type":"text","disabled":true},{"key":"order_number","value":"","description":"The identifier of the order pulled from source e-Commerce platform","type":"text","disabled":true},{"key":"status","value":"Printed"},{"key":"filter","value":"","type":"text","disabled":true},{"key":"include","value":"Shipping_Price"},{"key":"sort_column","value":"","description":"Order field to sort by.","type":"text","disabled":true},{"key":"sort_direction","value":"","type":"text","disabled":true},{"key":"page_number","value":"","type":"text","disabled":true},{"key":"include","value":"Shipment_Attributes"},{"key":"include","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"3390"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 17 Jul 2025 20:49:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"page_number\": 1,\n \"page_size\": 50,\n \"total_pages\": 1,\n \"total_records\": 1,\n \"data\": {\n \"orders\": [\n {\n \"order_id\": 123456789,\n \"platform\": \"TestOrders\",\n \"integration_id\": 1,\n \"order_status\": \"Printed\",\n \"order_number\": \"1\",\n \"reference\": \"\",\n \"order_date\": \"2025-07-08T23:29:42.3545569\",\n \"printed_date\": \"2025-07-09T02:48:27.732779\",\n \"shipped_date\": \"2025-07-09T02:48:27.732779\",\n \"contact_name\": \"John Smith\",\n \"company_name\": \"John Smith Ltd\",\n \"state\": \"WA\",\n \"country\": \"Australia\",\n \"shipping_method\": \"Standard\",\n \"shipping_description\": \"Standard\",\n \"shipment_type\": \"Outgoing\",\n \"carrier_id\": 10,\n \"carrier_name\": \"Australia Post\",\n \"carrier_service_code\": \"7H05\",\n \"carrier_service_name\": \"METRO CUBING\",\n \"tracking_numbers\": [\n \"2XD000000001000000000\"\n ],\n \"tracking_urls\": [\n \"https://auspost.com.au/mypost/track/details/2XD000000001000000000\"\n ],\n \"tracking_full_status\": \"\",\n \"manifest_number\": 0,\n \"manifest_sent\": false,\n \"writeback_status\": \"Not required\",\n \"writeback_details\": \"Not Required\",\n \"signature_required\": false,\n \"dangerous_goods\": false,\n \"export_type\": \"\",\n \"plt\": false,\n \"create_return\": false,\n \"currency\": \"NZD\",\n \"declared_value\": 51,\n \"dtp\": false,\n \"add_insurance\": false,\n \"insurance_value\": 0,\n \"price_breakdown\": {\n \"Calculated Price ex GST\": \"$26.41\",\n \"Calculated GST\": \"$2.64\",\n \"Calculated Price\": \"$29.05\",\n \"Predicted Delivery Dates \": \"2-3 days\"\n },\n \"total_shipping_price\": 29.05,\n \"shipping_freight_value\": 2.45,\n \"custom_margin_value\": 0,\n \"total_items\": 4,\n \"total_items_to_ship\": 0,\n \"total_shipped_items\": 0,\n \"total_qty_items\": 0,\n \"total_packages\": 0,\n \"weight\": \"0\",\n \"weight_unit\": \"kg\",\n \"address_validation\": \"Valid\",\n \"archived\": false,\n \"tags\": [\n \"PICKED\",\n \"PACKED\"\n ]\n }\n ]\n },\n \"succeeded\": true\n}"}],"_postman_id":"0aef707f-e2f5-493a-a382-8235c00c9c18"},{"name":"Create Order","id":"abcadf5c-9793-47b3-a2cb-d650c666d84d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"description":"Api key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"order\": {\r\n \"order_date\": \"\",\r\n \"order_number\": \"1776758251\",\r\n \"reference\": \"Online Order\",\r\n \"carrier\": \"AusPost\",\r\n \"carrier_name\": \"Australia Post\",\r\n \"shipping_method\": \"Return Express Shipping\",\r\n \"signature_required\": false,\r\n \"return_order\": false,\r\n \"destination\": {\r\n \"name\": \"Johnny Smith\",\r\n \"phone\": \"0290988227\",\r\n \"street\": \"20 George Street\",\r\n \"suburb\": \"Sydney\",\r\n \"state\": \"NSW\",\r\n \"post_code\": \"2000\",\r\n \"country\": \"Australia\",\r\n \"delivery_instructions\": \"Leave at door\"\r\n },\r\n \"items\": [\r\n {\r\n \"item_id\": 1065580746,\r\n \"description\": \"Mobile Phone\",\r\n \"sku\": \"MOBILE\",\r\n \"quantity\": 1,\r\n \"quantity_to_ship\": 0,\r\n \"weight\": 0.65,\r\n \"value\": 125\r\n },\r\n {\r\n \"item_id\": 1065580747,\r\n \"description\": \"Mobile Case (Black)\",\r\n \"sku\": \"MOBILE-CASE-BLK\",\r\n \"quantity\": 1,\r\n \"quantity_to_ship\": 0,\r\n \"weight\": 0.05,\r\n \"value\": 20\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders","description":"Create a new unshipped order
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"orders\": [\r\n {\r\n \"order_date\": \"2020-04-29T22:47:00.699943Z\",\r\n \"order_number\": \"10001\",\r\n \"reference\": \"Online Order\",\r\n \"shipping_method\": \"Express Shipping\",\r\n \"signature_required\": false,\r\n \"destination\": {\r\n \"name\": \"Johnny Smith\",\r\n \"phone\": \"0290988227\",\r\n \"street\": \"20 George Street\",\r\n \"suburb\": \"Sydney\",\r\n \"state\": \"NSW\",\r\n \"post_code\": \"2000\",\r\n \"country\": \"Australia\",\r\n \"delivery_instructions\": \"Leave at door\"\r\n },\r\n \"items\": [\r\n {\r\n \"description\": \"Mobile Phone\",\r\n \"sku\": \"MOBILE\",\r\n \"quantity\": 1,\r\n \"weight\": 0.65,\r\n \"value\": 125\r\n },\r\n {\r\n \"description\": \"Mobile Case (Black)\",\r\n \"sku\": \"MOBILE-CASE-BLK\",\r\n \"quantity\": 1,\r\n \"weight\": 0.05,\r\n \"value\": 20\r\n }\r\n ]\r\n },\r\n {\r\n \"order_date\": \"2020-04-29T22:47:00.699943Z\",\r\n \"order_number\": \"10002\",\r\n \"reference\": \"Online Order\",\r\n \"shipping_method\": \"International Shipping\",\r\n \"signature_required\": true,\r\n \"destination\": {\r\n \"name\": \"Robert Johnson\",\r\n \"phone\": \"099734100\",\r\n \"street\": \"10 Federal Street\",\r\n \"suburb\": \"Auckland Central\",\r\n \"city\": \"Auckland\",\r\n \"state\": \"Auckland\",\r\n \"post_code\": \"1010\",\r\n \"country\": \"New Zealand\",\r\n \"delivery_instructions\": \"See the receptionist\"\r\n },\r\n \"items\": [\r\n {\r\n \"description\": \"Mobile Case (Blue)\",\r\n \"sku\": \"MOBILE-CASE-BLU\",\r\n \"quantity\": 5,\r\n \"weight\": 0.05,\r\n \"value\": 20\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/import","description":"Create new unshipped orders (Maximum orders per API request: 50)
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"cb16ce77b085435f837f0e6f354eedd9","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order\": {\r\n \"order_id\": 488123472,\r\n \"order_date\": \"\",\r\n \"order_number\": \"1731273098\",\r\n \"reference\": \"Online Order\",\r\n \"carrier\": \"AusPost\",\r\n \"carrier_service_code\": \"7B05\",\r\n \"shipping_method\": \"Express Shipping\",\r\n \"signature_required\": false,\r\n \"destination\": {\r\n \"name\": \"John Smith\",\r\n \"phone\": \"0290988227\",\r\n \"street\": \"20 George Street\",\r\n \"suburb\": \"Sydney\",\r\n \"state\": \"NSW\",\r\n \"post_code\": \"2000\",\r\n \"country\": \"Australia\",\r\n \"delivery_instructions\": \"Leave at door\"\r\n },\r\n \"items\": [\r\n {\r\n \"item_id\": 1065580746,\r\n \"description\": \"Mobile Phone\",\r\n \"sku\": \"MOBILE\",\r\n \"quantity\": 1,\r\n \"weight\": 0.65,\r\n \"value\": 125\r\n },\r\n {\r\n \"item_id\": 1065580747,\r\n \"description\": \"Mobile Case (Black)\",\r\n \"sku\": \"MOBILE-CASE-BLK\",\r\n \"quantity\": 1,\r\n \"weight\": 0.05,\r\n \"value\": 20\r\n }\r\n ],\r\n \"packages\": [\r\n {\r\n \"weight\": 0.7,\r\n \"height\": 0.04,\r\n \"width\": 0.08,\r\n \"length\": 0.12\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders","description":"You can use the Update Order API to update order information. Different fields are available depending on the state of the order (i.e. once you have generated a label there is limited ability to modify the shipment details as they must be retained).
\nFor new/unshipped orders you can update all non read-only fields in the model:\nUpdate Order Model
\nFor printed & shipped orders you can update:
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"order\": {\r\n \"order_id\": 1020304051,\r\n \"order_date\": \"2020-11-03T01:39:03.0533776Z\",\r\n \"order_number\": \"10001\",\r\n \"reference\": \"Online Order\",\r\n \"carrier\": \"AusPost\",\r\n \"carrier_service_code\": \"7B05\",\r\n \"shipping_method\": \"Express Shipping\",\r\n \"signature_required\": false,\r\n \"destination\": {\r\n \"name\": \"John Smith\",\r\n \"phone\": \"0290988227\",\r\n \"street\": \"20 George Street\",\r\n \"suburb\": \"Sydney\",\r\n \"state\": \"NSW\",\r\n \"post_code\": \"2000\",\r\n \"country\": \"Australia\",\r\n \"delivery_instructions\": \"Leave at door\"\r\n },\r\n \"items\": [\r\n {\r\n \"item_id\": 1065580746,\r\n \"description\": \"Mobile Phone\",\r\n \"sku\": \"MOBILE\",\r\n \"quantity\": 1,\r\n \"weight\": 0.65,\r\n \"value\": 125\r\n },\r\n {\r\n \"item_id\": 1065580747,\r\n \"description\": \"Mobile Case (Black)\",\r\n \"sku\": \"MOBILE-CASE-BLK\",\r\n \"quantity\": 1,\r\n \"weight\": 0.05,\r\n \"value\": 20\r\n }\r\n ],\r\n \"packages\": [\r\n {\r\n \"package_id\": 1035548017,\r\n \"weight\": 0.7,\r\n \"height\": 0.04,\r\n \"width\": 0.08,\r\n \"length\": 0.12\r\n }\r\n ]\r\n }\r\n }\r\n]"},"url":"https://api.starshipit.com/api/orders/update","description":"You can use the Update Orders API to update order information. Different fields are available depending on the state of the order (i.e. once you have generated a label there is limited ability to modify the shipment details as they must be retained).
\nFor new/unshipped orders you can update all non read-only fields in the model:\nUpdate Order Model
\nFor printed & shipped orders you can update:
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n 128306022\r\n ],\r\n \"product_code\": \"7B05\",\r\n \"carrier_id\": \"10\" \r\n}"},"url":"https://api.starshipit.com/api/orders/batchupdate","description":"You can use the batch update order api to update the carrier information on a list of unshipped orders. \nYou can update:
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/delete","description":"Delete an unshipped order
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/archive","description":"Archive a printed/shipped order
\nApi key in your Starshipit account under Settings > API > API Key
\n"},{"key":"Ocp-Apim-Subscription-Key","type":"text","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n"}],"url":"https://api.starshipit.com/api/orders/restore","description":"Restore an archived order
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"parent_order_id\": 121330827,\r\n \"child_order_ids\": [\r\n 121330828\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/merge","description":"Merger multiple unshipped orders to an unshipped orders
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/orders/mergeable","description":"Get a list of unshipped orders where there are multiple orders going to the same person at the same address.
\n(default: 50, min: 1, max: 250)
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"default: 1
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"7fede2ed-8e0e-4486-9ed3-6aee02981f8e","name":"Get Suggested Merges","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"description":"Api key in your Starshipit account under Settings > API > API Key","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":{"raw":"https://api.starshipit.com/api/orders/mergeable?limit=50&page=1","protocol":"https","host":["api","starshipit","com"],"path":["api","orders","mergeable"],"query":[{"key":"limit","value":"50","description":"(default: 50, min: 1, max: 250)"},{"key":"page","value":"1","description":"default: 1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"6247"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Jul 2024 02:31:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"primary_order_id\": 440931582,\n \"orders\": [\n {\n \"order_id\": 440931582,\n \"order_number\": \"858\",\n \"order_date\": \"2024-07-01T05:10:34.4730965\",\n \"street\": \"3623 Altona 11\",\n \"suburb\": \"\",\n \"city\": \"Saint Thomas\",\n \"postcode\": \"00802\",\n \"state\": \"\",\n \"country\": \"Virgin Islands, U.S.\",\n \"contact\": \"Test Virgin Islands, U.S.\"\n },\n {\n \"order_id\": 440932662,\n \"order_number\": \"859\",\n \"order_date\": \"2024-07-01T05:12:34.4730965\",\n \"street\": \"3623 Altona 11\",\n \"suburb\": \"\",\n \"city\": \"Saint Thomas\",\n \"postcode\": \"00802\",\n \"state\": \"\",\n \"country\": \"Virgin Islands, U.S.\",\n \"contact\": \"Test Virgin Islands, U.S.\"\n }\n ]\n }\n ],\n \"total\": 1,\n \"total_pages\": 1,\n \"success\": true\n}"}],"_postman_id":"27f95247-808e-45da-b058-2f80cb7713bb"},{"name":"Assign Orders","id":"2c72d243-06bb-4e98-8489-2608e47ea6e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"description":"Api key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"orders\": [\r\n {\r\n \"order_id\": 121330827,\r\n \"current_api_key\": \"CURRENT_API_KEY\",\r\n \"new_api_key\": \"NEW_API_KEY\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/assign","description":"Assign unshipped orders by order_id or order_number from one account to another
\nApi key in your Starshipit account under Settings > API > API Key
\n"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": 430614764,\r\n \"carrier\": \"DHL\",\r\n \"carrier_service_code\": \"DOM\",\r\n \"packages\": [\r\n {\r\n \"weight\": 0.7,\r\n \"height\": 0.04,\r\n \"width\": 0.08,\r\n \"length\": 0.1\r\n }\r\n ],\r\n \"reprint\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/shipment","description":"Print a shipping label for a given order. The labels field returned in the response is a base64 encoded string that you can simply use to decode and save the output as a PDF file.
Api key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n 1020304051,\r\n 1020324318,\r\n 1020356475,\r\n 1020363915,\r\n 1020365786\r\n ],\r\n \"reprint\": false\r\n}"},"url":"https://api.starshipit.com/api/orders/shipments","description":"Print shipping labels for given orders. The labels field returned in the response is a base64 encoded string that you can simply use to decode and save the output as a PDF file.
Api key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n 1020304051,\r\n 1020324318,\r\n 1020356475,\r\n 1020363915,\r\n 1020365786\r\n ]\r\n}"},"url":"https://api.starshipit.com/api/orders/packingslips","description":"Create packing slips for single or multiple orders, or create packing summary to easily identity the quantities of each SKU to pick for all orders.
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [\r\n 121330827\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/manifest","description":"Finalise and manifest your printed orders. Manifesting will send the order details to your courier service for billing.
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": 128327582,\r\n \"to_return_shipment\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/shipment/clone","description":"Clone a printed or shipped order
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": 128433983\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/orders/shipment/replace","description":"Redo a printed or shipped order
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/track","description":"Get tracking details using a tracking number
\nWebhooks (callbacks) are event driven executions of code to send data from one application to another. For example, a webhook is a push notification from an email server sent to your phone.
\nStarshipit can send webhook requests when we receive tracking updates from your couriers for your orders. You can specify a notification endpoint URL were Starshipit will send these requests.
\nUse the notification endpoint URL to receive our webhook data and trigger a certain event in your own application. For example, send an order update email to your customer or update the order status in your database when ‘OutForDelivery’ tracking status is received.
\nThe notification endpoint URL needs to be built to accept the POST request that returns HTTP 200 OK response and the URL can be set in Settings > Customer Notifications.
\nThis POST request is used to create tracking only orders. It expects a payload containing an array of orders with their respective details such as name, order number, carrier, and tracking number.
\nThe request body should be in raw format and contain a JSON object with an array of orders. Each order should have the following parameters:
\nUpon successful processing of the request, the API responds with a JSON object containing all orders that were created with their order numbers and their corresponding tracking numbers as values. Additionally, the response includes a success boolean indicating the status of the request.Example
{\n \"orders\": {\n \"398667087\": \"XYZ-92312-VSDV-24814\",\n \"398667099\": \"NCA-21938-KASL-12314\",\n \"398667108\": \"MOX-53215-AJVV-12395\",\n \"398667112\": \"BZH-12841-ASGB-12451\"\n },\n \"success\": true\n}\n\nTracking Only orders provides a seamless solution for adding orders made outside of Starshipit into its tracking system. This integration is perfect for businesses seeking a centralized tracking hub for all orders, whether created in Starshipit or elsewhere. It provides consistent tracking updates regardless of where the label was created.
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"sender\": {\r\n \"street\": \"184 Exhibition Street\",\r\n \"suburb\": \"Melbourne\",\r\n \"city\": \"Melbourne\",\r\n \"state\": \"VIC\",\r\n \"post_code\": \"3000\",\r\n \"country_code\": \"AU\"\r\n },\r\n \"destination\": {\r\n \"street\": \"20 Liverpool Street\",\r\n \"suburb\": \"Paddington\",\r\n \"city\": \"Sydney\",\r\n \"state\": \"NSW\",\r\n \"post_code\": \"2021\",\r\n \"country_code\": \"AU\"\r\n },\r\n \"packages\": [\r\n {\r\n \"weight\": 0.1\r\n }\r\n ]\r\n}"},"url":"https://api.starshipit.com/api/rates","description":"Get a quote for a shipment
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"url":"https://api.starshipit.com/api/rates","description":"Get a quote for a shipment
\nApi key in your Starshipit account under Settings > API > API Key
\n","key":"StarShipIT-Api-Key","type":"text","value":""},{"description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","key":"Ocp-Apim-Subscription-Key","type":"text","value":""}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": 100000,\r\n \"refresh_rate\": true,\r\n \"sender\": {\r\n \"street\": \"10 Geonic Street\",\r\n \"suburb\": \"Woodridge\",\r\n \"city\": \"\",\r\n \"state\": \"QLD\",\r\n \"post_code\": \"4114\",\r\n \"country_code\": \"AU\"\r\n },\r\n \"destination\": {\r\n \"street\": \"10 Geoffrey Place\",\r\n \"suburb\": \"Mangere East\",\r\n \"city\": \"Auckland\",\r\n \"state\": \"\",\r\n \"post_code\": \"2024\",\r\n \"country_code\": \"NZ\"\r\n },\r\n \"packages\": [\r\n {\r\n \"weight\": 1.0,\r\n \"height\": 0.1,\r\n \"width\": 0.1,\r\n \"length\": 0.1,\r\n \"package_name\": \"Package\"\r\n }\r\n ],\r\n \"declared_value\": 20.00,\r\n \"return_order\": false,\r\n \"include_pricing\": true,\r\n \"signature_required\": null,\r\n \"authority_to_leave\": false,\r\n \"dangerous_goods\": false,\r\n \"insurance_value\": 0.0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/deliveryservices","description":"Get a list of available carrier delivery services
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"url":"https://api.starshipit.com//api/addressbook/filtered","description":"Retrieve a list of contacts that is stored in your address book. Results are sorted by specified column and returned one page at a time.
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"address_ids\": [\r\n\t\t81692357\r\n\t]\r\n}"},"url":"https://api.starshipit.com//api/addressbook/delete","description":"Remove a contact from your address book
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 6926658,\r\n \"address\": {\r\n \"code\": \"111\",\r\n \"name\": \"Add Address Test\",\r\n \"company\": \"My Company\",\r\n \"post_code\": \"3000\",\r\n \"street\": \"55 Bourke St\",\r\n \"suburb\": \"Melbourne\",\r\n \"city\": \"Melbourne\",\r\n \"state\": \"VIC\",\r\n \"country\": \"Australia\",\r\n \"phone\": \"9879879876\",\r\n \"instructions\": \"\",\r\n \"building\": \"Big Tall Building\",\r\n \"email\": \"test@starshipit.com\",\r\n \"carrier\": 0,\r\n \"signature_required\": false\r\n }\r\n}"},"url":"https://api.starshipit.com//api/addressbook/update","description":"Edit the address information for a saved contact.
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"code\": \"111\",\r\n \"name\": \"Add Address Test\",\r\n \"company\": \"My Company\",\r\n \"post_code\": \"3000\",\r\n \"street\": \"55 Bourke St\",\r\n \"suburb\": \"Melbourne\",\r\n \"city\": \"Melbourne\",\r\n \"state\": \"VIC\",\r\n \"country\": \"Australia\",\r\n \"phone\": \"123123123123\",\r\n \"instructions\": \"\",\r\n \"building\": \"Big Tall Building\",\r\n \"email\": \"test@starshipit.com\",\r\n \"carrier\": 0,\r\n \"signature_required\": false\r\n }\r\n}"},"url":"https://api.starshipit.com//api/addressbook/","description":"Save address information for a new contact.
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"url":"https://api.starshipit.com/api/manifests","description":"Retrieve a list of manifests. Results are ordered by date in descending order.
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"url":"https://api.starshipit.com/api/manifests/files/","description":"Retrieve a list of manifest files by manifest_id.
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"tracking_numbers\":[\r\n \"ABCD1234567890XYZ\",\r\n \"ON12345\"\r\n ],\r\n \"use_order_numbers\": true\r\n}"},"url":"https://api.starshipit.com/api/manifests/shipments","description":"Retrieve a list of shipment ids based on the tracking numbers or order numbers that have been supplied. These ids can be passed as a parameter to the manifest orders endpoint.
\nApi key in your Starshipit account under Settings > API > API Key
\n","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","description":"Subscription key in your Starshipit account under Settings > API > Subscription key
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"carrier\": \"PlainLabel\"\r\n}"},"url":"https://api.starshipit.com/api/manifests/carrier","description":"Manifest all relevant records for a given carrier that are ready to be shipped.
\n\"\" or \"shoe\" (Mandatory)
\n","type":"text/plain"},"key":"search_term","value":""},{"key":"page_number","value":"1"},{"description":{"content":"Min: 10 Max: 2000
\n","type":"text/plain"},"key":"page_size","value":"50"},{"key":"skip_records","value":"0"},{"description":{"content":"Barcode | BinLocation | Brand | Colour | Country | CustomsDescription | DangerousGoodsType | Height | HSCode | Length | Manufacturer | Materials | Model | Price | Purpose | Size | Sku | Title | Weight | Width
\n","type":"text/plain"},"key":"sort_column","value":"Sku"},{"description":{"content":"Ascending | Descending
\n","type":"text/plain"},"key":"sort_direction","value":"Ascending"}],"variable":[]}},"response":[{"id":"7a6d4b82-d391-4427-8bcc-1b4e9067be80","name":"Get Products","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","type":"text"}],"url":{"raw":"https://api.starshipit.com/api/products?search_term=&page_number=1&page_size=50&skip_records=0&sort_column=Sku&sort_direction=Ascending","protocol":"https","host":["api","starshipit","com"],"path":["api","products"],"query":[{"key":"search_term","value":""},{"key":"page_number","value":"1"},{"key":"page_size","value":"50"},{"key":"skip_records","value":"0"},{"key":"sort_column","value":"Sku"},{"key":"sort_direction","value":"Ascending"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"page_number\": 1,\n \"page_size\": 50,\n \"total_pages\": 0,\n \"total_records\": 1,\n \"data\": {\n \"products\": [\n {\n \"id\": 4541053,\n \"sku\": \"AMZ-BLK-SHOES-US11\",\n \"title\": \"Amazing Black Shoes Black US11\",\n \"country\": \"Australia\",\n \"weight\": 1.3,\n \"height\": 0.27,\n \"length\": 0.27,\n \"width\": 0.4,\n \"hs_code\": \"6404.11.0000\",\n \"color\": \"Black\",\n \"size\": \"US11\",\n \"bin_location\": \"A18\",\n \"price\": 99\n }\n ],\n \"success\": false\n },\n \"succeeded\": true\n}"}],"_postman_id":"ccf0f10f-e370-45c0-ba5c-13bfaac80ca6"},{"name":"Add Product","id":"8cfbd1b2-bd08-4cec-966f-7104cc147aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"Api key in your Starshipit account under Settings > API > API Key","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"Subscription key in your Starshipit account under Settings > API > Subscription key","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product\": {\r\n \"sku\": \"AMZ-BLK-SHOES-US11\",\r\n \"title\": \"Amazing Black Shoes Black US11\",\r\n \"customs_description\": null,\r\n \"description\": null,\r\n \"country\": \"Australia\",\r\n \"weight\": 1.3,\r\n \"height\": 0.27,\r\n \"length\": 0.27,\r\n \"width\": 0.4,\r\n \"hs_code\": \"6404.11.0000\",\r\n \"color\": \"Black\",\r\n \"size\": \"US11\",\r\n \"barcode\": null,\r\n \"bin_location\": \"A18\",\r\n \"brand\": null,\r\n \"usage\": null,\r\n \"material\": null,\r\n \"model\": null,\r\n \"mid\": null,\r\n \"price\": 99.00,\r\n \"dangerous_goods_type\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products","urlObject":{"protocol":"https","path":["api","products"],"host":["api","starshipit","com"],"query":[],"variable":[]}},"response":[{"id":"76b1fa54-7354-4d2b-b297-f13114296c7e","name":"Add Product","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product\": {\r\n \"sku\": \"AMZ-BLK-SHOES-US11\",\r\n \"title\": \"Amazing Black Shoes Black US11\",\r\n \"customs_description\": null,\r\n \"description\": null,\r\n \"country\": \"Australia\",\r\n \"weight\": 1.3,\r\n \"height\": 0.27,\r\n \"length\": 0.27,\r\n \"width\": 0.4,\r\n \"hs_code\": \"6404.11.0000\",\r\n \"color\": \"Black\",\r\n \"size\": \"US11\",\r\n \"barcode\": null,\r\n \"bin_location\": \"A18\",\r\n \"brand\": null,\r\n \"usage\": null,\r\n \"material\": null,\r\n \"model\": null,\r\n \"mid\": null,\r\n \"price\": 99.00,\r\n \"dangerous_goods_type\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4541053,\n \"product\": {\n \"id\": 4541053,\n \"sku\": \"AMZ-BLK-SHOES-US11\",\n \"title\": \"Amazing Black Shoes Black US11\",\n \"country\": \"Australia\",\n \"weight\": 1.3,\n \"height\": 0.27,\n \"length\": 0.27,\n \"width\": 0.4,\n \"hs_code\": \"6404.11.0000\",\n \"color\": \"Black\",\n \"size\": \"US11\",\n \"bin_location\": \"A18\",\n \"price\": 99\n },\n \"success\": true,\n \"errors\": []\n}"}],"_postman_id":"8cfbd1b2-bd08-4cec-966f-7104cc147aee"},{"name":"Update Product","id":"9101a9d7-91b1-492c-b7ad-5f92f80bbfd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"Api key in your Starshipit account under Settings > API > API Key","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"Subscription key in your Starshipit account under Settings > API > Subscription key","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 4541053,\r\n \"product\": {\r\n \"id\": 4541053,\r\n \"sku\": \"AMZ-BLK-SHOES-US11\",\r\n \"title\": \"Amazing Black Shoes Black US11\",\r\n \"customs_description\": null,\r\n \"description\": null,\r\n \"country\": \"Australia\",\r\n \"weight\": 1.3,\r\n \"height\": 0.27,\r\n \"length\": 0.27,\r\n \"width\": 0.4,\r\n \"hs_code\": \"6404.11.0000\",\r\n \"color\": \"Black\",\r\n \"size\": \"US11\",\r\n \"barcode\": null,\r\n \"bin_location\": \"A18\",\r\n \"brand\": null,\r\n \"usage\": null,\r\n \"material\": null,\r\n \"model\": null,\r\n \"mid\": null,\r\n \"price\": 99.00,\r\n \"dangerous_goods_type\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products/update","urlObject":{"protocol":"https","path":["api","products","update"],"host":["api","starshipit","com"],"query":[],"variable":[]}},"response":[{"id":"ce1b76e5-d347-4058-b993-7bcff03c09be","name":"Update Product","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 4541053,\r\n \"product\": {\r\n \"id\": 4541053,\r\n \"sku\": \"AMZ-BLK-SHOES-US11\",\r\n \"title\": \"Amazing Black Shoes Black US11\",\r\n \"customs_description\": null,\r\n \"description\": null,\r\n \"country\": \"Australia\",\r\n \"weight\": 1.3,\r\n \"height\": 0.27,\r\n \"length\": 0.27,\r\n \"width\": 0.4,\r\n \"hs_code\": \"6404.11.0000\",\r\n \"color\": \"Black\",\r\n \"size\": \"US11\",\r\n \"barcode\": null,\r\n \"bin_location\": \"A18\",\r\n \"brand\": null,\r\n \"usage\": null,\r\n \"material\": null,\r\n \"model\": null,\r\n \"mid\": null,\r\n \"price\": 99.00,\r\n \"dangerous_goods_type\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"product\": {\n \"id\": 4541053,\n \"sku\": \"AMZ-BLK-SHOES-US11\",\n \"title\": \"Amazing Black Shoes Black US11\",\n \"country\": \"Australia\",\n \"weight\": 1.3,\n \"height\": 0.27,\n \"length\": 0.27,\n \"width\": 0.4,\n \"hs_code\": \"6404.11.0000\",\n \"color\": \"Black\",\n \"size\": \"US11\",\n \"bin_location\": \"A18\",\n \"price\": 99\n },\n \"success\": true,\n \"errors\": []\n}"}],"_postman_id":"9101a9d7-91b1-492c-b7ad-5f92f80bbfd7"},{"name":"Delete Product","id":"5edb43f1-432b-4d1a-bb31-e05db0c879e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"Api key in your Starshipit account under Settings > API > API Key","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"Subscription key in your Starshipit account under Settings > API > Subscription key","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product_ids\": [\r\n 4541053\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products/delete","urlObject":{"protocol":"https","path":["api","products","delete"],"host":["api","starshipit","com"],"query":[],"variable":[]}},"response":[{"id":"6ede2553-8425-439c-a2c9-4d84b4906005","name":"Delete Product","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product_ids\": [\r\n 4541053\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"errors\": []\n}"}],"_postman_id":"5edb43f1-432b-4d1a-bb31-e05db0c879e3"},{"name":"Delete All Products","id":"5c110507-8c81-4ea8-9cb2-5254e8454c7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"Api key in your Starshipit account under Settings > API > API Key","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"Subscription key in your Starshipit account under Settings > API > Subscription key","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product_ids\": [],\r\n \"all_products\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products/delete","urlObject":{"protocol":"https","path":["api","products","delete"],"host":["api","starshipit","com"],"query":[],"variable":[]}},"response":[{"id":"072c3f88-81a4-4932-a172-f59e6a0ad596","name":"Delete All Products","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"StarShipIT-Api-Key","value":"","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product_ids\": [],\r\n \"all_products\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.starshipit.com/api/products/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"errors\": []\n}"}],"_postman_id":"5c110507-8c81-4ea8-9cb2-5254e8454c7b"}],"id":"4071f548-e276-4e03-bfbd-657e19740e83","_postman_id":"4071f548-e276-4e03-bfbd-657e19740e83","description":""},{"name":"Models","item":[],"id":"663ef804-c68d-4a25-882d-7efb2817ec49","description":"Accepted values for tax_type:
\naustralia_gst_number
\nbrazil_federal_tax_number
\ndata_universal_numbering_system
\nemployer_id
\neori_number
\nfederal_tax_id
\ngst_registration
\nireland_tax_id
\nrussian_taxpayer_personal_id
\nrussian_tax_registration_event_code
\nmovement_reference_code
\nrussian_primary_state_registration_number
\nrussian_okpo_code
\nausid_gst_registration
\nsocial_security_number
\nstate_tax_id
\nvat_registration
\noverseas_registered_supplier
\nimport_one_stop_shop
\nvat_in_ecommerce
\nfree_trade_zone_id
\ndeferment_account_duties_only
\ndeferment_account_tax_only
\ndeferment_account_duties_taxes_and_fees_only
\ngb_vat_foreign_registration
\nunified_social_credit_identifier_code
\ncustoms_registration_number
\nnational_id
\ndrivers_license
\npassport_number
\nsingapore_gst_number
\nmalaysia_low_value_registration_number
\n