Retrieve a variant

Request

Only available to Buyer Users.

Security

OAuth2(Required scopes: FullAccessOrderContributorShopper)

Path

productIDstringrequired

ID of the product.

variantIDstringrequired

ID of the variant.

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

Responses

Only available to Buyer Users.

Bodyapplication/json

IDstring, <= 100 characters

Example:""

Namestring, <= 100 characters

Example:""

Descriptionstring, <= 2000 characters

Example:""

Activeboolean

If false, variant is not visible or purchasable from a buyer's perspective.

Example:false

ShipWeightnumber, (float)

Example:0

ShipHeightnumber, (float)

Example:0

ShipWidthnumber, (float)

Example:0

ShipLengthnumber, (float)

Example:0

Inventoryobject(VariantInventory)

Example:

{
  "QuantityAvailable": 0,
  "NotificationPoint": 0,
  "LastUpdated": "2018-01-01T00:00:00-06:00"
}

SpecsArray of objects(VariantSpec)read-only

Example:

[
  {
    "SpecID": "",
    "Name": "",
    "OptionID": "",
    "Value": "",
    "PriceMarkupType": "NoMarkup",
    "PriceMarkup": 0
  }
]

xpobject

Example:

{}

Response

{
  "ID": "",
  "Name": "",
  "Description": "",
  "Active": false,
  "ShipWeight": 0,
  "ShipHeight": 0,
  "ShipWidth": 0,
  "ShipLength": 0,
  "Inventory": {
    "QuantityAvailable": 0,
    "NotificationPoint": 0,
    "LastUpdated": "2018-01-01T00:00:00-06:00"
  },
  "Specs": [
    { … }
  ],
  "xp": {}
}