Dokumentowanie do wtyczki "API hurtownika"

Format dostępu do interfejsu API:

Pobieranie listy kategorii produktów przesyłanych przez API.

<response>
    <categories>    
        <category id="23">Kategoria nadrzędna</category>
        <category id="45" parent_id="23">Podkategorią 1</category>
        <category id="25" parent_id="23">Podkategorią 2</category>
    </categories>
</response>    

Opis formatu wyniku:

Odbiór ilości towarów

Format dostępu do interfejsu API:

Uzyskanie ilości towarów dostępnych do uzyskania informacji za pośrednictwem interfejsu API.

Aby uzyskać liczbę towarów, należy użyć GET parametr op:

• op - operacji uzyskiwania resztek, ustawiana jest wartość count

<response>
    <productsCount>9999</productsCount>
</response>    

Opis formatu wyniku:

Uzyskiwanie sald i cen

Format dostępu do interfejsu API:

Uzyskiwanie sald i cen towarów bez treści przesyłanych przez API.

W celu zapewnienia wydajności wprowadzono ograniczenie do otrzymania listy produktów w wysokości 50 pozycji. Aby uzyskać towary, musisz użyć GET parametry op, offset i limit:

• op - operacji uzyskiwania resztek, ustawiana jest wartość stock
• offset - pozycja, od której chcesz otrzymywać dane, numeracja zaczyna się od 0. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 0.
• limit - Maksymalna liczba pozycji przekazywanych w próbce, maksymalna wartość 50. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 50.

<response>
    <offset>0</offset>
    <limit>5</limit>
    <prices>    
        <price>Cena strony</price>    
        <price>Cena hurtowa</price>    
    </prices>    
    <stock>    
        <product id="8" sku_id="8" category_id="25">
            <name>Produkt 1</name>
            <sku>Artykuł</sku>
            <brand>Marka</brand>
            <prices>
                <price tpype="retail" keep_price="1">
                    <name>Cena strony</name>>
                    <value>1000.0000</value>
                </feature<
                <feature type="purchase">
                    <name>Cena hurtowa</name>
                    <value>500.0000</value>
                </feature>
            </prices>
            <count>100</count>
        </product>
    </stock>
</response>    

Opis formatu wyniku:

Pobieranie treści

Format dostępu do interfejsu API:

Otrzymywanie treści towarów (nazwa, opis, charakterystyka, zdjęcia) bez cen i sald przesyłanych za pośrednictwem interfejsu API.

W celu zapewnienia wydajności, wprowadzono ograniczenie do otrzymania listy produktów w wysokości 50 pozycji. Aby uzyskać towary, musisz użyć GET parametryы op, offset i limit:

• op - operacji uzyskiwania resztek, ustawiana jest wartość content
• offset - pozycja, od której chcesz otrzymywać dane, numeracja zaczyna się od 0. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 0.
• limit - maksymalna liczba pozycji przekazywanych w próbce, maksymalna wartość 50. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 50.

<response>
    <offset>0</offset>
    <limit>5</limit>
    <content>    
        <product id="8" sku_id="8" category_id="25">
            <name>Produkt 1</name>
            <description>Opis produktu 1</description>
            <description_short>Opis produktu 1</description_short>
            <sku>Artykuł</sku>
            <brand>Marka</brand>
            <images>
                <image filename="50937.original.jpeg">
                    https://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50937&key=123123123
                </image>
                <image filename="50938.original.jpeg">
                    https://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50938&key=123123123
                </image>
            </images>
            <features>
                <feature status="public">
                    <name>Długość modelu</name>>
                    <value>60 cm</value>
                </feature<
                <feature status="public">
                    <name>Szerokość modelu</name>
                    <value>49 cm</value>
                </feature>
            </features>
        </product>
    </content>
</response>    

Opis formatu wyniku:

Format dostępu do interfejsu API:

Pobieranie obrazu produktu przesyłanego za pośrednictwem interfejsu API.

Jako parametry przekazywany jest id obrazu i klucz połączenia API. Zwracany obraz.

Format dostępu do interfejsu API:

Pobieranie listy kategorii produktów przesyłanych przez API.

