Obtenir un produit par ID

Récupère un produit par id. Un produit supprimé logiquement est renvoyé avec deleted: true.

GET/products/{productId}

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de chemin

productIdstringobligatoire

Réponses

200

Détails du produit

dataProductobligatoire

Produit. Les champs monétaires sont des entiers en centimes.

Afficher les propriétés

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

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).

404

Aucun élément avec cet id.

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).

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

productIdpath*

Requête

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

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

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/products/string",
    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/string',
  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",
    "description": "",
    "showOnScreen": true,
    "ageRestriction": false,
    "showOnScale": false,
    "saleStop": false,
    "imageUrl": ""
  }
}

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

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}