Stwórz

POST/token

Stwórz nowy token wykorzystując parametry username oraz password.

• Przyjmowane parametry
  • email (string, wymagany) - Adres e-mail.
  • password (string, wymagany) - Hasło.

URI

Content-Type: application/json

{
  "email": "[email protected]",
  "password": "bar"
}

Content-Type: application/json

{
  "token": "foo"
}

Content-Type: application/json

{
  "message": "Podane dane dostępowe są nieprawidłowe.",
  "error_code": "AuthenticationFailed",
  "status_code": 401
}

Content-Type: application/json

{
    "errors": {
        "email": [
            "Opis błędu",
        ],
        "password": [
            "Opis błędu.",
        ]
    },
    "error_code": "InvalidInput",
    "status_code": 400
}

Stwórz

POST/user

Stwórz nowego użytkownika.

• Przyjmowane parametry
  • name (string, wymagany, max: 60) - Imię.
  • surname (string, wymagany, max: 60) - Nazwisko.
  • email (string, wymagany, email, max: 255) - Adres e-mail.
  • password (string, wymagany, min: 8, max: 255) - Hasło.
  • street (string, wymagany, max: 100) - Ulica.
  • house_number (string, wymagany, max: 10) - Numer domu.
  • door_number (string, max: 10) - Numer mieszkania.
  • post_code (string, wymagany, max: 10) - Kod pocztowy.
  • city (string, wymagany, max: 50) - Miasto
  • country_id (integer, wymagany, występuje w zasobie GET /order/resources/countries) - ID kraju.
  • phone (string, wymagany) - Telefon.
  • company (string, max: 200) - Nazwa firmy.
  • tax_number (string, max: 16) - Numer NIP.
  • bank_account_number (digits, iban format, min: 26, max: 26) - Numer konta bankowego.
  • regulations_approval (bool, wymagany, accepted) - Akceptacja regulaminu. Regulamin znajduję się na stronie: https://wysylajnami.pl/regulamin
  • marketing_approval (bool, wymagany, accepted) - Zgoda na umieszczenie danych teleadresowych w bazie serwisu i wykorzystanie ich zgodnie z ustawą z dnia 29.09.1997 o ochronie danych osobowych - Dz. U. nr 133 poz. 883.
  • marketing_approval_2 (bool) - Zgoda na otrzymywanie na podany adres e-mail informacji handlowej.

URI

Content-Type: application/json

{
  "name": "Jan",
  "surname": "Kurier",
  "email": "[email protected]",
  "password": "password",
  "street": "Testowa",
  "house_number": "12",
  "door_number": "1",
  "post_code": "82-300",
  "city": "Elbląg",
  "country_id": 1,
  "phone": "500111222",
  "company": "ABC Sp. z o.o.",
  "tax_number": "123-333-333-33",
  "bank_account_number": "85389228519243536419972688",
  "regulations_approval": true,
  "marketing_approval": true
}

Content-Type: application/json

{
  "user_id": 34344
}

Content-Type: application/json

{
    "errors": {
        "email": [
            "Opis błędu",
        ],
        "password": [
            "Opis błędu.",
        ]
    },
    "error_code": "InvalidInput",
    "status_code": 400
}

Wyślij

POST/user/activate

Stwórz i prześlij link aktywacyjny.

URI

Content-Type: application/json

Content-Type: application/json

Content-Type: application/json

Zapomniane

POST/user/password/forgotten

Wyślij e-mail z linkiem do resetu hasła. Token jest ważny 60 minut.

• Przyjmowane parametry
  • email (string, wymagany) - Adres e-mail.

URI

Content-Type: application/json

{
  "email": "[email protected]"
}

Content-Type: application/json

Content-Type: application/json

{
  "errors": {
    "nazwa_pola": [
      "Opis błędu."
    ]
  },
  "error_code": "InvalidInput",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Nie znaleziono.",
  "error_code": "NotFound",
  "status_code": 404
}

Zresetuj

POST/user/password/reset

Zresetuj hasło.

• Przyjmowane parametry
  • password (string, wymagany, min: 8, max: 255) - Hasło.
  • password_confirmation (string, wymagany, min: 8, max: 255, identyczne z password) - Powtórzone hasło.
  • token (string, wymagany) - Token otrzymany z [POST /user/password/forgotten]

URI

Content-Type: application/json

{
    "password": "haslo",
    "password_confirmation": "haslo",
    "token": "abc1234",
}

Content-Type: application/json

Content-Type: application/json

{
  "errors": {
    "nazwa_pola": [
      "Opis błędu."
    ]
  },
  "error_code": "InvalidInput",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Nie znaleziono.",
  "error_code": "NotFound",
  "status_code": 404
}

Zmień

POST/user/password/change

Zmień hasło.

• Przyjmowane parametry
  • password (string, wymagany) - Aktualne hasło.
  • new_password (string, wymagany, min: 8, max: 255) - Nowe hasło.
  • new_password_confirmation (string, wymagany, min: 8, max: 255, identyczne z new_password) - Powtórzone nowe hasło.

URI

Content-Type: application/json

{
  "password": "mojeTrudneHaslo!@#",
  "new_password": "mojeTrudniejszeHaslo!#$%@",
  "new_password_confirmation": "mojeTrudniejszeHaslo!#$%@"
}

Content-Type: application/json

Content-Type: application/json

{
    "errors": {
        "nazwa_pola": [
            "Opis błędu."
        ]
    },
    "error_code": "InvalidInput",
    "status_code": 400
}

{
  "message": "Podany dane dostępowe są nieprawidłowe.",
  "error_code": "AuthenticationFailed",
  "status_code": 400
}

Szukaj

POST/user/cods/search

Wyszukaj pobrania użytkownika.

• Przyjmowane parametry
  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • order_id (integer, opcjonalny) - Numer zamówienia.
    • waybill_number (string, opcjonalny) - Numer listu przewozowego.
    • courier_id (integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.
      • 1 - Geis (K-ex)
      • 2 - GLS
      • 3 - DPD
      • 4 - InPost
      • 5 - DHL
      • 7 - Geis (ETL)
      • 8 - InPost Zagranica
      • 9 - InPost Paczkomaty
      • 11 - Patron Service
      • 12 - Fedex
      • 13 - GEODIS
      • 14 - UPS
      • 16 - Poczta Polska palety
      • 17 - Pocztex
      • 18 - Rohlig SUUS
      • 19 - ORLEN Paczka
      • 20 - Ambro Express
      • 22 - Rhenus Logistics
      • 23 - InPost Szybkie Zwroty
      • 24 - InPost Paczkomat → Kurier
      • 25 - InPost Paczkomaty Ekonomiczne
    • cod_status (integer, opcjonalny, akceptowane wartości: 21,23,24,25,26,27) - Status pobrania. Statusy opisane są poniżej:
      • 21 - Oczekuje
      • 23 - Przelano
      • 24 - Anulowano
      • 25 - Realizacja Geis (K-ex)
      • 26 - Realizacja Tba
      • 27 - Realizacja Geis (ETL)
    • pickup_date_since (date, opcjonalny) - Data odbioru od.
    • pickup_date_till (date, opcjonalny) - Data odbioru do.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "order_id": 123,
    "waybill_number": 123,
    "courier_id": 1,
    "cod_status": 23,
    "created_since": "2016-01-01",
    "created_till": "2017-01-30",
    "user_data": "Janusz Kowalski"
  }
}

Content-Type: application/json

{
  "total": 2,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "cods": [
    {
      "order_id": 777,
      "courier_id": 4,
      "waybill_number": "ABC123,
      "pickup_date": "2016-10-19",
      "type": 1,
      "value": 50,
      "bank_account_number": "12345678901234567890123456",
      "status": 23,
      "description": "Zwrot pobrania za zamówienie 777",
      "transferred_at": "2016-10-20 16:09:10",
      "package_receiver": {
        "name": "Janusz",
        "surname": "Kowalski ",
        "company": null
      }
    },
    {
      "order_id": 778,
      "courier_id": 4,
      "waybill_number": "ABC333",
      "pickup_date": "2016-10-20",
      "type": 1,
      "value": 30,
      "bank_account_number": "12345678901234567890123456",
      "status": 23,
      "description": "Zwrot pobrania za zamówienie 778",
      "transferred_at": "2016-10-21 09:19:12",
      "package_receiver": {
        "name": "Janusz",
        "surname": "Kowalski",
        "company": null
      }
    }
  ],
  "sum": 80 
}

