Shop Item

This endpoint is a GET request that retrieves a specific product from the Shop based on the provided productId. In this example, the productId parameter is mandatory

Endpoint

  • URL: /shop/products/:productId

  • Method: GET

URL Parameters

  • productId (required): The unique identifier of the product you want to retrieve information for.

Success Response

  • Code: 200 OK

  • Content:

{
    "message": "No Message",
    "data": {
        "parentId": "string",
        "productId": "string",
        "name": "string",
        "baseCurrency": "EUR",
        "region": "local",
        "variants": {
            ["VariantId"]: {
                "quote": 0,
                "name": "string",
                "state": "ACTIVE",
                "sku": "string"
            }
            // Additional variants can be listed here
        },
        "productType": "fixed",
        "customerDeal": "CustomerDeal"
    }
}

Fields Explanation

  • message: A message related to the API response, if any.

  • data: The main container for the product's detailed information.

    • parentId: The identifier of the parent product, if applicable.

    • productId: The unique identifier of the product.

    • name: The name of the product.

    • baseCurrency: The currency in which the product is priced.

    • region: The region of the product (LOCAL, GLOBAL , Read This). this means ehere product can be redeemed

    • variants: An object containing variant-specific information, indexed by variant ID.

      • quote: The price quote for the variant.

      • name: The name of the variant.

      • state: The current state of the variant (e.g., ACTIVE).

      • sku: The stock keeping unit identifier for the variant.

    • productType: The type of product (e.g., fixed).

    • customerDeal: See Customer Deal

Last updated