Getting Started

Base URL

All API requests should be made to:

https://www.shipsidekick.com/api/v1

or in test:

https://test.shipsidekick.com/api/v1

Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Multi-Client Authentication

If you're a parent organization managing multiple client organizations, you can authenticate on behalf of a specific client by including the X-SSK-Client header with the client's organization slug:

Authorization: Bearer YOUR_API_KEY
X-SSK-Client: client-org-slug

This allows you to:

• Make API requests scoped to a specific child organization
• Manage inventory, orders, and other resources for individual clients
• Use a single API key to access multiple client accounts

Example:

curl -X GET https://www.shipsidekick.com/api/v1/inventory/levels \
  -H "Authorization: Bearer your_api_key_here" \
  -H "X-SSK-Client: acme-corp"

This request will return inventory levels for the "acme-corp" organization instead of your parent organization.

Response Format

All successful responses will include a status code of 200 and a JSON response body. Error responses will include appropriate status codes (400, 401, 404, or 500) and an error object with a message.

Error Handling

In case of an error, the API will return an appropriate HTTP status code along with a JSON object containing an error message:

{
  "error": {
    "message": "Error message description",
    "details": {
      /* Additional error details if available */
    }
  }
}

Common error codes:

• 400 - Bad Request (invalid parameters)
• 401 - Unauthorized (invalid or missing API key)
• 404 - Not Found (order does not exist)
• 500 - Internal Server Error

OpenAPI Spec

Our OpenAPI Spec can be found here: https://docs.shipsidekick.com/openapi.json