Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetPostBuyFormsDataForBuyers

Ostatnia zmiana: 13.03.2012 r.
Dostępność:
Metoda pozwala kupującym na pobranie wszystkich danych z wypełnionych przez nich formularzy pozakupowych oraz dopłat do nich. Metoda zwraca także szczegółowe informacje dot. płatności (realizowanych przez Allegro Finanse) powiązanych ze wskazanymi transakcjami, transakcje koszykowe (również dla wielu sprzedających), informacje nt. wybranego punktu odbioru oraz dane identyfikacyjne dot. przesyłki zawierającej produkty składające się na wskazane transakcje. W przypadku podania w wejściowej tablicy niepoprawnych identyfikatorów transakcji lub takich do których zalogowany użytkownik nie ma dostępu, są one pomijane podczas prezentowania danych wyjściowych (dane zwracane są tylko dla identyfikatorów transakcji rozpoznanych jako poprawne i należące do użytkownika będącego właścicielem danej sesji). Dodatkowo - wywołanie metody dla transakcji, w której zalogowany użytkownik był stroną sprzedającą, spowoduje zwrócenie pustej struktury. Do takich celów wykorzystywana być powinna metoda doGetPostBuyFormsDataForSellers.

  1. session-id | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. transactions-ids-array | long[] | wymagany
    Tablica identyfikatorów transakcji lub dopłat do nich (maks. 25; informacje nt. powiązania identyfikatora oferty z identyfikatorem transakcji uzyskać można za pomocą metody doGetTransactionsIDs).



Orientacyjna struktura wywołania metody

