API URL Structure

Base URL

The Wherehouse API is accessible via the following base URL:

This base URL serves as the foundation for all API requests.

URL Scheme

The API follows a structured URL scheme that organizes resources under distinct entity-based endpoints. Each endpoint represents a specific category of data within the system and follows a RESTful approach.

Resource-Based Endpoints

Requests to the API are structured as follows:

Where {entity} is a placeholder for the specific resource category being accessed. Entities represent core objects and data models, such as products, orders, repricers, and more.

Examples of Endpoint Usage

Fetching data: GET /{entity} retrieves a collection of resources.

Creating new data: POST /{entity} submits new resource data to the system.

Versioning

The API uses versioning to ensure stability and backward compatibility. The current version is v1, which is specified in the base URL:

Versioning allows for updates and future improvements while maintaining support for existing integrations.

Authentication

All requests to the API require authentication. Refer to the authentication page for details on how to obtain and use API keys.

Error Handling

The API returns standard HTTP status codes and error messages to indicate the outcome of requests. Ensure that your integration handles these responses appropriately.

For further details on specific endpoints and their request/response structures, refer to the respective API documentation sections.

Structure Overview

API URL Structure#

Base URL#

URL Scheme#

Resource-Based Endpoints#

Examples of Endpoint Usage#

Versioning#

Authentication#

Error Handling#