Vytvoří novou zásilku doručovanou kurýrem na adresu příjemce.
{
"receiver": {
"name": "Nazev prijemce / firma",
"firstname": "Krestni jmeno prijemce",
"surname": "Prijmeni prijemce",
"city": "Praha",
"street": "ulice 12",
"state": "CZ",
"postal_code": "11000"
},
"reference_number": "123456",
"package_count": 2,
"weight": 1.23,
"volumetric_weight": 1.23,
"value": 1.23,
"comment": "poznamka",
"product": "S-24-CZ"
}
Možné datové prvky požadavku:
| Název | Typ | Povinný | Popis | |
|---|---|---|---|---|
| receiver | object | definuje příjemce zásilky; v případě, že není použit One by Allegro produkt box nebo výdejní místo, je tento element povinný | ||
| external_id | string(255) | ne | identifikátor adresy z Aplikace Zásilky | |
| name | string(100) | ano | označení příjemce zásilky | |
| street | string(100) | ano | ulice + číslo popisné | |
| city | string(50) | ano | město | |
| postal_code | string(5) | ano | PSČ | |
| state | string(2) | ano | kód země dle ISO 3166-1; obchodní oddělení One by Allegro dodá seznam možných zemí | |
| firstname | string(30) | ne | křestní jméno | |
| surname | string(30) | ne | příjmení | |
| string(50) | ne | |||
| phone | string(15) | ne | telefon | |
| mobile | string(15) | ne | mobilní telefon | |
| fax | string(15) | ne | fax | |
| note | string(75) | ne | poznámka | |
| sender | object | povinný element v případě přímé zásilky (direct_order), definuje odesílatele zásilky | ||
| external_id | string(255) | ne | identifikátor adresy z Aplikace Zásilky | |
| name | string(100) | ano | označení příjemce zásilky | |
| street | string(100) | ano | ulice + číslo popisné | |
| city | string(50) | ano | město | |
| postal_code | string(5) | ano | PSČ | |
| state | string(2) | ano | kód země dle ISO 3166-1; obchodní oddělení One by Allegro dodá seznam možných zemí | |
| firstname | string(30) | ne | křestní jméno | |
| surname | string(30) | ne | příjmení | |
| string(50) | ne | |||
| phone | string(15) | ne | telefon | |
| mobile | string(15) | ne | mobilní telefon | |
| fax | string(15) | ne | fax | |
| note | string(75) | ne | poznámka | |
| reference_number | string(20) | ne | referenční číslo/ID zásilky | |
| reference_number2 | string(50) | ne | druhé referenční číslo/ID zásilky | |
| package_count | integer | ano | počet balíků v zásilce | |
| package_number | string(50) | ne | volitelné číslo balíku zákazníka; pokud je uvedeno, je nutné aby počet elementů odpovídal počtu balíku v elementu package_count | |
| weight | float | ano | celková váha zásilky v kg | |
| volumetric_weight | float | ne | celková volumetrická váha zásilky v kg | |
| value | float | ano | celková hodnota zásilky v CZK | |
| comment | string(255) | ne | poznámka | |
| additive | bool | ne | požadavek na umožnění dodatečného přidání/odebrání balíku do zásilky; pokud je uvedena hodnota Y, lze k této zásilce v budoucnu přidávat/odebírat balíky speciálním XML požadavkem | |
| product | string(255) | One by Allegro produkt, který má být použit při doručení zásilky; v případě, že element není vyplněn, je vybrán automaticky produkt odpovídající parametrům zásilky; seznam možných produktů lze vyžádat na obchodním oddělení One by Allegro | ||
| additional_service | object | seznam doplňkových služeb | ||
| cash_on_delivery | float | ne | hodnota dobírky v CZK | |
| reverse_order | bool | ne | požadavek na službu „zpětná zásilka“ | |
| direct_order | bool | ne | požadavek na službu „přímá zásilka“ | |
| exchange_order | bool | ne | požadavek na službu „výměnná zásilka“ | |
| exchange_order_note | string(255) | ne | poznámka ke službě výměnná zásilka | |
| document_back | bool | ne | požadavek na službu „dokumenty zpět“ | |
| dokument_back_note | string(255) | ne | poznámka ke službě „dokumenty zpět“ | |
| insurance | bool | ne | požadavek na službu „připojištění“ | |
| phone_notification | bool | ne | požadavek na službu „telefonické potvrzení doručení zásilky“ | |
| phone_notification_number | string(15) | ne | telefonní číslo pro „telefonické potvrzení doručení zásilky“ příjemci v mezinárodním formátu (např. 00420123456789) | |
| phone_notification_number_direct | string(15) | ne | telefonní číslo pro „telefonické potvrzení vyzvednutí zásilky u odesílatele“ v mezinárodním formátu (např. 00420123456789); využívá se pouze v případě přímé zásilky (direct_order) | |
| phone_notification_note | string(255) | ne | poznámka ke službě „telefonické potvrzení doručení zásilky“ | |
| sms_notification | bool | ne | požadavek na službu „SMS potvrzení doručení zásilky“ | |
| sms_notification_number | string(15) | ne | telefonní číslo pro „SMS potvrzení doručení zásilky“ příjemci v mezinárodním formátu (např. 00420123456789) | |
| sms_notification_number_direct | string(15) | ne | telefonní číslo pro „SMS potvrzení vyzvednutí zásilky u odesílatele“ v mezinárodním formátu (např. 00420123456789); využívá se pouze v případě přímé zásilky (direct_order) | |
| email_notification | bool | ne | požadavek na službu „emailové potvrzení doručení zásilky“ | |
| email_notification_address | string(50) | ne | adresa pro „emailové potvrzení doručení zásilky“ příjemci | |
| email_notification_address_direct | string(50) | ne | adresa pro „emailové potvrzení vyzvednutí zásilky u odesílatele“; využívá se pouze v případě přímé zásilky (direct_order) | |
| carry | bool | ne | požadavek na službu „donos“ | |
| loss | bool | ne | požadavek na službu odnos | |
| pay_by_receiver | bool | ne | požadavek na službu „dopravu platí příjemce“ | |
| authentication | bool | ne | požadavek na službu „ověření totožnosti příjemce“ | |
| authentication_note | string(255) | ne | poznámka ke službě „ověření totožnosti příjemce“ | |
| takeover | bool | ne | požadavek na službu „osobní odběr“ | |
| takeover_place | integer | ne | identifikátor požadovaného místa pro osobní odběr | |
Na úspěšný požadavek vrátí server odpoveď (pole prvků)
[
{
"reference_number": "123456",
"code": "0",
"sorting_code": "S1PR011",
"barcode": [
"007O00122407*001002",
"007O00122407*002002"
],
"delivery_price": 198.0,
"order_number": "00700122407",
"product_name": "S-24-CZ"
}
]