sREST API - One by Allegro - dokumentace

One Point

Vytvoří novou zásilku uloženou na výdejním místě, kde si ji příjemce může vyzvednout.

Request

POST /package


{
  "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ázevTypPovinnýPopis
receiverobjectdefinuje příjemce zásilky; v případě, doručení na výdejní místo je tento element nepovinný (ale pouze doporučovaný)
external_idstring(255)neidentifikátor adresy z Aplikace Zásilky
namestring(100)anooznačení příjemce zásilky
streetstring(100)anoulice + číslo popisné
citystring(50)anoměsto
postal_codestring(5)anoPSČ
statestring(2)anokód země dle ISO 3166-1; obchodní oddělení One by Allegro dodá seznam možných zemí
firstnamestring(30)nekřestní jméno
surnamestring(30)nepříjmení
emailstring(50)neemail
phonestring(15)netelefon
mobilestring(15)nemobilní telefon
faxstring(15)nefax
notestring(75)nepoznámka
senderobjectpovinný element v případě přímé zásilky (direct_order), definuje odesílatele zásilky
external_idstring(255)neidentifikátor adresy z Aplikace Zásilky
namestring(100)anooznačení příjemce zásilky
streetstring(100)anoulice + číslo popisné
citystring(50)anoměsto
postal_codestring(5)anoPSČ
statestring(2)anokód země dle ISO 3166-1; obchodní oddělení One by Allegro dodá seznam možných zemí
firstnamestring(30)nekřestní jméno
surnamestring(30)nepříjmení
emailstring(50)neemail
phonestring(15)netelefon
mobilestring(15)nemobilní telefon
faxstring(15)nefax
notestring(75)nepoznámka
reference_numberstring(20)nereferenční číslo/ID zásilky
reference_number2string(50)nedruhé referenční číslo/ID zásilky
package_countintegeranopočet balíků v zásilce
package_numberstring(50)nevolitelné čí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
weightfloatanocelková váha zásilky v kg
volumetric_weightfloatnecelková volumetrická váha zásilky v kg
valuefloatanocelková hodnota zásilky v CZK
commentstring(255)nepoznámka
additiveboolnepož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
productstring(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_branchstring(10)Kód výdejního místa; povinné pole, pokud je produktem doručení na výdejní místo
pup_contactstring(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_serviceobjectseznam doplňkových služeb
cash_on_deliveryfloatnehodnota dobírky v CZK
direct_orderboolnepožadavek na službu „přímá zásilka“
insuranceboolnepožadavek na službu „připojištění“
email_notificationboolnepožadavek na službu „emailové potvrzení doručení zásilky“
email_notification_addressstring(50)neadresa pro „emailové potvrzení doručení zásilky“ příjemci
email_notification_address_directstring(50)neadresa pro „emailové potvrzení vyzvednutí zásilky u odesílatele“; využívá se pouze v případě přímé zásilky (direct_order)

Response

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"
        }
    ]