Sign in

v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB
Products

Retrieves the details of a specific product.

get/components/v1/product/{externalId}

Response

Product details retrieved successfully.

idstring

Product ID.

namestring

Product name.

displayNamestring

Product display name.

publisherProductIdstring

Product ID that you defined.

type'Quantity' | 'Time'

Product unit type.

descriptionstring

Product description.

prefixstring

Product prefix text.

suffixstring

Product suffix text.

textFontColorHexstring

Product text font color in hex format.

productImageUrlstring url

Product image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL.

productPrefixImageUrlstring url

Product prefix image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL.

productImageExternalUrlstring url

Original product image URL when the product uses an external image URL. This URL is used as provided to serve the image.

Example response

{
  "id": "507f1f77bcf86cd799439015",
  "name": "Gold Coins Pack",
  "displayName": "Gold Coins",
  "publisherProductId": "gold_coins_100",
  "type": "Quantity",
  "description": "A pack of 100 gold coins.",
  "prefix": "Get",
  "suffix": "coins",
  "textFontColorHex": "#f5c518",
  "productImageUrl": "https://media.appcharge.com/media/69133d595af23405d8e843a5",
  "productPrefixImageUrl": "https://media.appcharge.com/media/69133d595af23405d8e843a5",
  "productImageExternalUrl": "https://images.pexels.com/photos/35406321/pexels-photo-35406321.jpeg"
}