Ottieni prodotto per ID

Ottieni un prodotto per id. Un prodotto eliminato (soft-delete) viene restituito con deleted: true.

GET/products/{productId}

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri path

productIdstringobbligatorio

Risposte

200

Dettagli del prodotto

dataProductobbligatorio

Prodotto. I campi monetari sono interi in centesimi.

Mostra proprietà

idstringobbligatorio

Id del documento prodotto

externalIdstring

Identificatore esterno opzionale

namestring

priceinteger

Prezzo in centesimi.

supplierstring

Id del fornitore

taxCategorystring

Codice categoria IVA svizzera

Consentiti:8.12.63.80

categorystring

Id della categoria

declarationsstring

barcodestring

barcodeAliasesobject[]

EAN aggiuntivi facoltativi. Assente se non usato. Un array vuoto non viene salvato. Disponibile se la funzione alias dei codici a barre è attiva per l’organizzazione.

Mostra proprietà

Array di object

codestringobbligatorio

EAN aggiuntivo, in minuscolo come barcode

quantitynumber

Unità di base rappresentate da questo codice. Predefinito 1.

priceinteger

Prezzo facoltativo della confezione in centesimi

labelstring

externalIdstring

Id articolo esterno facoltativo

depositProductinteger

Cauzione in centesimi.

depositProductLabelstring

descriptionstring

salePriceinteger

Prezzo di vendita in centesimi.

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPriceinteger

Prezzo di costo in centesimi.

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

openInputboolean

imageUrlstring

URL dell'immagine. Impostare via create/update prodotto o POST /products/{productId}/image. Stringa vuota in update cancella il campo e gli oggetti storage dell'organizzazione.

indexinteger

allowStorestring[]

Id dei negozi consentiti (sola lettura).

hideStorestring[]

Id dei negozi nascosti (sola lettura).

deletedboolean

Soft-delete quando true.

createdatestring<date-time>

lastupdatestring<date-time>

instancestring

Id dell'organizzazione se presente

403

Chiave API mancante, sconosciuta o inattiva, oppure chiave Read su un’operazione di scrittura.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

404

Nessun elemento con questo id.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

Prova

Server

URL di baseURL di base personalizzatoSostituisce il server selezionato se impostato.

Autorizzazione

Token Bearer (chiave API)Ricorda su questo dispositivoUsa i miei valori negli esempi

Parametri

productIdpath*

Richiesta

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

Risposta

{
  "data": {
    "id": "a1b2c3",
    "name": "Acqua minerale 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"
}