Vytvoří novou zásilku uloženou na výdejním místě, kde si ji příjemce může vyzvednout.
{
"receiver": {
"city": "Praha",
"street": "ulice",
"state": "CZ",
"postal_code": "11000"
},
"reference_number": "123456",
"package_count": 1,
"weight": 1.23,
"volumetric_weight": 1.23,
"value": 1.23,
"comment": "poznamka",
"product": "PUP",
"pup_branch": "VM00075",
"pup_contact": "+420777112233"
}
Možné datové prvky požadavku:
| Název | Typ | Povinný | Popis | |
|---|---|---|---|---|
| receiver | object | definuje příjemce zásilky; v případě, doručení na výdejní místo je tento element nepovinný (ale pouze doporučovaný) | ||
| 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) | Produkt, který má být použit při doručení zásilky; v případě doručení na výdejní místo povinné zvolit správný produkt; seznam možných produktů lze vyžádat na obchodním oddělení One by Allegro | ||
| pup_branch | string(10) | Kód výdejního místa; povinné pole, pokud je produktem doručení na výdejní místo | ||
| pup_contact | string(15) | české mobilní telefon příjemce zásilky doručené na výdejní místo; povinné pole, pokud je produktem doručení na výdejní místo | ||
| additional_service | object | seznam doplňkových služeb | ||
| cash_on_delivery | float | ne | hodnota dobírky v CZK | |
| direct_order | bool | ne | požadavek na službu „přímá zásilka“ | |
| insurance | bool | ne | požadavek na službu „připojištění“ | |
| 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) | |
Na úspěšný požadavek vrátí server odpoveď (pole prvků)
[
{
"reference_number": "123456",
"code": "0",
"sorting_code": "S330120",
"barcode": "007I00122408*001001",
"delivery_price": 55.0,
"order_number": "00700122408",
"product_name": "PUP"
}
]