$dogetpostbuyformsdataforbuyers_request = array(
   'session-id' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'transactions-ids-array' => array(3381748)
);

  1. post-buy-form-data | PostBuyFormForBuyersDataStruct[]
    Tablica struktur zawierających informacje pobrane z wypełnionych formularzy pozakupowych.
    1. post-buy-form-id | long
      Identyfikator transakcji.
    2. post-buy-form-buyer-id | int
      Identyfikator kupującego.
    3. post-buy-form-sellers | PostBuyFormSellersStruct[]
      Tablica struktur zawierająca informacje o przedmiotach kupionych od określonych sprzedających składających się na transakcję.
      1. post-buy-form-seller-id | int
        Identyfikator sprzedającego.
      2. post-buy-form-seller-name | string
        Nazwa sprzedającego.
      3. post-buy-form-items | PostBuyFormItemStruct[]
        Tablica struktur zawierająca informacje o zakupach użytkownika w ofercie.
        1. post-buy-form-it-quantity | int
          Liczba zakupionych towarów.
        2. post-buy-form-it-amount | float
          Łączna cena za wszystkie zakupione w ofercie towary.
        3. post-buy-form-it-id | long
          Identyfikator oferty.
        4. post-buy-form-it-title | string
          Tytuł oferty.
        5. post-buy-form-it-country | int
          Identyfikator kraju.
        6. post-buy-form-it-price | float
          Cena pojedynczego towaru.
        7. post-buy-form-it-deals | PostBuyFormItemDealsStruct[] 
          Tablica struktur zawierająca informacje o pojedynczych zakupach użytkownika w ofercie.
          1. deal-id | long
            Identyfikator aktu zakupowego.
          2. deal-final-price | float
            Końcowa cena zakupu (z uwzględnieniem ewentualnego rabatu).
          3. deal-quantity | int
            Liczba kupionych przedmiotów.
          4. deal-date | datetime
            Data wystąpienia aktu zakupowego.
          5. deal-was-discounted | boolean
            Informacja czy zakup został dokonany z wykorzystaniem kodu rabatowego.
          6. deal-variant | PostBuyFormItemDealsVariantStruct
            Struktura zwracająca informacje o wybranym przez kupującego wariancie. W tej metodzie struktura zawsze będzie zwracana pusta.
            1. variant-name | string
              Nazwa parametru posiadającego warianty.
            2. variant-value | string
              Wartość wariantu parametru.
      4. post-buy-form-shipment-id | int
        Identyfikator sposobu dostawy (listę identyfikatorów sposobów dostawy uzyskać można za pomocą metody doGetShipmentData).
      5. post-buy-form-postage-amount | float
        Koszt wybranego sposobu dostawy.
      6. post-buy-form-msg-to-seller | string
        Treść wiadomości dla sprzedającego.
      7. post-buy-form-amount | float
        Łączna cena za wszystkie towary zakupione u danego sprzedającego (z wliczonym kosztem dostawy).
      8. post-buy-form-surcharges-list | long[]
        Tablica identyfikatorów dopłat do transakcji.
      9. post-buy-form-shipment-tracking | PostBuyFormShipmentTrackingStruct[]
        Tablica struktur zawierająca informacje o przesyłce.
        1. post-buy-form-operator-id | int
          Identyfikator operatora przesyłki (1 - UPS, 2 - GLS, 3 - Ruch, 4 - DHL, 5 - InPost, 6 - Poczta Polska, 7 - Siódemka, 9 - DPD, 10 - FedEX, 11 - TNT Express, 12 - DB Schenker, 13 - Raben, 14 - GEIS, 15 - Pocztex).
        2. post-buy-form-package-id | string
          Identyfikator paczki.
        3. post-buy-form-package-status | string
          Status przesyłki (od operatora).
      10. post-buy-form-gd-address | PostBuyFormAddressStruct
        Struktura zawierająca informacje o wybranym przez użytkownika punkcie odbioru.
        1. post-buy-form-adr-country | int
          Identyfikator kraju.
        2. post-buy-form-adr-street | string
          Adres punktu odbioru.
        3. post-buy-form-adr-postcode | string
          Kod pocztowy punktu odbioru.
        4. post-buy-form-adr-city | string
          Miasto, w którym znajduje się punkt odbioru.
        5. post-buy-form-adr-full-name | string
          Nazwa punktu odbioru.
        6. post-buy-form-adr-company | string
          Pole nieużywane (zawsze będzie puste).
        7. post-buy-form-adr-phone | string
          Telefon komórkowy użytkownika.
        8. post-buy-form-adr-nip | string
          Pole nieużywane
          (zawsze będzie puste).
        9. post-buy-form-created-date | string
          Data utworzenia formularza pozakupowego.
        10. post-buy-form-adr-type | int
          Pole nieużywane (zawsze będzie puste).
      11. post-buy-form-gd-additional-info | string
        Dodatkowe informacje związane z punktem dostawy.
      12. post-buy-form-sent-by-seller | int
        Informacja o tym która strona transakcji wypełniła formularz pozakupowy (0 - kupujący, 1 - sprzedający z poziomu Sendit.pl).
    4. post-buy-form-total-amount | float
      Łączna kwota za wszystkie zakupione w ramach transakcji towary (z wliczonym kosztem dostawy).
    5. post-buy-form-invoice-option | int
      Informacja o tym, czy użytkownik chce otrzymać fakturę za zakupy (1 - chce, 0 - nie chce).
    6. post-buy-form-invoice-data | PostBuyFormAddressStruct
      Struktura zawierająca dane użytkownika, na które ma zostać wystawiona faktura (wypełniana w przypadku, gdy post-buy-form-invoice-option = 1).
      1. post-buy-form-adr-country | int
        Identyfikator kraju.
      2. post-buy-form-adr-street | string
        Adres użytkownika.
      3. post-buy-form-adr-postcode | string
        Kod pocztowy użytkownika.
      4. post-buy-form-adr-city | string
        Miasto użytkownika.
      5. post-buy-form-adr-full-name | string
        Imię i nazwisko użytkownika.
      6. post-buy-form-adr-company | string
        Nazwa firmy użytkownika.
      7. post-buy-form-adr-phone | string
        Telefon użytkownika.
      8. post-buy-form-adr-nip | string
        NIP użytkownika.
      9. post-buy-form-created-date | string
        Data utworzenia formularza pozakupowego.
      10. post-buy-form-adr-type | int
        Typ adresu wskazanego przez użytkownika przy wypełnianiu formularza (analogiczny z typami zwracanymi przez doGetMyAddresses; dla adresów wpisanych ręcznie w polu zwracane jest 0).
    7. post-buy-form-shipment-address | PostBuyFormAddressStruct
      Struktura zawierająca adres do wysyłki użytkownika.
      1. post-buy-form-adr-country | int
        Identyfikator kraju.
      2. post-buy-form-adr-street | string
        Adres użytkownika.
      3. post-buy-form-adr-postcode | string
        Kod pocztowy użytkownika.
      4. post-buy-form-adr-city | string
        Miasto użytkownika.
      5. post-buy-form-adr-full-name | string
        Imię i nazwisko użytkownika.
      6. post-buy-form-adr-company | string
        Nazwa firmy użytkownika.
      7. post-buy-form-adr-phone | string
        Telefon użytkownika.
      8. post-buy-form-adr-nip | string
        Pole nieużywane
        (zawsze będzie puste).
      9. post-buy-form-created-date | string
        Data wypełnienia formularza.
      10. post-buy-form-adr-type | int
        Typ adresu wskazanego przez użytkownika przy wypełnianiu formularza (analogiczny z typami zwracanymi przez doGetMyAddresses; dla adresów wpisanych ręcznie w polu zwracane jest 0).
    8. post-buy-form-pay-type | string
      Typ metody płatności (zgodny z Allegro Finanse - pełną listę typów znajdziesz tutaj). Dodatkowo, w polu zwrócone mogą zostać także dwa inne typy: co (Checkout Allegro Finanse) oraz ai (Raty ) a także trzy typy spoza Allegro Finanse: collect_on_delivery (Płacę przy odbiorze), wire_transfer (Zwykły przelew - poza systemem Allegro Finanse) oraz not_specified (dla post-buy-form-sent-by-seller = 1).
    9. post-buy-form-pay-id | long
      Identyfikator płatności.
    10. post-buy-form-pay-status | string
      Status transakcji Allegro Finanse (listę wszystkich możliwych statusów dla wpłat podejrzeć można tutaj).
    11. post-buy-form-date-init | string
      Data rozpoczęcia transakcji Allegro Finanse.
    12. post-buy-form-date-recv | string
      Data zakończenia transakcji Allegro Finanse.
    13. post-buy-form-date-cancel | string
      Data anulowania transakcji Allegro Finanse.
    14. post-buy-form-payment-amount | float
      Kwota wpłacona przez kupującego za pośrednictwem Allegro Finanse.



