Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetRefundsList

Ostatnia zmiana: ---
Dostępność:
Metoda pozwala na pobranie listy złożonych wniosków o zwrot prowizji. Logika działania metody została oparta na systemie dynamicznych filtrów, zwracanych kontekstowo i pozwalających precyzyjnie sterować zakresem zwracanych danych. Tutorial opisujący zasadę działania dynamicznych filtrów znajduje się pod adresem: http://allegro.pl/webapi/tutorials.php/tutorial/id,281.

  1. sessionId | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. filterOptions | FilterOptionsType[] | niewymagany
    Kryteria filtrowania wyników (lista możliwych do ustawienia w danym kontekście filtrów, zwracana jest na wyjściu metody w ramach struktury filtersList).
    1. filterId | string | niewymagany
      Identyfikator filtra.
    2. filterValueId | string[] | niewymagany
      Identyfikator(y) wartości filtra (dla filtrów pojedynczych lub wielokrotnych).
    3. filterValueRange | RangeValueType | niewymagany
      Zakres wartości filtra (dla filtrów zakresowych).
      1. rangeValueMin | string | niewymagany
        Minimalna wartość filtra.
      2. rangeValueMax | string | niewymagany
        Maksymalna wartość filtra.
  3. resultSize | int | niewymagany
    Rozmiar porcji danych (min. 1, maks. 1000). Domyślna wartość: 100.
  4. resultOffset | int | niewymagany
    Sterowanie pobieraniem kolejnych porcji danych. Domyślna wartość: 0.



Orientacyjna struktura wywołania metody

$dogetrefundslist_request = array(
   'sessionId' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'filterOptions' => array(
     array(
      'filterId' => 'itemId',
      'filterValueId' => array('3199800297'))),
);


  1. refundsCount | int
    Liczba wszystkich wniosków o zwrot prowizji (pasujących do danego zapytania).
  2. refundsList | RefundListType[]
    Tablica struktur zawierajaca informacje o wnioskach o zwrot prowizji. Lista zwracana jest od najnowszego wniosku.
    1. dealId | long
      Identyfikator aktu zakupowego.
    2. dealDate | dateTime
      Data wystąpienia aktu zakupowego.
    3. buyerId | int
      Identyfikator kupującego.
    4. buyerLogin | string
      Nazwa kupującego.
    5. itemId | long
      Identyfikator oferty.
    6. itemTitle | string
      Tytuł oferty.
    7. bidsCount | int
      Liczba kupionych przedmiotów.
    8. quantityType | string
      Typ dostępnych w ofercie przedmiotów: pieces - sztuki, sets - komplety, pairs - pary.
    9. paymentStatus | string
      Status płatności za zakup (complete - zapłacone, missing - brak wpłaty, cod - płatność przy odbiorze, without_payu - brak informacji o wpłacie).
    10. refundDetails | RefundDetailsType
      Struktura zawierająca informacje o wnioskach o zwrot prowizji.
      1. refundId | int
        Identyfikator wniosku o zwrot prowizji.
      2. refundStatus | string
        Status wniosku o zwrot prowizji (5 - wniosek o zwrot prowizji utworzony, 15 - zwrot prowizji przyznany, 20 - zwrot prowizji naliczony, 30 - wniosek o zwrot prowizji wycofany, 50 i 60 - zwrot prowizji nieprzyznany).
      3. refundQuantity | int
        Ilość sztuk przedmiotu dla których został wypełniony wniosek o zwrot prowizji.
      4. createdDate | string
        Data stworzenia wniosku
      5. considerDate | string
        Data rozpatrzenia wniosku. Jeśli wniosek nie jest jeszcze rozpatrzony, zostanie zwrócone puste pole.
  3. filtersList | FilterListType[]
    Informacje o filtrach możliwych do ustawienia w danym kontekście.
    1. filterId | string
      Identyfikator filtra.
    2. filterName | string
      Nazwa filtra.
    3. filterType | string
      Typ filtra: country - filtr globalny dla danego serwisu/kraju, category - filtr istniejący tylko w ramach przekazanej kategorii (parametr).
    4. filterControlType | string
      Typ kontrolki potrzebnej do wyświetlenia filtra: combobox (do wyboru pojedyncza wartość z listy), checkbox (do wyboru wiele wartości z listy), textbox (wartość do samodzielnego uzupełnienia).
    5. filterDataType | string
      Typ danych jakie przyjmuje filtr: string, int, long, float, datetime.
    6. filterIsRange | boolean
      Informacja o tym czy parametr jest typu zakresowego: true/false.
    7. filterArraySize | int
      Maksymalna liczba wartości jaką można przekazać dla danego filtra (zwracana tylko dla filtrów wielokrotnych).
    8. filterValues | FilterValueType[]
      Informacje o wartościach filtrów.
      1. filterValueId | string
        Identyfikator wartości filtra.
      2. filterValueName | string
        Nazwa wartości filtra (do wyświetlenia w aplikacji).
      3. filterValueCount | int
        Liczba ofert pasujących do danego filtra (zwracana tylko gdy jest możliwa do wyliczenia w danym kontekście).
    9. filterRelations | FilterRelationType
      Informacje o relacjach między filtrami.
      1. relationAnd | string[]
        Lista wszystkich identyfikatorów filtrów, z którymi dany filtr musi zostać użyty.
      2. relationOr | string[]
        Lista identyfikatorów filtrów, spośród których co najmniej jeden musi być użyty z danym filtrem.
      3. relationExclude | string[]
        Lista identyfikatorów filtrów, z którymi dany filtr nie może zostać użyty.



