Specifikace feedu

Tato stránka popisuje dostupnostní feed ve formátu KouzelnýSklad/MagicStock.io

Hlavní feed

XML

<?xml version="1.0" encoding="UTF-8"?>
<availability_result id="123123" created_at="2021-12-31 18:21:56 +0100" details_count="38603">
  <product>
    <code>10250037</code>
    <availability>
      <code>3D</code>
      <label>do tří dnů</label>
      <max_days>3</max_days>
      <available>true</available>
      <date>2022-01-03</date>
      <stock_amount>1</stock_amount>
    </availability>
    <details>
      <detail>
        <depot_id>gyhadu-nukogy</depot_id>
        <supplier_code>V13834552</supplier_code>
        <date>2022-01-03</date>
        <stock_amount>1</stock_amount>
        <code>3D</code>
        <label>do tří dnů</label>
        <max_days>3</max_days>
        <available>true</available>
      </detail>
      ... další sklady ...
    </details>
    <deliveries>
      <delivery>
        <id>kihuzi-kiliky</id>
        <name>expressní sklad</name>
        <label>do 90 minut</label>
        <code>16H</code>
        <time>2022-08-05T12:36:00+02:00</time>
        <interval>90</interval>
      </delivery>
      ... další dopravci ...
    </deliveries>
  </product>
  ... další produkty ...
</availability_result>

JSON

{
  "id": 183,
  "created_at": "2022-05-19 17:15:55 +0200",
  "details_count": 8,
  "products": [
    {
      "code": "100",
      "availability": {
        "date": null,
        "stock_amount": 0,
        "code": "NA",
        "label": "Nedostupné",
        "available": false
      },
      "details": [
        {
          "depot_id": "nawipa-xynebe",
          "supplier_code": "100",
          "stock_amount": 0,
          "date": null,
          "available": false,
          "code": "NA",
          "label": "Nedostupné",
          "max_days": null
        },
        {
          "depot_id": "mekeri-qikiku",
          "supplier_code": "100",
          "stock_amount": 0,
          "date": null,
          "available": false,
          "code": "NA",
          "label": "Nedostupné",
          "max_days": null
        },
        ... další sklady ...
      ],
      "deliveries": [
        {
          "delivery_id": "kihuzi-kiliky",
          "name": "expressní sklad",
          "label": null,
          "code": null,
          "time": "2022-08-11T10:00:00+02:00",
          "interval": null
        },
        ... další dopravci ...
      ]
    },
    ... další produkty ...
  ]
}

Popis jednotlivých polí

availability_result

Kořenový element, obsahuje informace o feedu.

Atributy:

id - identifikátor výsledku
created_at - čas výpočtu dostupnosti
details_count - počet jednotlivých detailních dostupností

product

Element obsahující veškeré informace o dostupnosti produktu.

code

Identifikátor produktu - hodnota je buď z párovací tabulky (byla-li nastavena), nebo je stejná jako identifikátor v dodavatelském feedu.

availability

Element obsahující informace o dostupnosti produktu.

code - kód dostupnosti podle číselníku
label - popis dostupnosti podle číselníku
max_days - maximální počet dnů dostupnosti podle číselníku
available (true/false) - volba ano/ne pro dostupnost zboží
date - datum dostupnosti zboží
stock_amount - počet kusů skladem (pokud je dodavatel uvádí)

details / detail

Detailní informace o dostupnosti z jednotlivých skladů. Obsahuje jeden detail element pro každý sklad.

depot_id - unikátní identifikátor skladu
supplier_code - dodavatelský identifikátor produktu
availability - element s informacemi o dostupnosti (viz výše)
code - kód dostupnosti podle číselníku
label - popis dostupnosti podle číselníku
max_days - maximální počet dnů dostupnosti podle číselníku
available (true/false) - volba ano/ne pro dostupnost zboží

deliveries / delivery

Informace o dopravní dostupnosti pro jednotlivé dopravce. Obsahuje jeden delivery element pro každého dopravce.

delivery_id - unikátní identifikátor dopravce
name - název dopravce
code - kód popisku doručovací doby
label - popisek doručovací doby
time - přesný očekávaný čas doručení
interval - délka intervalu doručení (pokud je použito pravidlo s plovoucí dobou)

Změnový feed

XML

<?xml version="1.0" encoding="UTF-8"?>
<availability_changes>
  <product>
    <code>10250037</code>
    <availability>
      <code>3D</code>
      <label>do tří dnů</label>
      <max_days>3</max_days>
      <available>true</available>
      <date>2022-01-03</date>
      <stock_amount>1</stock_amount>
      <code>3D</code>
      <label>do tří dnů</label>
      <max_days>3</max_days>
      <available>true</available>
    </availability>
    <details>
      <detail>
        <depot_id>gyhadu-nukogy</depot_id>
        <supplier_code>V13834552</supplier_code>
        <date>2022-01-03</date>
        <stock_amount>1</stock_amount>
        <code>3D</code>
        <label>do tří dnů</label>
        <max_days>3</max_days>
        <available>true</available>
      </detail>
      ... další sklady ...
    </details>
  </product>
  ... další produkty ...
</availability_changes>

JSON

{
  "changes": [
    {
      "code": "103",
      "availability": {
        "date": "2022-05-22",
        "stock_amount": 4,
        "code": "3D",
        "label": "Do tří dnů",
        "max_days": 3,
        "available": true
      },
      "details": [
        {
          "depot_id": "mekeri-qikiku",
          "supplier_code": "103",
          "stock_amount": 4,
          "date": "2022-05-22",
          "available": true,
          "code": "3D",
          "label": "Do tří dnů",
          "max_days": 3
        },
        {
          "depot_id": "nawipa-xynebe",
          "supplier_code": "103",
          "stock_amount": 8,
          "date": "2022-05-26",
          "available": true,
          "code": "3D",
          "label": "Do tří dnů",
          "max_days": 3
        }
      ]
    },
    ... další produkty ...
  ]
}

Formát změnového feedu je stejný jako u hlavního feedu, liší se pouze kořenový element.