Lister ou rechercher des produits

Liste les produits, ou recherche avec q. La recherche prend en charge offset et limite la taille de page à 250. Sans q, seul limit s’applique.

GET/products

Autorisation

AutorisationJeton Bearer (API key) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

qstring

Texte de recherche. Active la pagination par `offset`.

limitinteger

Taille de page (1–5000, défaut 100 ; max 250 avec `q`).

min 1 · max 5000 · default: 100

offsetinteger

Ignorer des résultats de recherche. Uniquement avec `q`.

min 0 · max 10000 · default: 0

storestring

Filter by store id. Works with and without `q`. When set, `meta.total` reflects the filtered page (not the unfiltered search estimate).

cursorstring

Identifiant opaque de document pour la page suivante. Uniquement sans `q` (fonctionne avec `store`). Ne pas analyser. Suivre `meta.nextCursor` jusqu'à son absence. Avec `store` ou soft-delete, `returned` peut être inférieur à `limit` alors que `nextCursor` est présent.

Réponses

200Liste de produits avec meta.

dataProduct[]obligatoire

Afficher les propriétés

Array of Product

idstring

Id du document produit

externalIdstring

Identifiant externe optionnel

namestring

priceinteger

Prix en centimes.

supplierstring

Id du fournisseur

taxCategorystring

Code de catégorie TVA suisse

Autorisé:8.12.63.80

categorystring

Id de la catégorie

declarationsstring

barcodestring

depositProductinteger

Consigne en centimes.

depositProductLabelstring

descriptionstring

salePriceinteger

Prix de vente promotionnel en centimes.

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPriceinteger

Prix de revient en centimes.

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

openInputboolean

imageUrlstring

URL de l’image (lecture seule).

indexinteger

allowStorestring[]

Ids de magasins autorisés (lecture seule).

hideStorestring[]

Ids de magasins masqués (lecture seule).

deletedboolean

Supprimé logiquement lorsque true.

createdatestring<date-time>

lastupdatestring<date-time>

instancestring

Id de l’organisation lorsqu’il est présent

metaListMetaobligatoire

Métadonnées de liste. `returned` est la longueur de `data`. Les entrées de catalogue supprimées (soft delete) sont exclues des listes — `returned` peut être inférieur à `limit` même s'il reste des entrées actives.

Afficher les propriétés

totalintegerobligatoire

Avec recherche produit (`q`) : nombre estimé de correspondances. Sinon égal à `returned`. Peut être inférieur à `limit` lorsque des entrées supprimées ont été filtrées de la page.

returnedintegerobligatoire

Nombre d'éléments actifs dans `data` (entrées supprimées exclues).

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec `q`.

nextCursorstring

Curseur opaque pour la page suivante. Présent lorsque d'autres résultats sont possibles. Ne pas analyser ; transmettre tel quel comme `cursor`. Avec filtre soft-delete ou `store`, `returned < limit` ne signifie pas la fin de la liste.

400Requête incorrecte

errorValidationErrorobligatoire

Détails de validation.

Afficher les propriétés

formErrorsstring[]obligatoire

fieldErrorsobjectobligatoire

403Non autorisé

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

pathstringobligatoire

Chemin de la requête

503Recherche indisponible

errorstringobligatoire

Requête

curl -X GET "https://dashboard.scango.ch/api/v1/products" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dashboard.scango.ch/api/v1/products", {
  method: "GET",
  headers: {
    "Autorisation": "Bearer YOUR_TOKEN"
  }
});

Réponse

{
  "data": [
    {
      "id": "string",
      "externalId": "string",
      "name": "string",
      "price": 0,
      "supplier": "string",
      "taxCategory": "8.1",
      "category": "string",
      "declarations": "string",
      "barcode": "string",
      "depositProduct": 0,
      "depositProductLabel": "string",
      "description": "string",
      "salePrice": 0,
      "salePercentage": 0,
      "salePriceDateFrom": "2024-01-01T00:00:00Z",
      "salePriceDateTo": "2024-01-01T00:00:00Z",
      "costPrice": 0,
      "margin": 0,
      "showOnScreen": true,
      "ageRestriction": true,
      "showOnScale": true,
      "saleStop": true,
      "deactivated": true,
      "openInput": true,
      "imageUrl": "string",
      "index": 0,
      "allowStore": [
        "string"
      ],
      "hideStore": [
        "string"
      ],
      "deleted": true,
      "createdate": "2024-01-01T00:00:00Z",
      "lastupdate": "2024-01-01T00:00:00Z",
      "instance": "string"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}