API Conventions

Request Format

All requests must include the Authorization header with a valid Bearer token
Request bodies should be sent as application/json
All IDs are UUIDs in the format 00000000-0000-0000-0000-000000000000

Date and Time Formats

⚠️ IMPORTANT: Timezone Handling

The Consignly API has unconventional date/time handling that differs from standard ISO 8601 conventions:

Most date/time fields return warehouse-local times, even though they include a Z suffix

Fields like dateEntered, expectedArrivalDateTime, actualDispatchDateTime, and any field named xxxDate or xxxDateTime are NOT UTC — they represent the local time of the warehouse the entity belongs to

Only fields explicitly suffixed with Utc (e.g., createdDateTimeUtc, modifiedDateTimeUtc) are actual UTC times

Correct interpretation of dates requires knowledge of the warehouse's configured timezone. See Warehouses for timezone information.

Format	Example	Interpretation
Date	`2024-01-15`	Date only (warehouse-local)
Date (in DateTime field)	`2024-01-15T00:00:00Z`	Date-only fields always return with `00:00:00Z` time component
DateTime	`2024-01-15T14:30:00Z`	Warehouse-local time (despite `Z` suffix)
DateTime (UTC)	`2024-01-15T14:30:00Z`	True UTC (only for `*Utc` suffixed fields)

Note: Date-only fields (e.g., dateEntered, bestBeforeDate, expiryDate, sellByDate) always return with a 00:00:00Z time component. The Z suffix does not indicate UTC — it represents midnight in the warehouse's local timezone.

Example:

// A consignment at a Sydney warehouse (UTC+11)
{
  "dateEntered": "2024-01-15T09:00:00Z",      // Actually 9:00 AM Sydney time, NOT UTC
  "createdDateTimeUtc": "2024-01-14T22:00:00Z" // True UTC (9:00 AM Sydney = 10:00 PM previous day UTC)
}

Pagination

List endpoints return paginated results. See the Pagination guide for details.

Parameter	Type	Description
`PageIndex`	integer	Page number (1-based)
`PageSize`	integer	Items per page (max 500)

Response Format

All responses are returned as JSON. Successful responses include the requested data directly. Error responses include error details.

Quick Start

Authentication