Skip to main content

WineDirect Fulfillment API Gateway UAT 1.0 OAS 3.0

Download OpenAPI Specification

Provides access to the Fulfillment system.

Detailed Documentation

Authentication

The API uses Bearer Token authentication. Every endpoint except POST /api/v1/AccessToken requires an Authorization header.

Step 1: Request a bearer token

Call POST /api/v1/AccessToken with your API user credentials in the JSON body. No Authorization header is required for this call. The Authorization: <api-key> field shown in the reference UI is a global placeholder. Leave it blank when generating a token.
The bearer token is returned in the payload field of the response.
Call AccessToken no more than once every 8 hours and cache the returned token locally. Repeated calls may be rate-limited.

Step 2: Use the token on subsequent calls

Pass the token from payload as the Authorization header on every other endpoint, prefixed with Bearer :
Example in C#:

Step 3: Verify or refresh the token

  • GET /api/v1/AccessToken/WhoAmI — test whether the current token is still valid. A failure means the token has expired and you should call AccessToken again.
  • GET /api/v1/AccessToken/TokenDetails — check how long the current token has left before it expires.

From a browser

In the interactive API reference, click the Authorize button and enter the bearer token (including the Bearer prefix) returned from AccessToken.