# Vytvoření zásilky ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /shipment/batch: post: summary: Vytvoření zásilky deprecated: false description: >- Metoda **shipment/batch** slouží k vytvoření požadavku na získání zásilky , nebo skupiny zásilek. Při zavolání metody je návratovou hodnotou **batchId**, které následně slouží pro získávání stavu zpracovaní zásilky a následně pro získání etikety. Batch id je v odpovědi zobrazeno v hlavičce (headers) Location. :::caution[] **BatchId** je globální unikátní identifikátor (GUID), který se generuje pro každé zavolání metody pro vytvoření zásilky a pro další jeho zpracování je potřeba si jej uchovat. Je zapsané jako 32 hexadecimálních znaků rozdělených čtyřmi pomlčkami. ::: operationId: CreateShipments tags: - API Metody/ShipmentBatch - ShipmentBatch parameters: - name: Accept-Language in: header description: 'Language specification, default language: cs-CZ' required: false example: '' schema: $ref: '#/components/schemas/AcceptLanguageSchema' - name: X-Correlation-ID in: header description: Correlation Id of request required: false example: '' schema: $ref: '#/components/schemas/XCorrelationIdSchema' - name: X-LogLevel in: header description: The forced log level required: false example: '' schema: $ref: '#/components/schemas/XLogLevelSchema' requestBody: content: application/json: schema: type: object x-apidog-refs: 01JJRGVTSVG0GK0PKGW5EPK5GE: $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel x-apidog-overrides: returnChannel: &ref_76 oneOf: - type: object x-apidog-refs: 01JJRHNTKDP5NAFX6B456GCKA0: &ref_81 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel x-apidog-overrides: type: &ref_0 oneOf: - &ref_104 $ref: >- #/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstReturnChannel - &ref_2 $ref: '#/components/schemas/EmptyNullableObject' description: >- Typ návratové cesty štítku. S FTP není podporováno! address: &ref_1 maxLength: 100 type: string description: >- Pokud je vybrán Type = Email, pak zde vyplňovat email adresu. Pokud je vybrán Type = Ftp, pak zde vyplňovat FTP cestu. Email formát: xxxxxxx@yyyy.zzz FTP formát: ftp://user:password@host:port/path Délka: 100 nullable: true x-apidog-orders: - 01JJRHNTKDP5NAFX6B456GCKA0 properties: type: *ref_0 address: *ref_1 description: |+ x-apidog-ignore-properties: - type - address - *ref_2 description: >- Sekce návratových hodnot pro tisk štítku. Pokud vyplníte returnChannel a typ email, tak Vám přijde pro každou požádanou zásilku etiketa na uvedený email. Toto nefunguje na testovacím prostředí. Využití má toto spíše pro return zásilky, kdy žadateli přijde na email rovnou vytvořená etiketa. Chodí ovšem prázdný email bez jakéhokoliv textu pouze s pdf etiketou. shipments: &ref_78 minItems: 1 type: array items: type: object x-apidog-refs: 01JJRHEXY3465HMD7GERSCWWPF: &ref_83 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentModel x-apidog-overrides: externalNumbers: &ref_67 type: array items: type: object x-apidog-refs: 01JJS433HGV9Z074G4MYVSEMJB: &ref_5 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel x-apidog-overrides: externalNumber: &ref_3 maxLength: 100 minLength: 1 type: string description: 'Externí číslo zásilky Délka: 50' code: &ref_4 minLength: 1 type: string description: >- Kód typu externího čísla podle číselníku codelist/externalNumber Délka: 4 required: - externalNumber - code x-apidog-orders: - 01JJS433HGV9Z074G4MYVSEMJB properties: externalNumber: *ref_3 code: *ref_4 required: - externalNumber - code x-apidog-ignore-properties: - externalNumber - code description: >- ExternalNumbers jsou externí čísla pro zákaznické identifikace. Např. číslo objednávky, nebo určitý kód zboží. Nejčastěji se používá code CUST jako zákaznické. Toto číslo se následně tiskne i přímo na etiketu a zároveň se propisuje zákazníkovi do fakturace. Více v codelist/externalNumbers nullable: true referenceId: &ref_54 maxLength: 128 minLength: 1 type: string description: Jedinečná reference productType: &ref_56 minLength: 1 type: string description: >- Typ produktu. Více informací o jednotlivých typech na codelist/product ageCheck: &ref_57 type: string description: Služba kontrola věku (15,18+), nullable: true integratorId: &ref_58 maximum: 2147483647 minimum: 1 type: integer description: 'ID integrátora – pouze pro typ: integrátor' format: int32 nullable: true shipmentSet: &ref_59 oneOf: - type: object x-apidog-refs: 01JJRT8K3ZR73CEVX7XPHMY6EN: &ref_86 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetFeatureModel x-apidog-overrides: numberOfShipments: &ref_11 maximum: 2147483647 minimum: 0 type: integer description: Počet balíků na adresu - Max 50 format: int32 shipmentSetItems: &ref_12 type: array items: type: object x-apidog-refs: 01JJRTMR57QB0F1XFXPZ0MKGKC: &ref_102 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetItemModel x-apidog-overrides: externalNumbers: &ref_9 type: array items: type: object x-apidog-refs: 01JJRTN73NCQSFRTFXTJPPQV65: *ref_5 x-apidog-orders: - 01JJRTN73NCQSFRTFXTJPPQV65 properties: externalNumber: maxLength: 100 minLength: 1 type: string description: 'Externí číslo zásilky Délka: 50' code: minLength: 1 type: string description: >- Kód typu externího čísla podle číselníku codelist/externalNumber. Při použití typu PRTE nebo PRBC musí mít etiketa rozměry 150 x 100 mm Délka: 4 required: - externalNumber - code x-apidog-ignore-properties: - externalNumber - code description: Externí číslo pro každý balík zvlášť nullable: true insurance: &ref_10 oneOf: - type: object x-apidog-refs: 01JJRTS886ES8X31TMEM719J29: &ref_43 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel x-apidog-overrides: insuranceCurrency: &ref_7 minLength: 1 type: string description: >- Pojištění může být pouze v rámci naší národní měny – CZK Délka: 3 1. Pokud je InsurCurrency vyplněné, pak musí být vyplněno i InsurPrice. 2. Pouze CZK insurancePrice: &ref_6 minimum: 0 type: number description: >- Cena na kterou chcete balík pojistit. Max limity - /codelist/servicePriceLimit Délka: 12,4 Zadává se zde cena balíku. Standardní pojištění zásilky se zde neuvádí (automaticky do hodnoty 50.000 Kč u balíku, 100.000 Kč balíky do zahraničí. 1. Pokud je InsurancePrice vyplněné, pak musí být vyplněno i InsuranceCurrency. 2. Částka nesmí být záporná ani nulová. 3. Částka může být maximálně viz /codelist/servicePriceLimit format: double required: - insuranceCurrency - insurancePrice x-apidog-orders: - 01JJRTS886ES8X31TMEM719J29 properties: insurancePrice: *ref_6 insuranceCurrency: *ref_7 required: - insurancePrice - insuranceCurrency x-apidog-ignore-properties: - insurancePrice - insuranceCurrency - *ref_2 description: >- Pojištění jednotlivých balíků. Použijte pokud máte v sadě více balíků z různými cenami, které chcete pojistit. shipmentNumber: &ref_8 type: string description: >- Číslo zásilky. V případě že zákazník chce používat své číselné řady je určeno pro použití číselných řad které jsou přiděleny PPL a z nich se čerpá. Jinak se nevyplňuje. nullable: true x-apidog-orders: - 01JJRTMR57QB0F1XFXPZ0MKGKC properties: shipmentNumber: *ref_8 weighedShipmentInfo: oneOf: - type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] - type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] externalNumbers: *ref_9 insurance: *ref_10 customs: type: array items: &ref_103 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CustomsDeclarationDataModel description: Data k celní deklaraci nullable: true x-apidog-ignore-properties: - shipmentNumber - weighedShipmentInfo - externalNumbers - insurance - customs description: >- Sada zásilek. Slouží především pro zadávání konkrétních vah a hodnot připojištění, pokud je v sadě více balíků. nullable: true required: - numberOfShipments x-apidog-orders: - 01JJRT8K3ZR73CEVX7XPHMY6EN properties: numberOfShipments: *ref_11 additionallyAdded: type: boolean description: Additionally added nullable: true shipmentSetItems: *ref_12 required: - numberOfShipments x-apidog-ignore-properties: - numberOfShipments - additionallyAdded - shipmentSetItems - *ref_2 description: Sada zásilek backAddress: &ref_60 oneOf: - type: object x-apidog-refs: 01JJRVME610ENG4FNBJBCKXG9B: &ref_87 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.BackAddressModel x-apidog-overrides: country: &ref_13 minLength: 1 type: string description: >- Kód země podle číselníku - /codelist/country Délka: 2 1. Pokud se jedná o mezinárodní zásilku (ProductType = COPL, BUED, IMPO, CONN, COND, SMEU, SMED), pak se země odesílatele nesmí rovnat země příjemce a zároveň je pak toto pole povinné. 2. Pokud se jedná o tuzemskou zásilku (ProductType = BUSS, BUSD, DOPD, DOPD, PRIV, PRID, RETD, SMAR, SMAD), pak se země odesílatele musí rovnat země příjemce phone: &ref_14 maxLength: 30 type: string description: |- Telefon Délka: 30 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true email: &ref_15 maxLength: 50 type: string description: |- Email Délka: 50 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true required: - country x-apidog-orders: - 01JJRVME610ENG4FNBJBCKXG9B properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: *ref_13 contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: *ref_14 email: *ref_15 required: - zipCode - country x-apidog-ignore-properties: - name - name2 - street - city - zipCode - country - contact - phone - email - *ref_2 description: |- Adresa pro vrácení nedoručených zásilek sender: &ref_61 oneOf: - type: object x-apidog-refs: 01JJRVPNSNANHARSCXFZ29F2A6: &ref_88 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderAddressModel x-apidog-overrides: country: &ref_19 minLength: 1 type: string description: >- Kód země podle číselníku - /codelist/country Délka: 2 1. Pokud se jedná o mezinárodní zásilku (ProductType = COPL, BUED, IMPO, CONN, COND, SMEU, SMED), pak se země odesílatele nesmí rovnat země příjemce a zároveň je pak toto pole povinné. 2. Pokud se jedná o tuzemskou zásilku (ProductType = BUSS, BUSD, DOPD, DOPD, PRIV, PRID, RETD, SMAR, SMAD), pak se země odesílatele musí rovnat země příjemce phone: &ref_20 maxLength: 30 type: string description: |- Telefon Délka: 30 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true email: &ref_21 maxLength: 50 type: string description: |- Email Délka: 50 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true name: &ref_16 maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true street: &ref_17 maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: &ref_18 maxLength: 50 type: string description: 'Město Délka: 50' nullable: true required: - country - name - street - city x-apidog-orders: - 01JJRVPNSNANHARSCXFZ29F2A6 properties: name: *ref_16 name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: *ref_17 city: *ref_18 zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: *ref_19 contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: *ref_20 email: *ref_21 required: - name - street - city - zipCode - country x-apidog-ignore-properties: - name - name2 - street - city - zipCode - country - contact - phone - email - *ref_2 description: Odesílatel zásilky senderMask: &ref_62 oneOf: - type: object x-apidog-refs: 01JJRVYWB70MMZNZA5TP9EK5VG: &ref_89 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderMaskAddressModel x-apidog-overrides: country: &ref_23 minLength: 1 type: string description: >- Kód země podle číselníku - /codelist/country Délka: 2 name2: &ref_22 maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true required: - country x-apidog-orders: - 01JJRVYWB70MMZNZA5TP9EK5VG properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: *ref_22 street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: *ref_23 contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: maxLength: 30 type: string description: 'Telefon Délka: 30' nullable: true email: maxLength: 50 type: string description: 'Email Délka: 50' nullable: true required: - zipCode - country x-apidog-ignore-properties: - name - name2 - street - city - zipCode - country - contact - phone - email - *ref_2 description: |- Odesílatel zásilky – Alternativní adresa (v případě jiného odesílatele na etiketě, než je v evidenci. recipient: &ref_63 type: object x-apidog-refs: 01JJRW38QCQ617JAWEJHB5TV6P: &ref_90 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.RecipientAddressModel x-apidog-overrides: name2: &ref_24 maxLength: 50 type: string description: >- Dodatek (Název firmy / jméno) Délka: 50 Kontaktní osoba V případě zásilky na Výdejní místo, zde uvádět kontakt příjemce (jméno nebo firma) nebo duplikovat nullable: true zipCode: &ref_25 maxLength: 10 minLength: 1 type: string description: |- PSČ Délka: 10 Vyjímka Irsko: Město kopírujte do PSČ GB dle vzoru: A9 9AA A99 9AA A9A 9AA AA9 9AA AA99 9AA AA9A 9AA NL dle vzoru: 1234 AA country: &ref_26 minLength: 1 type: string description: >- Kód země podle číselníku - /codelist/country Délka: 2 1. Pokud se jedná o mezinárodní zásilku (ProductType = COPL, BUED, IMPO, CONN, COND, SMEU, SMED), pak se země odesílatele nesmí rovnat země příjemce a zároveň je pak toto pole povinné. 2. Pokud se jedná o tuzemskou zásilku (ProductType = BUSS, BUSD, DOPD, DOPD, PRIV, PRID, RETD, SMAR, SMAD), pak se země odesílatele musí rovnat země příjemce contact: &ref_27 maxLength: 50 type: string description: >- Kontaktní osoba. Délka: 50 V případě zásilky na Výdejní místo, zde uvádět kontakt příjemce (jméno nebo firma) nebo duplikovat nullable: true phone: &ref_28 maxLength: 30 type: string description: >- Telefon Délka: 30 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true email: &ref_29 maxLength: 50 type: string description: >- Email Délka: 50 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true required: - zipCode - country x-apidog-orders: - 01JJRW38QCQ617JAWEJHB5TV6P properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: *ref_24 street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: *ref_25 country: *ref_26 contact: *ref_27 phone: *ref_28 email: *ref_29 description: Příjemce zásilky required: - zipCode - country x-apidog-ignore-properties: - name - name2 - street - city - zipCode - country - contact - phone - email specificDelivery: &ref_64 oneOf: - type: object x-apidog-refs: 01JJS2M6YJJFM3Y2VJXRRJ6Z5W: &ref_91 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.SpecificDeliveryFeatureModel x-apidog-overrides: parcelShopCode: &ref_34 type: string description: > Kód výdejního místa Délka: 50 1. ProductType pouze PRIV, PRID, CONN, COND, SMAR, SMAD, SBOX, SBOD !! 2. Validace proti seznamu, který vrací metoda AccessPoint nullable: true specificDeliveryDate: &ref_30 type: string description: Specifické datum doručení format: date-time nullable: true specificDeliveryTimeFrom: &ref_31 type: string description: Specifický čas doručení -Od format: date-time nullable: true specificDeliveryTimeTo: &ref_32 type: string description: Specifický čas doručení -Do format: date-time nullable: true specificTakeDate: &ref_33 type: string description: Specifické datum převzetí format: date-time nullable: true x-apidog-orders: - 01JJS2M6YJJFM3Y2VJXRRJ6Z5W properties: specificDeliveryDate: *ref_30 specificDeliveryTimeFrom: *ref_31 specificDeliveryTimeTo: *ref_32 specificTakeDate: *ref_33 parcelShopCode: *ref_34 x-apidog-ignore-properties: - specificDeliveryDate - specificDeliveryTimeFrom - specificDeliveryTimeTo - specificTakeDate - parcelShopCode - *ref_2 cashOnDelivery: &ref_65 oneOf: - type: object x-apidog-refs: 01JJS2SHPBNMRXVNF85BTWBW5B: &ref_92 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CashOnDeliveryFeatureModel x-apidog-overrides: iban: &ref_35 type: string description: >- IBAN Délka: 50 1. IBAN pokud je vyplněn, pak musí být vyplněno i pole SWIFT. 2. Pokud je vyplněno IBAN a SWIFT, pak nemůže být vyplněny BankAccount a BankCode nullable: true swift: &ref_36 type: string description: >- Swift Délka: 50 1. SWIFT, pokud je vyplněno, pak musí být vyplněno i pole IBAN. 2. Pokud je vyplněno IBAN a SWIFT, pak nemůže být vyplněny BankAccount a BankCode. 3. Validace podle Číselník SWIFT nullable: true specSymbol: &ref_37 maxLength: 6 type: string description: |- Specifický symbol Délka: 6 Omezení na 0-10 čísel nullable: true account: &ref_38 type: string description: >- Číslo bankovního účtu Délka: 10 1. BankAccount pokud je vyplněno, pak musí být vyplněno i pole BankCode. 2. Pokud je vyplněno BankAccount a BankCode, pak nemůže být vyplněn IBAN a SWIFT nullable: true bankCode: &ref_39 type: string description: >- Kód banky Délka: 4 1. BankCode pokud je vyplněn, pak musí být vyplněno i pole BankAccount. 2. Pokud je vyplněno BankAccount a BankCode, pak nemůže být vyplněn IBAN a SWIFT. 3. Validace podle Číselník bankovních kódů nullable: true codPrice: &ref_40 minimum: 0 type: number description: >- Částka dobírky. Částka je oddělena tečkou. Pouze kladné číslo. Pokud je v CZK a země CZ, pak zaokrouhlená na celé částky 1. Pokud je CodPrice vyplněné, pak musí být vyplněno i CodCurrency. Délka: 12.4 2. Částka nesmí být záporná. 3. max limity - /codelist/servicePriceLimit format: double codCurrency: &ref_41 minLength: 1 type: string description: >- Měna dobírky, povolené měny - /codelist/currency Délka: 3 1. Pokud je vyplněno CodCurrency, pak musí být vyplněno i CodPrice. 2. Validace podle Číselník měn codVarSym: &ref_42 maxLength: 10 minLength: 1 pattern: ^\d+ type: string description: > Variabilní symbol dobírky. POUZE čísla Délka: 10 Omezení na 0-10 čísel. Pokud jsou vyplněny elementy CodCurrency nebo CodPrice, pak CodVarSym musí být vyplněn. required: - codPrice - codCurrency - codVarSym x-apidog-orders: - 01JJS2SHPBNMRXVNF85BTWBW5B properties: iban: *ref_35 swift: *ref_36 specSymbol: *ref_37 account: *ref_38 accountPre: type: string description: 'Před číslo bankovního účtu Délka: 10' nullable: true bankCode: *ref_39 codPrice: *ref_40 codCurrency: *ref_41 codVarSym: *ref_42 required: - codPrice - codCurrency - codVarSym x-apidog-ignore-properties: - iban - swift - specSymbol - account - accountPre - bankCode - codPrice - codCurrency - codVarSym - *ref_2 description: >- Platební informace pro dobírkové produkty. Dobírka je vázána k produktu, pro to aby požadavek s dobírkou prošel je nutné zadat správný typ produktu v zásilce (PRID, BUSD, SMAD, COND, DOPD, SMED). insurance: &ref_66 oneOf: - type: object x-apidog-refs: 01JJS3R7414A376EMGY1FW40CA: *ref_43 x-apidog-orders: - 01JJS3R7414A376EMGY1FW40CA properties: insurancePrice: minimum: 0 type: number description: >- Cena na kterou chcete balík pojistit. Max limity - /codelist/servicePriceLimit Délka: 12,4 Zadává se zde cena balíku. Standardní pojištění zásilky se zde neuvádí (automaticky do hodnoty 50.000 Kč u balíku, 100.000 Kč balíky do zahraničí. 1. Pokud je InsurancePrice vyplněné, pak musí být vyplněno i InsuranceCurrency. 2. Částka nesmí být záporná ani nulová. 3. Částka může být maximálně viz /codelist/servicePriceLimit format: double insuranceCurrency: minLength: 1 type: string description: >- Pojištění může být pouze v rámci naší národní měny – CZK Délka: 3 1. Pokud je InsurCurrency vyplněné, pak musí být vyplněno i InsurPrice. 2. Pouze CZK required: - insurancePrice - insuranceCurrency x-apidog-ignore-properties: - insurancePrice - insuranceCurrency - *ref_2 description: >- Pojištění balíků. Přidává pojištění pro balík nebo balíky v zásilce. Používejte pokud máte jeden balík v zásilce nebo více balíků se stejnou cenou v sadě. Pro balíky v sadě které mají různou cenu pro které chcete pojištění zadejte insurance v shipmentSetItems. services: &ref_68 type: array items: type: object x-apidog-refs: 01JJS49WTGCBMXV48BPPJQVK90: &ref_93 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ServiceModel x-apidog-overrides: code: &ref_44 minLength: 1 type: string description: > Kód služby - Validace podle /codelist/service Délka: 4 required: - code x-apidog-orders: - 01JJS49WTGCBMXV48BPPJQVK90 properties: code: *ref_44 required: - code x-apidog-ignore-properties: - code description: Služby nullable: true dormant: &ref_69 oneOf: - type: object x-apidog-refs: 01JJS4FYJFM29G4EY3QRM7TGCX: &ref_94 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantShipmentModel x-apidog-overrides: recipient: &ref_50 oneOf: - type: object x-apidog-refs: 01JJS4GDFZEQ8EPFYWF5PZV9P6: &ref_98 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantRecipientAddressModel x-apidog-overrides: country: &ref_45 minLength: 1 type: string description: >- Kód země podle číselníku - /codelist/country Délka: 2 1. Validace podle Číselník zemí 2. Pokud se jedná o mezinárodní zásilku (PackProductType = COPL, BUED, IMPO, CONN, COND, SMEU,SMED), pak se země odesílatele nesmí rovnat země příjemce a zároveň je pak toto pole povinné. 3. Pokud se jedná o tuzemskou zásilku (PackProductType = BUSS, BUSD, DOPD, DOPD, PRIV, PRID, RETD,SMAR, SMAD), pak se země odesílatele musí rovnat země příjemce. phone: &ref_46 maxLength: 30 type: string description: |- Telefon Délka: 30 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true email: &ref_47 maxLength: 50 type: string description: |- Email Délka: 50 Vyplněný kontaktní údaj výrazně zvyšuje úspěšnost doručení nullable: true required: - country x-apidog-orders: - 01JJS4GDFZEQ8EPFYWF5PZV9P6 properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: *ref_45 contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: *ref_46 email: *ref_47 required: - zipCode - country x-apidog-ignore-properties: - name - name2 - street - city - zipCode - country - contact - phone - email - *ref_2 externalNumbers: &ref_51 type: array items: type: object x-apidog-refs: 01JJS50J2RE0KDP1HZ4Z8NYDA2: &ref_99 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantExternalNumberModel x-apidog-overrides: code: &ref_48 minLength: 1 type: string description: >- Kód typu externího čísla podle číselníku codelist/externalNumber Délka: 4 Validace podle Číselník typ externích čísel required: - code x-apidog-orders: - 01JJS50J2RE0KDP1HZ4Z8NYDA2 properties: externalNumber: maxLength: 100 minLength: 1 type: string description: 'Externí číslo zásilky Délka: 50' code: *ref_48 required: - externalNumber - code x-apidog-ignore-properties: - externalNumber - code description: Externí čísla nullable: true services: &ref_52 type: array items: type: object x-apidog-refs: 01JJS52EZP2RRASF9YMZ4NYGGK: &ref_100 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantServiceModel x-apidog-overrides: code: &ref_49 minLength: 1 type: string description: >- Kód služby - /codelist/service Délka: 4 Služby vázány na daný produkt viz Číselník služeb. required: - code x-apidog-orders: - 01JJS52EZP2RRASF9YMZ4NYGGK properties: code: *ref_49 required: - code x-apidog-ignore-properties: - code description: Služby nullable: true x-apidog-orders: - 01JJS4FYJFM29G4EY3QRM7TGCX properties: shipmentNumber: type: string description: Číslo zásilky nullable: true note: type: string description: 'Poznámka Délka: 300' nullable: true recipient: *ref_50 externalNumbers: *ref_51 services: *ref_52 weighedShipmentInfo: oneOf: - &ref_101 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantWeighedShipmentFeatureModel - *ref_2 x-apidog-ignore-properties: - shipmentNumber - note - recipient - externalNumbers - services - weighedShipmentInfo - *ref_2 directInjection: &ref_70 oneOf: - &ref_96 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.DirectInjectionFeatureModel - *ref_2 description: >- Využito v případě přímého závozu zásilek do zahraničního depa. Musí být dohodnuto a přiděleno obch. zástupcem. labelService: &ref_71 oneOf: - type: object x-apidog-refs: 01JJS56PE6NZFFTNKN9C28497K: &ref_97 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelServiceModel x-apidog-overrides: labelless: &ref_53 type: boolean description: >- true / false Možnost volby tisku label / QR kód se smart PIN. Defaultně label. Pro QR je nutné nejprve kontaktovat obchodního zástupce k nastavení x-apidog-orders: - 01JJS56PE6NZFFTNKN9C28497K properties: labelless: *ref_53 x-apidog-ignore-properties: - labelless - *ref_2 shipmentNumber: &ref_55 type: string description: >- Uvadí se zde vlastní číslo zásilky. V případě přání na generovaní vlastních čísel zásilek, PPL poskytne zákazníkovi číselnou řadu v daném rozsahu a zákazník si může generovat čísla zásilek sám. nullable: true required: - referenceId - productType - recipient x-apidog-orders: - 01JJRHEXY3465HMD7GERSCWWPF properties: referenceId: *ref_54 shipmentNumber: *ref_55 productType: *ref_56 note: type: string description: 'Poznámka Délka: 300' nullable: true depot: type: string description: 'Nepoužívat. Délka: 2' nullable: true ageCheck: *ref_57 integratorId: *ref_58 shipmentSet: *ref_59 backAddress: *ref_60 sender: *ref_61 senderMask: *ref_62 recipient: *ref_63 specificDelivery: *ref_64 cashOnDelivery: *ref_65 insurance: *ref_66 externalNumbers: *ref_67 services: *ref_68 dormant: *ref_69 shipmentRouting: oneOf: - &ref_95 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentRoutingModel - *ref_2 directInjection: *ref_70 labelService: *ref_71 description: Informace k zásilkám required: - referenceId - productType - recipient x-apidog-ignore-properties: - referenceId - shipmentNumber - productType - note - depot - ageCheck - integratorId - shipmentSet - backAddress - sender - senderMask - recipient - specificDelivery - cashOnDelivery - insurance - externalNumbers - services - dormant - shipmentRouting - directInjection - labelService description: Zásilky labelSettings: &ref_77 oneOf: - type: object x-apidog-refs: 01JJRRDYBPNZ112F0FED0RN8YM: &ref_82 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel x-apidog-overrides: completeLabelSettings: &ref_75 oneOf: - type: object x-apidog-refs: 01JJRRF8V6YHC360ED8DYT25B5: &ref_85 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelSettingsModel x-apidog-overrides: isCompleteLabelRequested: &ref_72 type: boolean description: >- pokud je true vygeneruje URL se všemi štítky do jednoho souboru (max 1000 štítků per request; max 50 kusů na zásilku) pageSize: &ref_73 $ref: >- #/components/schemas/Eps.Api.MyApi2.Business.Enums.ConstPageSize description: Pouze jedá hodnota - "A4" position: &ref_74 maximum: 4 minimum: 1 type: integer format: int32 description: Pro A4 je pozice v rozmezí 1-4 nullable: true x-apidog-orders: - 01JJRRF8V6YHC360ED8DYT25B5 properties: isCompleteLabelRequested: *ref_72 pageSize: *ref_73 position: *ref_74 x-apidog-ignore-properties: - isCompleteLabelRequested - pageSize - position - *ref_2 description: |- ZPL kodování base64, více etiket v jedné odpovědi x-apidog-orders: - 01JJRRDYBPNZ112F0FED0RN8YM properties: format: &ref_84 $ref: >- #/components/schemas/Eps.Api.MyApi2.Web.Constants.ConstLabelFormat dpi: maximum: 1200 minimum: 203 type: integer description: Volba DPI pro ZPL format: int32 nullable: true completeLabelSettings: *ref_75 x-apidog-ignore-properties: - format - dpi - completeLabelSettings - *ref_2 description: labbelSettings slouží pro definici parametrů štítků shipmentsOrderBy: &ref_79 type: string description: Řazení etiket - ReferenceId, ShipmentNumber nullable: true required: - shipments x-apidog-orders: - 01JJRGVTSVG0GK0PKGW5EPK5GE properties: returnChannel: *ref_76 labelSettings: *ref_77 shipments: *ref_78 shipmentsOrderBy: *ref_79 required: - shipments x-apidog-ignore-properties: - returnChannel - labelSettings - shipments - shipmentsOrderBy example: |- { "returnChannel": { "type": "", "address": "" }, "labelSettings": { "format": "", "dpi": "", "completeLabelSettings": { "isCompleteLabelRequested": "", "pageSize": "", "position": "" } }, "shipments": [ { "productType": "", "referenceId": "", "shipmentNumber": "", "note": "", "depot": "", "ageCheck": "", "integratorId": "", "shipmentSet": { "numberOfShipments": "", "additionallyAdded": "", "shipmentSetItems": [ { "shipmentNumber": "", "weighedShipmentInfo": { "weight": "" }, "externalNumbers": [ { "code": "", "externalNumber": "" }, { "code": "", "externalNumber": "" } ], "insurance": { "insuranceCurrency": "", "insurancePrice": "" } }, { "shipmentNumber": "", "weighedShipmentInfo": { "weight": "" }, "externalNumbers": [ { "code": "", "externalNumber": "" }, { "code": "", "externalNumber": "" } ], "insurance": { "insuranceCurrency": "", "insurancePrice": "" } } ] }, "backAddress": { "country": "", "zipCode": "", "name": "", "name2": "", "street": "", "city": "", "contact": "", "phone": "", "email": "" }, "sender": { "country": "", "zipCode": "", "name": "", "name2": "", "street": "", "city": "", "contact": "", "phone": "", "email": "" }, "senderMask": { "country": "", "zipCode": "", "name": "", "name2": "", "street": "", "city": "", "contact": "", "phone": "", "email": "" }, "recipient": { "country": "", "zipCode": "", "name": "", "name2": "", "street": "", "city": "", "contact": "", "phone": "", "email": "" }, "specificDelivery": { "specificDeliveryDate": "", "specificDeliveryTimeFrom": "", "specificDeliveryTimeTo": "", "specificTakeDate": "", "parcelShopCode": "" }, "cashOnDelivery": { "codCurrency": "", "codPrice": "", "codVarSym": "088919", "iban": "", "swift": "", "specSymbol": "", "account": "", "accountPre": "", "bankCode": "" }, "insurance": { "insuranceCurrency": "", "insurancePrice": "" }, "externalNumbers": [ { "code": "", "externalNumber": "" }, { "code": "", "externalNumber": "" } ], "services": [ { "code": "" }, { "code": "" } ], "dormant": { "shipmentNumber": "", "note": "", "recipient": { "country": "", "zipCode": "", "name": "", "name2": "", "street": "", "city": "", "contact": "", "phone": "", "email": "" }, "externalNumbers": [ { "code": "", "externalNumber": "" }, { "code": "", "externalNumber": "" } ], "services": [ { "code": "" }, { "code": "" } ], "shipmentRouting": { "inputRouteCode": "28696" }, "directInjection": { "directAddressing": "", "gatewayZipCode": "", "gatewayCity": "", "country": "" }, "labelService": { "labelless": "" } } ], "shipmentsOrderBy": "" } responses: '201': description: Created content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] example: >+ //Pokud metoda GET/shipment/batch volá více zásilek a vrátí se jí chyba v podobě statusu 400, je chybná zásilka zobrazena v errors, kdy pořadí zásilky určuje číslo v závorce [1] počítáno od 0. { "errors": { "shipments[1].ProductType": [ "Invalid value" ] }, "type": "https://asp.net/core", "title": "One or more validation errors occurred.", "status": 400, "detail": "Please refer to the errors property for additional details.", "instance": "/shipment/batch" } headers: X-Correlation-ID: description: Correlation Id of request otherwise id of response schema: $ref: '#/components/schemas/XCorrelationIdSchema' Location: description: 'Součástí location je BatchId které je v uuid formátu ' schema: type: string x-apidog-name: Created '400': description: BadRequest content: application/problem+json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true x-apidog-orders: - 01JJRGKSRNH86MD5052ETQF9TZ x-apidog-refs: 01JJRGKSRNH86MD5052ETQF9TZ: &ref_80 $ref: >- #/components/schemas/Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel x-apidog-ignore-properties: - errors - type - title - status - detail - instance headers: {} x-apidog-name: Bad Request '500': description: InternalServerError content: application/problem+json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true x-apidog-orders: - 01JJRGM11N0GXNHJCYS291PT19 x-apidog-refs: 01JJRGM11N0GXNHJCYS291PT19: *ref_80 x-apidog-ignore-properties: - errors - type - title - status - detail - instance headers: {} x-apidog-name: Server Error '503': description: ServiceUnavailable content: application/problem+json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true x-apidog-orders: - 01JJRGM6ZDXRZDKRJFHZVQ8B3A x-apidog-refs: 01JJRGM6ZDXRZDKRJFHZVQ8B3A: *ref_80 x-apidog-ignore-properties: - errors - type - title - status - detail - instance headers: {} x-apidog-name: Service Unavailable security: [] x-apidog-folder: API Metody/ShipmentBatch x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/796227/apis/api-13465914-run components: schemas: AcceptLanguageSchema: type: string description: Accept-Language header schema x-apidog-folder: '' XCorrelationIdSchema: type: string description: X-Correlation-ID header schema x-apidog-folder: '' XLogLevelSchema: enum: - Trace - Debug - Information - Warning - Error - Critical type: string description: X-LogLevel header schema x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel: required: - shipments type: object properties: returnChannel: oneOf: - *ref_81 - *ref_2 labelSettings: oneOf: - *ref_82 - *ref_2 shipments: minItems: 1 type: array items: *ref_83 description: Zásilky shipmentsOrderBy: type: string description: Order by nullable: true additionalProperties: false description: CreateShipmentBatchModel x-apidog-orders: - returnChannel - labelSettings - shipments - shipmentsOrderBy x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Constants.ConstLabelFormat: enum: - Zpl - Pdf - Jpeg - Png - Svg type: string description: Label format x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel: type: object properties: format: *ref_84 dpi: maximum: 1200 minimum: 203 type: integer description: Volba DPI pro ZPL format: int32 nullable: true completeLabelSettings: oneOf: - *ref_85 - *ref_2 additionalProperties: false description: LabelSettingsModel x-apidog-orders: - format - dpi - completeLabelSettings x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelSettingsModel: type: object properties: isCompleteLabelRequested: type: boolean description: IsCompleteLabelRequested pageSize: *ref_73 position: maximum: 4 minimum: 1 type: integer description: Position format: int32 nullable: true additionalProperties: false description: CompleteLabelSettingsModel x-apidog-orders: - isCompleteLabelRequested - pageSize - position x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Business.Enums.ConstPageSize: enum: - Default - A4 type: string x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentRoutingModel: type: object properties: inputRouteCode: pattern: ^(([0-9]){5})$ type: string description: 'Nepoužívá se Délka: 5' nullable: true additionalProperties: false description: ShipmentRoutingModel x-apidog-orders: - inputRouteCode x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentModel: required: - referenceId - productType - recipient type: object properties: referenceId: maxLength: 128 minLength: 1 type: string description: Jedinečná reference! shipmentNumber: type: string description: Číslo zásilky nullable: true productType: minLength: 1 type: string description: Typ produktu note: type: string description: 'Poznámka Délka: 300' nullable: true depot: type: string description: 'Nepoužívat. Délka: 2' nullable: true ageCheck: type: string description: Služba kontrola věku (15,18+) nullable: true integratorId: maximum: 2147483647 minimum: 1 type: integer description: 'ID integrátora – pouze pro typ: integrátor' format: int32 nullable: true shipmentSet: oneOf: - *ref_86 - *ref_2 backAddress: oneOf: - *ref_87 - *ref_2 sender: oneOf: - *ref_88 - *ref_2 senderMask: oneOf: - *ref_89 - *ref_2 recipient: *ref_90 specificDelivery: oneOf: - *ref_91 - *ref_2 cashOnDelivery: oneOf: - *ref_92 - *ref_2 insurance: oneOf: - *ref_43 - *ref_2 externalNumbers: type: array items: *ref_5 description: Externí čísla nullable: true services: type: array items: *ref_93 description: Služby nullable: true dormant: oneOf: - *ref_94 - *ref_2 shipmentRouting: oneOf: - *ref_95 - *ref_2 directInjection: oneOf: - *ref_96 - *ref_2 labelService: oneOf: - *ref_97 - *ref_2 additionalProperties: false description: ShipmentModel x-apidog-orders: - referenceId - shipmentNumber - productType - note - depot - ageCheck - integratorId - shipmentSet - backAddress - sender - senderMask - recipient - specificDelivery - cashOnDelivery - insurance - externalNumbers - services - dormant - shipmentRouting - directInjection - labelService x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelServiceModel: type: object properties: labelless: type: boolean description: true / false additionalProperties: false description: LabelServiceModel x-apidog-orders: - labelless x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.DirectInjectionFeatureModel: type: object properties: directAddressing: type: boolean description: true / false gatewayZipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' nullable: true gatewayCity: maxLength: 35 minLength: 1 type: string description: 'Město Délka: 35' nullable: true country: minLength: 1 type: string description: 'Země Délka: 2' nullable: true additionalProperties: false description: DirectInjectionFeatureModel x-apidog-orders: - directAddressing - gatewayZipCode - gatewayCity - country x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantWeighedShipmentFeatureModel: type: object properties: weight: minimum: 0 type: number description: 'Váha zásilky deklarovaná odesílatelem. Délka: 9,2' format: double nullable: true additionalProperties: false description: DormantWeighedShipmentFeatureModel x-apidog-orders: - weight x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantShipmentModel: type: object properties: shipmentNumber: type: string description: Číslo zásilky nullable: true note: type: string description: 'Poznámka Délka: 300' nullable: true recipient: oneOf: - *ref_98 - *ref_2 externalNumbers: type: array items: *ref_99 description: Externí čísla nullable: true services: type: array items: *ref_100 description: Služby nullable: true weighedShipmentInfo: oneOf: - *ref_101 - *ref_2 additionalProperties: false description: DormantShipmentModel x-apidog-orders: - shipmentNumber - note - recipient - externalNumbers - services - weighedShipmentInfo x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantServiceModel: required: - code type: object properties: code: minLength: 1 type: string description: 'Kód služby - /codelist/service Délka: 4' additionalProperties: false description: DormantServiceModel x-apidog-orders: - code x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantExternalNumberModel: required: - externalNumber - code type: object properties: externalNumber: maxLength: 100 minLength: 1 type: string description: 'Externí číslo zásilky Délka: 50' code: minLength: 1 type: string description: >- Kód typu externího čísla podle číselníku codelist/externalNumber Délka: 4 additionalProperties: false description: DormantExternalNumberModel x-apidog-orders: - externalNumber - code x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantRecipientAddressModel: required: - zipCode - country type: object properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: minLength: 1 type: string description: 'Kód země podle číselníku - /codelist/country Délka: 2' contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: maxLength: 30 type: string description: 'Telefon Délka: 30' nullable: true email: maxLength: 50 type: string description: 'Email Délka: 50' nullable: true additionalProperties: false description: DormantRecipientAddressModel x-apidog-orders: - name - name2 - street - city - zipCode - country - contact - phone - email x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ServiceModel: required: - code type: object properties: code: minLength: 1 type: string description: 'Kód služby - /codelist/service Délka: 4' additionalProperties: false description: ServiceModel x-apidog-orders: - code x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.CashOnDeliveryFeatureModel: required: - codPrice - codCurrency - codVarSym type: object properties: iban: type: string description: 'IBAN Délka: 50' nullable: true swift: type: string description: 'Swift Délka: 50' nullable: true specSymbol: maxLength: 6 type: string description: 'Specifický symbol Délka: 6' nullable: true account: type: string description: 'Číslo bankovního účtu Délka: 10' nullable: true accountPre: type: string description: 'Před číslo bankovního účtu Délka: 10' nullable: true bankCode: type: string description: 'Kód banky Délka: 4' nullable: true codPrice: minimum: 0 type: number description: "Částka dobírky.\r\n1. Pokud je CodPrice vyplněné, pak musí být vyplněno i CodCurrency. Délka: 12.4\r\n2. Částka nesmí být záporná.\r\n3. max limity - /codelist/servicePriceLimit" format: double codCurrency: minLength: 1 type: string description: 'Měna dobírky, povolené měny - /codelist/currency Délka: 3' codVarSym: maxLength: 10 minLength: 1 pattern: ^\d+ type: string description: 'Variabilní symbol dobírky. POUZE čísla Délka: 30' additionalProperties: false description: CashOnDeliveryFeatureModel x-apidog-orders: - iban - swift - specSymbol - account - accountPre - bankCode - codPrice - codCurrency - codVarSym x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.SpecificDeliveryFeatureModel: type: object properties: specificDeliveryDate: type: string description: SpecificDeliveryDate format: date-time nullable: true specificDeliveryTimeFrom: type: string description: SpecificDeliveryTimeFrom format: date-time nullable: true specificDeliveryTimeTo: type: string description: SpecificDeliveryTimeTo format: date-time nullable: true specificTakeDate: type: string description: SpecificTakeDate format: date-time nullable: true parcelShopCode: type: string description: 'Kód výdejního místa Délka: 50' nullable: true additionalProperties: false description: SpecificDeliveryFeatureModel x-apidog-orders: - specificDeliveryDate - specificDeliveryTimeFrom - specificDeliveryTimeTo - specificTakeDate - parcelShopCode x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.RecipientAddressModel: required: - zipCode - country type: object properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: minLength: 1 type: string description: 'Kód země podle číselníku - /codelist/country Délka: 2' contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: maxLength: 30 type: string description: 'Telefon Délka: 30' nullable: true email: maxLength: 50 type: string description: 'Email Délka: 50' nullable: true additionalProperties: false description: RecipientAddressModel x-apidog-orders: - name - name2 - street - city - zipCode - country - contact - phone - email x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderMaskAddressModel: required: - zipCode - country type: object properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: minLength: 1 type: string description: 'Kód země podle číselníku - /codelist/country Délka: 2' contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: maxLength: 30 type: string description: 'Telefon Délka: 30' nullable: true email: maxLength: 50 type: string description: 'Email Délka: 50' nullable: true additionalProperties: false description: SenderMaskAddressModel x-apidog-orders: - name - name2 - street - city - zipCode - country - contact - phone - email x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderAddressModel: required: - zipCode - country type: object properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: minLength: 1 type: string description: 'Kód země podle číselníku - /codelist/country Délka: 2' contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: maxLength: 30 type: string description: 'Telefon Délka: 30' nullable: true email: maxLength: 50 type: string description: 'Email Délka: 50' nullable: true additionalProperties: false description: SenderAddressModel x-apidog-orders: - name - name2 - street - city - zipCode - country - contact - phone - email x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.BackAddressModel: required: - zipCode - country type: object properties: name: maxLength: 50 type: string description: 'Název firmy / jméno Délka: 50' nullable: true name2: maxLength: 50 type: string description: 'Dodatek (Název firmy / jméno) Délka: 50' nullable: true street: maxLength: 60 type: string description: 'Ulice Délka: 60' nullable: true city: maxLength: 50 type: string description: 'Město Délka: 50' nullable: true zipCode: maxLength: 10 minLength: 1 type: string description: 'PSČ Délka: 10' country: minLength: 1 type: string description: 'Kód země podle číselníku - /codelist/country Délka: 2' contact: maxLength: 50 type: string description: 'Kontaktní osoba. Délka: 50' nullable: true phone: maxLength: 30 type: string description: 'Telefon Délka: 30' nullable: true email: maxLength: 50 type: string description: 'Email Délka: 50' nullable: true additionalProperties: false description: BackAddressModel x-apidog-orders: - name - name2 - street - city - zipCode - country - contact - phone - email x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetFeatureModel: required: - numberOfShipments type: object properties: numberOfShipments: maximum: 2147483647 minimum: 0 type: integer description: Počet balíků na adresu - Max 50 format: int32 additionallyAdded: type: boolean description: Additionally added nullable: true shipmentSetItems: type: array items: *ref_102 description: Shipment set items nullable: true additionalProperties: false description: Shipment set x-apidog-orders: - numberOfShipments - additionallyAdded - shipmentSetItems x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.CustomsDeclarationDataModel: required: - hsCode - quantity - itemWeight - currency - description type: object properties: hsCode: maxLength: 13 minLength: 6 type: string description: Kód harmonizovaného systém quantity: maximum: 2147483647 minimum: 1 type: integer description: Množství položek format: int32 itemWeight: maximum: 9999999.999 minimum: 0.001 type: number description: Váha format: double value: maximum: 99999999.99 minimum: 0.01 type: number description: Hodnota položky format: double nullable: true currency: maxLength: 3 minLength: 3 type: string description: Měna description: maxLength: 100 minLength: 1 type: string description: Popis additionalProperties: false description: Customs declaration data model x-apidog-orders: - hsCode - quantity - itemWeight - value - currency - description x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetItemModel: type: object properties: shipmentNumber: type: string description: Číslo zásilky nullable: true weighedShipmentInfo: oneOf: - type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] - type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] externalNumbers: type: array items: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] description: Externí číslo pro každý balík zvlášť nullable: true insurance: oneOf: - type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] - type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] customs: type: array items: *ref_103 description: Data k celní deklaraci nullable: true additionalProperties: false description: Kus x-apidog-orders: - shipmentNumber - weighedShipmentInfo - externalNumbers - insurance - customs x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel: required: - insurancePrice - insuranceCurrency type: object properties: insurancePrice: minimum: 0 type: number description: >- Částka připojištění. Max limity - /codelist/servicePriceLimit Délka: 12,4 format: double insuranceCurrency: minLength: 1 type: string description: 'Připojištění může být pouze v rámci naší národní měny – CZK Délka: 3' additionalProperties: false description: InsuranceFeatureModel x-apidog-orders: - insurancePrice - insuranceCurrency x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel: required: - externalNumber - code type: object properties: externalNumber: maxLength: 100 minLength: 1 type: string description: 'Externí číslo zásilky Délka: 50' code: minLength: 1 type: string description: >- Kód typu externího čísla podle číselníku codelist/externalNumber Délka: 4 additionalProperties: false description: ExternalNumberModel x-apidog-orders: - externalNumber - code x-apidog-ignore-properties: [] x-apidog-folder: '' Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel: type: object properties: type: oneOf: - *ref_104 - *ref_2 address: maxLength: 100 type: string description: >- Pokud je vybrán Type = Email, pak zde vyplňovat email příjemce etikety Délka: 100 nullable: true additionalProperties: false description: ReturnChannelModel x-apidog-orders: - type - address x-apidog-ignore-properties: [] x-apidog-folder: '' EmptyNullableObject: description: Injected nullable object type: 'null' x-apidog-folder: '' Eps.Api.MyApi2.Business.Enums.ConstReturnChannel: enum: - None - Email - Ftp type: string x-apidog-folder: '' Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel: type: object properties: errors: type: object additionalProperties: type: array items: type: string x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] nullable: true type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: type: string x-apidog-orders: - errors - type - title - status - detail - instance x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: oauth2: type: apikey description: Get access token from authentication server. name: Authorization in: header Bearer: type: jwt description: >- JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}" scheme: bearer bearerFormat: JWT servers: [] security: [] ```