{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4d252822-5673-46a4-8c8d-d90443de6264","name":"Keep Space Public APIs","description":"# KeepSpace Public APIs\n\n## Introduction\n\nWelcome to the KeepSpace Public APIs documentation. These APIs provide programmatic access to KeepSpace's warehouse and logistics management platform, enabling you to integrate inventory management, order fulfillment, and delivery tracking capabilities directly into your applications.\n\nWith the KeepSpace APIs, you can:\n\n- **Manage Orders**: Create delivery orders, track shipments, and retrieve order details\n    \n- **Monitor Inventory**: Check real-time stock levels and item details across all KeepSpace warehouses\n    \n- **Track Deliveries**: Access tracking URLs and shipment status for customer transparency\n    \n- **Automate Workflows**: Integrate warehouse operations seamlessly with your existing systems\n    \n\n## Base URL\n\nAll API requests should be made to:\n\n```\nhttps://production-api.keepspace.com.au/api/pub/v1\n\n ```\n\n## Authentication\n\nThe KeepSpace Public APIs use **Basic Authentication** with an API key. You will receive your unique API key once you're onboarded to the platform.\n\n### How to Authenticate\n\nInclude your API key in the `Authorization` header of every request:\n\n```\nAuthorization: Basic <YOUR_API_KEY>\n\n ```\n\n**Important**: Keep your API key secure and never expose it in client-side code or public repositories.\n\n## API Categories\n\nThe KeepSpace Public APIs are organized into two main categories:\n\n### 📦 Orders\n\nManage the complete order lifecycle from creation to delivery:\n\n- **CREATE ORDER** - Submit new delivery orders with item and customer details\n    \n- **GET ORDER DETAILS** - Retrieve comprehensive information about a specific order\n    \n- **GET TRACKING URL** - Obtain tracking links for customer shipment monitoring\n    \n\n### 📋 Items\n\nAccess and manage your product inventory:\n\n- **GET ITEM DETAILS** - Retrieve detailed information about specific items by SKU\n    \n- **GET ITEM INVENTORY** - Check real-time inventory levels across all warehouses\n    \n\n## Getting Started\n\nFollow these steps to start using the KeepSpace APIs:\n\n1. **Obtain API Credentials**: Contact KeepSpace support to receive your API key\n    \n2. **Set Up Authentication**: Configure your application to include the API key in the Authorization header\n    \n3. **Test Connectivity**: Make a test request to the GET ITEM DETAILS endpoint to verify your setup\n    \n4. **Explore Endpoints**: Review the documentation for each endpoint to understand available operations\n    \n5. **Integrate**: Build your integration using the endpoints that match your workflow requirements\n    \n\n### Quick Example\n\nHere's a simple example of retrieving item details:\n\n``` bash\ncurl -X GET \\\n  &#x27;https://production-api.keepspace.com.au/api/pub/v1/items/<ITEM_SKU>&#x27; \\\n  -H &#x27;Authorization: Basic <YOUR_API_KEY>&#x27;\n\n ```\n\n## Response Format\n\nAll API responses are returned in JSON format with a consistent structure:\n\n### Success Response\n\n``` json\n{\n  \"success\": true,\n  \"data\": {\n    // Response data specific to the endpoint\n  }\n}\n\n ```\n\n### Error Response\n\n``` json\n{\n  \"success\": false,\n  \"error\": {\n    \"message\": \"Error description\",\n    \"code\": \"ERROR_CODE\"\n  }\n}\n\n ```\n\n## Common HTTP Status Codes\n\n| Status Code | Description |\n| --- | --- |\n| 200 | Success - Request completed successfully |\n| 201 | Created - Resource created successfully |\n| 400 | Bad Request - Invalid request parameters |\n| 401 | Unauthorized - Invalid or missing API key |\n| 404 | Not Found - Requested resource doesn't exist |\n| 500 | Internal Server Error - Server-side error occurred |\n\n## Best Practices\n\n- **Use HTTPS**: All requests must be made over HTTPS for security\n    \n- **Handle Errors Gracefully**: Implement proper error handling for all API calls\n    \n- **Validate Data**: Ensure all required fields are included and properly formatted before making requests\n    \n- **Store API Keys Securely**: Never hardcode API keys in your source code\n    \n- **SKU Case Sensitivity**: Note that SKUs are case-sensitive in all requests\n    \n- **Test in Development**: Thoroughly test your integration before deploying to production\n    \n\n## Rate Limiting\n\nTo ensure optimal performance for all users, API requests may be subject to rate limiting. If you encounter rate limit errors, implement exponential backoff in your retry logic.\n\n## Support & Contact\n\nFor technical support, questions, or to request API access:\n\n- **Email**: [support@keepspace.com.au](https://mailto:support@keepspace.com.au)\n    \n- **Documentation**: Refer to individual endpoint documentation for detailed parameter information\n    \n- **API Access**: Contact your KeepSpace account manager to obtain API credentials\n    \n- Test Environment: At this moment, we do not have staging/test environment to play with. You can create order to test but cancel through Keepspace UI platform.\n    \n\n---\n\n**Version**: 1  \n**Last Updated**: Dec 2025\n\nFor detailed information about each endpoint, including request parameters, response schemas, and examples, please refer to the individual request documentation within this collection.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1562922","team":464542,"collectionId":"4d252822-5673-46a4-8c8d-d90443de6264","publishedId":"TzRYc4cx","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1562922/TzRYc4cx","privateUrl":"https://go.postman.co/documentation/1562922-4d252822-5673-46a4-8c8d-d90443de6264","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-05-18T09:23:31.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/938ef51ba4b4a289e0b8214b67ac0920a0e1a6c4c9a963498370fc83d40f7a63","favicon":""},"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://documenter.gw.postman.com/view/metadata/TzRYc4cx"}