Get a single variant inventory record

Request

Security

OAuth2(Required scopes: FullAccessProductAdminProductReader)

Path

productIDstringrequired

ID of the product.

variantIDstringrequired

ID of the variant.

inventoryRecordIDstringrequired

ID of the inventory record.

curl -i -X GET \
  'https://api.ordercloud.io/v1/products/{productID}/variants/{variantID}/inventoryrecords/{inventoryRecordID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

IDstring, <= 100 characters

Example:""

OwnerIDstring

Example:""

AllowAllBuyersboolean

Allow inventory record to be used by all buyers without creating explicit assignments.

Default:true

Example:false

Addressobject(Address)read-only

Example:

{
  "ID": "",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "CompanyName": "",
  "FirstName": "",
  "LastName": "",
  "Street1": "",
  "Street2": "",
  "City": "",
  "State": "",
  "Zip": "",
  "Country": "",
  "Phone": "",
  "AddressName": "",
  "xp": {}
}

AddressIDstring

AddressID is required because an inventory record represents a location where physical inventory for a given product exists.

Example:""

OrderCanExceedboolean

Example:false

QuantityAvailableinteger, (int32)

Example:0

NotificationPointinteger, (int32)

Example:0

LastUpdatedstring, (date-time)read-only

Example:"2018-01-01T00:00:00-06:00"

xpobject

Example:

{}

Response

{
  "ID": "",
  "OwnerID": "",
  "AllowAllBuyers": false,
  "Address": {
    "ID": "",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "CompanyName": "",
    "FirstName": "",
    "LastName": "",
    "Street1": "",
    "Street2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Country": "",
    "Phone": "",
    "AddressName": "",
    "xp": {}
  },
  "AddressID": "",
  "OrderCanExceed": false,
  "QuantityAvailable": 0,
  "NotificationPoint": 0,
  "LastUpdated": "2018-01-01T00:00:00-06:00",
  "xp": {}
}