Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetPaymentData

Ostatnia zmiana: ---
Dostępność:
Metoda pozwala na pobranie informacji o opłatach związanych z korzystaniem z serwisu odpowiedniego dla wskazanego kraju.

  1. country-id | int | wymagany
    Identyfikator kraju (listę identyfikatorów krajów uzyskać można za pomocą metody doGetCountries).
  2. webapi-key | string | wymagany
    Klucz WebAPI użytkownika.



Orientacyjna struktura wywołania metody

$dogetpaymentdata_request = array(
   'country-id' => 1,
   'webapi-key' => 'g2fe408289'
);

  1. payment-list | BillingDataType[]
    Tablica struktur zawierających informacje o poszczególnych opłatach.
    1. billing-id | int
      Identyfikator opłaty.
    2. billing-type | string
      3-znakowy identyfikator typu opłaty.
    3. billing-fixperc | string
      Metoda obliczania opłaty za aukcję (F – opłata stała, kwota pobierana jest z billing-rate, P – opłata naliczana proporcjonalnie do ceny przedmiotu, procentowa wartość pobierana jest także z biling-rate)
    4. billing-name | string
      Opis opłaty.
    5. billing-range-from | string
      Minimalna cena przedmiotu, od której stosowana jest opłata (0 wskazuje na brak dolnego limitu).
    6. billing-range-to | string
      Maksymalna cena przedmiotu, do której stosowana jest opłata (0 wskazuje na brak górnego limitu).
    7. billing-cat | string
      Identyfikator kategorii, dla której naliczana jest opłata - obejmuje też podkategorie wskazanej kategorii (0 wskazuje na to, że opłata ma zastosowanie we wszystkich kategoriach).
    8. billing-rate | string
      Kwota opłaty stałej (dla billing-fixperc = F) lub ustalony procent ceny przedmiotu (dla billing-fixperc = P).
    9. billing-auction-type | int
      Typy ofert, dla których naliczana jest opłata (1 - dla sprzedaży w Sklepach Allegro, 0 - dla sprzedaży na  Allegro).



Orientacyjna struktura odpowiedzi serwera

$dogetpaymentdata_response = array(
   'payment-list' => array(
      array(...),
      array(
         'billing-id' => 333,
         'billing-type' => 'AP2',
         'billing-fixperc' => 'F',
         'billing-name' => 'Abonament za Allegro WebAPI - pakiet profesjonalny',
         'billing-range-from' => '0',
         'billing-range-to' => '0',
         'billing-cat' => '0',
         'billing-rate' => '600',
         'billing-auction-type' => 0),
      array(...),
      array(
         'billling-id' => 1,
         'billing-type' => 'SUC',
         'billing-fixperc' => 'P',
         'billing-name' => 'Prowizja od sprzedaży',
         'billing-range-from' => '0',
         'billing-range-to' => '50',
         'billing-cat' => '0',
         'billing-rate' => '.04',
         'billing-auction-type' => 0),
      array(...))
);

  • ERR_INPUT_COUNTRY_ERROR
    Niepoprawny identyfikator kraju (wskazany kraj nie jest obsługiwany lub w parametrze przekazano zerową/pustą wartość).
  • ERR_NO_DATABASE
    Problemy z bazą danych Allegro.
  • ERR_WEBAPI_EXPIRED
    Data ważności klucza WebAPI została przekroczona.
  • ERR_WEBAPI_KEY
    Niepoprawna wartość klucza WebAPI lub klucz został zablokowany.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI został zdezaktywowany (nie zaakceptowano warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.

Allegro nie bierze odpowiedzialności za skutki wykorzystania zamieszczonych przykładów kodu, nie daje także gwarancji ich poprawnego działania. Widoczny kod ma charakter wyłącznie poglądowy i może zawierać błędy.