Szukaj

POST/user/payments/search

Wyszukaj płatności użytkownika.

• Przyjmowane parametry

  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • order_id (integer, opcjonalny) - Numer zamówienia.
    • waybill_number (string, opcjonalny) - Numer listu przewozowego.
    • transaction_number (string, opcjonalny) - Numer transakcji.
    • invoice_number (string, opcjonalny) - Numer faktury VAT.
    • created_since (date, opcjonalny) - Data transakcji od.
    • created_till (date, opcjonalny) - Data transakcji do.

• Zwracane parametry

  • total (integer, zawsze zwracany) - Całkowita liczba wyników.
  • current_page (integer, zawsze zwracany) - Aktualna strona z wynikami.
  • last_page (integer, zawsze zwracany) - Ostatnia strona z wynikami.
  • per_page (integer, zawsze zwracany) - Liczba wyników na stronę.
  • payments (array[payment]) - Tablica z wynikami.

• Zwracany obiekt payment

  • type (integer, zawsze zwracany, zwracane wartości: 21, 22, 24, 25) - Typ płatności.
    • 21 - Doładowanie salda
    • 22 - Płatność za zamówienie
    • 24 - Odjęcie z salda
    • 25 - Zwrot za zamówienie
  • method (string, zawsze zwracany, zwracane wartości: przelewy24, balance, transfer) - Metoda płatności.
    • przelewy24 - Przelewy24
    • balance - Saldo
    • transfer - Przelew
  • number (string, zawsze zwracany) - Unikalny numer transakcji.
  • created_at (date, zawsze zwracany) - Data wykonania transakcji.
  • description (string, zawsze zwracany) - Opis transakcji.
  • amount (numeric, zawsze zwracany) - Kwota transakcji.
  • balance (numeric, zawsze zwracany) - Saldo użytkownika po transkacji.
  • invoice_number (string, opcjonalny) - Numer faktury VAT przypisanej do transakcji.
  • invoice_id (integer, opcjonalny) - Numer ID faktury VAT przypisanej do transakcji.
  • order_id (integer, opcjonalny) - Numer zamówienia, zwracany jeśli type wynosi 22.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "order_id": 123
  }
}

Content-Type: application/json

{
  "total": 1,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "payments": [
    {
      "type": 22,
      "number": "OTH-777-701",
      "created_at": "2017-02-04 19:07:38",
      "description": "Zamówienie nr: 777",
      "amount": 22.99,
      "balance": 14,
      "invoice_number": "3333/Test/2017",
      "order_id" : "777
    }
  ]
}

Opłać saldem

POST/user/payments

Opłać zamówienia użytkownika, wykorzystując środki na saldzie.

• Przyjmowane parametry

  • order_ids (array[integer], wymagany, min: 1) - Tablica zamówień.

• Zwracane parametry

  • total (numeric, zawsze zwracany) - Całkowita kwota opłaconych zamówień.
  • paid (array[integer], zawsze zwracany) - Tablica z opłaconymi zamówieniami.
  • not_waiting (array[integer], opcjonalny) - Tablica z zamówieniami, które zostały wysłane do opłacenia, a nie oczekują na płatność.

URI

Content-Type: application/json

{
  "order_ids": [
    123,
    234
  ]
}

Content-Type: application/json

{
  "paid": [
    123
  ],
  "not_waiting": [
    234
  ],
  "total": "40,90"
}

Content-Type: application/json

{
  "errors": {
    "nazwa_pola": [
      "Opis błędu."
    ]
  },
  "error_code": "InvalidInput",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Płatność wymagana lub brak wystarczających środków.",
  "error_code": "PaymentRequired",
  "status_code": 402
}

Content-Type: application/json

{
  "message": "Nie znaleziono.",
  "error_code": "NotFound",
  "status_code": 404
}

Stwórz doładowanie

POST/user/payments/balance

Stwórz doładowanie salda. Metoda tworzy obiekt balance, który później można wykorzystać do np. wygenerowania linku PayU.

• Przyjmowane parametry

  • amount (number, wymagany, min: 1, max: 10000) - Kwota doładowania.

• Zwracane parametry

  • balance_id (integer, zawsze zwracany) - Numer ID doładowania.

URI

Content-Type: application/json

{
  "amount": "100"
}

Content-Type: application/json

{
  "balance_id": 86808
}

Content-Type: application/json

{
  "errors": {
    "nazwa_pola": [
      "Opis błędu."
    ]
  },
  "error_code": "InvalidInput",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Brak dostępu.",
  "error_code": "AccessDenied",
  "status_code": 401
}

Szukaj

POST/user/invoices/search

Wyszukaj faktury użytkownika.

• Przyjmowane parametry

  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • order_id (integer, opcjonalny) - Numer zamówienia.
    • invoice_number (string, opcjonalny) - Numer faktury VAT.
    • issued_since (date, opcjonalny) - Data wystawienia faktury VAT od.
    • issued_till (date, opcjonalny) - Data wystawienia faktury VAT do.

• Zwracane parametry

  • total (integer, zawsze zwracany) - Całkowita liczba wyników.
  • current_page (integer, zawsze zwracany) - Aktualna strona z wynikami.
  • last_page (integer, zawsze zwracany) - Ostatnia strona z wynikami.
  • per_page (integer, zawsze zwracany) - Liczba wyników na stronę.
  • invoices (array[invoice]) - Tablica z wynikami.

• Zwracany obiekt invoice

  • id (integer, zawsze zwracany) - Numer ID faktury VAT.
  • number (string, zawsze zwracany) - Numer faktury VAT.
  • date_of_issue (date, zawsze zwracany) - Data wystawienia faktury VAT.
  • sale_date (date, zawsze zwracany) - Data sprzedaży.
  • payment_method (integer, zawsze zwracany, zwracane wartości: 1, 2, 3) - Metoda płatności widoczna na fakturze VAT.
  • sum (numeric, zawsze zwracany) - Całkowita kwota brutto na fakturze VAT.
    • 1 - Przelew
    • 2 - Przelewy24
    • 3 - Płatność elektroniczna
  • issuer (object issuer, zawsze zwracany) - Wystawca faktury VAT - sprzedawca.
  • billed_to (object issuer, zawsze zwracany) - Nabywca.
  • positions (array[position], zawsze zwracany) - Zbiór pozycji na fakturze VAT.

• Zwracany obiekt issuer

  • name (string, zawsze zwracany) - Nazwa wystawcy.

• Zwracany obiekt billed_to

  • name (string, zawsze zwracany) - Nazwa nabywcy.
  • tax_number (string, opcjonalny) - Numer NIP nabywcy.
  • street_with_number (string, zawsze zwracany) - Ulica wraz z numerem nabywcy.
  • city (string, zawsze zwracany) - Miasto nabywcy.
  • post_code (string, zawsze zwracany) - Kod pocztowym nabywcy.
  • country (string, zawsze zwracany) - Kraj nabywcy.

• Zwracany obiekt position

  • amount_gross (numeric, zawsze zwracany) - Kwota brutto.
  • quantity (integer, opcjonalny) - Ilość.
  • unit (string, zawsze zwracany) - Jednostka miary.
  • tax_percent (numeric, zawsze zwracany) - Stawka VAT.
  • description (string, zawsze zwracany) - Opis.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "order_id": 777
  }
}

Content-Type: application/json

{
  "total": 1,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "invoices": [
    {
      "id": 123,
      "number": "1111/20/2017",
      "date_of_issue": "2017-02-28",
      "sale_date": "2017-02-28",
      "payment_method": 2,
      "sum": 26.4
      "issuer": {
        "name": "Spółka z ograniczoną odpowiedzialnością"
      },
      "bill_to": {
        "name": "Jan Kowalski",
        "tax_number": "123-444-223-22",
        "street_with_number": "Testowa 11/1",
        "city": "Testowo",
        "post_code": "00-001",
        "country": "Polska"
      },
      "positions": [
        {
          "amount_gross": 10,
          "quantity": 1,
          "unit": "szt.",
          "tax_percent": 23,
          "description": "Usługi kurierskie zgodnie z zamówieniem nr: 777"
        },
        {
          "amount_gross": 16.4,
          "quantity": 1,
          "unit": "szt.",
          "tax_percent": 23,
          "description": "Usługi kurierskie zgodnie z zamówieniem nr: 778"
        }
      ]
    }
  ]
}

