Skip to main content
GET
Gets a list of sellable inventory.

Authorizations

Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Query Parameters

accountNumber
string
required

AccountNumber is the unique Customer ID in the WineDirect system.

Minimum string length: 2
warehouseCode
string

The warehouse (Code)

subInventoryCode
string

The code for the sub inventory where the inventory is

*IGNORED if SKU is included.

eg. "SHIP" - PRIMARY

sku
string

The SKU of an inventory

onHandOnly
boolean
default:true
required

Whether to restrict the inventory to those which are on hand.

*IGNORED if SKU is included.

Defaults to True (Restrict to on hand)

Response

200 - application/json

Returns the list of sellable inventory

Generic container for all service responses

isSuccess
boolean

Was the request successful. If not, the message will have more information.

message
string | null

Any error message

payload
object[] | null

The payload object of the response