Užklausos leidžia gauti naujausią informaciją apie produktus iš internetinės parduotuvės. Prašome naudoti šį dokumentą teisingam mūsų užklausų priėmimui.

 

HTTP užklausos pavyzdys:

GET http://www.{jūsųdomenas}/index.php?route={jūsųKelias}&token={tokenoNumeris}&selectMethod={metodas}&offset={nuokrypis}&limit={limitas}

 

1.Inicijavimo užklausa (Init request)
Tai pradinė užklausa, kurioje PriceInfo prašo prekybininko, remiantis ISO 4217 standartu, palaikomas valiutas.

Inicijavimo užklausos pavyzdys:

{
    "type": "init"
}

Inicijavimo užklausos pavyzdžio atsakymas:

{
    "currencies": [
        {
            "code": "EUR"
        },
        {
            "code": "PLN"
        }
    ]
}

Laukų aprašymas:

currencies: Valiutų objektų masyvas. Kiekvienas masyvo objektas turi lauką code.

code: Valiuta.

 

2.Ribojimo užklausa (By limit)
Šioje užklausoje PriceInfo prašo gauti produktų informaciją:

Užklausos pavyzdys:

{
    "currency": "EUR",
    "type": "prods",
    "token": 12345,
    "selectMethod": "limit",
    "offset": 0,
    "limit": 10
}

MySQL užklausos pavyzdys (Užklausa išrenka visus įrašus iš lentelės ir apriboja rezultatų skaičių iki 10, pradedant nuo pirmo įrašo):

SELECT * FROM prods LIMIT 0, 10

 

Jei naudojate skaitinius produktų identifikatorius, palikite atsakyme didžiausią identifikatorių (sku id) surinktų produktų reikšmę. Kitą kartą PriceInfo atsiųs užklausą naudodamas paskutinį identifikatorių (lastId).

 

3.Užklausa pagal paskutinį identifikatorių (By last id)
Šioje užklausoje PriceInfo prašo produktų informacijos, kurio identifikatorius (sku id) didesnis nei nurodytas lastId.

Užklausos pavyzdys:

{
    "currency": "EUR",
    "type": "prods",
    "token": 12345,
    "selectMethod": "lastId",
    "lastId": 22,
    "limit": 10
}

MySQL užklausos pavyzdys (Užklausa išrenka visus įrašus iš lentelės, kurio identifikatorius yra didesnis nei 22, ir apriboja rezultatų skaičių iki 10):

SELECT * FROM prods WHERE id > 22 LIMIT 10

 

Užklausos laukų aprašymas (By lastId & By limit):

currency: Valiutos kodas, kuriuo norite pateikti produktų kainas (pvz., "EUR", "USD").

type: Užklausos tipas, nurodantis produktų informaciją (pvz., "prods" arba "init").

selectMethod: Duomenų išrinkimo metodas, kuris gali turėti parametrą "limit" arba "lastId".

token: Unikalus prekybininko identifikatorius, skirtas gauti jo produktų duomenis.

offset: Nukrypimas (pradžios pozicija) produktų išrinkimui (taikoma tik naudojant metodą "limit").

limit: Maksimalus gautinų produktų skaičius.

lastId: Paskutinio gauto produkto identifikatorius (taikoma tik naudojant metodą "lastId").

Pavyzdys teisingos užklausos atsakymo:

{
    "prods": [
        {
            "sku": 1234,
            "url": "https://example.com",
            "price": 9.99,
            "data": {
                "title": "ExampleProduct",
                "model": "ExampleModel",
                "description": "ExampleProductDescription",
                "manufacturer": "ExampleManufacturer",
                "weight": 10,
                "ean": [
                    "1234567890",
                    "0987654321"
                ]
            },
            "delivery": [
                {
                    "country": [
                        "BE",
                        "DE"
                    ],
                    "carriers": [
                        {
                            "price": 9.99,
                            "name": "UPS",
                            "deliveryDaysEst": 3
                        },
                        {
                            "price": 0,
                            "name": "PickupInStore",
                            "deliveryDaysEst": 0,
                            "inStore": ""
                        }
                    ]
                },
                {
                    "country": "PL",
                    "carriers": [
                        {
                            "price": 5,
                            "name": "UPS",
                            "deliveryDaysEst": 3
                        },
                        {
                            "price": 9.99,
                            "name": "UPS",
                            "deliveryDaysEst": 2
                        }
                    ]
                }
            ],
            "itemsAvailable": 42,
            "images": [
                {
                    "url": "https://example.com/image1.jpg"
                },
                {
                    "url": "https://example.com/image2.jpg"
                }
            ]
        }
    ],
    "lastId": 1234
}

Laukų lentelė su aprašymu:

 

Lauko pavadinimasAprašymasLauko tipasPrivalumas
resultReikiamų produktų sąrašasArrayPrivalomas
result[0].skuProdukto SKU IDString / IntegerPrivalomas
result[0].urlProdukto URLStringPrivalomas
result[0].priceProdukto kaina, įskaitant visus mokesčiusFloatPrivalomas
result[0].availablePrekių kiekis kaip prieinamasIntegerPrivalomas
result[0].detailIšsami informacija apie produktąArrayPrivalomas (jei užklausos parametras "get" yra "detail")
result[0].detail.titleProdukto pavadinimasStringPrivalomas
result[0].detail.modelProdukto modelisStringNeprivalomas
result[0].detail.descriptionProdukto aprašymasStringNeprivalomas
result[0].detail.manufacturerProdukto gamintojasStringNeprivalomas
result[0].detail.weightProdukto svoris kilogramaisFloatNeprivalomas
result[0].detail.eanProdukto EAN kodų sąrašas arba produkto EANArray / StringPrivalomas
result[0].detail.imagesProdukto paveikslėlių sąrašasArrayPrivalomas
result[0].detail.images[0]Produkto paveikslėlisObjectPrivalomas
result[0].detail.images[0].urlProdukto paveikslėlio URLStringPrivalomas
result[0].deliveryGalimi produkto pristatymo metodaiStringPrivalomas (jei užklausos parametras "get" yra "delivery")
result[0].delivery[0].countryPristatymo šalies kodas pagal ISO 3166 arba šalių kodų sąrašasArray / StringPrivalomas
result[0].delivery[0].carriersPristatymo vežėjaiArrayPrivalomas
result[0].delivery[0].carriers[0]Pristatymo vežėjo objektasObjectPrivalomas
result[0].delivery[0].carriers[0].priceProdukto pristatymo kaina, įskaitant visus mokesčiusFloatPrivalomas
result[0].delivery[0].carriers[0].namePristatymo metodo pavadinimasFloatPrivalomas
result[0].delivery[0].carriers[0].deliveryDaysEstPristatymo metodo numatytas pristatymo dienų skaičiusFloatPrivalomas
nextKitas žymė reikalingas kitai Ecatalog užklausaiAnyPrivalomas