{"categories":[
        {"id":"23","name":"Kategoria nadrzędna"},
        {"id":45","name":"Podkategorią 1","parent_id":"23"},
        {"id":"25","name":"Podkategorią 2","parent_id":"23"}
]}

Opis formatu wyniku:

Odbiór ilości towarów

Format dostępu do interfejsu API:

Uzyskanie ilości towarów dostępnych do uzyskania informacji za pośrednictwem interfejsu API.

Aby uzyskać ilość towarów należy użyć parametru GET op:

• op - operacji uzyskiwania resztek, ustawiana jest wartość count

{"product":{"productsCount":9999}}

Opis formatu wyniku:

Uzyskiwanie sald i cen

Format dostępu do interfejsu API:

Uzyskiwanie sald i cen towarów bez treści przesyłanych przez API.

W celu zapewnienia wydajności, wprowadzono limit półfabrykatów na listę towarów w wysokości 50 pozycji. Aby uzyskać towary, musisz użyć GET parametry op, offset i limit:

• op - operacji uzyskiwania resztek, ustawiana jest wartość stock
• offset - pozycja, od której chcesz otrzymywać dane, numeracja zaczyna się od 0. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 0.
• limit - maksymalna liczba pozycji przekazywanych w próbce, maksymalna wartość 50. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 50.

{
    "offset":"0",
    "limit":"50",
    "prices":[
        {"id":"0","name":"Cena strony"},
        {"id":"3","name":"Cena hurtowa"},
    ],
    "stock":[
        {
            "id":"8",
            "sku_id":"8",
            "category_id":"25",
            "name":"Produkt 1",
            "sku":"Artykuł",
            "brand":"Marka",
            "prices":[
                {
                    "id":"0",
                    "type":"retail",
                    "name":"Cena strony",
                    "currency":"PLN",
                    "price":"1000.0000",
                },
                {
                    "id":"3",
                    "type":"purchase",
                    "name":"Cena hurtowa",
                    "currency":"PLN",
                    "price":"500.0000",
                }
            ],
            "count":"100",
        }
    ]
}

Opis formatu wyniku:

Pobieranie treści

Format odwołania do API:

Otrzymywanie treści towarów (nazwa, opis, charakterystyka, zdjęcia) bez cen i sald przesyłanych za pośrednictwem interfejsu API.

W celu zapewnienia wydajności, wprowadzono ograniczenie do otrzymania listy produktów w wysokości 50 pozycji. Aby uzyskać towary, musisz użyć GET parametry op, offset i limit:

• op - operacji uzyskiwania resztek, ustawiana jest wartość content
• offset - pozycja, od której chcesz otrzymywać dane, numeracja zaczyna się od 0. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 0.
• limit - maksymalna liczba pozycji przekazywanych w próbce, maksymalna wartość 50. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 50.

{
    "offset":"0",
    "limit":"50",
    "prices":[
        {"id":"0","name":"Cena strony"},
        {"id":"3","name":"Cena hurtowa"},
    ],
    "content":[
        {
            "id":"8",
            "sku_id":"8",
            "category_id":"25",
            "name":"Товар 1",
            "description":"Opis produktu 1",
            "description_short":"Opis produktu 1",
            "sku":"Artykuł",
            "brand":"Marka",
            "images":[
                {
                    "filename":"50937.original.jpeg",
                    "url":"https://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50937&key=123123123",
                },
                {
                    "filename":"50938.original.jpeg",
                    "url":"https://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50938&key=123123123",
                }
            ],
            "features":[
                {
                    "status":"public",
                    "name":"Długość modelu",
                    "value":"60 cm",
                },
                {
                    "status":"public",
                    "name":"Szerokość modelu",
                    "value":"49 cm",
                }
            ],
        }
    ]
}

Opis formatu wyniku:

Format dostępu do interfejsu API:

Pobieranie obrazu produktu przesyłanego za pośrednictwem interfejsu API.

Jako parametry przekazywany jest id obrazu i klucz połączenia API. Zwracany obraz.

Uzyskiwanie sald i cen

Format dostępu do interfejsu API:

Uzyskiwanie sald i cen towarów bez treści przesyłanych przez API.

Aby uzyskać towary, musisz użyć GET parametry op, offset i limit:

• op - operacji uzyskiwania resztek, ustawiana jest wartość stock
• offset - pozycja, od której chcesz otrzymywać dane, numeracja zaczyna się od 0. Jeśli parametr nie jest określony, wartość jest przyjmowana jako 0.
• limit - Maksymalna liczba pozycji przekazywanych w próbce. Jeśli parametr nie jest określony, wszystkie towary są rozładowywane, a wartość offset jest ignorowana.

Opis formatu wyniku:

Format dostępu do interfejsu API:

Pobieranie obrazu produktu przesyłanego za pośrednictwem interfejsu API.

Jako parametry przekazywany jest id obrazu i klucz połączenia API. Zwracany obraz.

Pobieranie treści

Format dostępu do interfejsu API:

Otrzymywanie treści towarów (nazwa, opis, charakterystyka, zdjęcia) bez cen i sald przesyłanych za pośrednictwem interfejsu API.

W celu zapewnienia wydajności wprowadzono ograniczenie do otrzymania listy produktów w wysokości 50 pozycji. Aby uzyskać towary, musisz użyć GET parametry op, offset i limit:

• op - operacji uzyskiwania resztek, ustawiana jest wartość content

Format danych wyjściowych jest zgodny z formatem YML.

Format dostępu do interfejsu API:

Pobieranie obrazu produktu przesyłanego za pośrednictwem interfejsu API.

Jako parametry przekazywany jest id obrazu i klucz połączenia API. Zwracany obraz.