Retrieve a product

Request

Only available to Buyer Users.

Security

OAuth2(Required scopes: FullAccessOrderContributorShopper)

Path

productIDstringrequired

ID of the product.

Query

sellerIDstring

ID of the seller.

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

Responses

Only available to Buyer Users.

Bodyapplication/json

PriceScheduleobject(BuyerPriceSchedule)read-only

Example:

{
  "PriceBreaks": [
    { … }
  ],
  "Discount": {
    "ID": "",
    "Description": ""
  },
  "OwnerID": "",
  "ID": "",
  "Name": "",
  "ApplyTax": false,
  "ApplyShipping": false,
  "MinQuantity": 0,
  "MaxQuantity": 0,
  "UseCumulativeQuantity": false,
  "RestrictedQuantity": false,
  "Currency": "",
  "SaleStart": "2018-01-01T00:00:00-06:00",
  "SaleEnd": "2018-01-01T00:00:00-06:00",
  "IsOnSale": false,
  "xp": {}
}

IDstring, <= 100 characters

Example:""

ParentIDstring

ID of the parent product. If not null, IsParent should be false

Example:""

IsParentboolean

If true, ParentID must be null, as a parent product cannot have a parent itself.

Example:false

IsBundlebooleanread-only

If true, IsParent must be false, as a parent product cannot be a bundle.

Example:false

Namestring, <= 100 characters

Example:""

Descriptionstring, <= 2000 characters

Example:""

QuantityMultiplierinteger, (int32), >= 1

For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.

Default:1

Example:0

ShipWeightnumber, (float)

Example:0

ShipHeightnumber, (float)

Example:0

ShipWidthnumber, (float)

Example:0

ShipLengthnumber, (float)

Example:0

Activeboolean

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

Example:false

SpecCountinteger, (int32)read-only

Count of specs assigned to the product.

Example:0

VariantCountinteger, (int32)read-only

Count of variants generated from the product/spec combinations.

Example:0

ShipFromAddressIDstring

Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.

Example:""

Inventoryobject(Inventory)

Example:

{
  "Enabled": false,
  "NotificationPoint": 0,
  "VariantLevelTracking": false,
  "OrderCanExceed": false,
  "QuantityAvailable": 0,
  "LastUpdated": "2018-01-01T00:00:00-06:00"
}

DefaultSupplierIDstring

Used for forwarding orders to suppliers.

Example:""

AllSuppliersCanSellboolean

If true, all suppliers are eligible to opt into selling this product.

Example:false

Returnableboolean

Example:false

DateCreatedstring, (date-time)read-only

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

xpobject

Example:

{}

Response

{
  "PriceSchedule": {
    "PriceBreaks": [ … ],
    "Discount": { … },
    "OwnerID": "",
    "ID": "",
    "Name": "",
    "ApplyTax": false,
    "ApplyShipping": false,
    "MinQuantity": 0,
    "MaxQuantity": 0,
    "UseCumulativeQuantity": false,
    "RestrictedQuantity": false,
    "Currency": "",
    "SaleStart": "2018-01-01T00:00:00-06:00",
    "SaleEnd": "2018-01-01T00:00:00-06:00",
    "IsOnSale": false,
    "xp": {}
  },
  "ID": "",
  "ParentID": "",
  "IsParent": false,
  "IsBundle": false,
  "Name": "",
  "Description": "",
  "QuantityMultiplier": 0,
  "ShipWeight": 0,
  "ShipHeight": 0,
  "ShipWidth": 0,
  "ShipLength": 0,
  "Active": false,
  "SpecCount": 0,
  "VariantCount": 0,
  "ShipFromAddressID": "",
  "Inventory": {
    "Enabled": false,
    "NotificationPoint": 0,
    "VariantLevelTracking": false,
    "OrderCanExceed": false,
    "QuantityAvailable": 0,
    "LastUpdated": "2018-01-01T00:00:00-06:00"
  },
  "DefaultSupplierID": "",
  "AllSuppliersCanSell": false,
  "Returnable": false,
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "xp": {}
}