Welcome 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.
\nWith the KeepSpace APIs, you can:
\nManage Orders: Create delivery orders, track shipments, and retrieve order details
\nMonitor Inventory: Check real-time stock levels and item details across all KeepSpace warehouses
\nTrack Deliveries: Access tracking URLs and shipment status for customer transparency
\nAutomate Workflows: Integrate warehouse operations seamlessly with your existing systems
\nAll API requests should be made to:
\nhttps://production-api.keepspace.com.au/api/pub/v1\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.
\nInclude your API key in the Authorization header of every request:
Authorization: Basic <YOUR_API_KEY>\n\nImportant: Keep your API key secure and never expose it in client-side code or public repositories.
\nThe KeepSpace Public APIs are organized into two main categories:
\nManage the complete order lifecycle from creation to delivery:
\nCREATE ORDER - Submit new delivery orders with item and customer details
\nGET ORDER DETAILS - Retrieve comprehensive information about a specific order
\nGET TRACKING URL - Obtain tracking links for customer shipment monitoring
\nAccess and manage your product inventory:
\nGET ITEM DETAILS - Retrieve detailed information about specific items by SKU
\nGET ITEM INVENTORY - Check real-time inventory levels across all warehouses
\nFollow these steps to start using the KeepSpace APIs:
\nObtain API Credentials: Contact KeepSpace support to receive your API key
\nSet Up Authentication: Configure your application to include the API key in the Authorization header
\nTest Connectivity: Make a test request to the GET ITEM DETAILS endpoint to verify your setup
\nExplore Endpoints: Review the documentation for each endpoint to understand available operations
\nIntegrate: Build your integration using the endpoints that match your workflow requirements
\nHere's a simple example of retrieving item details:
\ncurl -X GET \\\n 'https://production-api.keepspace.com.au/api/pub/v1/items/<ITEM_SKU>' \\\n -H 'Authorization: Basic <YOUR_API_KEY>'\n\nAll API responses are returned in JSON format with a consistent structure:
\n{\n \"success\": true,\n \"data\": {\n // Response data specific to the endpoint\n }\n}\n\n{\n \"success\": false,\n \"error\": {\n \"message\": \"Error description\",\n \"code\": \"ERROR_CODE\"\n }\n}\n\nUse HTTPS: All requests must be made over HTTPS for security
\nHandle Errors Gracefully: Implement proper error handling for all API calls
\nValidate Data: Ensure all required fields are included and properly formatted before making requests
\nStore API Keys Securely: Never hardcode API keys in your source code
\nSKU Case Sensitivity: Note that SKUs are case-sensitive in all requests
\nTest in Development: Thoroughly test your integration before deploying to production
\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.
\nFor technical support, questions, or to request API access:
\nEmail: support@keepspace.com.au
\nDocumentation: Refer to individual endpoint documentation for detailed parameter information
\nAPI Access: Contact your KeepSpace account manager to obtain API credentials
\nTest 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.
\nVersion: 1
Last Updated: Dec 2025
For detailed information about each endpoint, including request parameters, response schemas, and examples, please refer to the individual request documentation within this collection.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"KeepSpace Public APIs","slug":"keepspace-public-apis"}],"owner":"1562922","collectionId":"4d252822-5673-46a4-8c8d-d90443de6264","publishedId":"TzRYc4cx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-18T09:23:31.000Z"},"item":[{"name":"Orders","item":[{"name":"OUTBOUND - CREATE ORDER","id":"4cfd9743-33ed-4c25-9fd7-a0d1ea10afb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic oafyvuxupc9drcb4d7jchytefr2a4xhagqrhmdlkqjtnoxi9vbokeg5mgz3qavtc","type":"text"}],"body":{"mode":"raw","raw":"\n{\n \"booking\": {\n \"company_name\": \"Company Name\", //optional\n \"contact_name\": \"Customer Test Name\",\n \"contact_phone\": \"098701234\",\n \"address\": \"Address line 1\",\n \"address2\": null, // optional\n \"suburb\": \"Hello Suburb\",\n \"postcode\": \"7123\",\n \"state\": \"WA\",\n \"country\": \"Australia\",\n \"email\": \"example@gmail.com\",\n \"reference\": \"ref-out-stage-02022026-003\", // when source_shop and source_id is not available, this is used for unique order validation \n \"shipping_method\": \"Express\",\n \"source_shop\": \"test.shopify.com\", // optional your website for sending back tracking id\n \"source_id\": \"your_website_order_id_01\" // optional but once you add in this and source_shop, combination will be checked for duplicate order\n },\n \"items\": [\n {\n \"sku\": \"royalScissors56789876596\", // case sensitive\n \"quantity\": 1, // quantity integer only\n \"sale_price\": \"56\", // optional - this is majorly used for customs for international orders\n \"sale_currency\": \"AUD\" // // optional - this is majorly used for customs for international orders. 3 letters Currency code\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-api.keepspace.com.au/api/pub/v1/bookings/item-delivery","description":"This endpoint creates a new order for item delivery in the KeepSpace system. It allows you to submit booking details along with item information to initiate an outbound delivery order.
\nThis endpoint requires Basic Authentication using your API key.
\nYou will be assigned api key once you give go ahead for that which you will be using in for AUTHORISATION HEADER for the request
\nHeader:
\nAuthorization: Basic <YOUR_API_KEY>\n\nExcel Link to REQUEST PARAMETERS details
https://docs.google.com/spreadsheets/d/1uXBoAay80eNOzIZNDNDz04RUR9ZYQs_kIxemYg6wby0/edit#gid=0
contact_name (string, required) - Customer's full name
\ncontact_phone (string, required) - Customer's contact phone number
\naddress (string, required) - Primary address line
\nsuburb (string, required) - Suburb/city name
\npostcode (string, required) - Postal/ZIP code
\nstate (string, required) - State/province code (e.g., \"WA\")
\ncountry (string, required) - Country name
\nemail (string, required) - Customer's email address
\nshipping_method (string, required) - Delivery method (e.g., \"Express\")
\ncompany_name (string, optional) - Company name if applicable
\naddress2 (string, optional) - Secondary address line
\nreference (string, optional) - Unique reference identifier for the order
\nsource_shop (string, optional) - Your website/shop identifier (e.g., \"test.shopify.com\")
\nsource_id (string, optional) - Your website's order ID
\nArray of items to be delivered. Each item contains:
\nsku (string, required) - Stock Keeping Unit (case sensitive)
\nquantity (integer, required) - Number of items to deliver
\nsale_price (string, optional) - Item price (primarily used for customs on international orders)
\nsale_currency (string, optional) - 3-letter currency code (e.g., \"AUD\") for customs purposes
\nThe system validates orders for duplicates using one of two methods:
\nsource_shop + source_id combination: When both fields are provided, this combination is checked for duplicate orders
\nreference field: When source_shop and source_id are not available, the reference field is used for unique order validation
\nRecommendation: Use source_shop and source_id when integrating with e-commerce platforms to enable tracking ID callbacks.
\nWhen you provide source_shop and source_id, the system can send tracking information back to your website once the order is processed.
\nCreating an express delivery order for a customer who purchased an item from your Shopify store. The order includes the customer's delivery details and the item SKU with quantity. By providing source_shop and source_id, you'll receive tracking updates back to your e-commerce platform.
\nIf you donโt receive status 201 in create order api, make sure your parameters are correct
\nMake sure orders are unique by checking combination of email, reference, contact_name.. If there is existing booking for same combination, you will get error
\nYou will get order_id in response of create order api. You need to store that with you for calling the api to get tracking url. This ID will be order id in keepspace system for you to reference back.
\nThis endpoint creates a new order for inbound in the KeepSpace system. It allows you to submit booking details along with item information to initiate an inbound rceivable order.
\nThis endpoint requires Basic Authentication using your API key.
\nYou will be assigned api key once you give go ahead for that which you will be using in for AUTHORISATION HEADER for the request
\nHeader:
\nAuthorization: Basic <YOUR_API_KEY>\n\nExcel Link to REQUEST PARAMETERS details
https://docs.google.com/spreadsheets/d/1uXBoAay80eNOzIZNDNDz04RUR9ZYQs_kIxemYg6wby0/edit#gid=0
contact_name (string, required) - Customer's full name
\ncontact_phone (string, required) - Customer's contact phone number
\naddress (string, required) - Primary address line
\nsuburb (string, required) - Suburb/city name
\npostcode (string, required) - Postal/ZIP code
\nstate (string, required) - State/province code (e.g., \"WA\")
\ncountry (string, required) - Country name
\nemail (string, required) - Customer's email address
\nshipping_method (string, required) - Delivery method (e.g., \"Express\")
\ncompany_name (string, optional) - Company name if applicable
\naddress2 (string, optional) - Secondary address line
\nreference (string, optional) - Unique reference identifier for the order
\nsource_shop (string, optional) - Your website/shop identifier (e.g., \"test.shopify.com\")
\nsource_id (string, optional) - Your website's order ID
\nArray of items to be delivered. Each item contains:
\nsku (string, required) - Stock Keeping Unit (case sensitive)
\nquantity (integer, required) - Number of items to deliver
\nsale_price (string, optional) - Item price (primarily used for customs on international orders)
\nsale_currency (string, optional) - 3-letter currency code (e.g., \"AUD\") for customs purposes
\nThe system validates orders for duplicates using one of two methods:
\nsource_shop + source_id combination: When both fields are provided, this combination is checked for duplicate orders
\nreference field: When source_shop and source_id are not available, the reference field is used for unique order validation
\nRecommendation: Use source_shop and source_id when integrating with e-commerce platforms to enable tracking ID callbacks.
\nWhen you provide source_shop and source_id, the system can send tracking information back to your website once the order is processed.
\nCreating an express delivery order for a customer who purchased an item from your Shopify store. The order includes the customer's delivery details and the item SKU with quantity. By providing source_shop and source_id, you'll receive tracking updates back to your e-commerce platform.
\nIf you donโt receive status 201 in create order api, make sure your parameters are correct
\nMake sure orders are unique by checking combination of email, reference, contact_name.. If there is existing booking for same combination, you will get error
\nYou will get order_id in response of create order api. You need to store that with you for calling the api to get tracking url. This ID will be order id in keepspace system for you to reference back.
\nThis endpoint retrieves the tracking URL for a specific booking. Use this to obtain a link that allows customers to track their booking status and location in real-time.
\nThis endpoint requires Basic Authentication. Include your API key in the Authorization header:
\nYou will be assigned api key once you give go ahead for that which you will be using in for AUTHORISATION HEADER for the request
\nAuthorization: Basic <YOUR_API_KEY>\n\nThe response will contain the tracking URL and related booking tracking information. The tracking URL can be shared with customers to allow them to monitor their booking progress.
\nA logistics company wants to provide their customers with real-time tracking capabilities. After creating a booking, they call this endpoint with the booking ID to retrieve a tracking URL. The customer can click the link to view the current status and location of their booking.
\nEnsure the Booking_ID provided is valid and exists in the system
Tracking url will be null unless order is processed and available in our DB.
\nThis endpoint is read-only and does not modify booking data
\nKeep your API key secure and never expose it in client-side code
\nFor tracking api, you will get status code 200 only if you pass correct order id in parameters.
\nYou will get order_id in response of create order api. You need to store that with you for clling up this API.
\nRetrieves comprehensive details for a specific booking/order by its unique booking ID. This endpoint returns complete information about the order including status, customer details, shipping address, shipment tracking, and cost information.
\nThis endpoint requires Basic Authentication using your API key.
\nYou will be assigned api key once you give go ahead for that which you will be using in for AUTHORISATION HEADER for the request
\nAdd your API key to the Authorization header:
Authorization: Basic <YOUR_API_KEY>\n\nExample: /api/pub/v1/bookings/ where is the order id from keepspace.
The API returns a JSON object with the following structure:
\n{\n \"success\": true,\n \"data\": {\n \"details\": {\n \"overview\": {\n \"id\": \"Booking ID\",\n \"currency\": \"Currency code (e.g., AUD)\",\n \"is_international\": \"Boolean indicating if shipment is international\",\n \"status\": {\n \"text\": \"Status description (e.g., Processed)\",\n \"progress\": \"Progress percentage (0-100)\"\n }\n },\n \"address\": {\n \"country\": {\n \"name\": \"Country name\",\n \"iso2\": \"Two-letter country code\"\n },\n \"address_line_1\": \"Primary address line\",\n \"address_line_2\": \"Secondary address line (optional)\",\n \"suburb\": \"Suburb/city\",\n \"postcode\": \"Postal code\",\n \"state\": \"State/province code\"\n },\n \"customer\": {\n \"name\": \"Customer name\",\n \"company_name\": \"Company name\",\n \"phone_number\": \"Contact phone number\",\n \"email\": \"Customer email address\",\n \"source\": \"Order source (e.g., KeepSpace API)\",\n \"reference\": \"Customer reference number\",\n \"uid\": \"Customer unique identifier (nullable)\"\n },\n \"shipment\": {\n \"shipping_method\": \"Shipping method description\",\n \"warehouse\": {\n \"name\": \"Warehouse location\"\n },\n \"carrier\": \"Carrier name (e.g., StarTrack)\",\n \"service\": \"Service type (e.g., FPP Express)\",\n \"insurance\": {\n \"value\": \"Insurance value\",\n \"currency\": \"Insurance currency\"\n },\n \"duties\": \"Customs duties information (nullable)\",\n \"tracking\": {\n \"id\": \"Tracking number\",\n \"url\": \"Tracking URL\"\n }\n },\n \"total_supplier_cost\": \"Total cost in the specified currency\"\n }\n },\n \"message\": null\n}\n\nRequest:
\nGET https://production-api.keepspace.com.au/api/pub/v1/bookings/<BOOKING_ID>\nAuthorization: Basic <YOUR_API_KEY>\n\nResponse: Returns complete booking details including order status (Processed at 100%), delivery address in Brighton East, VIC, customer information, StarTrack shipment tracking, and total supplier cost of $197.85 AUD.
\nTrack order status and progress
\nRetrieve shipping and tracking information
\nAccess customer details for a specific order
\nGet delivery address information
\nMonitor order costs and currency
\nEnsure the booking ID exists in your account
\nThe message field will contain error details if the request fails
Tracking URLs provide direct links to carrier tracking pages
\nAll monetary values are returned in the currency specified in the overview.currency field
This endpoint retrieves real-time inventory levels for a specific item across all KeepSpace warehouses. Use this to check stock availability, stored quantities, and items on hold for any product in your catalog.
\nThis endpoint requires Basic Authentication. You will be assigned api key once you give go ahead for that which you will be using in for AUTHORISATION HEADER for the request
\nInclude your API key in the Authorization header:
\nAuthorization: Basic <YOUR_API_KEY>\n\nThe response returns a JSON object with the following structure:
\nsuccess (boolean): Indicates whether the request was successful
\ndata.details.summary: Contains basic item information
\ntitle (string): The full product title/name
\nsku (string): The item's SKU identifier
\ndata.details.warehouse_inventories (array): List of inventory details for each warehouse
\nwarehouse (string): The name/location of the warehouse (e.g., \"Melbourne\", \"Perth\")
\navailable (integer): Number of items available for sale/allocation
\nstored (integer): Total number of items physically stored in the warehouse
\nhold (integer): Number of items on hold (reserved but not yet allocated)
\nmessage (string|null): Additional information or error messages
\nA retailer wants to check if they have sufficient stock of a connector (SKU: CNP-295) before fulfilling a large order. By calling this endpoint, they can see that Melbourne has 22 units available while Perth has none, allowing them to route the order appropriately or inform the customer of availability.
\n{\n \"success\": true,\n \"data\": {\n \"details\": {\n \"summary\": {\n \"title\": \"Inline Plug Connector, IP68, 16A, 5-pole...\",\n \"sku\": \"CNP-295\"\n },\n \"warehouse_inventories\": [\n {\n \"warehouse\": \"Melbourne\",\n \"available\": 22,\n \"stored\": 22,\n \"hold\": 0\n },\n {\n \"warehouse\": \"Perth\",\n \"available\": 0,\n \"stored\": 0,\n \"hold\": 0\n }\n ]\n }\n },\n \"message\": null\n}\n\nThis endpoint retrieves comprehensive information about a specific item in the KeepSpace inventory system using its SKU (Stock Keeping Unit). The response includes product details, dimensions, shipping information, and item preferences.
\nThis endpoint requires Basic Authentication using your API key.
\nAuthorization: Basic <YOUR_API_KEY>\n\nReplace with your actual KeepSpace API key.
\nGET https://production-api.keepspace.com.au/api/pub/v1/items/<ITEM_SKU>\nAuthorization: Basic <YOUR_API_KEY>\n\n{\n \"success\": true,\n \"data\": {\n \"details\": {\n \"summary\": {\n \"sku\": \"string\",\n \"description\": \"string\",\n \"title\": \"string\",\n \"barcode\": \"string\",\n \"type\": \"string\",\n \"images\": [\n {\n \"url\": \"string\"\n }\n ],\n \"category\": \"string | null\",\n \"auto_breakdown\": {\n \"is_auto_breakdown\": boolean,\n \"lower_limit\": \"number | null\"\n },\n \"items_per_unit\": \"number | null\"\n },\n \"dimensions\": {\n \"weight\": {\n \"value\": number,\n \"text\": \"string\",\n \"unit_type\": \"string\"\n },\n \"height\": {\n \"value\": number,\n \"text\": \"string\",\n \"unit_type\": \"string\"\n },\n \"width\": {\n \"value\": number,\n \"text\": \"string\",\n \"unit_type\": \"string\"\n },\n \"length\": {\n \"value\": number,\n \"text\": \"string\",\n \"unit_type\": \"string\"\n }\n },\n \"shipping_values\": {\n \"retail_cost\": {\n \"value\": number,\n \"text\": \"string\",\n \"unit_type\": \"string\"\n },\n \"supplier_cost\": {\n \"value\": number,\n \"text\": \"string\",\n \"unit_type\": \"string\"\n },\n \"country_of_manufacture\": \"string\",\n \"hs_code\": \"string\"\n },\n \"preferences\": {\n \"is_scannable\": boolean,\n \"is_pre_packed\": boolean,\n \"is_fragile\": boolean,\n \"low_stock_alert\": number,\n \"include_marketing_material\": boolean\n }\n }\n },\n \"message\": \"string | null\"\n}\n\nsku: The unique stock keeping unit identifier
\ndescription: Detailed description of the item
\ntitle: Display title of the item
\nbarcode: Product barcode number
\ntype: Item type (e.g., \"BASE\")
\nimages: Array of image URLs for the product
\ncategory: Product category (can be null)
\nauto_breakdown: Configuration for automatic breakdown of units
\nitems_per_unit: Number of items per unit (can be null)
\nAll dimension fields include:
\nvalue: Numeric measurement
\ntext: Formatted text representation
\nunit_type: Unit of measurement (kg, cm, etc.)
\nretail_cost: Retail price information
\nsupplier_cost: Supplier cost information
\ncountry_of_manufacture: Origin country
\nhs_code: Harmonized System code for customs
\nis_scannable: Whether the item can be scanned
\nis_pre_packed: Pre-packaging status
\nis_fragile: Fragile handling requirement
\nlow_stock_alert: Threshold for low stock notifications
\ninclude_marketing_material: Whether to include marketing materials
\nโ ๏ธ SKU Case Sensitivity: The SKU parameter is case-sensitive. Ensure you use the exact case as stored in the system. For example, CNP-295 is different from cnp-295.
Retrieve product information for display in e-commerce platforms
\nVerify item details before creating orders
\nCheck inventory specifications and dimensions
\nAccess shipping and pricing information
\nValidate product data in your system
\nIf the item is not found or the SKU is incorrect, the API will return an appropriate error response. Always check the success field in the response to determine if the request was successful.
This endpoint retrieves real-time inventory levels for a specific item across all KeepSpace warehouses. Use this to check stock availability, stored quantities, and items on hold for any product in your catalog.
\nThis endpoint requires Basic Authentication. You will be assigned api key once you give go ahead for that which you will be using in for AUTHORISATION HEADER for the request
\nInclude your API key in the Authorization header:
\nAuthorization: Basic <YOUR_API_KEY>\n\nThe response returns a JSON object with the following structure:
\nsuccess (boolean): Indicates whether the request was successful
\ndata.details.summary: Contains basic item information
\ntitle (string): The full product title/name
\nsku (string): The item's SKU identifier
\ndata.details.warehouse_inventories (array): List of inventory details for each warehouse
\nwarehouse (string): The name/location of the warehouse (e.g., \"Melbourne\", \"Perth\")
\navailable (integer): Number of items available for new orders. [Stored - hold]
\nstored (integer): Total number of items physically stored in the warehouse
\nhold (integer): Number of items on hold - which are assigned to orders already
\nmessage (string|null): Additional information or error messages
\nA retailer wants to check if they have sufficient stock of a connector (SKU: CNP-295) before fulfilling a large order. By calling this endpoint, they can see that Melbourne has 22 units available while Perth has none, allowing them to route the order appropriately or inform the customer of availability.
\nGET https://production-api.keepspace.com.au/api/pub/v1/items/<ITEM_SKU>/inventory\nAuthorization: Basic <YOUR_API_KEY>\n\n{\n \"success\": true,\n \"data\": {\n \"details\": {\n \"summary\": {\n \"title\": \"Inline Plug Connector, IP68, 16A, 5-pole...\",\n \"sku\": \"CNP-295\"\n },\n \"warehouse_inventories\": [\n {\n \"warehouse\": \"Melbourne\",\n \"available\": 22,\n \"stored\": 22,\n \"hold\": 0\n },\n {\n \"warehouse\": \"Perth\",\n \"available\": 0,\n \"stored\": 0,\n \"hold\": 0\n }\n ]\n }\n },\n \"message\": null\n}\n\n