Baloom
  1. API
Baloom
  • Developers
    • Créer une nouvelle application développeur
      POST
    • Lister toutes les applications développeur
      GET
    • Obtenir une application par ID
      GET
    • Mettre à jour une application
      PATCH
    • Supprimer une application
      DELETE
    • Créer une clé API pour une application
      POST
    • Lister les clés API d'une application
      GET
    • Révoquer une clé API
      POST
  • Webhooks
    • Créer un endpoint webhook
      POST
    • Lister les endpoints webhooks
      GET
    • Obtenir un endpoint webhook par ID
      GET
    • Mettre à jour un endpoint webhook
      PATCH
    • Supprimer un endpoint webhook
      DELETE
    • Obtenir l'historique des événements webhooks
      GET
  • API
    • Lister les produits
      GET
    • Obtenir un produit par ID
      GET
    • Lister les catégories
      GET
    • Obtenir une catégorie par ID
      GET
    • Lister les commandes
      GET
    • Obtenir une commande par ID
      GET
    • Lister les clients
      GET
    • Obtenir un client par ID
      GET
    • Lister les factures
      GET
    • Obtenir une facture par ID
      GET
  • Schemas
    • CreateApplicationDto
    • UpdateApplicationDto
    • DeveloperApplication
    • CreateApiKeyDto
    • ApiKey
    • Product
    • Category
    • Order
    • Customer
    • Invoice
    • PaginatedResponse
    • CreateWebhookEndpointDto
    • UpdateWebhookEndpointDto
    • WebhookEndpoint
    • WebhookEvent
    • WebhookPayload
    • Error
  1. API

Lister les produits

GET
/api/products
Retourne la liste des produits de l'organisation. Peut être filtrée par site via le header X-Site-Id ou le paramètre siteId.

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Header Params

Responses

🟢200OK
application/json
Liste des produits
Body

🟠400Bad Request
🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/products?siteId&page&limit&search&categoryId&brandId&isActive&trackInventory&type&orderBy&orderDirection' \
--header 'X-Site-Id;' \
--header 'X-API-Key: <api-key>'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "name": "string",
            "description": "string",
            "type": "PHYSICAL",
            "sku": "string",
            "barcode": "string",
            "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
            "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
            "unit": "PIECE",
            "images": [
                "string"
            ],
            "purchasePrice": 0,
            "sellingPrice": 0,
            "taxRate": 0,
            "isActive": true,
            "trackInventory": true,
            "minStockLevel": 0,
            "maxStockLevel": 0,
            "reorderPoint": 0,
            "isPerishable": true,
            "shelfLifeDays": 0,
            "attributes": {},
            "tags": [
                "string"
            ],
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0,
        "totalPages": 0
    }
}
Modified at 2026-01-04 12:06:10
Previous
Obtenir l'historique des événements webhooks
Next
Obtenir un produit par ID
Built with