Skip to content
Commerce
/
/
Gets merchandise info

Gets merchandise info

Request

Gets merchandise info

Path
tenantIdstringrequired

The tenant

idstringrequired

The id of the merchandise

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/merchandise/{tenantId}/public/{id}'

Responses

The merchandise was retrieved

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
additional_image_urlsArray of strings(Additional Image Urls)

Additional images

business_unit_idstring(Business Unit)

The biz unit

category_idsArray of strings(Categories)

The categories to which this product belongs

date_addedstring(Date Added)

The date that this product was added to inventory

descriptionstring(Description)

Product description to be displayed on the portal

enable_special_pricesboolean(Enable Special Prices)

Special prices are are enabled

idstring(ID)

The unique identifier of the merchandise

image_urlstring(Image Url)

Image to be displayed of the product

is_newboolean(Is New)

Whether this product is new

member_pricenumber, (double)(Member Price)

The price of the product for an active member in the store currency

modifier_optionsArray of objects
namestring(Name)

The name of the merchandise

pricenumber, (double)(Price)required

The price of the product in the store currency

sellable_fromstring, (date-time)(Sellable From)

Date/time from which this product is sellable

sellable_untilstring, (date-time)(Sellable Until)

Date/time until which this product is sellable

sort_ordernumber, (float)(Sort Order)

The sort order of hte product

track_inventoryboolean(Track Inventory)

Whether inventory is tracked

variant_optionsArray of objects
variantsArray of objects
Response
{
  "additional_image_urls": [
    "string"
  ],
  "business_unit_id": "string",
  "category_ids": [
    "string"
  ],
  "date_added": "string",
  "description": "string",
  "enable_special_prices": true,
  "id": "string",
  "image_url": "string",
  "is_featured": true,
  "is_new": true,
  "member_price": 0.1,
  "modifier_options": [
    { … }
  ],
  "name": "string",
  "price": 0.1,
  "sellable_from": "2019-08-24T14:15:22Z",
  "sellable_until": "2019-08-24T14:15:22Z",
  "sort_order": 0.1,
  "track_inventory": true,
  "variant_options": [
    { … }
  ],
  "variants": [
    { … }
  ]
}