Szukaj

POST/user/address-book/search

Wyszukaj adresy użytkownika.

• Przyjmowane parametry

  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • name (string, opcjonalny) - Imię.
    • surname (string, opcjonalny) - Nazwisko.
    • email (string, opcjonalny) - Adres e-mail.
    • company (string, opcjonalny) - Nazwa firmy.
    • street (string, opcjonalny) - Ulica.
    • house_number (string, opcjonalny) - Numer domu.
    • door_number (string, opcjonalny) - Numer mieszkania.
    • post_code (string, opcjonalny) - Kod pocztowy.
    • city (string, opcjonalny) - Miasto.
    • country_id (integer, opcjonalny, zgodny z GET /order/resources/countries) - Kod kraju.
    • phone (string, opcjonalny) - Telefon.
    • pop_code (string, opcjonalny) - Kod paczkomatu.
    • pp_code (string, opcjonalny) - Kod placówki Poczty Polskiej.
    • ruch_code (string, opcjonalny) - Kod Punktu RUCHu.

• Zwracane parametry

  • total (integer, zawsze zwracany) - Całkowita liczba wyników.
  • current_page (integer, zawsze zwracany) - Aktualna strona z wynikami.
  • last_page (integer, zawsze zwracany) - Ostatnia strona z wynikami.
  • per_page (integer, zawsze zwracany) - Liczba wyników na stronę.
  • addresses (array[address], zawsze zwracany) - Tablica z wynikami.

• Zwracany obiekt address

  • id (integer, zawsze zwracany) - Numer ID.
  • is_default (bool, zawsze zwracany) - Adres domyślny.
  • name (string, opcjonalny) - Imię.
  • surname (string, opcjonalny) - Nazwisko.
  • company (string, opcjonalny) - Nazwa firmy.
  • email (string, opcjonalny) - Adres e-mail.
  • street (string, opcjonalny) - Ulica.
  • house_number (string, opcjonalny) - Numer domu.
  • door_number (string, opcjonalny) - Numer mieszkania.
  • post_code (string, opcjonalny) - Kod pocztowy.
  • city (string, opcjonalny) - Miasto.
  • country_id (integer, opcjonalny, zgodny z GET /order/resources/countries) - Kod kraju.
  • phone (string, opcjonalny) - Telefon.
  • pop (object pop, opcjonalny) - Paczkomat.

• Zwracany obiekt pop

  • code (string, zawsze zwracany) - Kod.
  • country_code (string, zawsze zwracany) - Kod kraju.
  • city (string, zawsze zwracany) - Miasto.
  • street (string, zawsze zwracany) - Ulica.
  • house_number (string, opcjonalny) - Numer domu.
  • province (string, zawsze zwracany) - Województwo.
  • post_code (string, zawsze zwracany) - Kod pocztowy.
  • description (string, opcjonalny) - Dodatkowy opis.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "name": "Kowalski"
  }
}

Content-Type: application/json

{
  "total": 12,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "addresses": [
    {
      "id": 111,
      "is_default": false,
      "name": "Jan",
      "surname": "Kowalski",
      "company": null,
      "email": "[email protected]",
      "street": "Kowalska",
      "house_number": "1",
      "door_number": "6",
      "post_code": "82-300",
      "city": "Elbląg",
      "country_id": 1,
      "phone": "+48123456789"
    },
    {
      "id": 1113,
      "is_default": false,
      "name": "Jerzy",
      "surname": "Kowalski",
      "company": null,
      "email": "[email protected]",
      "street": "Kowalska",
      "house_number": "1",
      "door_number": null,
      "post_code": "00-001",
      "city": "Warszawa",
      "country_id": 1,
      "phone": "+481111111111"
    },
    {
      "id": 1114,
      "is_default": true,
      "name": "Anna",
      "surname": "Kowalski",
      "company": null,
      "email": "[email protected]",
      "street": "Testowa",
      "house_number": "1",
      "door_number": "6",
      "post_code": "01-112",
      "city": "Warszawa",
      "country_id": 1,
      "phone": "123456789",
      "pop": {
        "code": "ELB01A",
        "street": "płk. Stanisława Dąbka",
        "house_number": "74",
        "city": "Elbląg",
        "post_code": "82-300"
      }
    }
  ]
}

Dodaj

POST/user/address-book

Dodaj adres użytkownika.

• Przyjmowane parametry
  • name (string, wymagany jeśli company jest puste) - Imię.
  • surname (string, wymagany jeśli company jest puste) - Nazwisko.
  • email (string, opcjonalny) - Adres e-mail.
  • company (string, opcjonalny) - Nazwa firmy.
  • street (string, opcjonalny) - Ulica.
  • house_number (string, opcjonalny) - Numer domu.
  • door_number (string, opcjonalny) - Numer mieszkania.
  • post_code (string, opcjonalny) - Kod pocztowy.
  • city (string, opcjonalny) - Miasto.
  • country_id (integer, opcjonalny, zgodny z GET /order/resources/countries) - Kod kraju. Domyślnie 1.
  • phone (string, opcjonalny) - Telefon.
  • pop_code (string, opcjonalny) - Kod paczkomatu.
  • pp_code (string, opcjonalny) - Kod placówki Poczty Polskiej.
  • ruch_code (string, opcjonalny) - Kod Punktu RUCHu.
  • default (bool, opcjonalny) - Ustawia adres jako domyślny.

URI

Content-Type: application/json

{
        "name" : "Jan",
        "surname": "Kowalski",
        "email"    : "[email protected]",
        "company": "Kowalski S.A.",
        "street": "Kowalska",
        "house_number": "1",
        "door_number": "1a",
        "post_code": "82-300",
        "city": "Elbląg",
        "country_id": 1,
        "phone": "+48123456789",
        "pop_code": "BEL01A",
        "pp_code": "123456",
        "ruch_code": "WS-492393-25-18",
    }

Content-Type: application/json

Importuj

POST/import/addresses

Importuj adresy użytkownika z pliku CSV. Przed importem należy przesłać plik CSV na serwer (patrz: zasób File).

• Przyjmowane parametry
  • token (string, wymagany) - Token.
  • file_id (string, wymagany) - Identyfikator przesłanego pliku CSV.

URI

Content-Type: application/json

{
  "file_id": "8e8215a8161c01f4e297c1c41e195528bt5ozTxWOsGTq2Se4wQCCcrznu1225GJ"
}

Content-Type: application/json

Szukaj

POST/user/partner/orders/search

Wyszukaj zamówienia użytkowników przypisanych do partnera.

• Przyjmowane parametry

  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • order_id (integer, opcjonalny) - Numer ID zamówienia.
    • user_id (integer, opcjonalny) - Numer ID użytkownika.
    • product_id (integer, opcjonalny, akceptowane wartości: 1, 2, 3) - Typ przesyłki.
      • 1 - Koperta.
      • 2 - Paczka.
      • 3 - Paleta.
    • courier_id (integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.
      • 1 - Geis (K-ex)
      • 2 - GLS
      • 3 - DPD
      • 4 - InPost
      • 5 - DHL
      • 7 - Geis (ETL)
      • 8 - InPost Zagranica
      • 9 - InPost Paczkomaty
      • 11 - Patron Service
      • 12 - Fedex
      • 13 - GEODIS
      • 14 - UPS
      • 16 - Poczta Polska palety
      • 17 - Pocztex
      • 18 - Rohlig SUUS
      • 19 - ORLEN Paczka
      • 20 - Ambro Express
      • 22 - Rhenus Logistics
      • 23 - InPost Szybkie Zwroty
      • 24 - InPost Paczkomat → Kurier
      • 25 - InPost Paczkomaty Ekonomiczne
    • order_status (integer, opcjonalny) - Status zamówienia.
      • 11 - Oczekuje
      • 12 - Zapłacone
      • 13 - Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)
      • 14 - Anulowane
    • created_since (date, opcjonalny) - Data stworzenia zamówienia od.
    • created_till (date, opcjonalny) - Data stworzenia zamówienia do.

