{"openapi":"3.0.0","info":{"contact":{"email":"info@dpd.cz","name":"DPD CZ","url":"https://www.dpd.com/cz/cs/"},"description":"This documentations describes what the GeoAPI is and how to use it properly.\n\n**What is GeoAPI**\n\nThe GeoAPI allows DPD customers to manage (CRUD) their shipments and shipment related data.\n\nThe main purpose of the API is to provide the customer the means for:\n\n  - Creating and managing new shipments\n  - Ordering pickups for parcels\n  - Printing parcel labels\n  - Listing all available shipping services\n  - Validating shipping routes\n \n  It also provides methods for listing your pickup addresses and the details of individual parcels.\n\n  Each user is assigned a user account under which he is able to track multiple customer DSWs (customer numbers).  \n  You as a customer can use a single GeoAPI account to send shipments under multiple DPD customer numbers.\n\n**V2 documentation**\n\nNote that some of the endpoints have a new version 2 available.  \nFor complete V2 documentation, please visit <a href='/v2/swagger'>/v2/swagger</a>.\n","title":"DPD GeoAPI","version":"1.0.0"},"servers":[{"description":"GeoAPI Production environment","url":"https://geoapi.dpd.cz/v1"},{"description":"GeoAPI Test environment","url":"https://geoapi-test.dpd.cz/v1"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/me":{"get":{"description":"Use this method to get information about your customers and customer addresses.\n\nUser account which is used to find the data is determined by an API key provided in a request header.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}},"description":"All active customers of the current user account and their list of addresses"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Get the active customers of the user account and their list of addresses."}},"/parcels":{"get":{"description":"Use this for getting the list of all parcels associated with any of the customers under this user account.  \nReturns everything that was created in a selected time-frame by the current user account.  \nThe goal is to provide an overview of every parcel via a single endpoint.\n","parameters":[{"description":"Start of the time-frame in the YYYY-MM-DD (ISO 8601) format","explode":true,"in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/DateTime"},"style":"form"},{"description":"End of the time-frame in the YYYY-MM-DD (ISO 8601) format","explode":true,"in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/DateTime"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"}}},"description":"List of all parcels for the current user account"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"List all parcels for the current active user account"}},"/parcels/labels":{"post":{"description":"Same as the `POST /parcels/{parcelIdent}/labels` endpoint but for batched printing.  \nA single ZPL/EPL script will contain instructions for printing multiple labels.  \nThe PDF will contain one or multiple pages with all labels.\n\n**Capabilities**\n\nSame as the `POST /parcels/{parcelIdent}/labels` \n\n**Limitations**\n\nSame as the `POST /parcels/{parcelIdent}/labels`\n\nBear in mind that a shipment cannot have both a label and drop-off codes. \\\nOnce an attempt to print a label or to generate drop-off codes has been made, \\\nthe shipment will be marked as such and GeoAPI will not let you switch to a different drop-off method.\n","requestBody":{"content":{"application/json":{"examples":{"pdfA4":{"summary":"A4 PDF format print request","value":{"printType":"PDF","printProperties":{"pageSize":"A4","labelsPerPage":4,"labelsOffset":1},"parcels":[{"parcelNumber":"13815045502659"},{"id":138}]}},"pdfA6":{"summary":"A6 PDF format print request","value":{"printType":"PDF","printProperties":{"pageSize":"A6","labelsPerPage":1},"parcels":[{"parcelNumber":"13815045502659"},{"id":138}]}},"eplRaw":{"summary":"EPL or Raw format print request","value":{"printType":"EPL","parcels":[{"parcelNumber":"13815045502659"},{"id":138}]}},"zpl":{"summary":"ZPL format print request","value":{"printType":"ZPL","parcels":[{"parcelNumber":"13815045502659"},{"id":138}]}},"zplLegacyBarcode":{"summary":"ZPL with legacy narrow barcode (denser, harder to scan)","value":{"printType":"ZPL","printProperties":{"barcodeLayout":"narrowAuto"},"parcels":[{"parcelNumber":"13815045502659"}]}}},"schema":{"$ref":"#/components/schemas/_parcels_labels_post_request"}}},"description":"The printing options and parcels","required":true},"responses":{"200":{"content":{"text/plain":{"schema":{"$ref":"#/components/schemas/LabelScript"}},"application/json":{"schema":{"$ref":"#/components/schemas/LabelRaw"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/LabelPDF"}}},"description":"The parcel labels"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Some of the parcel numbers are invalid, the request is malformed or some of the parcels are collection parcels"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Some of the provided parcels do not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Concurrent request conflicted with the current request"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Print the labels for multiple parcels"}},"/parcels/{parcelIdent}/labels":{"post":{"description":"The parcel can have multiple labels, so an array is always returned.  \nThe script/PDF always contains only single label.\n\nTwo labels will be returned when printing the labels for a swap parcel.  \nOne of the labels, that is designated for the return journey to the sender, is placed into the package.  \nThe system allows only for a single parcel swap shipments. The exchange is always done on a piece-by-piece bases.\n\n**Capabilities**\n\n- You can choose between the following formats: **ZPL, EPL, PDF and raw data**.  \n  For more info see [Print Type](#/PrintType)\n  - The ZPL/EPL script can be sent directly to the printer port.  \n  - The decoded Base64 can be saved as a PDF file.  \n  - The raw data output can be used to populate a custom print template.\n\n**Limitations**\n\n- **This endpoint cannot be called for collection parcels, DPD will take care of printing their shipping labels.**  \n  Collection parcels - Parcels that are sent from the customer to you (e.g. a complaint)\n","parameters":[{"description":"The identification of the parcel in question.\n\nThe value will be interpreted as a parcel number by default.\n\nIf you want to provide a GeoAPI ID then provide the input with the 'id-' prefix (e.g. `id-23479`).  \nYou can do this with the parcel number too using the 'no-' prefix (e.b. `no-12345678901234`)\n","examples":{"implicitParcelNumber":{"summary":"Implicit parcel number","value":"12345678901234"},"explicitParcelNumber":{"summary":"Explicit parcel number","value":"no-12345678901234"},"explicitId":{"summary":"Explicit GeoAPI ID","value":"id-23456"}},"explode":false,"in":"path","name":"parcelIdent","required":true,"schema":{"$ref":"#/components/schemas/_parcels__parcelIdent__labels_post_parcelIdent_parameter"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"pdfA4":{"summary":"A4 PDF format print request","value":{"printType":"PDF","printProperties":{"pageSize":"A4","labelsPerPage":4,"labelsOffset":1}}},"pdfA6":{"summary":"A6 PDF format print request","value":{"printType":"PDF","printProperties":{"pageSize":"A6","labelsPerPage":1}}},"eplRaw":{"summary":"EPL or Raw format print request","value":{"printType":"EPL"}},"zpl":{"summary":"ZPL format print request","value":{"printType":"ZPL"}},"zplLegacyBarcode":{"summary":"ZPL with legacy narrow barcode (denser, harder to scan)","value":{"printType":"ZPL","printProperties":{"barcodeLayout":"narrowAuto"}}}},"schema":{"$ref":"#/components/schemas/_parcels__parcelIdent__labels_post_request"}}},"description":"The printing options","required":true},"responses":{"200":{"content":{"text/plain":{"schema":{"$ref":"#/components/schemas/LabelScript"}},"application/json":{"schema":{"$ref":"#/components/schemas/LabelRaw"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/LabelPDF"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/LabelBinary"}}},"description":"The parcel labels"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The parcel number is invalid, the request is malformed or the parcel is a collection parcel"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Parcel with the specified id does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Concurrent request conflicted with the current request"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Print the parcel labels"}},"/parcels/tracking":{"post":{"description":"Same as the `GET /parcels/{parcelNo}/tracking` endpoint but for batched tracking information.\n","requestBody":{"$ref":"#/components/requestBodies/PostTrackingRequestBody"},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TrackingResult"},"type":"array"}}},"description":"The parcel tracking info"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Parcel number is invalid or the request is malformed"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Some of the provided parcels do not exist"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Get the tracking info for multiple parcels"}},"/parcels/{parcelIdent}/tracking":{"get":{"parameters":[{"description":"The identification of the parcel in question.\n\nThe value will be interpreted as a parcel number by default.\n\nIf you want to provide a GeoAPI ID then provide the input with the 'id-' prefix (e.g. `id-23479`).  \nYou can do this with the parcel number too using the 'no-' prefix (e.b. `no-12345678901234`)\n","examples":{"implicitParcelNumber":{"summary":"Implicit parcel number","value":"12345678901234"},"explicitParcelNumber":{"summary":"Explicit parcel number","value":"no-12345678901234"},"explicitId":{"summary":"Explicit GeoAPI ID","value":"id-23456"}},"explode":false,"in":"path","name":"parcelIdent","required":true,"schema":{"$ref":"#/components/schemas/_parcels__parcelIdent__labels_post_parcelIdent_parameter"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingResult"}}},"description":"Parcel events for the given parcel"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The parcel number is invalid or the request is malformed"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Parcel with the specified id does not exist"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Get parcel tracking info"}},"/pickup-orders":{"post":{"description":"You can create pickup orders via this endpoint.  \nA pickup order is a request for a courier to come and pick your parcels up.  \nThe courier will then proceed to forward the parcels into further transit and make sure they will eventually reach their shipping destination.  \n\nIf the customerAddress (standard) or parcelNo (collection) is not found, an error will be returned\n\nIf you provide a parcel number that belongs to a standard parcel when creating the pickup order,  \nan error will be thrown as the parcel number is only expected to be provided when ordering a pickup for a collection parcel.  \n\n**Other means of ordering pickups**\n\n- The pickup can be ordered via the `POST /pickup-orders` endpoint or it can be personally negotiated (you can setup recurring pickups this way).\n","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NewPickupOrder"},"maxItems":50,"type":"array"}}},"description":"The pickup order options","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PickupOrder"},"type":"array"}}},"description":"The pickup order has been successfully created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Some of the parcel numbers, the customer address or the pickup date is invalid, or the request is malformed"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request Timeout. Took too long to respond."},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Create a new pickup order."}},"/pickup-orders/{pickupOrderId}":{"delete":{"description":"Use this endpoint to cancel your parcel pickup orders.\n\n**Limitations**\n\nIt might not be possible to cancel some pickup orders.  \nPickup orders can be canceled only until a certain deadline   \nThis is usually early in the morning of the pickup day.\n","parameters":[{"description":"The unique ID of the pickup order in question","explode":false,"in":"path","name":"pickupOrderId","required":true,"schema":{"$ref":"#/components/schemas/PickupOrderID"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/_pickup_orders__pickupOrderId__delete_200_response"}}},"description":"Pickup order successfully deleted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The unique ID is invalid, the request is malformed or the order can not be canceled at this time"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Pickup order with the specified id does not exist"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Cancel pickup order by pickupOrderId"},"get":{"parameters":[{"description":"The unique ID of the pickup order in question","explode":false,"in":"path","name":"pickupOrderId","required":true,"schema":{"$ref":"#/components/schemas/PickupOrderID"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupOrder"}}},"description":"Successfully found the requested pickup order"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The unique ID is invalid or the request is malformed"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Pickup order with the specified ID does not exist"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Show information about a specific pickup order."}},"/shipping-services":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ShippingServiceList"},"type":"array"}}},"description":"A list of shipping services"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"List of all available shipping services in JSON."}},"/countries":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Country"},"type":"array"}}},"description":"A list of countries"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"List all available countries for your account"}},"/customers":{"get":{"description":"Each user account has multiple customers associated with it.  \n\nEach customer has its own [DSW](#/CustomerDSW) and his own customer addresses.\n","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Customer"},"type":"array"}}},"description":"Info about the customer"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"List all customers associated with the active user account"}},"/customers/{customerDSW}/addresses":{"get":{"description":"You can use these customer addresses when creating a new shipment or pickup order.\n\nIf the customer is not associated with your account, an error will be returned.\n","parameters":[{"description":"The DSW of the customer in question","explode":false,"in":"path","name":"customerDSW","required":true,"schema":{"$ref":"#/components/schemas/CustomerDSW"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CustomerAddress"},"type":"array"}}},"description":"A list of the pickup addresses assigned to the customer"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The customer id is invalid or the request is malformed"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The customer id is not associated with your account or the API token provided is not valid"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"List all addresses associated with the specified customer"}},"/shipments":{"post":{"description":"Use this endpoint to create new parcel shipments.\n\nShipments consist of one or more parcels.\n\n**Recommendations:** \n\n*It is strongly recommended to batch the shipments into medium sized requests (cca 10 items). Sending many small requests at once can cause performance degradation.\nGeoApi handles maximum of 50 shipments in one request.*\n\nIn case you have incorporated a mistake into the shipment data,  \njust create a new shipment with corrected data.  \nYou can then throw away the printed labels and use new ones.\n","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NewShipment"},"maxItems":50,"type":"array"}}},"description":"The shipment specifications","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"}}},"description":"Info about the created shipments"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewShipmentError"}}},"description":"The request was invalid due to malformed input or incorrect usage."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewShipmentError"}}},"description":"The customer id is not associated with your account or the API token provided is not valid"},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request Timeout. Took too long to respond."},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Create new shipments"}},"/parcels/{parcelIdent}/drop-off-codes":{"post":{"description":"Returns codes that can be used for drop-off instead of a printed label.\n\n**Limitations**\n  \nBear in mind that a shipment cannot have both a label and drop-off codes. \nOnce an attempt to print a label or to generate drop-off codes has been made, \nthe shipment will be marked as such and GeoAPI won't let you switch to a different drop-off method.\n","parameters":[{"description":"The identification of the parcel in question.\n\nThe value will be interpreted as a parcel number by default.\n\nIf you want to provide a GeoAPI ID then provide the input with the 'id-' prefix (e.g. `id-23479`).  \nYou can do this with the parcel number too using the 'no-' prefix (e.b. `no-12345678901234`)\n","examples":{"implicitParcelNumber":{"summary":"Implicit parcel number","value":"12345678901234"},"explicitParcelNumber":{"summary":"Explicit parcel number","value":"no-12345678901234"},"explicitId":{"summary":"Explicit GeoAPI ID","value":"id-23456"}},"explode":false,"in":"path","name":"parcelIdent","required":true,"schema":{"$ref":"#/components/schemas/_parcels__parcelIdent__labels_post_parcelIdent_parameter"},"style":"simple"}],"requestBody":{"$ref":"#/components/requestBodies/PostDropOffCodesRequestBody"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DropoffCodes"}}},"description":"Label-less drop-off codes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request was invalid due to malformed input or incorrect usage."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"404":{"description":"Parcel with the specified id does not exist"},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request Timeout. Took too long to respond."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Concurrent request conflicted with the current request"},"500":{"description":"Uncaught server error - Issue is on our side"}},"summary":"Get label-less drop-off codes for a parcel"}}},"components":{"parameters":{"CustomerDSW":{"description":"The DSW of the customer in question","explode":false,"in":"path","name":"customerDSW","required":true,"schema":{"$ref":"#/components/schemas/CustomerDSW"},"style":"simple"},"ParcelIdent":{"description":"The identification of the parcel in question.\n\nThe value will be interpreted as a parcel number by default.\n\nIf you want to provide a GeoAPI ID then provide the input with the 'id-' prefix (e.g. `id-23479`).  \nYou can do this with the parcel number too using the 'no-' prefix (e.b. `no-12345678901234`)\n","examples":{"implicitParcelNumber":{"summary":"Implicit parcel number","value":"12345678901234"},"explicitParcelNumber":{"summary":"Explicit parcel number","value":"no-12345678901234"},"explicitId":{"summary":"Explicit GeoAPI ID","value":"id-23456"}},"explode":false,"in":"path","name":"parcelIdent","required":true,"schema":{"$ref":"#/components/schemas/_parcels__parcelIdent__labels_post_parcelIdent_parameter"},"style":"simple"},"ParcelNo":{"description":"The parcel number of the parcel in question","explode":false,"in":"path","name":"parcelNo","required":true,"schema":{"$ref":"#/components/schemas/ParcelNo"},"style":"simple"}},"requestBodies":{"PostTrackingRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingInput"}}},"required":true},"PostDropOffCodesRequestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DropOffCodesInput"}}},"required":false}},"responses":{"ServerError":{"description":"Uncaught server error - Issue is on our side"},"ResponseTimeoutError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Request Timeout. Took too long to respond."},"Unauthorized":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API token provided has expired or it is not valid"},"ConflictError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Concurrent request conflicted with the current request"}},"schemas":{"ShipmentId":{"description":"Unique shipment ID.\n\nThis ID is used to reference the shipment in the API endpoints.\n","example":123456789,"type":"number"},"PickupOrderID":{"description":"This ID is used in the API to uniquely identify a pickup order.\n\nThe user is able to order a pickup for a shipment on one of the customer addresses.  \nDPD will pick the shipment up on the address specified by the user and transfer it to the DPD depot for further processing.  \nThe user is also able to order a regular pickup, in that case the user is usually not using this API to create new shipments.\n","type":"number"},"CustomerID":{"description":"The internal GeoAPI customer ID\n\nYou would only use this if there is no other way to identify the customer.\n","type":"number"},"CustomerDSW":{"description":"The customer unique global identification number used across multiple DPD services.\n\nA single user account can have multiple customers.  \nThis allows for a single user account to manage multiple branches via this API.\n","maxLength":12,"minLength":11,"type":"string"},"CustomerIdent":{"oneOf":[{"$ref":"#/components/schemas/CustomerIdent_oneOf"},{"$ref":"#/components/schemas/CustomerIdent_oneOf_1"}]},"Date":{"description":"Represented in the YYYY-MM-DD (ISO 8601) format","maxLength":10,"minLength":10,"type":"string"},"DateTime":{"description":"Represented in the ISO 8601 format","example":"2025-07-22T16:32:10.679Z","type":"string"},"PaymentType":{"description":"CASH - Payment by cash\n\nCASH_OR_CARD - Payment by cash or card\n","enum":["Cash","CashOrCard"],"type":"string"},"ServiceCode":{"description":"The DPD wide shipping service/product code.\n\nThis is calculated based on the requested shipment services like COD, notification and etc...\n\nIt is (for instance) used when resolving the shipping route.\n","example":"101","type":"string"},"AdditionalCode":{"description":"The DPD wide shipping additional service/product code\n\nThe original shipping ServiceCode is no longer enough and has to be supplemented by the AdditionalCode\n","example":"A15","type":"string"},"ServiceCombination":{"description":"The DPD wide shipping service/product combination code.\nThis is the combination of the codes from the selected services.\n","example":"D-B2C-PSD","type":"string"},"DepotName":{"example":"DPD - 0152361","type":"string"},"ParcelReference1":{"description":"A reference is an internal information for your use cases.\nYou can use this (for instance) to correlate the parcel with your internal system IDs.\n\nThis reference is printed on the parcel label.\nIt is shortened to 14/17 characters when printed on the label.\n","maxLength":35,"type":"string"},"ParcelReference2":{"description":"A reference is an internal information for your use cases.\nYou can use this (for instance) to correlate the parcel with your internal system IDs.\n\nThis reference is printed on the parcel label.\nThis is shortened do 14/17 characters when printed on the label.\n","maxLength":35,"type":"string"},"ParcelReference3":{"description":"Additional information for your use cases.  \nYou can use this (for instance) to correlate the parcel with your internal system IDs.\n","maxLength":35,"type":"string"},"ParcelReference4":{"description":"Additional information for your use cases.  \nYou can use this (for instance) to correlate the parcel with your internal system IDs.\n","maxLength":35,"type":"string"},"Street":{"description":"Including the descriptive number","example":"Example Street 368/23","maxLength":35,"type":"string"},"PostalCode":{"example":"40001","maxLength":7,"minLength":3,"type":"string"},"City":{"example":"Praha 8","type":"string"},"CustomerAddressIt4emId":{"description":"This ID is used DPD wide to uniquely identify a customer address (alternative to GeoAPI specific Customer Address ID)","type":"number"},"CustomerAddressId":{"description":"Internal GeoAPI ID","type":"number"},"CustomerAddressIdent":{"description":"Used to uniquely identify a customer address in the API","oneOf":[{"$ref":"#/components/schemas/CustomerAddressIdent_oneOf"},{"$ref":"#/components/schemas/CustomerAddressIdent_oneOf_1"}]},"ParcelWeight":{"description":"Weight of the parcel in grams\nE.g 1500 represents 1.5 kg.\n","type":"number"},"CourierNote":{"description":"This is a note for the courier.  \nYou can leave some additional information for the courier using this property.\n","example":"Call before arrival","maxLength":200,"type":"string"},"StatusCode":{"description":"Returns the current state of pickup order.\n- Created is a default state\n","enum":["New","Created","ToCancel","Canceled"],"type":"string"},"StatusText":{"description":"Detailed information about the status of the pickup order.\n- `New` = The pickup has been ordered by the customer. We are now waiting for its creation in the DPD systems.\n- `Created` = The pickup order has been created in the DPD systems\n- `ToCancel` = A cancel request for the pickup order has been received and sent for processing\n- `Canceled` = The pickup order has been successfully canceled\n","maxLength":200,"type":"string"},"Me":{"description":"The first active customer of the user account and their list of addresses","properties":{"userAccount":{"$ref":"#/components/schemas/UserAccount"},"customers":{"items":{"$ref":"#/components/schemas/Me_customers_inner"},"type":"array"}},"required":["customers","userAccount"],"type":"object"},"DeliveryOptions":{"properties":{"completeness":{"$ref":"#/components/schemas/Completeness"}},"type":"object"},"Completeness":{"description":"Provide this information if you want to specify the completeness of the delivery.\n- CompleteOnly = All parcels of the shipment must be delivered\n- PossiblyIncomplete = The shipment can be delivered incomplete\n\ndefault behavior:\n  - shipment with CoD = CompleteOnly\n  - shipment without CoD = PossiblyIncomplete\n","enum":["CompleteOnly","PossiblyIncomplete"],"type":"string"},"Insurance":{"properties":{"amountCents":{"description":"Units of the specified currency in cents.\nFor example 125 units of CZK is 1.25 CZK.\n","type":"number"},"currency":{"$ref":"#/components/schemas/Currency"}},"required":["amountCents","currency"],"type":"object"},"InsuranceInput":{"allOf":[{"$ref":"#/components/schemas/Insurance"},{"properties":{"currency":{"enum":["CZK","EUR"],"type":"string"}}}]},"ParcelNumbers":{"properties":{"main":{"allOf":[{"$ref":"#/components/schemas/ParcelNo"},{"description":"Parcel number for a standard/collection parcel"}]},"back":{"allOf":[{"$ref":"#/components/schemas/ParcelNo"},{"description":"Parcel number assigned only to back parcels (in Swap service)"}]}},"title":"Parcel numbers","type":"object"},"ParcelReferences":{"description":"A reference is an internal information for your use cases.","properties":{"ref1":{"$ref":"#/components/schemas/ParcelReference1"},"ref2":{"$ref":"#/components/schemas/ParcelReference2"},"ref3":{"$ref":"#/components/schemas/ParcelReference3"},"ref4":{"$ref":"#/components/schemas/ParcelReference4"}},"title":"Parcel references","type":"object"},"ShipmentReference":{"description":"You can set this to your invoice number or other value per preference and data needs.\n","maxLength":35,"title":"Shipment reference","type":"string"},"ShipmentReferences":{"description":"A reference is an internal information for your use cases.\n\nShipment references are only used in the data, not printed to any labels.\n","properties":{"ref1":{"$ref":"#/components/schemas/ShipmentReference"},"ref2":{"$ref":"#/components/schemas/ShipmentReference"},"ref3":{"$ref":"#/components/schemas/ShipmentReference"},"ref4":{"$ref":"#/components/schemas/ShipmentReference"}},"title":"Shipment References","type":"object"},"Payer":{"properties":{"customer":{"$ref":"#/components/schemas/Customer"},"customerAddress":{"$ref":"#/components/schemas/CustomerAddress"}},"required":["customer"]},"Shipment":{"properties":{"id":{"$ref":"#/components/schemas/ShipmentId"},"shipmentType":{"$ref":"#/components/schemas/ShipmentType"},"customer":{"$ref":"#/components/schemas/Customer"},"references":{"$ref":"#/components/schemas/ShipmentReferences"},"receiver":{"$ref":"#/components/schemas/Receiver"},"sender":{"$ref":"#/components/schemas/Sender"},"payer":{"$ref":"#/components/schemas/Payer"},"declaredSender":{"$ref":"#/components/schemas/DeclaredSender"},"services":{"$ref":"#/components/schemas/Shipment_services"},"parcels":{"items":{"$ref":"#/components/schemas/Parcel"},"type":"array"},"source":{"$ref":"#/components/schemas/Source"}},"required":["customer","payer","receiver","sender","shipmentType"],"type":"object"},"NewShipment":{"properties":{"customer":{"$ref":"#/components/schemas/NewShipment_customer"},"deliveryOptions":{"$ref":"#/components/schemas/DeliveryOptions"},"shipmentType":{"$ref":"#/components/schemas/ShipmentType"},"sender":{"$ref":"#/components/schemas/SenderSpecs"},"receiver":{"$ref":"#/components/schemas/ReceiverSpecs"},"payer":{"$ref":"#/components/schemas/PayerSpecs"},"references":{"$ref":"#/components/schemas/ShipmentReferences"},"declaredSender":{"$ref":"#/components/schemas/DeclaredSender"},"parcels":{"items":{"$ref":"#/components/schemas/NewShipment_parcels_inner"},"type":"array"},"source":{"$ref":"#/components/schemas/Source"},"services":{"$ref":"#/components/schemas/NewShipment_services"}},"required":["customer","parcels","receiver","sender","shipmentType"],"title":"New Shipment","type":"object"},"ShipmentExample":{"properties":{"services":{"$ref":"#/components/schemas/ShipmentServices"}},"required":["services"],"type":"object"},"ShipmentServices":{"properties":{"notification":{"$ref":"#/components/schemas/NotificationService"},"airExpress":{"$ref":"#/components/schemas/AirExpressService"},"dpdTimeGuarantee":{"$ref":"#/components/schemas/DPDTimeGuaranteeService"},"dpdGuarantee":{"$ref":"#/components/schemas/DPDGuaranteeService"},"swap":{"$ref":"#/components/schemas/SwapService"},"dpdPneu":{"$ref":"#/components/schemas/DPDPneuService"},"cashOnDelivery":{"$ref":"#/components/schemas/CashOnDeliveryService_1"},"pickupPoint":{"$ref":"#/components/schemas/PickupPointService"},"departmentDelivery":{"$ref":"#/components/schemas/DepartmentDeliveryService"},"personalIdentification":{"$ref":"#/components/schemas/PersonalIdentificationService"},"dpdReturn":{"$ref":"#/components/schemas/DPDReturnService"},"shopToShop":{"$ref":"#/components/schemas/ShopToShopService"},"shopToHome":{"$ref":"#/components/schemas/ShopToHomeService"},"ddtl":{"$ref":"#/components/schemas/DedicatedDirectTruckLoadService"},"noRedirection":{"$ref":"#/components/schemas/NoRedirectionService"}},"type":"object"},"LabelRaw":{"description":"Data for all the parcels","items":{"$ref":"#/components/schemas/LabelData"},"type":"array"},"PickupPointService":{"allOf":[{"$ref":"#/components/schemas/PickupPointID"},{"description":"You can use this service to order a delivery to a specified pickup point\n\nSet this value to the ID of the pickup point you want the shipment to be delivered to.\n","title":"Pickup point delivery"}]},"DPDTimeGuaranteeService":{"description":"You can choose from the selection of DPD delivery services with guaranteed delivery times\n\nDPD12 - Delivery before 12:00\n\nDPD18 - Guaranteed second day delivery before 18:00\n","enum":["DPD12","DPD18"],"title":"DPD Time guarantee","type":"string"},"NotificationService":{"default":false,"description":"Private shipment with predict notifications and 1HP\n\nEnable this service to send notifications about the delivery times to your customers.\n","title":"Notification","type":"boolean"},"CashOnDeliveryService":{"allOf":[{"$ref":"#/components/schemas/CashOnDeliveryWithAccount"},{"description":"Cash on delivery - Allows you to specify the amount to be collected from the consignee","title":"Cash on delivery"}]},"AirExpressService":{"default":false,"description":"Service providing express air delivery","title":"Air express","type":"boolean"},"DPDGuaranteeService":{"default":false,"description":"Enable for guaranteed timely delivery abroad\n","title":"DPD Guarantee","type":"boolean"},"SwapService":{"description":"Swap shipment - Parcels exchanged one for another","title":"Swap","type":"boolean"},"DPDPneuService":{"default":false,"description":"Delivery of (vehicle) tires","title":"DPD Pneu","type":"boolean"},"DepartmentDeliveryService":{"description":"The shipment is delivered to a department without any personal identification.\n\nInternal info: Setting identification to \"false\" (the only option currently) equals the \"1\" type in the old GeoAPI\n","properties":{"building":{"description":"The building where the shipment is delivered to","example":"Budova A","maxLength":25,"type":"string"},"floor":{"description":"The floor where the shipment is delivered to","example":"Druhé patro","maxLength":25,"type":"string"},"department":{"description":"The department where the shipment is delivered to","example":"Dopravní oddělení","maxLength":25,"type":"string"}},"required":["building","department","floor"],"title":"Department delivery","type":"object"},"PersonalIdentificationService":{"allOf":[{"$ref":"#/components/schemas/IDCheck"}],"description":"Delivery with personal identification using the ID-Check method.\n\nThe receiver will have to provide an identification card matching the information provided here.\n\nIf you have selected a pickup point delivery service, then the identification will be conducted at the pickup point.\n\n**Limitations**\n\nThe personal identification service is only available when the delivery to department is not requested:\n\nSee the service table for more info.\n","title":"Personal identification"},"DPDReturnService":{"default":false,"description":"A special service where the **original receiver** of a **previous shipment** returns the shipment, typically due to a complaint.\n\nThe return shipment will be dropped of by the **original receiver** at a pickup point and sent back to the **original sender**.\n\nBut this new shipment must be setup in a usual way as it will travel from the **sender** (original receiver) to the **receiver** (original sender).\nThe only difference is the **semantic link** to the **previous shipment**.\n\n**Limitations**\n\nDPD service cannot be combined with any other service. Also only the PDF label can be printed.\n","title":"DPD Return Service","type":"boolean"},"ShopToShopService":{"default":false,"description":"A special service where a standard parcel is sent from a pickup point instead of being pickup up by a courier\n\nThe package is also always delivered to a pickup point\n","title":"DPD Shop to Shop","type":"boolean"},"NoRedirectionService":{"default":false,"description":"This is an additional service to the S2S product which cannot be redirected\n","title":"DPD No Direction","type":"boolean"},"ShopToHomeService":{"default":false,"description":"A special service where a standard parcel is sent from a pickup point instead of being pickup up by a courier\n\nThe package is delivered to an arbitrary address.\n","title":"DPD Shop to Home","type":"boolean"},"DedicatedDirectTruckLoadService":{"default":false,"description":"A special service where multiple parcels are delivered in a single containe.\n","title":"Dedicated Direct Truck Load","type":"boolean"},"IDCheck":{"description":"This data is used when a check against a personal ID card is required","properties":{"name":{"description":"The name of the person to be checked","example":"John Doe","maxLength":35,"type":"string"},"personalId":{"description":"The personal identification card number of the receiving person","example":"123456789012345678","maxLength":18,"type":"string"}},"required":["name"],"type":"object"},"ShipmentType":{"description":"A type of the shipment. The type has impact on validations of sender/receiver, selected services, parcel numbers assigning and routing.\n","enum":["Standard","Collection","ThirdPartyCollection","Import","ThirdPartyStandard","Return"],"type":"string"},"SenderSpecs":{"allOf":[{"title":"Sender Specs"},{"description":"Specification of the sender of the shipment (source)"},{"oneOf":[{"$ref":"#/components/schemas/CustomerAddressIdent"},{"description":"Physical address of the sender of the shipment (source)","properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"title":"Address","type":"object"}]}]},"ReceiverSpecs":{"allOf":[{"title":"Receiver Specs"},{"description":"Specification of the receiver of the shipment (destination)"},{"oneOf":[{"$ref":"#/components/schemas/CustomerAddressIdent"},{"description":"Physical address of the receiver of the shipment (destination)","properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"title":"Address","type":"object"}]}]},"PayerSpecs":{"allOf":[{"description":"Specification of the payer of the shipment. Mostly could be derived from sender or receiver. Required in some types of shipments (for example in 3rdPartyCollection shipment).","properties":{"customer":{"$ref":"#/components/schemas/CustomerIdent"},"customerAddress":{"$ref":"#/components/schemas/Payer_Specs_customerAddress"}},"title":"Payer Specs","type":"object"}]},"AddressPickupOrderSpecs":{"description":"The pickup is ordered to a selected customer address (your address).\n\nThe courier can/will pick up all parcels for which you have printed labels.\n","properties":{"customerAddress":{"$ref":"#/components/schemas/CustomerAddressIdent"},"date":{"$ref":"#/components/schemas/Date"},"note":{"$ref":"#/components/schemas/CourierNote"}},"required":["customerAddress"],"title":"Address"},"ArbitraryAddressPickupOrderSpecs":{"description":"The pickup is ordered to an arbitrary address.\n\nThe courier can/will pick up all parcels for which you have printed labels at the location.\n","properties":{"customer":{"$ref":"#/components/schemas/CustomerIdent"},"arbitraryAddress":{"$ref":"#/components/schemas/ArbitraryAddressPickupOrderSpecs_arbitraryAddress"},"date":{"$ref":"#/components/schemas/Date"},"note":{"$ref":"#/components/schemas/CourierNote"}},"required":["arbitraryAddress","customer"],"title":"ArbitraryAddress"},"ParcelPickupOrderSpecs":{"description":"The pickup is ordered for a specific collection parcel(s).\n\nThe labels are printed by the DPD.\n","properties":{"parcel":{"$ref":"#/components/schemas/ParcelIdent"},"date":{"$ref":"#/components/schemas/Date"},"note":{"$ref":"#/components/schemas/CourierNote"}},"required":["parcel"],"title":"Parcel"},"CollectionPickupOrderResponse":{"description":"The created collection pickup order.\n","properties":{"parcels":{"description":"All parcel numbers from the collection shipment for which the pickup order was created.\n","items":{"$ref":"#/components/schemas/ParcelIdent"},"type":"array"},"date":{"$ref":"#/components/schemas/Date"},"note":{"$ref":"#/components/schemas/CourierNote"}},"required":["parcels"],"title":"Collection"},"NewPickupOrder":{"allOf":[{"title":"New pickup order specification"},{"oneOf":[{"$ref":"#/components/schemas/AddressPickupOrderSpecs"},{"$ref":"#/components/schemas/ParcelPickupOrderSpecs"},{"$ref":"#/components/schemas/ArbitraryAddressPickupOrderSpecs"}]}]},"PickupOrder":{"properties":{"id":{"$ref":"#/components/schemas/PickupOrderID"},"specs":{"$ref":"#/components/schemas/PickupOrder_specs"},"statusCode":{"$ref":"#/components/schemas/StatusCode"},"statusText":{"$ref":"#/components/schemas/StatusText"}},"required":["id","specs","statusCode","statusText"]},"StandardPrintTypeBatchInput":{"allOf":[{"$ref":"#/components/schemas/StandardPrintTypeInput"},{"properties":{"parcels":{"items":{"$ref":"#/components/schemas/ParcelIdent"},"type":"array"}},"required":["parcels"],"type":"object"}]},"ZPLPrintTypeBatchInput":{"allOf":[{"$ref":"#/components/schemas/ZPLPrintTypeInput"},{"properties":{"parcels":{"items":{"$ref":"#/components/schemas/ParcelIdent"},"type":"array"}},"required":["parcels"],"type":"object"}]},"PDFPrintTypeBatchInput":{"allOf":[{"$ref":"#/components/schemas/PDFPrintTypeInput"},{"properties":{"parcels":{"items":{"$ref":"#/components/schemas/ParcelIdent"},"type":"array"}},"required":["parcels"],"type":"object"}]},"StandardPrintTypeInput":{"properties":{"printType":{"description":"Option descriptions\n- EPL - EPL script format ready for printing.\n  The first 14 characters from the parcel reference 3 and reference 4 are used on the label.\n- RAW - Raw data, can be used for own printing solution.\n  This type returns the reference3 and reference4 fields for every physical parcel in full length.\n","enum":["EPL","RAW"],"type":"string"}},"required":["printType"],"type":"object"},"ZPLPrintTypeInput":{"properties":{"printType":{"description":"Option descriptions\n- ZPL - ZPL script format ready for printing.\n  The first 17 characters from the parcel reference 3 and reference 4 are used on the label.\n","enum":["ZPL"],"type":"string"},"printProperties":{"$ref":"#/components/schemas/ZPLPrintProperties"}},"required":["printType"],"type":"object"},"PDFPrintTypeInput":{"properties":{"printType":{"description":"Option descriptions\n- PDF - PDF in the Base64 encoding containing the parcel label.  \n  The first 17 characters from the parcel reference 3 and reference 4 are used on the label.\n","enum":["PDF"],"type":"string"},"printProperties":{"$ref":"#/components/schemas/PDFPrintTypeInput_printProperties"}},"required":["printProperties","printType"],"type":"object"},"LabelData":{"properties":{"delivery":{"$ref":"#/components/schemas/LabelData_delivery"},"origin":{"$ref":"#/components/schemas/LabelData_origin"},"parcel":{"$ref":"#/components/schemas/LabelData_parcel"},"parcelCount":{"description":"The number of parcels inside the shipment","type":"number"},"routing":{"$ref":"#/components/schemas/Routing"},"service":{"$ref":"#/components/schemas/LabelData_service"},"barCode":{"description":"The barcode to be printed on the label","example":"%000000213815045502659337372","maxLength":28,"minLength":28,"type":"string"},"barCodeText":{"description":"The text to be printed above the label","type":"string"},"cod":{"$ref":"#/components/schemas/LabelData_cod"},"departmentDelivery":{"$ref":"#/components/schemas/DepartmentDeliveryService"},"personalIdentification":{"$ref":"#/components/schemas/PersonalIdentificationService"}},"required":["barCode","barCodeText","delivery","origin","parcel","parcelCount","routing","service"],"type":"object"},"LabelScript":{"description":"A script in a txt format that can be sent to the printer.  \nIt can contain instructions for single label or multiple labels.  \nSupported formats are ZPL and EPL.\n","type":"string"},"LabelPDF":{"description":"Base64 encoded PDF representing one or more labels","format":"byte","type":"string"},"LabelBinary":{"description":"Some of the label templates benefit from being sent in a raw byte format.\n\nCurrently EPL labels that include the GW command have to be sent in binary format to preserve the image data \"as is\"\n","format":"binary","type":"string"},"ShippingServiceList":{"properties":{"apiServiceCombination":{"items":{"type":"string"},"type":"array"},"servicesForCombination":{"items":{"$ref":"#/components/schemas/ShippingService"},"type":"array"}},"required":["apiServiceCombination","servicesForCombination"],"type":"object"},"ShippingService":{"properties":{"id":{"type":"number"},"example":{"$ref":"#/components/schemas/ShipmentExample"},"limitations":{"$ref":"#/components/schemas/ShippingService_limitations"},"code":{"type":"string"},"additionalCode":{"$ref":"#/components/schemas/AdditionalCode"},"text":{"type":"string"},"combination":{"type":"string"},"prefix":{"type":"string"},"mark":{"type":"string"},"backVariant":{"$ref":"#/components/schemas/ShippingService_backVariant"}},"required":["code","combination","example","id","limitations","prefix"],"type":"object"},"A4PrintProperties":{"properties":{"pageSize":{"description":"Use the A4 option if you wish to get a version optimized for A4 paper size.\n","enum":["A4"],"type":"string"},"labelsPerPage":{"description":"Number of labels per page.","enum":[1,4],"type":"number"},"labelsOffset":{"description":"Number of labels to skip before printing.","maximum":3,"minimum":0,"type":"number"}},"required":["labelsPerPage","pageSize"],"type":"object"},"A6PrintProperties":{"properties":{"pageSize":{"description":"Use the A6 option if you wish to get a version optimized for A6 paper size.\n","enum":["A6"],"type":"string"},"labelsPerPage":{"description":"Number of labels per page.","enum":[1],"type":"number"}},"required":["labelsPerPage","pageSize"],"type":"object"},"ZPLPrintProperties":{"description":"Optional configuration for ZPL label barcode rendering.\nIf omitted, the standard `wideAuto` layout is used.\nOnly applicable when printType is ZPL.\n","properties":{"barcodeLayout":{"description":"Barcode rendering layout preset.\nIf omitted, `wideAuto` is used.\n- `wideAuto` — Wide bars (module width 3) with automatic Code 128 subset selection.\n  The standard rendering for ZPL: less dense, easier to scan, recommended for 203 dpi printers.\n- `narrowAuto` — Narrow bars (module width 2) with Code 128 Subset B encoding.\n  Denser, harder-to-scan output. Use only if downstream tooling requires the legacy format.\n","enum":["wideAuto","narrowAuto"],"type":"string"}},"type":"object"},"Depot":{"properties":{"name":{"$ref":"#/components/schemas/DepotName"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","name"],"type":"object"},"Parcel":{"description":"For more info about parcels see the [Parcel Number](#/ParcelNo)","properties":{"parcelNumbers":{"$ref":"#/components/schemas/ParcelNumbers"},"references":{"$ref":"#/components/schemas/ParcelReferences"},"insurance":{"$ref":"#/components/schemas/Insurance"},"isPrinted":{"description":"Are the labels for this parcel already printed?","type":"boolean"},"weightGrams":{"$ref":"#/components/schemas/ParcelWeight"},"id":{"type":"number"}},"required":["id","isPrinted","parcelNumbers"],"type":"object"},"Source":{"description":"Contains information related to the \"source\" of the shipment.\nThe source usually refers to the system that created the shipment via the API.\n","properties":{"systemId":{"description":"Uniquely identifies the source system in which the shipment was created.\n\nThis has to be filled if you have received instructions from the DPD to do so.\n\nYou can fill this even if you did not receive the instructions.\nWe will then be able to connect the shipments with your particular system for debugging and analytics if you do so.\n","type":"string"},"additionalInfo":{"additionalProperties":true,"type":"object"}},"type":"object"},"UserAccount":{"description":"User Account of the GeoApi.","properties":{"id":{"type":"number"},"apiKey":{"type":"string"},"accountNote":{"type":"string"}},"required":["apiKey","id"],"type":"object"},"Customer":{"description":"For more info about customers see the [Customer DSW](#/CustomerDSW)","properties":{"DSW":{"$ref":"#/components/schemas/CustomerDSW"},"isActive":{"type":"boolean"},"id":{"$ref":"#/components/schemas/CustomerID"}},"required":["DSW","id","isActive"],"type":"object"},"CustomerAddress":{"description":"Each user account, can have multiple customers (identified by DSW).  \nAnd each customer can have multiple customer addresses.  \nThese addresses can for instance represent the pickup addresses for pickup services.\n","properties":{"it4emId":{"$ref":"#/components/schemas/CustomerAddressIt4emId"},"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Your registered address. \nYou can for instance create (parcel) pickup orders on these addresses.\n"},"isActive":{"type":"boolean"}},"required":["address","info","isActive","it4emId"],"type":"object"},"ContactPerson":{"description":"The name of the person who can be contacted for more information about the parcel.\n","example":"John Doe","type":"string"},"Error":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"$ref":"#/components/schemas/Error_description"}},"required":["code","message"],"type":"object"},"NewShipmentError":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"description":{"$ref":"#/components/schemas/NewShipmentError_description"}},"required":["code","message"],"type":"object"},"DetailedError":{"properties":{"path":{"example":"0 -> receiver -> info -> name1","type":"string"},"message":{"example":"String must contain at most 35 character(s)","type":"string"},"unionErrors":{"items":{"$ref":"#/components/schemas/DetailedUnionError"},"type":"array"}},"required":["path"],"type":"object"},"DetailedUnionError":{"properties":{"option":{"example":0,"type":"number"},"description":{"example":"The issues presented in this object represent issues for one of the available union options. Only one of the presented options can be satisfied at once.","type":"string"},"issues":{"items":{"$ref":"#/components/schemas/DetailedUnionError_issues_inner"},"type":"array"}},"required":["message","option"],"type":"object"},"ParcelId":{"description":"The internal GeoAPI parcel ID\n\nYou would only use this if there is no other way to identify the parcel.\n","example":138,"type":"number"},"ParcelNo":{"description":"Each shipment can have multiple (physical) parcels.  \nThis number is used to identify and reference an individual parcel in the shipment.  \nEach parcel has its own label.\n","example":"13815045502659","maxLength":14,"minLength":14,"type":"string"},"TrackingInput":{"properties":{"parcels":{"description":"Parcel identifiers","items":{"$ref":"#/components/schemas/TrackingInput_parcels_inner"},"type":"array"}},"required":["parcels"],"type":"object"},"TrackingResult":{"properties":{"parcelInfo":{"$ref":"#/components/schemas/TrackingResult_parcelInfo"},"parcelEvents":{"description":"Individual parcel events","items":{"$ref":"#/components/schemas/TrackingResult_parcelEvents_inner"},"type":"array"}},"required":["parcelEvents","parcelInfo"],"type":"object"},"HazardousSubstanceOutput":{"allOf":[{"$ref":"#/components/schemas/HazardousSubstance"},{"description":"A substance as accepted in a specific destination Business Unit, together with the\ntransport permissions for that Business Unit. The same substance (UN number + class +\nclassification code + packing group) can appear multiple times in the list — once per\nBusiness Unit — so filter by `destinationBuCode` to see what a given BU accepts.\n","properties":{"packingGroup":{"description":"Packing Group - a grouping of hazardous materials according to the degree of danger they present.\n\nI - Substances presenting high danger\nII - Substances presenting medium danger\nIII - Substances presenting low danger\n","example":"II","nullable":true,"type":"string"},"nameAndDescription":{"description":"Name and description of the hazardous material","example":"ACETONE","maxLength":255,"type":"string"},"destinationBuCode":{"description":"The DPD internal code of the destination Business Unit (e.g. \"015\" = Czech Republic)\nthat the permissions below apply to.\n","example":"015","type":"string"},"importAllowed":{"description":"Whether the substance may be imported into this Business Unit.","example":true,"type":"boolean"},"exportAllowed":{"description":"Whether the substance may be exported from this Business Unit.","example":true,"type":"boolean"},"domesticAllowed":{"description":"Whether the substance may be shipped domestically within this Business Unit.","example":true,"type":"boolean"}},"required":["destinationBuCode","domesticAllowed","exportAllowed","importAllowed"]}]},"HazardousSubstance":{"description":"Hazardous substance identification using UN Number, Class, Classification Code, and Packing Group.\n","properties":{"unNo":{"description":"UN Number (4 digits).\n\nUnited Nations Number from ADR - Dangerous Goods Regulation\n","example":"1993","pattern":"^\\d{4}$","type":"string"},"class":{"description":"Class  \n9 Classes of dangerous goods  \nClass 1 : explosives  \nClass 2 : Flammable Gases/Non-flammable gas/toxic gas  \nClass 3 : Flammable Liquids  \nClass 4 : Flammable solids/Substances liable to spontaneous combustion/Substances which, in contact with water emit flammable gases  \nClass 5 : Oxidising Substances/organic peroxides  \nClass 6 : Toxic substances/Infectious substances  \nClass 7 : Radioactive  \nClass 8 : Corrosive  \nClass 9 : Miscellaneous  \n","example":"3","maxLength":10,"type":"string"},"classCode":{"description":"Classification Group (C-Code).\n\nThe classification code characterizes hazardous properties of a substance or object, such as toxic or flammable. \n\nThese properties can also occur in combination, for example toxic and corrosive.\n","example":"F1","maxLength":10,"nullable":true,"type":"string"}},"required":["class","unNo"],"title":"Hazardous Substance","type":"object"},"Country":{"properties":{"localizedName":{"description":"Localized country name (e.g. in Czech)","type":"string"},"numericCode":{"$ref":"#/components/schemas/CountryNumeric"},"alpha2Code":{"$ref":"#/components/schemas/CountryAlpha2"},"alpha3Code":{"$ref":"#/components/schemas/CountryAlpha3"},"codInfo":{"$ref":"#/components/schemas/Country_codInfo"}},"required":["alpha2Code","alpha3Code","codInfo","localizedName","numericCode"],"type":"object"},"CountryNumeric":{"description":"Country ISO numeric code","example":"203","maxLength":3,"minLength":3,"type":"string"},"CountryAlpha2":{"description":"Country ISO Alpha-2 code","maxLength":2,"minLength":2,"type":"string"},"CountryAlpha3":{"description":"Country ISO Alpha-3 code","maxLength":3,"minLength":3,"type":"string"},"DropOffCodesInput":{"properties":{"aztec":{"$ref":"#/components/schemas/DropOffCodesInput_aztec"}},"type":"object"},"DropoffCodes":{"properties":{"pin":{"$ref":"#/components/schemas/DropoffCodes_pin"},"aztec":{"$ref":"#/components/schemas/DropoffCodes_aztec"}},"required":["expiresAt","pin"],"type":"object"},"Currency":{"description":"Currency in the ISO 4217 format","example":"CZK","maxLength":3,"minLength":3,"type":"string"},"Receiver":{"description":"Info about the receiver of the shipment (destination)","properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"type":"object"},"Sender":{"description":"Info about the sender of the shipment (source)","properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"type":"object"},"DeclaredSender":{"description":"Allows you to specify any address as the declared sender.\n\nDeclared sender is a sender that will be listed on the parcel labels \nand will also be listed in the shipment data.\n\nHowever it does not affect the actual shipment routing. The actual sender (pickup place) will still be the \"sender\".\n\n**Usages**\n\n- This is, for instance, used when you are shipping packages for your partner / declared sender.\n","properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"type":"object"},"HazardousSubstanceInput":{"allOf":[{"$ref":"#/components/schemas/HazardousSubstance"},{"description":"Hazardous substance identification using UN Number, Class, Classification Code, and Packing Group.\n\nThe data should be populated based on the list of of supported Hazardous Substances (Hazardous Goods) from the appropriate endpoint of this API.  \nOnly substances from this list will pass the validation during creation of the shipment.\n\nBased on International Carriage of Dangerous Goods by Road - The Dangerous Goods list\n","properties":{"packingGroup":{"description":"Packing Group - a grouping of hazardous materials according to the degree of danger they present.\n\nI - Substances presenting high danger  \nII - Substances presenting medium danger  \nIII - Substances presenting low danger  \n","enum":["I","II","III"],"example":"II","nullable":true,"type":"string"}}}]},"CashOnDeliveryService_1":{"allOf":[{"$ref":"#/components/schemas/CashOnDeliveryWithAccount"},{"description":"Cash on delivery - Allows you to specify the amount to be collected from the consignee","title":"Cash on delivery"}]},"CashOnDeliveryWithAccount":{"properties":{"amountCents":{"$ref":"#/components/schemas/CodAmount"},"currency":{"$ref":"#/components/schemas/Currency"},"payment":{"$ref":"#/components/schemas/PaymentType"},"account":{"$ref":"#/components/schemas/CodAccount"},"variableSymbol":{"description":"Variable symbol of the COD payment","example":"17","maxLength":10,"type":"string"}},"required":["amountCents","currency","payment"],"type":"object"},"CodAmount":{"description":"The amount to be collected on delivery.  \nThis value is always represented in cents of the specified currency.  \nCents in this context signify a 1/100 of the currency base units.\n\nFor example when the COD is supposed to be 45.5 CZK, the value should be 4550 (with appropriate currency settings)  \nOr when the COD is supposed to be 2 EUR, the sent value should be 200 (with appropriate currency settings)  \n","type":"number"},"LimitedQuantitiesService":{"description":"Service for shipping hazardous substances (hazardous goods) in Limited Quantities (LQ) mode.\n\nWhen enabled, all parcels must contain the hazardous substance data.\n","title":"Limited Quantities Service","type":"boolean"},"PickupPointID":{"description":"Uniquely identifies a pickup point\n\nAlso internally used by DPD\n","example":"CZ10190","type":"string"},"SubjectInfo":{"properties":{"name1":{"$ref":"#/components/schemas/SubjectName"},"name2":{"$ref":"#/components/schemas/SubjectNameSecondary"},"contact":{"$ref":"#/components/schemas/SubjectInfo_contact"}},"required":["name1"],"title":"Subject information","type":"object"},"SubjectName":{"description":"The name of the sender/receiver.\n\nUsually this is the full name of the receiver/sender.\nYou can also specify the name of the receiving/sending company (e.g) \n\nIt is up to you to specify all required information, for the delivery to be successfully completed.\n\nWARNING: Depending on type of the label, this field will be shortened to fit the label.\n  - PDF/EPL 31 characters for receiver and 28 characters for sender\n  - ZPL 31 characters for receiver and 19 characters for sender\n","example":"John Doe","maxLength":35,"type":"string"},"SubjectNameSecondary":{"description":"You can use this property if you need to add some additional information about the receiver/sender.\nOr if the information about the receiver/sender are better expressed in separate fields\n\nFor example, you can specify the name of the company here, or the name of the person who is sending/receiving for the shipment.\n\nWARNING: Depending on type of the label, this field will be shortened to fit the label.\n  - PDF/EPL 31 characters for receiver and 28 characters for sender\n  - ZPL 31 characters for receiver and 19 characters for sender\n","example":"John Doe","maxLength":35,"type":"string"},"PhoneNumber":{"description":"Can be with or without the international prefix","example":"123 456 789","maxLength":31,"type":"string"},"Email":{"type":"string"},"Address":{"properties":{"street":{"$ref":"#/components/schemas/Street_1"},"postalCode":{"$ref":"#/components/schemas/PostalCode"},"city":{"$ref":"#/components/schemas/City_1"},"houseNumber":{"$ref":"#/components/schemas/HouseNumber"},"country":{"$ref":"#/components/schemas/CountryIdent"}},"required":["city","country","postalCode","street"],"type":"object"},"Street_1":{"description":"Including the descriptive number\n\nWARNING: Depending on type of the label, this field will be shortened to fit the label.\n  - PDF 31 characters for receiver and 28 characters for sender\n  - ZPL/EPL 31 characters for receiver and 19 characters for sender\n","example":"Example Street 368/23","maxLength":35,"type":"string"},"City_1":{"description":"WARNING: Depending on type of the label, this field will be shortened to fit the label.\n  - PDF/EPL 31 characters for receiver and 28 characters for sender\n  - ZPL 31 characters for receiver and 19 characters for sender\n","example":"Praha 8","maxLength":35,"type":"string"},"HouseNumber":{"type":"string"},"ParcelIdent":{"oneOf":[{"$ref":"#/components/schemas/ParcelIdent_oneOf"},{"$ref":"#/components/schemas/ParcelIdent_oneOf_1"}]},"PickupPointName":{"description":"Name of the pickup point\n\nAlso internally used by DPD\n","example":"Tabák - Praha 8","type":"string"},"Routing":{"properties":{"routingText":{"$ref":"#/components/schemas/RoutingText"},"DSORT":{"$ref":"#/components/schemas/DSORT"},"OSORT":{"$ref":"#/components/schemas/OSORT"},"SSORT":{"$ref":"#/components/schemas/SSORT"}},"required":["DSORT","OSORT","SSORT","routingText"],"type":"object"},"RoutingText":{"description":"The routing text includes information such as depot country alpha 2, destination business unit, destination depot, S-Sort","example":"CZ-DPD-1392-001B","type":"string"},"DSORT":{"description":"The delivery route","type":"string"},"OSORT":{"description":"The pickup tour","type":"string"},"SSORT":{"description":"Sorting","type":"string"},"ServiceDesignation":{"properties":{"code":{"type":"string"},"combination":{"type":"string"},"prefix":{"type":"string"},"text":{"type":"string"},"mark":{"type":"string"}},"required":["code","combination","prefix"],"type":"object"},"RoutingData":{"properties":{"routing":{"$ref":"#/components/schemas/Routing"},"dispatchDepot":{"$ref":"#/components/schemas/DispatchDepot"},"destinationDepot":{"$ref":"#/components/schemas/RoutingData_destinationDepot"}},"required":["destinationDepot","dispatchDepot","routing"],"type":"object"},"DispatchDepot":{"properties":{"depotNumbers":{"$ref":"#/components/schemas/DispatchDepot_depotNumbers"},"street":{"$ref":"#/components/schemas/Street_1"},"city":{"$ref":"#/components/schemas/City_1"},"countryAlpha2":{"$ref":"#/components/schemas/CountryAlpha2"},"postalCode":{"$ref":"#/components/schemas/PostalCode"}},"required":["city","countryAlpha2","depotNumbers","postalCode","street"],"type":"object"},"AztecFormats":{"enum":["PDF","PNG","SVG"],"type":"string"},"CodAccount":{"description":"The account to which the COD payment should be sent","properties":{"bankCode":{"deprecated":true,"description":"Code of your bank  \n\nDeprecated: Use the \"domestic\" object instead.\n","example":"0800","maxLength":4,"minLength":4,"type":"string"},"bankName":{"deprecated":true,"description":"Your custom bank designation (might be displayed to the customer).  \n\nWe suggest you use capital letters and numbers.  \n\nDeprecated: Use the \"domestic\" object instead.\n","example":"KOMERCNI BANKA","maxLength":30,"type":"string"},"accountNumber":{"deprecated":true,"description":"The account number without bankCode  \n\nDeprecated: Use the \"domestic\" object instead.\n","example":"654321-1234567890","maxLength":17,"minLength":17,"type":"string"},"accountName":{"deprecated":true,"description":"Your custom account number name for organizational purposes.  \n\nWe suggest using only capital letters and numbers.  \n\nDeprecated: Use the \"domestic\" object instead.\n","example":"SPOLECNOST HLAVNI UCET","maxLength":30,"type":"string"},"domestic":{"$ref":"#/components/schemas/CodAccount_domestic"},"international":{"$ref":"#/components/schemas/CodAccount_international"}},"type":"object"},"CountryIdent":{"oneOf":[{"$ref":"#/components/schemas/CountryIdent_oneOf"},{"$ref":"#/components/schemas/CountryIdent_oneOf_1"},{"$ref":"#/components/schemas/CountryIdent_oneOf_2"}]},"_parcels_labels_post_request":{"oneOf":[{"$ref":"#/components/schemas/StandardPrintTypeBatchInput"},{"$ref":"#/components/schemas/ZPLPrintTypeBatchInput"},{"$ref":"#/components/schemas/PDFPrintTypeBatchInput"}]},"_parcels__parcelIdent__labels_post_request":{"oneOf":[{"$ref":"#/components/schemas/StandardPrintTypeInput"},{"$ref":"#/components/schemas/ZPLPrintTypeInput"},{"$ref":"#/components/schemas/PDFPrintTypeInput"}]},"_parcels__parcelIdent__labels_post_parcelIdent_parameter":{"oneOf":[{"$ref":"#/components/schemas/ParcelId"},{"$ref":"#/components/schemas/ParcelNo"}]},"_pickup_orders__pickupOrderId__delete_200_response":{"properties":{"pickupId":{"$ref":"#/components/schemas/PickupOrderID"}},"required":["pickupId"],"type":"object"},"CustomerIdent_oneOf":{"properties":{"dsw":{"$ref":"#/components/schemas/CustomerDSW"}},"required":["dsw"],"type":"object"},"CustomerIdent_oneOf_1":{"properties":{"id":{"$ref":"#/components/schemas/CustomerID"}},"required":["id"],"type":"object"},"CustomerAddressIdent_oneOf":{"properties":{"id":{"$ref":"#/components/schemas/CustomerAddressId"}},"required":["id"],"type":"object"},"CustomerAddressIdent_oneOf_1":{"properties":{"it4emId":{"$ref":"#/components/schemas/CustomerAddressIt4emId"}},"required":["it4emId"],"type":"object"},"Me_customers_inner":{"properties":{"customer":{"$ref":"#/components/schemas/Customer"},"addresses":{"items":{"$ref":"#/components/schemas/CustomerAddress"},"type":"array"}},"required":["addresses","customer"],"type":"object"},"Shipment_services_selectedServices":{"allOf":[{"$ref":"#/components/schemas/ShipmentServices"},{"description":"The services that have been selected for this shipment"}]},"Shipment_services":{"properties":{"serviceCode":{"$ref":"#/components/schemas/ServiceCode"},"serviceCombination":{"$ref":"#/components/schemas/ServiceCombination"},"selectedServices":{"$ref":"#/components/schemas/Shipment_services_selectedServices"}},"required":["serviceCode","serviceCombination"],"type":"object"},"NewShipment_customer":{"allOf":[{"description":"Info about the customer under which this shipment should be tracked."},{"$ref":"#/components/schemas/CustomerIdent"}]},"NewShipment_parcels_inner_additionalServices_insurance":{"allOf":[{"description":"Additional insurance (Higher that the base insurance)\n"},{"$ref":"#/components/schemas/InsuranceInput"}]},"NewShipment_parcels_inner_additionalServices":{"properties":{"insurance":{"$ref":"#/components/schemas/NewShipment_parcels_inner_additionalServices_insurance"}},"type":"object"},"NewShipment_parcels_inner":{"properties":{"parcelNumber":{"allOf":[{"description":"Parcel number from your own parcel number range. \nIf you do not supply this property, the number will be automatically assigned\nby the system and will be returned in the response for further use.\n"},{"$ref":"#/components/schemas/ParcelNo"}]},"backParcelNumber":{"allOf":[{"$ref":"#/components/schemas/ParcelNo"},{"description":"Back parcel number is used in SWAP service for the parcel returned to you. When the number is not provided and SWAP service is selected, then this number will be autogenerated.\n"}]},"references":{"$ref":"#/components/schemas/ParcelReferences"},"additionalServices":{"$ref":"#/components/schemas/NewShipment_parcels_inner_additionalServices"},"weightGrams":{"$ref":"#/components/schemas/ParcelWeight"}},"type":"object"},"NewShipment_services":{"allOf":[{"$ref":"#/components/schemas/ShipmentServices"},{"description":"You can choose the DPD provided services in this section  \n\nThere are a lot of services that DPD offers,  \nbut only some combinations are valid.\n\n**Limitations**\n\nSome services can be used separately and others need to be combined with one another.\n\n- You can use the service table to find the correct service combination for your use case. TODO: Service table link\n- Or alternatively you can use the GET /services endpoint to get a list of all compatible services.\n"}]},"Address_1":{"description":"Physical address of the payer of the shipment","properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"title":"Address","type":"object"},"Payer_Specs_customerAddress":{"oneOf":[{"$ref":"#/components/schemas/CustomerAddressIdent"},{"$ref":"#/components/schemas/Address_1"}]},"ArbitraryAddressPickupOrderSpecs_arbitraryAddress":{"properties":{"info":{"$ref":"#/components/schemas/SubjectInfo"},"address":{"$ref":"#/components/schemas/Address"}},"required":["address","info"],"type":"object"},"PickupOrder_specs":{"oneOf":[{"$ref":"#/components/schemas/AddressPickupOrderSpecs"},{"$ref":"#/components/schemas/CollectionPickupOrderResponse"},{"$ref":"#/components/schemas/ArbitraryAddressPickupOrderSpecs"}]},"PDFPrintTypeInput_printProperties":{"oneOf":[{"$ref":"#/components/schemas/A4PrintProperties"},{"$ref":"#/components/schemas/A6PrintProperties"}]},"LabelData_delivery_pickupPoint":{"properties":{"pudoId":{"$ref":"#/components/schemas/PickupPointID"},"name":{"$ref":"#/components/schemas/PickupPointName"}},"required":["name","pudoId"],"type":"object"},"LabelData_delivery":{"properties":{"name1":{"$ref":"#/components/schemas/SubjectName"},"name2":{"$ref":"#/components/schemas/SubjectNameSecondary"},"phone":{"$ref":"#/components/schemas/PhoneNumber"},"contactPerson":{"$ref":"#/components/schemas/ContactPerson"},"street":{"$ref":"#/components/schemas/Street_1"},"houseNumber":{"$ref":"#/components/schemas/HouseNumber"},"city":{"$ref":"#/components/schemas/City_1"},"countryAlpha2":{"$ref":"#/components/schemas/CountryAlpha2"},"postalCode":{"$ref":"#/components/schemas/PostalCode"},"pickupPoint":{"$ref":"#/components/schemas/LabelData_delivery_pickupPoint"}},"required":["city","countryAlpha2","name1","postalCode","street"],"type":"object"},"LabelData_origin_sender":{"properties":{"name1":{"$ref":"#/components/schemas/SubjectName"},"name2":{"$ref":"#/components/schemas/SubjectNameSecondary"},"street":{"$ref":"#/components/schemas/Street_1"},"city":{"$ref":"#/components/schemas/City_1"},"countryAlpha2":{"$ref":"#/components/schemas/CountryAlpha2"},"postalCode":{"$ref":"#/components/schemas/PostalCode"}},"type":"object"},"LabelData_origin":{"properties":{"sender":{"$ref":"#/components/schemas/LabelData_origin_sender"},"dispatchDepot":{"$ref":"#/components/schemas/Depot"}},"required":["dispatchDepot","sender"],"type":"object"},"LabelData_parcel_references":{"properties":{"ref1":{"$ref":"#/components/schemas/ParcelReference1"},"ref2":{"$ref":"#/components/schemas/ParcelReference2"}},"type":"object"},"LabelData_parcel":{"properties":{"parcelNo":{"$ref":"#/components/schemas/ParcelNo"},"parcelNoCheck":{"description":"Parcel number check character","maxLength":1,"minLength":1,"type":"string"},"index":{"description":"The parcel index in the shipment (MPS)","type":"number"},"references":{"$ref":"#/components/schemas/LabelData_parcel_references"},"weightKilograms":{"type":"string"}},"required":["index","parcelNo","parcelNoCheck"],"type":"object"},"LabelData_service":{"description":"The shipping service/product specification","properties":{"combination":{"$ref":"#/components/schemas/ServiceCombination"},"code":{"$ref":"#/components/schemas/ServiceCode"},"additionalCode":{"$ref":"#/components/schemas/AdditionalCode"},"mark":{"description":"A shipping service mark (It is rarely used)","type":"string"},"text":{"description":"Service Text used in the routing part of the Label","type":"string"}},"required":["code","combination"],"type":"object"},"LabelData_cod":{"properties":{"amount":{"description":"The Cash On Delivery amount to be collected.\n","type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"payment":{"$ref":"#/components/schemas/PaymentType"},"variableSymbol":{"description":"Variable symbol of the COD payment","example":"17","maxLength":10,"type":"string"}},"required":["amount","currency","payment"],"type":"object"},"ShippingService_limitations_weightLimit":{"properties":{"maxWeightGrams":{"type":"number"}},"required":["maxWeightGrams"],"type":"object"},"ShippingService_limitations_mpsDisabled_oneOf_timeFrames_inner":{"properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"],"type":"object"},"ShippingService_limitations_mpsDisabled_oneOf":{"properties":{"timeFrames":{"items":{"$ref":"#/components/schemas/ShippingService_limitations_mpsDisabled_oneOf_timeFrames_inner"},"type":"array"}},"required":["timeFrames"],"type":"object"},"ShippingService_limitations_mpsDisabled":{"oneOf":[{"type":"boolean"},{"$ref":"#/components/schemas/ShippingService_limitations_mpsDisabled_oneOf"}]},"ShippingService_limitations_requiredContactInfo":{"properties":{"oneOf":{"items":{"type":"string"},"type":"array"},"allOf":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ShippingService_limitations_countryLimitations_origin_countries":{"properties":{"isoAlpha2":{"items":{"$ref":"#/components/schemas/CountryAlpha2"},"type":"array"}},"required":["isoAlpha2"],"type":"object"},"ShippingService_limitations_countryLimitations_origin":{"properties":{"mode":{"type":"string"},"countries":{"$ref":"#/components/schemas/ShippingService_limitations_countryLimitations_origin_countries"}},"required":["countries","mode"],"type":"object"},"ShippingService_limitations_countryLimitations":{"properties":{"origin":{"$ref":"#/components/schemas/ShippingService_limitations_countryLimitations_origin"},"destination":{"$ref":"#/components/schemas/ShippingService_limitations_countryLimitations_origin"}},"type":"object"},"ShippingService_limitations":{"properties":{"weightLimit":{"$ref":"#/components/schemas/ShippingService_limitations_weightLimit"},"noSameCountry":{"type":"boolean"},"supportedShipmentTypes":{"items":{"$ref":"#/components/schemas/ShipmentType"},"type":"array"},"mpsDisabled":{"$ref":"#/components/schemas/ShippingService_limitations_mpsDisabled"},"requiredContactInfo":{"$ref":"#/components/schemas/ShippingService_limitations_requiredContactInfo"},"printing":{"type":"string"},"countryLimitations":{"$ref":"#/components/schemas/ShippingService_limitations_countryLimitations"}},"required":["supportedShipmentTypes","weightLimit"],"type":"object"},"ShippingService_backVariant":{"properties":{"code":{"type":"string"},"additionalCode":{"$ref":"#/components/schemas/AdditionalCode"},"text":{"type":"string"},"combination":{"type":"string"},"prefix":{"type":"string"},"mark":{"type":"string"}},"required":["code","combination","prefix"],"type":"object"},"Error_description":{"oneOf":[{"type":"string"},{"type":"number"},{"additionalProperties":true,"description":"Object providing detailed information specific to the encountered error.\n\nThis may vary across different error responses.\n","type":"object"}]},"NewShipmentError_description":{"oneOf":[{"items":{"$ref":"#/components/schemas/DetailedError"},"type":"array"},{"type":"string"},{"type":"number"},{"additionalProperties":true,"description":"Object providing detailed information specific to the encountered error.\n\nThis may vary across different error responses.\n","type":"object"}]},"DetailedUnionError_issues_inner":{"properties":{"path":{"example":"0 -> receiver -> info -> name1","type":"string"},"message":{"example":"String must contain at most 35 character(s)","type":"string"}},"required":["path"],"type":"object"},"TrackingInput_parcels_inner":{"oneOf":[{"$ref":"#/components/schemas/ParcelNo"},{"$ref":"#/components/schemas/ParcelIdent"}]},"TrackingResult_parcelInfo_serviceDesignation":{"allOf":[{"$ref":"#/components/schemas/ServiceDesignation"},{"properties":{"backVariant":{"$ref":"#/components/schemas/ServiceDesignation"}},"type":"object"}]},"TrackingResult_parcelInfo_routing":{"properties":{"main":{"$ref":"#/components/schemas/RoutingData"},"back":{"$ref":"#/components/schemas/RoutingData"}},"type":"object"},"TrackingResult_parcelInfo":{"description":"Info about the parcel","properties":{"sender":{"$ref":"#/components/schemas/Sender"},"receiver":{"$ref":"#/components/schemas/Receiver"},"declaredSender":{"$ref":"#/components/schemas/DeclaredSender"},"pickupPointId":{"$ref":"#/components/schemas/PickupPointID"},"cod":{"$ref":"#/components/schemas/CashOnDeliveryService_1"},"serviceDesignation":{"$ref":"#/components/schemas/TrackingResult_parcelInfo_serviceDesignation"},"parcelId":{"$ref":"#/components/schemas/ParcelId"},"parcelNumber":{"$ref":"#/components/schemas/ParcelNo"},"routing":{"$ref":"#/components/schemas/TrackingResult_parcelInfo_routing"}},"required":["parcelId","parcelNumber","receiver","routing","sender","serviceDesignation"],"type":"object"},"TrackingResult_parcelEvents_inner_status":{"properties":{"statusCode":{"type":"string"},"description":{"type":"string"}},"required":["description","statusCode"],"type":"object"},"TrackingResult_parcelEvents_inner_service":{"properties":{"code":{"type":"string"},"additionalCode":{"type":"string"}},"required":["code"],"type":"object"},"TrackingResult_parcelEvents_inner":{"properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/TrackingResult_parcelEvents_inner_status"},"additionalInfo":{"type":"string"},"createdAt":{"type":"string"},"service":{"$ref":"#/components/schemas/TrackingResult_parcelEvents_inner_service"}},"required":["createdAt","id","status"],"type":"object"},"Country_codInfo":{"description":"Info about COD (Cash On Delivery) services for a country","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"maxAmountCents":{"description":"Maximum allowed COD amount for this country\n\nRepresented in cents of the given currency\n","type":"number"},"cardMaxAmountCents":{"description":"Maximum allowed COD amount for card payments for this country\n\nRepresented in cents of the given currency\n","type":"number"}},"type":"object"},"DropOffCodesInput_aztec":{"description":"If the options are filled in, the aztec code will be included in the selected format","properties":{"format":{"$ref":"#/components/schemas/AztecFormats"}},"required":["format"],"type":"object"},"DropoffCodes_pin":{"properties":{"value":{"type":"string"},"expiresAt":{"$ref":"#/components/schemas/DateTime"}},"required":["expiresAt","value"],"type":"object"},"DropoffCodes_aztec":{"properties":{"value":{"description":"Base64 encoded aztec code in the selected format","type":"string"},"format":{"$ref":"#/components/schemas/AztecFormats"}},"required":["format","value"],"type":"object"},"SubjectInfo_contact":{"properties":{"person":{"example":"John Doe","minLength":2,"type":"string"},"phone":{"$ref":"#/components/schemas/PhoneNumber"},"email":{"$ref":"#/components/schemas/Email"}},"type":"object"},"ParcelIdent_oneOf":{"properties":{"parcelNumber":{"$ref":"#/components/schemas/ParcelNo"}},"required":["parcelNumber"],"type":"object"},"ParcelIdent_oneOf_1":{"properties":{"id":{"$ref":"#/components/schemas/ParcelId"}},"required":["id"],"type":"object"},"RoutingData_destinationDepot_depotNumbers":{"properties":{"longNumber":{"type":"string"},"shortNumber":{"type":"string"}},"required":["longNumber","shortNumber"],"type":"object"},"RoutingData_destinationDepot":{"properties":{"depotNumbers":{"$ref":"#/components/schemas/RoutingData_destinationDepot_depotNumbers"}},"required":["depotNumbers"],"type":"object"},"DispatchDepot_depotNumbers":{"properties":{"longNumber":{"type":"string"},"shortNumber":{"type":"string"}},"type":"object"},"CodAccount_domestic":{"description":"Country specific bank account information.\n\nThis is currently reserved for CZ based bank accounts!  \n\nIf you provide any non CZ based bank acccount that will pass validation, it might get used for domestic CZ payments!\n","properties":{"bankCode":{"description":"Code of your bank","example":"0800","maxLength":4,"minLength":4,"type":"string"},"bankName":{"description":"Your custom bank designation (might be displayed to the customer).\n\nWe suggest you use capital letters and numbers.\n","example":"KOMERCNI BANKA","maxLength":30,"type":"string"},"accountNumber":{"description":"The account number without bankCode","example":"654321-1234567890","maxLength":17,"minLength":17,"type":"string"},"accountName":{"description":"Your custom account number name for organizational purposes.\n\nWe suggest using only capital letters and numbers.\n","example":"SPOLECNOST HLAVNI UCET","maxLength":30,"type":"string"}},"required":["accountName","accountNumber","bankCode","bankName"],"type":"object"},"CodAccount_international":{"properties":{"IBAN":{"description":"The IBAN of the COD account","example":"CZ6508000000192000145399","maxLength":34,"type":"string"},"BIC":{"description":"BIC - The SWIFT Address assigned to a bank","example":"KOMBCZPP","maxLength":11,"minLength":8,"type":"string"}},"required":["BIC","IBAN"],"type":"object"},"CountryIdent_oneOf":{"properties":{"isoAlpha3":{"$ref":"#/components/schemas/CountryAlpha3"}},"required":["isoAlpha3"],"type":"object"},"CountryIdent_oneOf_1":{"properties":{"isoAlpha2":{"$ref":"#/components/schemas/CountryAlpha2"}},"required":["isoAlpha2"],"type":"object"},"CountryIdent_oneOf_2":{"properties":{"isoNumeric":{"$ref":"#/components/schemas/CountryNumeric"}},"required":["isoNumeric"],"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"description":"Every account will receive its unique API key.  \nThis key is used to uniquely identify your account.","in":"header","name":"x-api-key","type":"apiKey"}}}}