Lister ou rechercher des produits

Liste les produits ou les recherche avec q.

Sans q, les produits sont triés par name ; paginer avec cursor. Avec q, les résultats sont triés par pertinence et paginés avec offset ; limit est plafonné à 250. Un q qui ressemble à un code-barres (au moins 8 lettres, chiffres, - ou _, dont un chiffre) est comparé exactement à barcode et barcodeAliases au lieu d’une recherche textuelle.

Les résultats de recherche ne contiennent qu’une partie des champs : id, name, price, barcode, supplier, category, externalId, taxCategory, margin, imageUrl, allowStore, hideStore, les champs de promotion, deactivated, ageRestriction, showOnScreen, openInput et showOnScale. Récupérez un produit par id pour l’enregistrement complet.

GET/products

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

qstring

Texte de recherche. Active la recherche : pagination avec offset, limit plafonné à 250.

limitinteger

Taille de page (1–5000, défaut 100). Avec q, les valeurs supérieures à 250 sont ramenées à 250 ; meta.limit indique la valeur appliquée.

min 1 · max 5000 · default: 100

offsetinteger

Nombre de résultats à ignorer. Uniquement avec q, ignoré sinon.

min 0 · max 10000 · default: 0

storestring

Uniquement les produits visibles dans ce magasin (id du magasin). Fonctionne avec et sans q. Avec q, meta.total compte alors la page filtrée au lieu d’estimer tous les résultats.

min length 1

cursorstring

meta.nextCursor de la page précédente. Uniquement sans q (les deux ensemble renvoient 400). Ne pas l’analyser ; un curseur inconnu repart de la première page.

min length 1

Réponses

200

Liste de produits avec meta.

dataProduct[]obligatoire

Afficher les propriétés

Tableau de Product

idstringobligatoire

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

barcodeAliasesobject[]

EAN supplémentaires facultatifs. Absent s’il n’est pas utilisé. Un tableau vide n’est pas enregistré. Disponible lorsque la fonction alias de code-barres est activée pour l’organisation.

Afficher les propriétés

Tableau de object

codestringobligatoire

EAN supplémentaire, en minuscules comme barcode

quantitynumber

Nombre d’unités de base représentées par ce code. 1 par défaut.

priceinteger

Prix facultatif du lot en centimes

labelstring

externalIdstring

Id d’article externe facultatif

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. Définir via create/update produit ou POST /products/{productId}/image. Une chaîne vide à la mise à jour efface le champ et supprime le stockage de l’organisation.

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 dans data. Avec includeDeleted=true (commandes), les commandes supprimées sont comptées.

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec q.

nextCursorstring

Curseur opaque pour la page suivante ; à transmettre tel quel dans cursor. Présent lorsque d’autres résultats peuvent exister. Les éléments supprimés logiquement sont filtrés après lecture, une page peut donc être plus courte que limit alors que nextCursor est présent. Jamais renvoyé pour les catégories, fournisseurs et magasins, qui ne sont pas paginés.

400

Paramètres de requête invalides.

errorValidationErrorobligatoire

Détails de validation.

Afficher les propriétés

formErrorsstring[]obligatoire

fieldErrorsobjectobligatoire

403

Clé API absente, inconnue ou inactive, ou clé Read sur une opération d’écriture.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

503

La recherche de produits est temporairement indisponible.

errorstringobligatoire

Essayer

Serveur

URL de baseURL de base personnaliséeRemplace le serveur sélectionné si renseignée.

Autorisation

Jeton Bearer (clé API)Mémoriser sur cet appareilUtiliser mes valeurs dans les exemples

Paramètres

qqueryTexte de recherche. Active la recherche : pagination avec `offset`, `limit` plafonné à 250.limitqueryTaille de page (1–5000, défaut 100). Avec `q`, les valeurs supérieures à 250 sont ramenées à 250 ; `meta.limit` indique la valeur appliquée.offsetqueryNombre de résultats à ignorer. Uniquement avec `q`, ignoré sinon.storequeryUniquement les produits visibles dans ce magasin (id du magasin). Fonctionne avec et sans `q`. Avec `q`, `meta.total` compte alors la page filtrée au lieu d’estimer tous les résultats.cursorquery`meta.nextCursor` de la page précédente. Uniquement sans `q` (les deux ensemble renvoient 400). Ne pas l’analyser ; un curseur inconnu repart de la première page.

Requête

curl -X GET 'https://dashboard.scango.ch/api/v1/products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/products",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/products',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Réponse

{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Eau minérale 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6",
      "category": "cat_01",
      "supplier": "sup_01",
      "showOnScreen": true
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 1,
    "nextCursor": "a1b2c3"
  }
}

{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Eau minérale 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6"
    }
  ],
  "meta": {
    "total": 42,
    "returned": 20,
    "limit": 20,
    "offset": 0
  }
}

{
  "error": {
    "formErrors": [],
    "fieldErrors": {
      "limit": [
        "Number must be less than or equal to 5000"
      ]
    }
  }
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}

{
  "error": "Product search failed"
}