• Zwracane parametry

  • total (integer, zawsze zwracany) - Całkowita liczba wyników.
  • current_page (integer, zawsze zwracany) - Aktualna strona z wynikami.
  • last_page (integer, zawsze zwracany) - Ostatnia strona z wynikami.
  • per_page (integer, zawsze zwracany) - Liczba wyników na stronę.
  • orders (array[order], zawsze zwracany) - Tablica z wynikami.
  • number_of_users (integer, zawsze zwracany) - Liczba aktywnych użytkowników przypisanych do partnera.
  • number_of_orders (integer, zawsze zwracany) - Liczba zamówień przypisanych do partnera.
  • number_of_packages (integer, zawsze zwracany) - Liczba paczek przypisanych do partnera.
  • total_commission (numeric, zawsze zwracany) - Całkowita kwota prowizji.

• Zwracany obiekt order

  • id (integer, zawsze zwracany) - Numer ID.
  • created_at (date, zawsze zwracany) - Data stworzenia zamówienia.
  • pickup_date (date, zawsze zwracany) - Data odbioru.
  • courier_id (integer, zawsze zwracany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.
    • 1 - Geis (K-ex)
    • 2 - GLS
    • 3 - DPD
    • 4 - InPost
    • 5 - DHL
    • 7 - Geis (ETL)
    • 8 - InPost Zagranica
    • 9 - InPost Paczkomaty
    • 11 - Patron Service
    • 12 - Fedex
    • 13 - GEODIS
    • 14 - UPS
    • 16 - Poczta Polska palety
    • 17 - Pocztex
    • 18 - Rohlig SUUS
    • 19 - ORLEN Paczka
    • 20 - Ambro Express
    • 22 - Rhenus Logistics
    • 23 - InPost Szybkie Zwroty
    • 24 - InPost Paczkomat → Kurier
    • 25 - InPost Paczkomaty Ekonomiczne
  • product_id (integer, zawsze zwracany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.
    • 1 - Koperta.
    • 2 - Paczka.
    • 3 - Paleta.
  • weight (numeric, zawsze zwracany) - Waga przesyłki.
  • length (numeric, zawsze zwracany) - Długość przesyłki.
  • width (numeric, zawsze zwracany) - Szerokość przesyłki.
  • height (numeric, zawsze zwracany) - Wysokość przesyłki.
  • status (integer, zawsze zwracany) - Status zamówienia.
    • 11 - Oczekuje
    • 12 - Zapłacone
    • 13 - Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)
    • 14 - Anulowane
  • price (numeric, zawsze zwracany) - Kwota zamówienia.
  • user (object user) - Użytkownik przypisany do zamówienia.
  • commission (numeric, zawsze zwracany) - Kwota prowizji.

• Zwracany obiekt user

  • id (integer, zawsze zwracany) - Numer ID użytkownika.
  • created_at (date, opcjonalny) - Data stworzenia użytkownika.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "courier_id": 4
  }
}

Content-Type: application/json

{
  "total": 2,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "orders": [
    {
      "id": 12345,
      "created_at": "2017-02-21 21:42:32",
      "pickup_date": "2017-02-22",
      "courier_id": 4,
      "product_id": 2,
      "weight": 3.6,
      "length": 30,
      "width": 25,
      "height": 15,
      "status": 12,
      "price": 75,
      "user": {
        "id": 11,
        "created_at": "2017-02-21 21:42:32"
      },
      "commission": 7.5
    },
    {
      "id": 12346,
      "created_at": "2017-02-21 21:33:03",
      "pickup_date": "2017-02-22",
      "courier_id": 4,
      "product_id": 2,
      "weight": 11,
      "length": 30,
      "width": 30,
      "height": 30,
      "status": 12,
      "price": 17.5,
      "user": {
        "id": 11,
        "created_at": "2017-02-21 21:33:03"
      },
      "commission": 2.5
    }
  ],
  "number_of_users": 25,
  "number_of_orders": 2,
  "number_of_packages": 2,
  "total_commission": 10
}

Dodaj

POST/user/allegro/accounts

Dodaj konto allegro.

• Przyjmowane parametry
  • username (string, wymagany) - Login do konta Allegro.pl.
  • password (string, wymagany) - Hasło do konta Allegro.pl.

URI

Content-Type: application/json

{
  "username": "test",
  "password": "test"
}

Content-Type: application/json

Content-Type: application/json

{
  "errors": {
    "nazwa_pola": [
      "Opis błędu."
    ]
  },
  "error_code": "InvalidInput",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Podany dane dostępowe są nieprawidłowe.",
  "error_code": "AuthenticationFailed",
  "status_code": 401
}

Stwórz

POST/user/allegro/syncs/:accountID

Rozpocznij synchronizacje użytkownika.

• Przyjmowane parametry

  • token (string, wymagany) - Token.

• Zwracane parametry

  • working_control (string, zawsze zwracany) - ID synchronizacji.

URI

Content-Type: application/json

Content-Type: application/json

{
  "working_control": "abc123"
}

Szukaj

POST/user/allegro/accounts/:accountID/items/search

Pobierz rekordy allegro.

• Przyjmowane parametry

  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • buyer_data (string, opcjonalny) - Dane kupującego (login, e-mail, id).
    • auction_id (integer, opcjonalny) - Numer ID aukcji.
    • payment_status (string, opcjonalny) - Status płatności. Wartości filtra powinny zostać pobrane dynamicznie.
    • payment_type (string, opcjonalny) - Typ płatności.
      • wire_transfer - Przelew tradycyjny
      • collect_on_delivery - Płacę przy odbiorze
      • payu - PayU
    • shipment_type (integer, opcjonalny) - Typ wysyłki. Wartości filtra powinny zostać pobrane dynamicznie.
    • with_invoice (bool, opcjonalny) - Faktura.
    • sold_since (date, opcjonalny) - Data sprzedaży od.
    • sold_till (date, opcjonalny) - Data sprzedaży do.
    • data (string, opcjonalny) - Szukaj wszędzie.

• Zwracane parametry

  • total (integer, zawsze zwracany) - Całkowita liczba wyników.
  • current_page (integer, zawsze zwracany) - Aktualna strona z wynikami.
  • last_page (integer, zawsze zwracany) - Ostatnia strona z wynikami.
  • per_page (integer, zawsze zwracany) - Liczba wyników na stronę.
  • items (array[item], zawsze zwracany) - Tablica z wynikami.

