Skip to main content
GET
/
api
/
v1
/
Inventories
/
Sellable
Gets a list of sellable inventory.
curl --request GET \
  --url https://api.example.com/api/v1/Inventories/Sellable \
  --header 'Authorization: <api-key>'
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "warehouseCode": "GLW, WDI, PSO, SMA, SHW,MHT,AMC",
      "warehouseName": "Glenwillow, Green Island, Paso Robles, Santa Maria, Willamette Valley",
      "sku": "<string>",
      "description": "<string>",
      "wineDirectSku": "<string>",
      "subInventoryCode": "<string>",
      "subInventoryName": "<string>",
      "qtyOnHand": 123,
      "qtyOnOrders": 123,
      "qtyOnIns": 123,
      "qtyAvailableToSell": 123,
      "qtyAvailableToPromise": 123
    }
  ]
}

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)

"GLW" - Glenwillow,
"WDI" - Green Island,
"PSO" - Paso Robles,
"SMA" - Santa Maria,
"SHW" - Willamette Valley
"DAL" - Dallas
​
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