Aller au contenu
scango.ch
Français
DeutschNon traduitEnglishNon traduitFrançaisItalianoNon traduit
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Obtenir un produit par ID

Récupère un produit par id.

GET/products/{productId}
Autorisation
AutorisationJeton Bearer (API key) · headerobligatoire
Clé API de l’organisation.
Paramètres de chemin
productIdstringobligatoire
Réponses
200Détails du produit
dataProductobligatoire
Produit. Les champs monétaires sont des entiers en centimes.
Afficher les propriétés
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
barcodeAliasesobject[]
Optional additional EANs. Absent when unused. Empty array is not persisted. Available when the barcode aliases feature is enabled for the organization.
Afficher les propriétés
Array of object
codestringobligatoire
Additional EAN, lowercased like barcode
quantitynumber
Base units represented by this code. Defaults to 1.
priceinteger
Optional pack price in cents
labelstring
externalIdstring
Optional external article ID
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
403Non autorisé
statusCodeintegerobligatoire
Code de statut HTTP
messagestringobligatoire
Message d’erreur lisible
timestampstring<date-time>obligatoire
pathstringobligatoire
Chemin de la requête
404Not found
statusCodeintegerobligatoire
Code de statut HTTP
messagestringobligatoire
Message d’erreur lisible
timestampstring<date-time>obligatoire
pathstringobligatoire
Chemin de la requête
Requête
curl -X GET "https://dashboard.scango.ch/api/v1/products/string" \
  -H "Authorization: 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",
    "barcodeAliases": [
      {
        "code": "string",
        "quantity": 0,
        "price": 0,
        "label": "string",
        "externalId": "string"
      }
    ],
    "depositProduct": 0,
    "depositProductLabel": "string",
    "description": "string",
    "salePrice": 0,
    "salePercentage": 0,
    "salePriceDateFrom": "2019-08-24T14:15:22Z",
    "salePriceDateTo": "2019-08-24T14:15:22Z",
    "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": "2019-08-24T14:15:22Z",
    "lastupdate": "2019-08-24T14:15:22Z",
    "instance": "string"
  }
}