Disponibilità dei prodotti tramite API

Swagger

L’API fornisce le quantità disponibili in magazzino e in produzione, suddivise per città e colore. 

1. Indirizzo e metodo

GET

http://ea.f1s.org.ua:8080/EA/ru_RU/hs/API/GetInfo

2. Parametri della richiesta

Passare un oggetto JSON con codifica URL nel parametro di query param. La richiesta GET non utilizza un corpo. Entrambi i campi sono obbligatori.

Senza varianti

curl --get \
  'http://ea.f1s.org.ua:8080/EA/ru_RU/hs/API/GetInfo' \
  --data-urlencode 'param={"token":"<YOUR_TOKEN>","includeCharacteristics":false}'

Con varianti

curl --get \
  'http://ea.f1s.org.ua:8080/EA/ru_RU/hs/API/GetInfo' \
  --data-urlencode 'param={"token":"<YOUR_TOKEN>","includeCharacteristics":true}'

3. Campi della risposta

Con includeCharacteristics: true vengono restituiti anche characteristicCode e characteristicName. Il campo color è presente solo se valorizzato. Se l’esportazione dei prezzi è disabilitata, price e vatStatus sono omessi. Il prezzo 0 è un valore numerico e non indica un campo assente.

vatStatus: included — IVA inclusa; excluded — IVA esclusa; null — stato non determinato.

4. Dettaglio per città e colore

Ogni elemento di details contiene city (stringa oppure null), stockQuantity e productionQuantity (numeri). L’array facoltativo colors contiene color, stockQuantity e productionQuantity. Se nessun colore è valorizzato, colors è omesso. Le quantità senza colore restano nei totali della città ma non sono incluse in colors: la somma per colore può quindi essere inferiore al totale della città. La somma dei valori delle città coincide con le quantità complessive della voce. Una città non determinata è indicata con city: null.

Un array vuoto [] indica che non vi sono quantità disponibili. Conservare i codici come stringhe per mantenere gli zeri iniziali.

5. Esempio senza varianti

Gli esempi contengono dati illustrativi.

[
  {
    "productCode": "0000005870",
    "article": "ЕА-0005870",
    "productName": "Olflex Classic 110 18G1",
    "unit": "м",
    "stockQuantity": 200,
    "productionQuantity": 100,
    "details": [
      {
        "city": "Запоріжжя",
        "stockQuantity": 150,
        "productionQuantity": 100,
        "colors": [
          {
            "color": "Чорний",
            "stockQuantity": 150,
            "productionQuantity": 100
          }
        ]
      },
      {
        "city": "Кам'янець-Подільський",
        "stockQuantity": 50,
        "productionQuantity": 0
      }
    ]
  }
]

6. Esempio con varianti

Gli esempi contengono dati illustrativi.

[
  {
    "productCode": "0000005870",
    "article": "ЕА-0005870-000004287",
    "productName": "Olflex Classic 110 18G1",
    "unit": "м",
    "stockQuantity": 40,
    "productionQuantity": 0,
    "price": 42.5,
    "vatStatus": "included",
    "characteristicCode": "000004287",
    "characteristicName": "Відрізок 40 м",
    "details": [
      {
        "city": "Запоріжжя",
        "stockQuantity": 40,
        "productionQuantity": 0
      }
    ]
  }
]

7. Codici di stato ed errori

I codici error sono in inglese. I messaggi message sono in ucraino, indipendentemente dalla lingua della guida. Esempi di errore:

{
  "error": "access_denied",
  "message": "Токен не вказано"
}

{
  "error": "internal_error",
  "message": "Не вдалося отримати залишки. Зверніться до постачальника"
}

Content-Type: application/json; charset=utf-8

Se il prezzo non è fornito, mantenere quello già memorizzato. In caso di errore della richiesta, conservare i dati precedenti. Il token di accesso è riservato.