Using the API documentation, you can integrate your shop with our system.

API URL

API URL: https://shop-api.buybox.click/

POST /registerEntry

Zapytanie zgłaszające przekierowanie z widgetu. Należy wywołać, kiedy sklep zostanie odwiedzony z parametrem `bbclid`. Jeśli w adresie URL znajdzie się parametr "_ga", to należy go również przekazać.

Przykładowe zapytanie:

Headers:

Content-Type: application/json

Body:

{
  "bbclid": "{bbclid}",
  "bb_cid": {your-shop-ID},
  "_ga": "{_ga}",
}

Przykładowa odpowiedź

{
  "bbuuid": "{visitor-ID}",
  "expiry": 90,
}

POST /registerOrder

Zapytanie zgłaszające nam zamówienie / transakcję, wraz z informacją o zamówionych produktach i szczegółach rozliczeniowych. Należy je wywołać po potwierdzeniu zamówienia (ostatni krok procesu zakupowego) o ile dla użytkownika składającego zamówienie mamy {visitor-ID}.

Przykładowe zapytanie:

Headers:

Content-Type: application/json

Body:

{
"campaignId": {your-shop-ID},
  "bbuuid": "{visitor-ID}",
  "orderId": "{your-order-ID}",
  "products": [
    {
      "productId": "{your-product-ID}",
      "quantity": {item-quantity},
      "gross": {item-gross-price},
      "net": {item-net-price},
      "commissionId": {your-commission-id}
    }
  ]
}

Przykładowa odpowiedź

Serwer zwróci pustą odpowiedź ze statusem 200.

Omówienie:

  • property - wyboldowane parametry są obowiązkowe
  • {bbclid} - identyfikator przejścia do sklepu (kliknięcia) - wartość parametru bbclid
  • bolded parameters are required
  • {your-shop-ID} - unikalny identyfikator sklepu, który otrzymasz od Opiekuna 100Shoppers
  • {visitor-ID} - identyfikator nadawany odwiedzającemu, należy go przechowywać, przez ilość dni podanych w “expiry”. Użytkownik musi być identyfikowalny przy każdorazowym powrocie do sklepu
  • {your-order-ID} - identyfikator zamówienia / transakcji w sklepie.
  • {your-product-ID} - identyfikator produktu zgodny z identyfikatorem oferty przekazywanej nam w pliku XML.
  • {item-quantity} - liczba zamówionych produktów.
  • {item-gross-price} – cena jednostkowa produktu brutto
  • {your-commission-id} – identyfikator prowizji używanej do rozliczeń dla danej pozycji zamówienia. Dla sklepów wyświetlanych na stronie producenta, prowizja nie jest naliczana i wynosi "0". ID prowizji przekaże Opiekun 100Shoppers.

Inne metody integracji:

  • Skrypty sklepowe
  • Prestashop plugin
  • Wtyczka dla platformy Shoper
  • Google Tag Manager