v1

latestOpenAPI 3.0.12026-07-2681110143.5 KB
Products

Get Product By ID

Returns only the product record for the productId you specify

get/products/{productId}

Path parameters

productIdstring required
Example:aaaee3f-262c-47a4-b0e6-f9ce8b54fcd7

Response

Successful operation

idstring uuid
namestring

The name of a product

vendorNamestring

The name of the vendor

shortDescriptionstring

A short description of the product

descriptionstring

A long description of the Product

skustring

The product sku

vendorSkustring

The product vendor sku

altVendorSkustring uuid

The Microsoft legacy sku has been deprecated. Please transition to vendorSku

requiresCommitmentboolean

Whether the product requires a commitment

Example response

{
  "name": "Acme Corps Productivity Suite",
  "vendorName": "Acme Corps",
  "shortDescription": "Short description about the product to sell",
  "description": "A Long description about the product to sell",
  "sku": "4225-776-3234",
  "vendorSku": "12345-AA-XYZ"
}