• Zwracany obiekt item

  • id (integer, zawsze zwracany) - Numer ID.
  • allegro_user_id (integer, zawsze zwracany) - Numer ID konta Allegro.pl.
  • form_id (integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.
  • form_id (integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.
  • form_created_at (date, zawsze zwracany) - Data sprzedaży / stworzenia formularza.
  • buyer_id (integer, zawsze zwracany) - Numer ID kupującego w Allegro.pl.
  • buyer_login (string, zawsze zwracany) - Login kupującego w Allegro.pl.
  • buyer_email (string, zawsze zwracany) - Adres e-mail kupującego w Allegro.pl.
  • wants_invoice (bool, zawsze zwracany) - Informacja o tym, czy klient chce fakture VAT.
  • to_pay_amount (numeric, zawsze zwracany) - Całkowita kwota do zapłaty.
  • postage_amount (numeric, zawsze zwracany) - Kwota wysyłki.
  • payment_type (string, zawsze zwracany) - Typ płatności.
  • payment_status (string, zawsze zwracany) - Status płatności.
  • shipment_type (integer, zawsze zwracany) - Typ wysyłki.
  • message (string, opcjonalny) - Widomość od kupujacego.
  • order (object order, opcjonalny) - Przypisane zamówienie w Wysylajnami.pl.
  • receiver_address (object address, zawsze zwracany) - Adres doręczenia.
  • invoice_address (object address, opcjonalny) - Adres do faktury VAT.
  • positions (array[position], zawsze zwracany) - Tablica z zakupionymi produktami.

• Zwracany obiekt order

  • id (integer, zawsze zwracany) - Numer ID zamówienia.
  • courier_id (integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.
    • 1 - Geis (K-ex)
    • 2 - GLS
    • 3 - DPD
    • 4 - InPost
    • 5 - DHL
    • 7 - Geis (ETL)
    • 8 - InPost Zagranica
    • 9 - InPost Paczkomaty
    • 11 - Patron Service
    • 12 - Fedex
    • 13 - GEODIS
    • 14 - UPS
    • 16 - Poczta Polska palety
    • 17 - Pocztex
    • 18 - Rohlig SUUS
    • 19 - ORLEN Paczka
    • 20 - Ambro Express
    • 22 - Rhenus Logistics
    • 23 - InPost Szybkie Zwroty
    • 24 - InPost Paczkomat → Kurier
    • 25 - InPost Paczkomaty Ekonomiczne
  • waybill_number (string, opcjonalny) - Numer listu przewozowego.
  • courier_status (integer, opcjonalny) - Status przesyłki u kuriera.
    • 1 - Nieznany
    • 4 - Wprowadzona
    • 6 - Anulowana
    • 7 - Nieodebrana
    • 8 - W doręczeniu
    • 9 - Doręczona
    • 10 - Zwrot do nadawcy
    • 13 - Zakończona
    • 15 - List ręczny
  • status (integer, opcjonalny) - Status zamówienia.
    • 11 - Oczekuje
    • 12 - Zapłacone
    • 13 - Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)
    • 14 - Anulowane
  • insurance_value (numeric, opcjonalny) - Wartość ubezpieczenia.
  • cod_value (numeric, opcjonalny) - Wartość pobrania.
  • product_id (integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.
    • 1 - Koperta.
    • 2 - Paczka.
    • 3 - Paleta.
  • weight (numeric, zawsze zwracany) - Waga przesyłki.
  • length (numeric, zawsze zwracany) - Długość przesyłki.
  • width (numeric, zawsze zwracany) - Szerokość przesyłki.
  • height (numeric, zawsze zwracany) - Wysokość przesyłki.
  • number_of_packages (integer, zawsze zwracany) - Liczba przesyłek.
  • price (numeric, zawsze zwracany) - Cena zamówienia.
  • description (string, zawsze zwracany) - Zawartość.

• Zwracany obiekt address

  • name (string) - Imię.
  • surname (string) - Nazwisko.
  • company (string) - Nazwa firmy.
  • street (string) - Ulica.
  • house_number (string) - Numer domu.
  • door_number (string) - Numer mieszkania.
  • post_code (string) - Kod pocztowy.
  • city (string) - Miasto.
  • country_id (integer) - Kod kraju.
  • phone (string) - Telefon.
  • pop (object pop, opcjonalny) - Paczkomat.
  • pp (object pp, opcjonalny) - placówka Poczty Polskiej.
  • ruch (object ruch, opcjonalny) - Punkt RUCHu.
  • tax_number (string, opcjonalny) - Numer NIP.

• Zwracany obiekt pop

  • code (string, zawsze zwracany) - Kod paczkomatu.

• Zwracany obiekt pp

  • code (string, zawsze zwracany) - Kod placówki Poczty Polskiej.

• Zwracany obiekt ruch

  • code (string, zawsze zwracany) - Kod Punktu RUCHu.

• Zwracany obiekt position

  • auction_id (string, zawsze zwracany) - Numer aukcji Allegro.pl.
  • auction_title (string, zawsze zwracany) - Tytuł aukcji Allegro.pl.
  • quantity (integer, zawsze zwracany) - Ilość.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "buyer_data": "Kowalski"
  }
}

Content-Type: application/json

{
  "total": 1,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "items": [
    {
      "id": 1,
      "allegro_user_id": 1,
      "form_id": 111111,
      "form_created_at": "2015-10-24 09:44:48",
      "buyer_id": 111112,
      "buyer_login": "niezarejestrowany",
      "buyer_email": "[email protected]",
      "wants_invoice": false,
      "to_pay_amount": 46,
      "postage_amount": 44,
      "payment_type": "collect_on_delivery",
      "payment_status": "",
      "shipment_type": 11,
      "message": "dsdsds",
      "order": {
        "id": 1111,
        "courier_id": 4,
        "waybill_number": null,
        "courier_status": null,
        "courier_pickup_number": null,
        "status": 11,
        "insurance_value": 46,
        "cod_value": 0,
        "product_id": 1,
        "weight": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "number_of_packages": 1,
        "price": "17.00",
        "description": "test"
      },
      "receiver_address": {
        "name": "Jan",
        "surname": "Kowalski",
        "company": "ABC S. A.",
        "street": "Testowa",
        "house_number": "30/3",
        "post_code": "01-111",
        "city": "Warszawa",
        "country_id": 1,
        "phone": "123456789",
        "tax_number": ""
      },
      "invoice_address": null,
      "positions": [
        {
          "auction_id": "111111",
          "auction_title": "testowa aukcja",
          "quantity": 2
        }
      ]
    }
  ]
}

Szukaj w archiwum

POST/user/allegro/accounts/:accountID/items/trash/search

Pobierz zarchiwizowane rekordy allegro.

• Przyjmowane parametry

  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • buyer_data (string, opcjonalny) - Dane kupującego (login, e-mail, id).
    • auction_id (integer, opcjonalny) - Numer ID aukcji.
    • payment_status (string, opcjonalny) - Status płatności. Wartości filtra powinny zostać pobrane dynamicznie.
    • payment_type (string, opcjonalny) - Typ płatności.
      • wire_transfer - Przelew tradycyjny
      • collect_on_delivery - Płacę przy odbiorze
      • payu - PayU
    • shipment_type (integer, opcjonalny) - Typ wysyłki. Wartości filtra powinny zostać pobrane dynamicznie.
    • with_invoice (bool, opcjonalny) - Faktura.
    • sold_since (date, opcjonalny) - Data sprzedaży od.
    • sold_till (date, opcjonalny) - Data sprzedaży do.
    • data (string, opcjonalny) - Szukaj wszędzie.

• Zwracane parametry

  • total (integer, zawsze zwracany) - Całkowita liczba wyników.
  • current_page (integer, zawsze zwracany) - Aktualna strona z wynikami.
  • last_page (integer, zawsze zwracany) - Ostatnia strona z wynikami.
  • per_page (integer, zawsze zwracany) - Liczba wyników na stronę.
  • items (array[item], zawsze zwracany) - Tablica z wynikami.

• Zwracany obiekt item

  • id (integer, zawsze zwracany) - Numer ID.
  • allegro_user_id (integer, zawsze zwracany) - Numer ID konta Allegro.pl.
  • form_id (integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.
  • form_id (integer, zawsze zwracany) - Numer ID wypełnionego formularza Allegro.pl.
  • form_created_at (date, zawsze zwracany) - Data sprzedaży / stworzenia formularza.
  • buyer_id (integer, zawsze zwracany) - Numer ID kupującego w Allegro.pl.
  • buyer_login (string, zawsze zwracany) - Login kupującego w Allegro.pl.
  • buyer_email (string, zawsze zwracany) - Adres e-mail kupującego w Allegro.pl.
  • wants_invoice (bool, zawsze zwracany) - Informacja o tym, czy klient chce fakture VAT.
  • to_pay_amount (numeric, zawsze zwracany) - Całkowita kwota do zapłaty.
  • postage_amount (numeric, zawsze zwracany) - Kwota wysyłki.
  • payment_type (string, zawsze zwracany) - Typ płatności.
  • payment_status (string, zawsze zwracany) - Status płatności.
  • shipment_type (integer, zawsze zwracany) - Typ wysyłki.
  • message (string, opcjonalny) - Widomość od kupujacego.
  • order (object order, opcjonalny) - Przypisane zamówienie w Wysylajnami.pl.
  • receiver_address (object address, zawsze zwracany) - Adres doręczenia.
  • invoice_address (object address, opcjonalny) - Adres do faktury VAT.
  • positions (array[position], zawsze zwracany) - Tablica z zakupionymi produktami.

• Zwracany obiekt order

  • id (integer, zawsze zwracany) - Numer ID zamówienia.
  • courier_id (integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.
    • 1 - Geis (K-ex)
    • 2 - GLS
    • 3 - DPD
    • 4 - InPost
    • 5 - DHL
    • 7 - Geis (ETL)
    • 8 - InPost Zagranica
    • 9 - InPost Paczkomaty
    • 11 - Patron Service
    • 12 - Fedex
    • 13 - GEODIS
    • 14 - UPS
    • 16 - Poczta Polska palety
    • 17 - Pocztex
    • 18 - Rohlig SUUS
    • 19 - ORLEN Paczka
    • 20 - Ambro Express
    • 22 - Rhenus Logistics
    • 23 - InPost Szybkie Zwroty
    • 24 - InPost Paczkomat → Kurier
    • 25 - InPost Paczkomaty Ekonomiczne
  • waybill_number (string, opcjonalny) - Numer listu przewozowego.
  • courier_status (integer, opcjonalny) - Status przesyłki u kuriera.
    • 1 - Nieznany
    • 4 - Wprowadzona
    • 6 - Anulowana
    • 7 - Nieodebrana
    • 8 - W doręczeniu
    • 9 - Doręczona
    • 10 - Zwrot do nadawcy
    • 13 - Zakończona
    • 15 - List ręczny
  • status (integer, opcjonalny) - Status zamówienia.
    • 11 - Oczekuje
    • 12 - Zapłacone
    • 13 - Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)
    • 14 - Anulowane
  • insurance_value (numeric, opcjonalny) - Wartość ubezpieczenia.
  • cod_value (numeric, opcjonalny) - Wartość pobrania.
  • product_id (integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.
    • 1 - Koperta.
    • 2 - Paczka.
    • 3 - Paleta.
  • weight (numeric, zawsze zwracany) - Waga przesyłki.
  • length (numeric, zawsze zwracany) - Długość przesyłki.
  • width (numeric, zawsze zwracany) - Szerokość przesyłki.
  • height (numeric, zawsze zwracany) - Wysokość przesyłki.
  • number_of_packages (integer, zawsze zwracany) - Liczba przesyłek.
  • price (numeric, zawsze zwracany) - Cena zamówienia.
  • description (string, zawsze zwracany) - Zawartość.

• Zwracany obiekt address

  • name (string) - Imię.
  • surname (string) - Nazwisko.
  • company (string) - Nazwa firmy.
  • street (string) - Ulica.
  • house_number (string) - Numer domu.
  • door_number (string) - Numer mieszkania.
  • post_code (string) - Kod pocztowy.
  • city (string) - Miasto.
  • country_id (integer) - Kod kraju.
  • phone (string) - Telefon.
  • pop (object pop, opcjonalny) - Paczkomat.
  • pp (object pp, opcjonalny) - Placówka Poczty Polskiej.
  • ruch (object ruch, opcjonalny) - Punkt RUCHu.
  • tax_number (string, opcjonalny) - Numer NIP.

• Zwracany obiekt pop

  • code (string, zawsze zwracany) - Kod paczkomatu.

• Zwracany obiekt pp

  • code (string, zawsze zwracany) - Kod placówki Poczty Polskiej.

• Zwracany obiekt ruch

  • code (string, zawsze zwracany) - Kod Punktu RUCHu.

• Zwracany obiekt position

  • auction_id (string, zawsze zwracany) - Numer aukcji Allegro.pl.
  • auction_title (string, zawsze zwracany) - Tytuł aukcji Allegro.pl.
  • quantity (integer, zawsze zwracany) - Ilość.

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 50,
  "filters": {
    "buyer_data": "Kowalski"
  }
}

Content-Type: application/json

{
  "total": 1,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "items": [
    {
      "id": 1,
      "allegro_user_id": 1,
      "form_id": 111111,
      "form_created_at": "2015-10-24 09:44:48",
      "buyer_id": 111112,
      "buyer_login": "niezarejestrowany",
      "buyer_email": "[email protected]",
      "wants_invoice": false,
      "to_pay_amount": 46,
      "postage_amount": 44,
      "payment_type": "collect_on_delivery",
      "payment_status": "",
      "shipment_type": 11,
      "message": "dsdsds",
      "order": {
        "id": 1111,
        "courier_id": 4,
        "waybill_number": null,
        "courier_status": null,
        "courier_pickup_number": null,
        "status": 11,
        "insurance_value": 46,
        "cod_value": 0,
        "product_id": 1,
        "weight": 0,
        "length": 0,
        "width": 0,
        "height": 0,
        "number_of_packages": 1,
        "price": "17.00",
        "description": "test"
      },
      "receiver_address": {
        "name": "Jan",
        "surname": "Kowalski",
        "company": "ABC S. A.",
        "street": "Testowa",
        "house_number": "30/3",
        "post_code": "01-111",
        "city": "Warszawa",
        "country_id": 1,
        "phone": "123456789",
        "tax_number": ""
      },
      "invoice_address": null,
      "positions": [
        {
          "auction_id": "111111",
          "auction_title": "testowa aukcja",
          "quantity": 2
        }
      ]
    }
  ]
}

Przywróć

POST/user/allegro/accounts/:accountID/items/trash/restore

Przywróć wybrane rekordy Allegro.

• Przyjmowane parametry
  • item_ids (array[integer], wymagany, min: 1) - Tablica rekordów Allegro.

URI

Content-Type: application/json

{
  "item_ids": [
    123,
    234
  ]
}

Content-Type: application/json

Content-Type: application/json

{
  "errors": {
    "nazwa_pola": [
      "Opis błędu."
    ]
  },
  "error_code": "InvalidInput",
  "status_code": 400
}

Content-Type: application/json

{
  "message": "Nie znaleziono.",
  "error_code": "NotFound",
  "status_code": 404
}

Szukaj

POST/user/orders/search

Wyszukaj zamówienia użytkownika.

• Przyjmowane parametry
  • page (integer, opcjonalny, min: 1) - Numer strony, domyślnie 1.
  • per_page (integer, opcjonalny, min: 1) - Ilość zwracanych wyników na stronę, domyślnie 50.
  • filters (object, opcjonalny) - Tablica filtrów.
    • order_id (integer, opcjonalny) - Numer zamówienia.
    • waybill_number (string, opcjonalny) - Numer listu przewozowego.
    • order_status (integer, opcjonalny) - Status zamówienia.
      • 11 - Oczekuje
      • 12 - Zapłacone
      • 13 - Błąd (wystąpił prawdopodobnie problem z płatnością, wymagany kontakt z BOK)
      • 14 - Anulowane
    • courier_status (integer, opcjonalny) - Status przesyłki u kuriera.
      • 1 - Nieznany
      • 4 - Wprowadzona
      • 6 - Anulowana
      • 7 - Nieodebrana
      • 8 - W doręczeniu
      • 9 - Doręczona
      • 10 - Zwrot do nadawcy
      • 13 - Zakończona
      • 15 - List ręczny
    • created_since (date, opcjonalny) - Data stworzenia zamówienia od.
    • created_till (date, opcjonalny) - Data stworzenia zamówienia do.
    • courier_id (integer, opcjonalny, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera.
      • 1 - Geis (K-ex)
      • 2 - GLS
      • 3 - DPD
      • 4 - InPost
      • 5 - DHL
      • 7 - Geis (ETL)
      • 8 - InPost Zagranica
      • 9 - InPost Paczkomaty
      • 11 - Patron Service
      • 12 - Fedex
      • 13 - GEODIS
      • 14 - UPS
      • 16 - Poczta Polska palety
      • 17 - Pocztex
      • 18 - Rohlig SUUS
      • 19 - ORLEN Paczka
      • 20 - Ambro Express
      • 22 - Rhenus Logistics
      • 23 - InPost Szybkie Zwroty
      • 24 - InPost Paczkomat → Kurier
      • 25 - InPost Paczkomaty Ekonomiczne
    • user_data (string, opcjonalny) - Dane zamówienia (np. imię, nazwisko, numer telefonu, e-mail etc.).

URI

Content-Type: application/json

{
  "page": 1,
  "per_page": 20,
  "filters": {
    "order_id": 123,
    "waybill_number": 123,
    "order_status": 12,
    "courier_status": 1,
    "created_since": "2017-01-01",
    "created_till": "2017-01-30",
    "user_data": "Jan Kowalski"
  }
}

Content-Type: application/json

{
  "total": 1,
  "current_page": 1,
  "last_page": 1,
  "per_page": 50,
  "orders": [
    {
        "order_id": 123,
        "pickup_at": "2017-01-26",
        "pickup_hour_since": "10:00",
        "pickup_hour_till": "13:00",
        "status": 12,
        "created_at": "2017-01-25 16:13:06",
        "courier_id": 1,
        "waybill_number": "123ABC1",
        "courier_status": 6,
        "courier_pickup_number": null,
        "price": 20.1,
        "product_id": 2,
        "number_of_packages": 1,
        "weight": 10.1,
        "length": 1.1,
        "width": 20,
        "height": 20,
        "cod_type": 0,
        "cod_value": null,
        "cod_bank_account_number": null,
        "insurance_value": null,
        "non_standard": true,
        "description": "Buty",
        "options": [
            "without_waybill",
            "direct_delivery_only"
        ],
        "payment": [
            "method" : "balance",
            "invoice_id" : null,
            "invoice_number" : null
        ],
        "sender": {
            "name": "Jan",
            "surname": "Testowy",
            "company": "Test SA",
            "street": "Testowa",
            "house_number": 11,
            "door_number": 6,
            "post_code": "82-300",
            "city": "Elbląg",
            "country_id": 1,
            "phone": 123456789,
            "email": "[email protected]",
            "pop": null,
            "pp": null,
            "ruch": null
        },
        "receiver": {
            "name": "Jan",
            "surname": "Odbiorca",
            "company": null,
            "street": "Testowa",
            "house_number": 11,
            "door_number": null,
            "post_code": "00-123",
            "city": "Warszawa",
            "country_id": 1,
            "phone": 12345678,
            "email": "[email protected]",
            "pop": null,
            "pp": null,
            "ruch": null
        },
        "invoice": {
            "name": "Jan",
            "surname": "Faktura",
            "company": "Faktura SA",
            "tax_number": null,
            "street": "Fakturowa",
            "house_number": 11,
            "door_number": 2,
            "post_code": "82-300",
            "city": "Elbląg",
            "country_id": 1,
            "phone": 123456789,
            "email": "[email protected]"
        }
    },
    {
        "order_id": 124,
        "pickup_at": "2017-01-26",
        "pickup_hour_since": "10:00",
        "pickup_hour_till": "13:00",
        "status": 12,
        "created_at": "2017-01-25 16:18:06",
        "courier_id": 1,
        "waybill_number": "123ABC1",
        "courier_status": 6,
        "courier_pickup_number": 12312423,
        "price": 22.1,
        "product_id": 2,
        "number_of_packages": 1,
        "weight": 10.1,
        "length": 1.1,
        "width": 20,
        "height": 20,
        "cod_type": 0,
        "cod_value": null,
        "cod_bank_account_number": null,
        "insurance_value": null,
        "non_standard": false,
        "description": "Test",
        "options": [
        "without_waybill",
        "direct_delivery_only"
        ],
        "sender": {
            "name": "Jan",
            "surname": "Testowy",
            "company": "Test SA",
            "street": "Testowa",
            "house_number": 11,
            "door_number": 6,
            "post_code": "82-300",
            "city": "Elbląg",
            "country_id": 1,
            "phone": 123456789,
            "email": "[email protected]",
            "pop": null,
            "pp": null,
            "ruch": null
        },
        "receiver": {
            "name": "Jan",
            "surname": "Odbiorca",
            "company": null,
            "street": "Testowa",
            "house_number": 11,
            "door_number": null,
            "post_code": "00-123",
            "city": "Warszawa",
            "country_id": 1,
            "phone": 12345678,
            "email": "[email protected]",
            "pop": null,
            "pp": null,
            "ruch": null
        },
        "invoice": {
            "name": "Jan",
            "surname": "Faktura",
            "company": "Faktura SA",
            "tax_number": null,
            "street": "Fakturowa",
            "house_number": 11,
            "door_number": 2,
            "post_code": "82-300",
            "city": "Elbląg",
            "country_id": 1,
            "phone": 123456789,
            "email": "[email protected]"
        }
    }
  ]
}

Stwórz

POST/user/orders

Stwórz zamówienie. W sytuacji, gdy żądanie nie zawiera parametru token, system utworzy konto dla podanego adresu e-mail (nadawca lub dane zlecającego). Konto zostanie utworzone na dane pobrane z pierwszego poprawnie stworzonego zamówienia. Hasło do logowania zostanie przesłane na podany adres e-mail.

• Przyjmowane parametry
  • regulations_approval (bool, wymagany bez: token) - Akceptacja regulaminu. Parametr wymagany do rejestracji konta, opcjonalny, jeśli przesyłany jest token. Regulamin znajduję się na stronie: https://wysylajnami.pl/regulamin
  • marketing_approval (bool, wymagany bez: token) - Parametr wymagany do rejestracji konta, opcjonalny, jeśli przesyłany jest token. Zgoda na umieszczenie danych teleadresowych w bazie serwisu i wykorzystanie ich.
  • marketing_approval_2 (bool) - Parametr wymagany do rejestracji konta, opcjonalny, jeśli przesyłany jest token. Zgoda na otrzymywanie na podany adres e-mail informacji handlowej.
  • packages (array, wymagany, min: 1, max: 50) - Tablica obiektów package.
  • package (object, wymagany) - Objekt określający przesyłkę.
    • product_id (integer, wymagany, akceptowane wartości: 1, 2, 3) - Typ przesyłki.
      • 1 - Koperta.
      • 2 - Paczka.
      • 3 - Paleta.
    • weight (numeric, wymagany jeśli: product_id = 2, 3) - Waga przesyłki.
    • length (numeric, wymagany jeśli: product_id = 2, 3) - Długość przesyłki.
    • width (numeric, wymagany jeśli: product_id = 2, 3) - Szerokość przesyłki.
    • height (numeric, wymagany jeśli: product_id = 2, 3) - Wysokość przesyłki.
    • number_of_packages (integer, opcjonalny, domyślnie: 1) - Liczba przesyłek.
    • non_standard (bool, wymagany jeśli: product_id = 2) - Rodzaj opakowania. Opcja dostępna tylko dla paczki.
    • insurance_value (numeric, wymagany z: cod_type_id, min: 0.01 lub cod_value, max: 50000.0, niedostępny dla: courier_id = 2) - Ubezpieczenie przesyłki. Wartość minimalna to (jeśli podano) wartość pobrania. Opcja niedostępna dla kuriera GLS.
    • cod_type_id (integer, opcjonalny, akceptowane wartości: 1, 2) - Typ pobrania.
      • 1 - Standard (dostępne dla: courier_id = 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12).
      • 2 - Express (dostępne dla: courier_id = 1).
    • cod_value (numeric, wymagany z: cod_type_id, min: 0.01, max: 20000.0) - Wartość pobrania.
    • cod_bank_account_number (numeric, max: 26 znaków, walidacja na numer IBAN PL, wymagany z: cod_type_id) - Numer konta do zwrotu pobrania.
    • description (string, wymagany, max: 30 znaków) - Opis zawartości.
    • courier_id (integer, wymagany, akceptowane wartości: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12) - Numer ID kuriera. Kurier może być niedostępny. Zawsze należy sprawdzić dostępność przez /order/resources/couriers.
      • 1 - Geis (K-ex)
      • 2 - GLS
      • 3 - DPD
      • 4 - InPost
      • 5 - DHL
      • 7 - Geis (ETL)
      • 8 - InPost Zagranica
      • 9 - InPost Paczkomaty
      • 11 - Patron Service
      • 12 - Fedex
      • 13 - GEODIS
      • 14 - UPS
      • 16 - Poczta Polska palety
      • 17 - Pocztex
      • 18 - Rohlig SUUS
      • 19 - ORLEN Paczka
      • 20 - Ambro Express
      • 22 - Rhenus Logistics
      • 23 - InPost Szybkie Zwroty
      • 24 - InPost Paczkomat → Kurier
      • 25 - InPost Paczkomaty Ekonomiczne
    • pickup_date (date, wymagany, format: Y-m-d) - Data nadania przesyłki.
    • hours (array[hours], opcjonalny) - Godziny odbioru przesyłki.
      • from (string, zawsze zwracany) - Godzina odbioru od.
      • to (string, zawsze zwracany) - Godzina odbioru do.
    • options (array, opcjonalny) - Opcje dodatkowe. Akceptowane wartości poniżej. Tablice należy przesłać jako zbiór nazw opcji, które powinny zostać dodane do zamówienia.
      • direct_delivery_only
      • delivery_phone_advice_note
      • delivery_sms_advice_note
      • delivery_email_advice_note
      • email_confirmation_of_delivery
      • sms_confirmation_of_delivery
      • pre_delivery_information
      • check_contents_before_accepting
      • without_waybill
      • no_pickup
      • with_pickup
      • delivery_until_9_00
      • delivery_until_12_00
      • delivery_between_18_00_and_22_00
      • delivery_on_saturday
      • express_delivery
      • handle_with_care
    • sender (object, wymagany) - Dane nadawcy.
      • name (string, wymaganie, tylko znaki alfabetu, max: 30 znaków z surname) - Imię.
      • surname (string, wymaganie, tylko znaki alfabetu, max: 30 znaków z name) - Nazwisko.
      • company (string, opcjonalny, max: 60 znaków, jeśli courier_id = 8 to max: 50 znaków) - Nazwa firmy.
      • tax_number (string, opcjonalny, dostępny tylko dla niezalogowanych, max: 16 znaków) - Numer NIP.
      • street (string, wymagany, max: 100 znaków, jeśli courier_id = 8 to max: 90 znaków, jeśli courier_id = 5 to max: 60 znaków) - Ulica.
      • house_number (string, wymagany, max: 10 znaków) - Numer domu.
      • door_number (string, opcjonalny, max: 10 znaków) - Numer mieszkania.
      • post_code (string, wymagany, max: 10 znaków) - Kod pocztowy.
      • city (string, wymagany, max: 50 znaków) - Miasto.
      • country_id (integer, wymagany, zgodny z GET /order/resources/countries) - Kod kraju.
      • phone (string, wymagany, jeśli country_id = 1: min: 5 znaków, max: 13 znaków, jeśli country_id != 1 to max: 20 znaków) - Telefon.
      • pop_code (string, wymagany jeśli courier_id = 9, zgodny z GET /pop/search) - Kod paczkomatu.
      • pp_code (string, wymagany jeśli courier_id = 17, zgodny z GET /pp/search) - Kod placówki Poczty Polskiej.
      • ruch_code (string, wymagany jeśli courier_id = 19, zgodny z GET /ruch/search) - Kod Punktu RUCHu.
      • email (string, wymagany, opcjonalny, jeśli niezalogowany i wypełniono invoice, email, max: 255 znaków) - E-mail.
      • add_to_address_book (bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
    • receiver (object, wymagany) - Dane odbiorcy.
      • name (string, wymaganie, tylko znaki alfabetu, max: 30 znaków z surname) - Imię.
      • surname (string, wymaganie, tylko znaki alfabetu, max: 30 znaków z name) - Nazwisko.
      • company (string, opcjonalny, max: 60 znaków, jeśli courier_id = 8 to max: 50 znaków) - Nazwa firmy.
      • street (string, wymagany, max: 100 znaków, jeśli courier_id = 8 to max: 90 znaków, jeśli courier_id = 5 to max: 60 znaków) - Ulica.
      • house_number (string, wymagany, max: 10 znaków) - Numer domu.
      • door_number (string, opcjonalny, max: 10 znaków) - Numer mieszkania.
      • post_code (string, wymagany, max: 10 znaków) - Kod pocztowy.
      • city (string, wymagany, max: 50 znaków) - Miasto.
      • country_id (integer, wymagany, zgodny z GET /order/resources/countries) - Kod kraju.
      • phone (string, wymagany, jeśli country_id = 1: min: 5 znaków, max: 13 znaków, jeśli country_id != 1 to max: 20 znaków) - Telefon.
      • pop_code (string, wymagany jeśli courier_id = 9, zgodny z GET /pop/search) - Kod paczkomatu.
      • pp_code (string, wymagany jeśli courier_id = 17, zgodny z GET /pp/search) - Kod placówki Poczty Polskiej.
      • ruch_code (string, wymagany jeśli courier_id = 19, zgodny z GET /ruch/search) - Kod Punktu RUCHu.
      • email (string, opcjonalny, email, max: 255 znaków) - E-mail.
      • add_to_address_book (bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.
    • invoice (object, opcjonalny) - Dane do faktury VAT lub dla niezalogowanych - dane do właściciela konta oraz dane do faktury VAT.
      • name (string, wymaganie, tylko znaki alfabetu, max: 30 znaków z surname) - Imię.
      • surname (string, wymaganie, tylko znaki alfabetu, max: 30 znaków z name) - Nazwisko.
      • company (string, opcjonalny, jeśli podano name oraz surname, max: 60 znaków, jeśli courier_id = 8 to max: 50 znaków) - Nazwa firmy.
      • tax_number (string, opcjonalny, max: 16 znaków) - Numer NIP. Tylko dla niezalogowanych.
      • street (string, wymagany, max: 100 znaków, jeśli courier_id = 8 to max: 90 znaków, jeśli courier_id = 5 to max: 60 znaków) - Ulica.
      • house_number (string, wymagany, max: 10 znaków) - Numer domu.
      • door_number (string, opcjonalny, max: 10 znaków) - Numer mieszkania.
      • post_code (string, wymagany, max: 10 znaków) - Kod pocztowy.
      • city (string, wymagany, max: 50 znaków) - Miasto.
      • country_id (integer, wymagany, zgodny z GET /order/resources/countries) - Kod kraju.
      • phone (string, wymagany, jeśli country_id = 1: min: 5 znaków, max: 13 znaków, jeśli country_id != 1 to max: 20 znaków) - Telefon.
      • email (string, wymagany dla niezalogowanych, email, max: 255 znaków) - E-mail.
      • add_to_address_book (bool, opcjonalny) - Informacja czy dodać adres do książki adresowej.

URI

Content-Type: application/json

{
  "regulations_approval": true,
  "marketing_approval": true,
  "marketing_approval_2": true,
  "packages": [
    {
      "product_id": 2,
      "weight": 50,
      "length": 200,
      "width": 200,
      "height": 200,
      "number_of_packages": 1,
      "non_standard": true,
      "insurance_value": 1000,
      "cod_type_id": 1,
      "cod_value": 1000,
      "cod_bank_account_number": "52175000120000000032413366",
      "description": "123",
      "pickup_date": "2017-04-10",
      "pickup_hours": {
        "from": "11:00",
        "to": "13:00"
      },
      "courier_id": 4,
      "sender": {
        "name": "Jan",
        "surname": "Kowalski",
        "street": "Kowalska",
        "house_number": "12",
        "post_code": "01-111",
        "city": "Warszawa",
        "country_id": 1,
        "phone": "123456789"
      },
      "receiver": {
        "name": "Anna",
        "surname": "Kowalski",
        "street": "Testowa",
        "house_number": "11",
        "door_number": "2",
        "post_code": "82-300",
        "city": "Elbląg",
        "country_id": 1,
        "phone": "123456789"
      },
      "invoice": {
        "name": "Jan",
        "surname": "Kowalski",
        "company": "Kowalski Sp. z o.o.",
        "street": "Testowa",
        "house_number": "12",
        "post_code": "82-300",
        "city": "Elbląg",
        "country_id": 1,
        "phone": "123456789",
        "email": "[email protected]"
      }
    }
  ]
}

Content-Type: application/json

[
  {
    "order_id": 777,
    "price": 3931.5,
    "courier_id": 4
  }
]

Importuj

POST/import/orders

Import zamówień z pliku CSV. Obsługiwane formaty i przykładowe pliki CSV są dostępne w zakładce Import zamówień. Przed importem należy przesłać plik CSV na serwer (patrz: zasób File).

• Przyjmowane parametry

  • token (string, wymagany) - Token.
  • file_id (string, wymagany) - Identyfikator przesłanego pliku CSV.
  • import_order_type_id (int, wymagany, akceptowane wartości: 1, 2) - Rodzaj przesłanego pliku CSV.
    • 1 - CSV.
    • 2 - Shoper.

• Zwracane parametry

  • working_control (string, zawsze zwracany) - Hash kontrolny.
  • status (int, zawsze zwracany) - Kod statusu.
  • progress (int, zawsze zwracany) - Postęp importu zamówień wyrażony w procentach.

URI

Content-Type: application/json

{
  "file_id": "8e8215a8161c01f4e297c1c41e195528bt5ozTxWOsGTq2Se4wQCCcrznu1225GJ"
}

Content-Type: application/json

{
  "working_control": "84faf9c06eee5f14123755c955ce054bYQmVv9mJtFjalVGnH9g3yStHW9D3Qmnq",
  "status": 100,
  "progress": 0
}