createOrder

Opis metody

Metoda służąca do składania zamówienia z możliwością uwzględnienia wielu przesyłek. Przysyłki tworzone są z utworzonego wcześniej porównania ofert (search_id) oraz wybranego cennika (courier_id) przy użyciu metody getValuation.

Request

authArrayDane autoryzacyjne
loginStringLogin (e-mail)
api_keyStringKlucz autoryzacji do API (api_key)
CartCouponArraySzczegóły kuponu rabatowego
wymagany: Nie
codeStringKod kuponu rabatowego
wymagany: Nie
CartOrderArraySzczegóły zamówienia
paymentStringsposób płatności
wartości: 'bank' - Skarbonka, 'dotpay' - Dotpay.pl, 'online' - Transferuj.pl, 'pay_later' - Płatność odroczona
wymagany: Tak
CartArrayKoszyk, zbiór wielu zamówień przesyłek
[ ]Array
OrderArraySzczegóły przesyłki
search_idIntegerID porównania, pobrane z metody getValuation
courier_idIntegerID cennika, pobrane z metody getValuation
nameStringDane nadawcy: Imię i nazwisko
vat_companyStringDane nadawcy: Firma
emailStringDane nadawcy: Adres e-mail
streetStringDane nadawcy: Ulica
house_noStringDane nadawcy: Nr domu
locum_noStringDane nadawcy: Nr lokalu
cityStringDane nadawcy: Miasto
postalStringDane nadawcy: Kod pocztowy, format: xx-xxx
inpost_postal_fromStringPaczkomat nadawcy, np: ELB01A
wymagany: Tak, dla cennika Paczkomaty
phoneStringDane nadawcy: Nr telefonu
custom_pickupBooleanOkreśla niestandardowy adres odbioru przesyłki, pola adresowe pickup tylko jeśli Courier.custom_pickup_enable
pickup_nameStringNiestandardowy odbiór: Imię i nazwisko / firma
wymagany: Tak, przy niestandardowym odbiorze
pickup_phoneStringNiestandardowy odbiór: Nr telefonu
wymagany: Tak, przy niestandardowym odbiorze
pickup_streetStringNiestandardowy odbiór: Ulica
wymagany: Tak, przy niestandardowym odbiorze
pickup_house_noStringNiestandardowy odbiór: Nr domu
wymagany: Tak, przy niestandardowym odbiorze
pickup_locum_noStringNiestandardowy odbiór: Nr lokalu
wymagany: Tak, przy niestandardowym odbiorze
pickup_cityStringNiestandardowy odbiór: Miasto
wymagany: Tak, przy niestandardowym odbiorze
pickup_postalStringNiestandardowy odbiór: Kod pocztowy
wymagany: Tak, przy niestandardowym odbiorze
sender_saveBooleanOkreśla dodanie nadawcy do książki adresowej
pickup_dateDateData przyjazdu kuriera, format: yyyy-mm-dd
wymagany: Tak, przy pickup_hours = hours|date
pickup_ready_timeIntegerGodzina 'od' przyjazdu kuriera, format: 24h
wymagany: Tak, przy pickup_hours = hours
pickup_ready_time_minuteIntegerMinuty 'od' przyjazdu kuriera
wymagany: Tak, przy pickup_hours = hours
pickup_close_timeIntegerGodzina 'do' przyjazdu kuriera, format: 24h
wymagany: Tak, przy pickup_hours = hours
pickup_close_time_minuteIntegerMinuty 'do' przyjazdu kuriera
wymagany: Tak, przy pickup_hours = hours
taker_nameStringDane odbiorcy: Imię i nazwisko
taker_vat_companyStringDane odbiorcy: Firma
taker_emailStringDane odbiorcy: E-mail
taker_email_notifyBooleanDane odbiorcy: Określa powiadomienie odbiorcy o nadaniu paczki
taker_email_notify_messageStringDane odbiorcy: Dodatkowa wiadomość dla odbiorcy
taker_streetStringDane odbiorcy: Ulica
taker_house_noStringDane odbiorcy: Nr domu
taker_locum_noStringDane odbiorcy: Nr lokalu
taker_cityStringDane odbiorcy: Miasto
taker_postalStringDane odbiorcy: Kod pocztowy, format: xx-xxx
inpost_postal_toStringPaczkomat odbiorcy, np: ELB01A
wymagany: Tak, dla cennika Paczkomaty
taker_phoneStringDane odbiorcy: Telefon
taker_saveBooleanOkreśla dodanie odbiorcy do książki adresowej
package_contentStringZawartość paczki
stacjapaczka_id_stacjiStringNumer wybranej stacji, dla Courier.courier_type = stacjapaczka

Response

successBooleanOkreśla czy metoda wykonała się poprawnie czy z błędami
dataArraySzczegółowe parametry odpowiedzi serwera
CartOrderArraySzczegóły zamówienia
priceFloatCena brutto zamówienia
price_nettoFloatCena netto zamówienia
id_prefixStringNumer zamówienia
payment_urlStringURL płatności zamówienia
OrderArraySzczegóły paczek
[ ]Array
idIntegerID paczki
priceFloatCena brutto paczki
price_nettoFloatCena netto paczki