Shop List

Overview

This API allows users to access and obtain a comprehensive list of products available . Additionally, the service enables users to obtain detailed information about individual products, such as specifications, pricing, and availability. This facilitates efficient distribution processes by providing a centralized hub for managing and acquiring products from multiple suppliers or manufacturers.. It supports various query parameters for flexible searches and provides paginated results

Endpoint

Query Shop Items

Retrieves a list of shop items based on the provided query parameters.

• URL: /shop/products

• Method: GET

• Query Parameters:

Parameter	Type	Description
pageToken	string	Optional. A token for pagination to fetch the next set of results. in order to use pagination you need to send pageToken if it exists on previous request
pageSize	number	Optional, the size of each page. Range between 5-50
parentId	string	Optional, filter the products list based on parentId

• Success Response:

  • Code: 200 OK

  • Content:

  • {
        "nextPageToken": "<TOKEN_FOR_NEXT_PAGE>",
        "result": [
              {
                    "country": "GLOBAL",
                    "productId": "038-00",
                    "name": "THE_GLOBAL_GIFT_CARD",
                    "state": "ACTIVE",
                    "region": "global",
                    "parentId": "038",
                    "baseCurrency": "EUR",
                    "variants": {
                        "038-00-range": {
                            "range": {
                                "min": 5,
                                "max": 5000,
                                "step": 5,
                            },
                            "state": "ACTIVE",
                            "name": "Global Gift Card",
                            "sku": "038-00-range"
                        }
                    },
                    "productType": "range",
                    "customerDeal": "CustomerDeal"
                },
        ]
    }

• Note: The nextPageToken value is provided for pagination. Include this token as the pageToken parameter in your next request to retrieve subsequent pages.

Response Data

The response from the "Query Shop Items" endpoint contains a JSON object with two main properties: nextPageToken and result. Below is a detailed description of each field within the response data:

• nextPageToken (string | null): A token that can be used to fetch the next page of results. This value is null if there are no more pages to retrieve.

• result (array): An array of shop item objects. Each object in the array represents a single shop item and contains the following fields:

  • parentId (string): The ID of the parent item. This field helps in understanding the hierarchy or brand of items within the shop.

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

  • productId (string): A unique identifier for the product. This is crucial for fetching specific product details or performing operations related to the product.

  • name (string): The English name of the product. This is the human-readable name used to identify the product in listings or searches.

  • baseCurrency (string): The base currency code (ISO 4217) for the product prices. Indicates the currency in which product prices are quoted.

  • variants (object): Depending on productType, this object contains detailed information about each variant of the product:

    • For productType = fixed,

      • variants are described by:

        • sku (string): The stock-keeping unit identifier.

        • state (string): The availability state (ACTIVE or INACTIVE).

        • name (string): The name of the variant.

        • quote (number): The price of the variant.

    • For productType = range,

    • variants represent a range of options, described by:

      • state (number): The availability state (ACTIVE or INACTIVE).

      • sku (string): The stock-keeping unit identifier for the range.

      • name (number): The name of the variant.

      • range (object):

        • min (number): The minimum value in the range.

        • max (number): The maximum value in the range.

        • step (number): The increment between values in the range.

    • For productType = time,

    • variants described by:

      • equity(string): basically a label for the variants (12 Gem )

      • sku (string): The stock-keeping unit identifier.

      • state (string): The availability state (ACTIVE or INACTIVE).

      • name (string): The name of the variant.

      • quote (number): The price of the variant.

    • For productType = custom_fixed,

    • variants described by:

      • sku (string): The stock-keeping unit identifier.

      • state (string): The availability state (ACTIVE or INACTIVE).

      • name (string): The name of the variant.

      • quote (number): The price of the variant.

• productType (string): Indicates the type of product, affecting the structure of variants. Possible values include fixed for specific items and range for items available in a range of options.

• customerDeal (object): See Customer Deal