Products – ZeroXPay

Get Store Products

HTTP Method: GET
URL Path: https://public.zeroxpay.com/v1/store/products
Query Parameters:

status (optional): Filter products by status.

Description: Lists all products available in the store, optionally filtered by status.

Response Structure

The response is a JSON array of objects, each representing a product with the following fields:

created_at (string): The creation date and time of the product record in TIMESTAMPTZ format.
description (string | null): A brief description of the product. This field is null if no description has been provided.
id (string): The unique identifier for the product.
name (string): The name of the product.
store_id (string): The identifier of the store this product belongs to.
image_url (string | null): The URL to the product's image. This field is null if no image has been set.
status ('active' | 'hidden'): The status of the product.
quantity_available (number | null): The quantity of the product available for sale. This field is null if the quantity is not specified.
seller_note (string | null): A note from the seller regarding the product to be shared after a purchase. This field is null if no note has been provided.
prices (array): An array of objects containing the product's prices for different currencies. Each price object includes:
- id (string): The unique identifier for the price entry.
- amount (string): The price amount as a string (to handle large numbers precisely).
- currency (object): An object containing details about the currency:
  - id (string): The unique identifier for the currency.
  - name (string): The name of the currency.
  - symbol (string): The symbol of the currency.
  - address (string): The blockchain address of the currency token.
  - user_id (string | null): The user ID should be present if the currency is a custom ERC20 token added by the user.
  - chain_id (number): The blockchain network ID.
  - decimals (number): The number of decimal places for the currency.
  - icon_url (string): The URL to the currency's icon.
  - created_at (string): The creation date and time of the currency record.
- created_at (string): The creation date and time of the price entry.
- product_id (string): The ID of the product this price is associated with.
- currency_id (string): The ID of the currency used for this price.
- wallet_address (string): The wallet address associated with this price.

Response Example

[
  {
    "created_at": "2023-01-01 16:48:32.007852+00",
    "description": "An example product description.",
    "id": "prod456",
    "name": "Example Product Name",
    "store_id": "store789",
    "image_url": "https://example.com/product.png",
    "status": "active",
    "quantity_available": 100,
    "seller_note": "This is a seller note."
    "prices": [
      {
        "id": "a897ed55-8c90-45a5-9f13-3e987885a7d0",
        "amount": "1000000000000000",
        "currency": {
          "id": "867e1219-725b-4818-b6f8-880615e626fa",
          "name": "POL",
          "symbol": "POL",
          "address": "0x0000000000000000000000000000000000000000",
          "user_id": null,
          "chain_id": 137,
          "decimals": 18,
          "icon_url": "https://tokens-data.1inch.io/images/0xcc42724c6683b7e57334c4e856f4c9965ed682bd.png",
          "created_at": "2023-09-06T09:23:06.325621+00:00",
        },
        "created_at": "2024-09-15T08:45:10.409316+00:00",
        "product_id": "prod456",
        "currency_id": "867e1219-725b-4818-b6f8-880615e626fa",
        "wallet_address": "0xABC...."
      },
      {
        "id": "a9b477d7-4973-4421-8b9c-033195b40c58",
        "amount": "846500000000000",
        "currency": {
          "id": "7df8424a-5921-4c7e-a74e-2f15669adab1",
          "name": "Compound",
          "symbol": "COMP",
          "address": "0x8505b9d2254a7ae468c0e9dd10ccea3a837aef5c",
          "user_id": null,
          "chain_id": 137,
          "decimals": 18,
          "icon_url": "https://tokens.1inch.io/0xc00e94cb662c3520282e6f5717214004a7f26888.png",
          "created_at": "2023-09-06T09:23:06.325621+00:00",
        },
        "created_at": "2024-09-18T21:19:21.462426+00:00",
        "product_id": "prod456",
        "currency_id": "7df8424a-5921-4c7e-a74e-2f15669adab1",
        "wallet_address": "0xABC...."
      }
    ]
  }
]

GET store GET currencies