Introduction

The Candid Wholesale API lets you retrieve your orders and update their shipping information.

Endpoints

The Candid Wholesale API is accessed at https://api.candidwholesale.com/api/v1. All endpoints begin with that prefix.

Structure

The Candid Wholesale API uses JSON:API.

Includes

We do not support the includes directive.

Sorting

You can sort the results by passing a sort parameter. In general all attributes are sortable, unless described in the specific endpoint. By default results are sorted by their id attribute.

You can change an attribute’s sorting from ascending to descending by prefixing the attribute name with a minus sign. For example sort=-order_date to get the most recently-placed orders.

Pagination

By default results are paginated to 10 items per page. You can change the page size by giving a page[size] parameter (up to 100 items). You can request a specific page with the page[number] parameter.

Filtering

Many filtering possibilities are provided, as described below under specific endpoints.

Dates & Times

Timestamps are given in ISO 8601 format, specifically YYYY-MM-DDTHH:MM:SSZ, always in UTC. Dates are given in YYYY-MM-DD.

Monetary

Monetary values are given in cents as integers, e.g. orders have order_total_cents.

Authentication