Orientacyjna struktura odpowiedzi serwera

$dogetpostbuyformsdataforbuyers_response = array(
   'post-buy-form-data' => array(
      array(
         'post-buy-form-id' => 3381748,
         'post-buy-form-buyer-id' => 43765,
         'post-buy-form-sellers' =>   array(
            array(
               'post-buy-form-seller-id' => 1831859,
               'post-buy-form-seller-name' => 'm010ch',

               'post-buy-form-items' => array(
                  array(
                     'post-buy-form-it-quantity' => 3,
                     'post-buy-form-it-amount' => 30.00,
                     'post-buy-form-it-id' => 975567862,
                     'post-buy-form-it-title' => 'Oferta testowa',
                     'post-buy-form-it-country' => 1,
                     'post-buy-form-it-price' => 10.00,
                     'post-buy-form-it-deals' =>
                        array(
                           'deal-id' => 987121979,
                           'deal-final-price' => 20.00,
                           'deal-quantity' => 1,
                           'deal-date' => '2013-12-18 13:08:16',
                           'deal-was-discounted' => true,
                           'deal-variant' =>
                                 'variant-name' => 'Rozmiar',
                                 'variant-value' => '42'))),
               'post-buy-form-shipment-id' => 10005,
               'post-buy-form-postage-amount' => 20.00,
               'post-buy-form-msg-to-seller' => 'Proszę o szybką wysyłkę',
               'post-buy-form-amount' => 50.00,
               'post-buy-form-surcharges-list' => array( 5681726),
               'post-buy-form-shipment-tracking' => array(
                  array(
                     'post-buy-form-operator-id' => 1,
                     'post-buy-form-package-id' => '1Z7E09X67746525354'
,
                     'post-buy-form-package-status' => 'Wysłane z ładunkiem' )) ,
               'post-buy-form-gd-address' => array(
                  'post-buy-form-adr-country' => 1,
                  'post-buy-form-adr-street' => 'ul. Gen. Maczka 1A/4',
                  'post-buy-form-adr-postcode' => '60-651',
                  'post-buy-form-adr-city' => 'Poznań',
                  'post-buy-form-adr-full-name' => 'DHL SERVICE POINT: Moto-obroty',
                  'post-buy-form-adr-company' => '',
                  'post-buy-form-adr-phone' => '600111222',
                  'post-buy-form-adr-nip'  => '',
                  'post-buy-form-created-date' => '2011-05-01 11:11:06 ' ,
                  'post-buy-form-adr-type' => 0),
                'post-buy-form-gd-additional-info' => 'W soboty punkt czynny do godziny 14.',
               'post-buy-form-sent-by-seller' => 0),
         'post-buy-form-total-amount' => 50.00,
         'post-buy-form-invoice-option' => 0,
         'post-buy-form-invoice-data' => array(
            'post-buy-form-adr-country' => 0,
            'post-buy-form-adr-street' => '',
            'post-buy-form-adr-postcode' => '',
            'post-buy-form-adr-city' => '',
            'post-buy-form-adr-full-name' => '',
            'post-buy-form-adr-company' => '',
            'post-buy-form-adr-phone' => '',
            'post-buy-form-adr-nip' => '',
            'post-buy-form-created-date' => '',
            'post-buy-form-adr-type' => 0),

         'post-buy-form-shipment-address' => array(
            'post-buy-form-adr-country' => 1,
            'post-buy-form-adr-street' => 'ul. Wspólna 80',
            'post-buy-form-adr-postcode' => '60-328',
            'post-buy-form-adr-city'  => 'Poznań',
            'post-buy-form-adr-full-name'  => 'Jan Kowalski',
            'post-buy-form-adr-company' => '',
            'post-buy-form-adr-phone' => '987-654-321',
            'post-buy-form-adr-nip'  => '',
            'post-buy-form-created-date' => ' 2011-05-01 11:11:06 ',
            'post-buy-form-adr-type' => 1),

         'post-buy-form-pay-type' => 'ab',
         'post-buy-form-pay-id' => 87893421,
         'post-buy-form-pay-status' => 'Zakończona',
         'post-buy-form-date-init' => '2010-10-21 11:11:06 ',
         'post-buy-form-date-recv' => '2010-10-21 11:12:42 ',
         'post-buy-form-date-cancel' =>
'',

         'post-buy-form-payment-amount' => 50.00))
);

  • ERR_INPUT_ARRAY_EMPTY
    Tablica identyfikatorów transakcji jest pusta.
  • ERR_INPUT_ARRAY_OVERSIZED
    Liczba podanych identyfikatorów transakcji przekracza dopuszczalny limit (maks. 25).
  • ERR_NEW_PAYMENT_INTERNAL_ERROR
    Wewnętrzny błąd systemu związany z pobieraniem transakcji Allegro Finanse.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_SURCHARGES_ONLY
    Przekazano wyłącznie identyfikatory transakcji będących dopłatami.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI na którym została wygenerowana sesja został zdezaktywowany (jego właściciel nie zaakceptował warunków Regulaminu 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.