List variant inventory records visible to this user

Request

Only available to Buyer Users.

Security

OAuth2(Required scopes: FullAccessShopper)

Path

productIDstringrequired

ID of the product.

variantIDstringrequired

ID of the variant.

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""AddressID"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ID""AddressID""!ID""!AddressID"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

includeAddressboolean

Include address of the inventory record.

curl -i -X GET \
  'https://api.ordercloud.io/v1/me/products/{productID}/variants/{variantID}/inventoryrecords?search=string&searchOn=ID&sortBy=ID&page=1&pageSize=20&filters=&includeAddress=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Only available to Buyer Users.

Bodyapplication/json

ItemsArray of objects(InventoryRecord)

Example:

[
  {
    "ID": "",
    "OwnerID": "",
    "AllowAllBuyers": false,
    "Address": { … },
    "AddressID": "",
    "OrderCanExceed": false,
    "QuantityAvailable": 0,
    "NotificationPoint": 0,
    "LastUpdated": "2018-01-01T00:00:00-06:00",
    "xp": {}
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}