Back to endpoints

Get a single merchandise item

GET api/V3/{language}/org/{orgIdentifier}/merchandise/{id}

Returns a single merchandise item with the id provided.

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
id (integer)

Merchandise id

Required

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id

Image (string)
Name (string)

Resource name

Description (string)

Description of the activity that will be visible to your customers in your store

Availability (string)
Price (decimal number)

Price of activity

Quantity (integer)
Visibility (string)
Taxes (ApplicableTaxesModelV3)

Response Formats

CODE SAMPLE JSON
{
  "Id": 1,
  "Image": "https://www.cloud.com/image.jpg",
  "Name": "Chess Board",
  "Description": "Amilia-branded marble chess board.",
  "Availability": "Available",
  "Price": 100.45,
  "Quantity": 0,
  "Visibility": "Visible",
  "Taxes": null
}