Orientacyjna struktura odpowiedzi serwera

$dogetrefundslist_response = array(
   'refundsCount' => 1,
   'refundsList' => array(
      array(
        'dealId' => 987121979,
        'dealDate' => 2013-12-18 13:08:16,
        'buyerId' => 5921761,
        'buyerLogin' => 'testowekonto',
        'itemId' => 3136513627,
        'itemTitle' => 'Wiedźmin - Sezon Burz',
        'bidsCount' => 1,
        'quantityType' => 'pieces',
        'paymentStatus' => 'complete',
        'refundDetails' => array(
             'refundId' => 736284,
             'refundStatus' => '15',
             'refundQuantity' => 1,
             'createdDate' => '2013-12-29 11:12:46'
             'considerDate' =>'2014-01-02 15:36:27'))),
   'filtersList' => array(
      array(
        'filterId' => 'itemId',
        'filterName' => 'Identyfikator oferty',
        'filterType' => 'country',
        'filterControlType' => 'textbox',
        'filterDataType' => 'long',
        'filterIsRange' => false,
        'filterRelations' => array(
             'relationExclude' => array('userLogin'))),
      array(
        'filterId' => 'userLogin',
        'filterName' => 'Nazwa użytkownika',
        'filterType' => 'country',
        'filterControlType' => 'textbox',
        'filterDataType' => 'string',
        'filterIsRange' => false,
        'filterRelations' => array(
             'relationExclude' => array('itemId'))))
);


  • ERR_FILTER_DEPENDENCY_MISMATCH
    Filtr nie może zostać użyty jednocześnie z przynajmniej jednym z podanych filtrów: lista filtrów.
  • ERR_INCORRECT_FILTER_VALUE
    Niepoprawna wartość identyfikatora wartości filtra (dla filtra pojedynczego, wielokrotnego lub zakresowego).
  • ERR_INCORRECT_RESULT_OFFSET
    Niepoprawna wartość offsetu (mniejsza od 0).
  • ERR_INCORRECT_RESULT_SIZE
    Niepoprawna wartość rozmiaru porcji danych (spoza zakresu 1-1000).
  • ERR_METHOD_UNAVAILABLE_IN_FOREIGN_COUNTRY
    Metoda dostępna tylko w kraju użytkownika.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.

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.