{"openapi":"3.1.0","info":{"title":"META-API Shipment","version":"3.3.26\n2026-07-23 12:55:02"},"servers":[{"url":"https://api.dpdgroup.com"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"shipping","description":"the shipping API"}],"paths":{"/shipping/v2/shipment":{"post":{"tags":["shipping"],"operationId":"shippingV2ShipmentPost","parameters":[{"name":"LabelPrintFormat","in":"query","required":true,"schema":{"type":"string","enum":["PDF","EPL","ZPL","TIFF","PPR","SPD","Z2D","THE","XML","XML2D","THEPSG","ZPLPSG","ZPL300","JSON","PS","DATA","CLP","HTML","PNG","GIF","RAW"]}},{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"ExtraBarcode","in":"header","required":false,"schema":{"type":"boolean"}},{"name":"PUS-CLIENT-KEY","in":"header","required":false,"schema":{"type":"string"}},{"name":"LabelPaperFormat","in":"query","required":false,"schema":{"type":"string","enum":["A4","A5","A6","A7"]}},{"name":"LabelPrinterStartPosition","in":"query","required":false,"schema":{"type":"string","enum":["UPPER_LEFT","UPPER_RIGHT","LOWER_LEFT","LOWER_RIGHT"]}},{"name":"qrcode","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"DropOffType","in":"query","required":false,"schema":{"type":"string","enum":["FULL_LABEL","QR_CODE","BOTH"]}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"LabelPrintResolution","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"simulate","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"withDocument","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"AUTO-PUS-SELECTOR","in":"query","required":false,"schema":{"type":"string","enum":["DSS","APS"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentResponse"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}]}},"/shipping/v2/pickupscheduling":{"post":{"tags":["shipping","pickupsched"],"operationId":"shippingV2PickupschedulingPost","parameters":[{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"simulate","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupSchedule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}]}},"/shipping/v2/colreq":{"post":{"tags":["shipping","collection request"],"operationId":"shippingV2ColreqPost","parameters":[{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"simulate","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}]}},"/shipping/v1/shipment":{"post":{"tags":["shipping"],"operationId":"shippingV1ShipmentPost","parameters":[{"name":"LabelPrintFormat","in":"query","required":true,"schema":{"type":"string","enum":["PDF","EPL","ZPL","TIFF","PPR","SPD","Z2D","THE","XML","XML2D","THEPSG","ZPLPSG","ZPL300","JSON","PS","DATA","CLP","HTML","PNG","GIF","RAW"]}},{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"ExtraBarcode","in":"header","required":false,"schema":{"type":"boolean"}},{"name":"PUS-CLIENT-KEY","in":"header","required":false,"schema":{"type":"string"}},{"name":"LabelPaperFormat","in":"query","required":false,"schema":{"type":"string","enum":["A4","A5","A6","A7"]}},{"name":"LabelPrinterStartPosition","in":"query","required":false,"schema":{"type":"string","enum":["UPPER_LEFT","UPPER_RIGHT","LOWER_LEFT","LOWER_RIGHT"]}},{"name":"qrcode","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"DropOffType","in":"query","required":false,"schema":{"type":"string","enum":["FULL_LABEL","QR_CODE","BOTH"]}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"LabelPrintResolution","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"simulate","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"withDocument","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"AUTO-PUS-SELECTOR","in":"query","required":false,"schema":{"type":"string","enum":["DSS","APS"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Shipment"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipment.ShipmentResponse"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipment.Error"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipment.Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipment.Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shipment.Error"}}}}},"security":[{"bearerAuth":[]}]}},"/shipping/v1/pickupscheduling":{"post":{"tags":["shipping","pickupsched"],"operationId":"shippingV1PickupschedulingPost","parameters":[{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"simulate","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickupscheduling.PickupSchedule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickupscheduling.Response"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickupscheduling.Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickupscheduling.Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickupscheduling.Error"}}}}},"security":[{"bearerAuth":[]}]}},"/shipping/v1/login":{"post":{"tags":["shipping","login"],"operationId":"shippingV1LoginPost","parameters":[{"name":"X-DPD-BUCODE","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-DPD-LOGIN","in":"header","required":false,"schema":{"type":"string"}},{"name":"X-DPD-PASSWORD","in":"header","required":false,"schema":{"type":"string"}},{"name":"X-DPD-CLIENTID","in":"header","required":false,"schema":{"type":"string"}},{"name":"X-DPD-CLIENTSECRET","in":"header","required":false,"schema":{"type":"string"}},{"name":"force","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/shipping/v1/label":{"post":{"tags":["shipping","label"],"operationId":"shippingV1LabelPost","parameters":[{"name":"LabelPrintFormat","in":"query","required":true,"schema":{"type":"string","enum":["PDF","EPL","ZPL","TIFF","PPR","SPD","Z2D","THE","XML","XML2D","THEPSG","ZPLPSG","ZPL300","JSON","PS","DATA","CLP","HTML","PNG","GIF","RAW"]}},{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"LabelPaperFormat","in":"query","required":false,"schema":{"type":"string","enum":["A4","A5","A6","A7"]}},{"name":"LabelPrinterStartPosition","in":"query","required":false,"schema":{"type":"string","enum":["UPPER_LEFT","UPPER_RIGHT","LOWER_LEFT","LOWER_RIGHT"]}},{"name":"LabelPrintResolution","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label.LabelRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label.LabelResponse"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label.Error"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label.Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label.Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/label.Error"}}}}},"security":[{"bearerAuth":[]}]}},"/shipping/v1/colreq":{"post":{"tags":["shipping","collection request"],"operationId":"shippingV1ColreqPost","parameters":[{"name":"X-DPD-REQUESTOR","in":"header","required":false,"schema":{"type":"string"}},{"name":"debug","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"simulate","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colreq.Collection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colreq.Response"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colreq.Error"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colreq.Error"}}}},"408":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colreq.Error"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colreq.Error"}}}}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"Debug":{"type":"object","properties":{"request":{"type":"string"},"response":{"type":"string"},"methodName":{"type":"string"}}},"Label":{"type":"object","properties":{"base64Data":{"type":"string"},"media-type":{"type":"string"},"qrcode":{"type":"string","description":"BALTICS specificity, format always in PNG"},"pincode":{"type":"string","description":"BALTICS specificity"}}},"ParcelBarcode":{"type":"object","properties":{"parcel":{"type":"string","description":"Parcel number."},"barcode":{"type":"string"},"reference":{"type":"string"}}},"QrCode":{"type":"object","properties":{"base64Data":{"type":"string","description":"qr code data base64 encoded"},"media-type":{"type":"string","description":"format of the label"},"pincode":{"type":"string","description":"pin code"}}},"ShipmentResponse":{"type":"object","properties":{"warningMessage":{"type":"string"},"shipmentId":{"type":"string"},"parcelIds":{"type":"array","description":"List of parcel Ids","items":{"type":"string"}},"networkShipmentId":{"type":"string"},"networkParcelIds":{"type":"array","description":"List of parcel Ids","items":{"type":"string"}},"parcelBarcodes":{"type":"array","items":{"$ref":"#/components/schemas/ParcelBarcode"}},"label":{"$ref":"#/components/schemas/Label"},"qrcode":{"$ref":"#/components/schemas/QrCode"},"others":{"type":"array","description":"List of other label","items":{"$ref":"#/components/schemas/Label"}},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/Debug"}}}},"Error":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"errorOrigin":{"type":"string","description":"Identifies where the error occurred.","enum":["META-API","BU-API"]}}},"Address":{"type":"object","properties":{"companyName":{"type":"string","description":"Company Name"},"name1":{"type":"string","description":"Name"},"name2":{"type":"string","description":"Name"},"street":{"type":"string","description":"Street"},"houseNumber":{"type":"string","description":"House number (could be included into in the address field and not set)."},"addressLine2":{"type":"string","description":"Address Line 2"},"addressLine3":{"type":"string","description":"Address Line 3"},"interphoneName":{"type":"string","description":"Name on the interphone"},"floor":{"type":"string","description":"Information on the floor (e.g. if located in a huge office building)"},"doorCode":{"type":"string","description":"A code to open the door . It is possible to input 3 different codes separated by a /"},"building":{"type":"string","description":"Information of the building (e.g. when located on a big campus)."},"department":{"type":"string","description":"Information on the department (e.g. when located in a huge office-building with different departments on the same floor)."},"country":{"type":"string","description":"country (ISO 3166). All three ISO standards will be accepted: * ISO 3166-1: 2 Alpha Numerical Characters * ISO 3166-1: 3 Alpha Numerical Characters * ISO 3166-1: 3 Numerical Characters "},"state":{"type":"string","description":"State within the country, e.g. CA for California."},"zipCode":{"type":"string","description":"Destination zipcode of the parcel"},"city":{"type":"string","description":"city"},"siteId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Used for all address types."},"siteType":{"type":"string","description":"SPEEDY specificity. Site type can be used in conjunction with countryId and siteName to find unique site. Used for addresses of type 1 (local address)."},"siteName":{"type":"string","description":"SPEEDY specificity. Site type can be used in conjunction with countryId and siteName to find unique site. Used for all address types."},"streetId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Street identifier. If not provided, but street type and street name are provided - the system will try to find unique match by them in site. Used for addresses of type 1 (local address)."},"streetType":{"type":"string","description":"SPEEDY specificity. Street type. Used for addresses of type 1 (local address)."},"complexId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Complex identifier. If not provided, but complex type and complex name are provided - the system will try to find unique match by them in site. Used for addresses of type 1 (local address)."},"complexType":{"type":"string","description":"SPEEDY specificity. Complex type. Used for addresses of type 1 (local address)."},"complexName":{"type":"string","description":"SPEEDY specificity. Complex name. Used for addresses of type 1 (local address)."},"blockNo":{"type":"string","description":"SPEEDY specificity. Block No. Used for addresses of type 1 (local address)."},"entranceNo":{"type":"string","description":"SPEEDY specificity. Entrance. Used for addresses of type 1 (local address)."},"apartmentNo":{"type":"string","description":"SPEEDY specificity. Apartment. Used for addresses of type 1 (local address)."},"poiId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Point of interest identifier. Used for addresses of type 1 (local address)."}}},"Amount":{"type":"object","properties":{"amount":{"type":"number","format":"float","description":"The number of decimal will depend of the currency (it could be from 0 to three digit).","example":48.831},"currency":{"type":"string","description":"Currency code (ISO 4217 alpha 3)"}},"required":["amount","currency"]},"Cifcost":{"type":"object","properties":{"amount":{"type":"number","format":"float","description":"The number of decimal will depend of the currency (it could be from 0 to three digit).","example":48.831},"currency":{"type":"string","description":"Currency code (ISO 4217 alpha 3)"}},"required":["amount","currency"]},"Cod":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/Amount"},"collectType":{"type":"string","description":"Collection type   * `s0` : cash   * `s1` : crossed cheque   * `s2` : credit card   * `s3` : ...   * `s9` : default (depending of the receiving BU)   * Values with uppercase are accepted as well: S0, S1, S2, S3, S9 "},"purpose":{"type":"string","description":"Intended use"},"bankCode":{"type":"string","description":"Bank Code"},"bankName":{"type":"string","description":"Bank Name"},"bankAccountNumber":{"type":"string","description":"Bank account number"},"bankAccountName":{"type":"string","description":"Account holder"},"iban":{"type":"string","description":"International account number"},"bic":{"type":"string","description":"Bank Code"}},"required":["amount"]},"ContactDetails":{"type":"object","properties":{"contactPerson":{"type":"string","description":"Name of the person to contact"},"phone1":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"phone2":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"fax":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"email":{"type":"string","description":"Email address"}}},"CustomerInfos":{"type":"object","properties":{"customerAccountNumber":{"type":"string","description":"BU’s Internal Customer’s Account Number"},"customerSubAccountNumber":{"type":"string","description":"Customer number SUBID"},"customerID":{"type":"string","description":"BU’s internal Unique Customer ID/Identifier"},"originalCustomerId":{"type":"string","description":"Original customer ID for Integration Customers in certain DPD Business Units"}}},"Delivery":{"type":"object","properties":{"dateFrom":{"type":"string","format":"date"},"dateTo":{"type":"string","format":"date"},"timeFrom":{"type":"string"},"timeTo":{"type":"string"},"timeSlotTariff":{"type":"string"}}},"Dimensions":{"type":"object","properties":{"length":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"width":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"height":{"type":"integer","format":"int32","description":"Dimmension in cm units"}}},"Document":{"type":"object","properties":{"documentType":{"type":"string"},"creationDateTime":{"type":"string","format":"date-time"}}},"Hazardous":{"type":"object","properties":{"classCode":{"type":"string","description":"Substance identification: Classification code"},"identificationClass":{"type":"string","description":"Substance identification: Class"},"substanceWeight":{"type":"string","description":"Net weight of the hazardous substance in Grams."},"factor":{"type":"integer","format":"int32","description":"Factor of the substance"},"notOtherwiseSpecified":{"type":"string","description":"Not else named"},"packingGroup":{"type":"string","description":"Substance identification: Packing group"},"subsidiaryRisk":{"type":"string","description":"Substance sub-danger"},"description":{"type":"string","description":"Substance description"},"hazardousWeight":{"type":"string","description":"Total weight of the hazardous articles in Grams."},"tunnelRestrictionCode":{"type":"string","description":"Tunnel restriction code"},"identificationUnNo":{"type":"string","description":"Substance identification: UN-No."},"packingCode":{"type":"string","description":"Packing code (see PACKINGCODE). Mandatory in case of hazardous parcel"}}},"Insurance":{"type":"object","properties":{"insuranceAmount":{"$ref":"#/components/schemas/Amount"},"insuranceParcelContent":{"type":"string","description":"Description of parcel for insurance"}}},"InterInvoiceLine":{"type":"object","properties":{"invoicePosition":{"type":"string","description":"Line number of the invoice"},"quantityOfItems":{"type":"string","description":"Quantity of items per article or invoice line even for low / mid / high value or any type of customer"},"content":{"type":"string","description":"Content (Depending of the destination system. Could be cut by some system to the first 35 characters)"},"amountOfPosition":{"type":"number","format":"float"},"manufacturedCountry":{"type":"string"},"netWeight":{"type":"string","description":"Total weight of the articles in the current line, excluding packaging, in grams."},"grossWeight":{"type":"string","description":"Total weight of the articles including packaging in the current line, in grams."},"customerProductCode":{"type":"string","description":"Internal Customer product code"},"productDescription":{"type":"string","description":"Short description of the product"},"fabricComposition":{"type":"string","description":"Description of fabric composition"},"importTarifCode":{"type":"string"},"exportTarifCode":{"type":"string"},"goodsWebPage":{"type":"string","format":"uri"},"parcelRank":{"type":"string","description":"Rank of the parcel within a multi-piece shipment. Set to one for the masterpiece of the shipment or for a single piece. Default = Blank"}}},"International":{"type":"object","properties":{"parcelType":{"type":"string","description":"Parcel type within the shipment. Different parcel types can't be mixed into one shipment * `D` : Document  * `P` : Non-Doc "},"customsAmount":{"$ref":"#/components/schemas/Amount"},"customsAmountEx":{"$ref":"#/components/schemas/Amount"},"customsTerms":{"type":"string","description":"Parcel type within the shipment Different parcel types can't be mixed into one shipment * `s01` : DAP, not cleared * `s02` : DDP, delivered duty paid (incl. duties and excl. taxes) * `s03` : DDP, delivered duty paid (incl. duties and taxes) * `s05` : ex works (EXW) * `s06` : DAP * `s07` : DAP & DDP enhanced, Duty and taxes were pre-paid by the receiver' ","enum":["s01","s02","s03","s04","s05","s06","s07"]},"customsPaper":{"type":"string","description":"Accompanying documents e.g. A | G | B Separator is \"|\" (a pipe) in case of multiple invoice documents * `A` : commercial invoice * `B` : pro forma invoice * `C` : export declaration * `D` : EUR1 * `E` : EUR2 * `F` : ATR * `G` : delivery note * `H` : third party billing * `I` : T1 document ","enum":["A","B","C","D","E","F","G","H","I"]},"clearanceStatus":{"type":"string","description":"Values:   * `N` : No  * `F` : Free  * `E` : Export Cleared  * `T` : Transit Cleared  * `I` : Import Cleared  * `H` : Hybrid ","enum":["N","F","E","T","I","H"]},"customsHighLowValue":{"type":"string","description":"(H)igh, (M)id (above 22€ and below 150€), (L)ow.  * `H` : High  * `M` : Medium   * `L` : Low ","enum":["H","M","L"]},"customsInvoice":{"type":"string","description":"Invoice number Separator is \"|\" (a pipe) in case of multiple invoice numbers"},"customsInvoiceDates":{"type":"array","description":"Invoice dates","items":{"type":"string","format":"date"}},"importer":{"$ref":"#/components/schemas/InternationalImporter"},"mrn":{"type":"string","description":"MRN of the electronic export declaration Remarks: The \"|\" is the separator between two MRN."},"exporter":{"$ref":"#/components/schemas/InternationalExporter"},"numberOfArticles":{"type":"string","description":"This is the real number of commodities (ImportTarifCode / ExportTarifCode). The number of Interinvoicelines must equal the NumberOfArticles"},"destinationCountryRegistration":{"type":"string","description":"Destination country registration information : Registration number or FDA If destination is DPD UK : Applies to B2B and B2C (Not applicable for C2C) shipments with a goods value under £135 (Excludes shipping cost) and if the Incoterm is not DDP. This is expected to come into force March 19, however no official communication from HMRC yet."},"exportReason":{"type":"string","description":"Reason for export  * `s01` : sale  * `s02` : return/replacement  * `s03` : gift ","enum":["s01","s02","s03"]},"interInvoiceLines":{"type":"array","items":{"$ref":"#/components/schemas/InterInvoiceLine"}},"shipmentContent":{"type":"string","description":"A detailed description of the overall contents of the consignement (UK->EU export only)"}}},"InternationalExporter":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"eori":{"type":"string"}}},"InternationalImporter":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"gln":{"type":"string","description":"GLN number (Global location number)"},"vatNumber":{"type":"string"},"customerDefermentNumber":{"type":"string","description":"Customer deferment number with can be used for duty tax collection"},"eori":{"type":"string","description":"EORI number, dependency of the customs export regime."}}},"LegalEntity":{"type":"object","properties":{"businessType":{"type":"string","description":"Business Type:   * `P` : PRIVATE   * `B` : BUSINESS ","enum":["P","B"]},"eori":{"type":"string"},"vatNumber":{"type":"string"},"taxIdType":{"type":"string","description":"Type of document if businessType = B, this field becomes mandatory (dependency of the customs export regime) applicable or not according export customs clearance of origin country if businessType = P, this field is empty. Note - Data in this field to be captured based on the rules of each BU.   * `P` : PASSPORT Number   * `C` : CNPJ (ou CPF) Number (Brésil) ","enum":["P","C"]},"taxIdValue":{"type":"string","description":"Document information. Data in this field to be captured based on the rules of each BU. Become mandatory if IDType is filled"},"webSite":{"type":"string","format":"uri"},"FiscalVatRepresentant":{"type":"string","description":"Fiscal VAT number. This field should be left Blank / Empty and Only populated with the Fiscal VAT number if applicable / known"}}},"MaskedSender":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/ContactDetails"}}},"Message":{"type":"object","properties":{"messageType":{"type":"string","description":"Notification type * `EMAIL` * `PHONE` * `SMS` * `APP` ","enum":["EMAIL","PHONE","SMS","APP"]},"messageDestination":{"type":"string","description":"Destination for the notification, e.g. telephone number, email address, etc. … The required data format for the pro active message types SMS, phone and FAX is as follows: \"+international country numberphone number\" Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX' "},"messageLanguage":{"type":"string","description":"Language of the proactive notification 2 (ISO 639-1 alpha 2 code, e.g. DE). MSG are maintain per BU. The list of available language is maintain by the BU which send the message.. Default language will be the one in the BU which send the message. "},"messageDestType":{"type":"string","description":"Destination stakeholder of the notification: * `s0` : Receiver / Consignee (default if not provided) * `s1` : Sender / Consignor * `s2` : Requester * `s3` : Other ","enum":["s0","s1","s2","s3"]},"senderCompany":{"type":"string"}}},"ModelReturn":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/CustomerInfos"},"address":{"$ref":"#/components/schemas/Address","description":"return Address"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"comment":{"type":"string"},"depot":{"type":"string","description":"GeoRouting depot code 7 digits - BU code 3 digits + 4 | specificy for BRT - fill with the ID given by your representative"}}},"Parcel":{"type":"object","properties":{"parcelInfos":{"$ref":"#/components/schemas/ParcelInfos"},"parcelRank":{"type":"string","description":"Rank of the parcel within a multi-piece shipment. Set to one for the masterpiece of the shipment or for a single piece. Default = Blank"},"senderParcelRefs":{"type":"array","description":"List of sender parcels references","items":{"type":"string"}},"partnerParcelRefs":{"type":"array","description":"Partner´s own parcel reference field","items":{"type":"string"}},"insurance":{"$ref":"#/components/schemas/Insurance"},"hazardousLimitedQuantities":{"type":"boolean","description":"Limited quantities of hazardous goods parcel value. "},"hazardousPackingCode":{"type":"string","description":"Packing code * `0A` Thin sheet packing * `0A1` Thin sheet packing with non removable head * `0A2` Thin sheet packing with removable head * `1A` Steel barrel * `1A1` Steel barrel with non removable head * `1A2` Steel barrel with removable head * `1B` Aluminum barrel * `1B1` Aluminum barrel with non removable head * `1B2` Aluminum barrel with removable head * `1H` Plastics barrel * `1H1` Plastics barrel with non removable head * `1H2` Plastics barrel with removable head * `3A` Steel canister * `3A1` Steel canister with non removable head * `3A2` Steel canister with removable head * `3B` Aluminum canister * `3B1`  Aluminum canister with non removable head * `3B2` Aluminum canister with removable head * `3H` Plastics canister * `3H1` Plastics canister with non removable head * `3H2` Plastics canister with removable head * `4A` Steel crates * `4B` Aluminum crate * `4D` Plywood crate * `4G` Cardboard crate * `4H` Plastics crate * `4H1` Plastics crate-plastics expanded * `4H2` Plastics crate-plastics solid * `5H` Plastics bags * `5M` Paper bags * `6H` Combination packing "},"parcelContent":{"type":"string","description":"Content (Depending of the destination systems. Could be cut by some system to the first 35 characters) The language recommended in this field is English"},"cod":{"$ref":"#/components/schemas/Cod"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"hazardous":{"type":"array","items":{"$ref":"#/components/schemas/Hazardous"}},"reference":{"type":"string","description":"Field used only by PL customers to transmit the reference associated with the parcel number."}}},"ParcelInfos":{"type":"object","properties":{"parcelNumber":{"type":"string","description":"Parcel number."},"parcelNumberCcKey":{"type":"string","description":"Control character key compute from the parcel number."},"dimensions":{"$ref":"#/components/schemas/Dimensions"},"weight":{"type":"string"}}},"Person":{"type":"object","properties":{"personalDeliveryType":{"type":"string","description":"Personal delivery type:  * `s1` : department delivery (without personal identification)  * `s2` : personal delivery with personal identification (IDCheck)  * `s3` : personal delivery without personal identification at PUDO (e.g. Direct PUDO delivery)  * `s4` : personal delivery with personal identification at PUDO (e.g. Direct PUDO delivery)  * `s5` : personal delivery with personal identification at PUDO plus ID-Check (e.g. Direct PUDO delivery)  * `s6` : personal delivery with personal identification (ID Check) and recording of the ID. ","enum":["s1","s2","s3","s4","s5","s6"]},"personalAuthorizedName":{"type":"string"},"phone1":{"type":"string"},"phone2":{"type":"string"},"personalIdNumber":{"type":"string","description":"Real consignee's personal identification number."},"personalDateOfBirth":{"type":"string","format":"date"},"address":{"$ref":"#/components/schemas/Address"},"contact":{"type":"string","description":"Recipient contact person. Could be different of the consignee's name"},"fax":{"type":"string"},"email":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"comment":{"type":"string"}}},"Pickup":{"type":"object","properties":{"date":{"type":"string","format":"date"},"fromTime":{"type":"string"},"toTime":{"type":"string"}},"required":["date"]},"Receiver":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/CustomerInfos"},"pudoId":{"type":"string","description":"ID number of PUDO point (parcel shop, post office, customer network point, etc., .) This field must use the GeoPost standard PUDO definition (Mandatory for the Cross Border delivery) e.g: CC12345 with: CC: Country Code compliant with ISO 3166-1: 2 Alpha Numerical Characters 12345: PUDO Number' "},"address":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"comment":{"type":"string"},"legalEntity":{"$ref":"#/components/schemas/LegalEntity"}}},"Sender":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/CustomerInfos"},"pudoId":{"type":"string","description":"ID number of PUDO point (parcel shop, post office, customer network point, etc., .) This field must use the GeoPost standard PUDO definition (Mandatory for the Cross Border delivery) e.g: CC12345 with: CC: Country Code compliant with ISO 3166-1: 2 Alpha Numerical Characters 12345: PUDO Number' "},"addressId":{"type":"string","description":"sender AddressId (for CZ, SK, SPEEDY, BALTICS)"},"address":{"$ref":"#/components/schemas/Address"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"accountOwner":{"type":"string","description":"Define the owner of the customer account customer. This owner is responsible to bill the parcel."},"legalEntity":{"$ref":"#/components/schemas/LegalEntity"},"maskedSender":{"$ref":"#/components/schemas/MaskedSender"}}},"Shipment":{"type":"object","properties":{"return":{"$ref":"#/components/schemas/ModelReturn"},"shipmentInfos":{"$ref":"#/components/schemas/ShipmentInfos"},"customsReference":{"type":"string","description":"Consignment number for the customs point of view."},"sendingDepot":{"type":"string"},"mpsCompleteDelivery":{"type":"string","description":"Values :   * `s0` - Reserved for the future usage (default)   * `s1` - No complete delivery (MPS incomplete)   * `s2` - Complete delivery (MPS complete). It is mandatory for COD ","enum":["s0","s1","s2"]},"mpsCompleteDeliveryLabel":{"type":"string","description":"Defines if the label for complete delivery is printed for pickup. Default value is false."},"customerReferenceNumbers":{"type":"array","items":{"type":"string"}},"customerBillingReference":{"type":"string","description":"Customer reference for billing or clearing"},"cifcost":{"$ref":"#/components/schemas/Cifcost"},"numberOfParcels":{"type":"string","description":"Number of parcels per shipment. A 0 value is acceptable in some BUs and will trigger an open multi-piece shipment, with automated or manual consolidation"},"sender":{"$ref":"#/components/schemas/Sender"},"receiver":{"$ref":"#/components/schemas/Receiver"},"international":{"$ref":"#/components/schemas/International"},"person":{"$ref":"#/components/schemas/Person"},"parcel":{"type":"array","items":{"$ref":"#/components/schemas/Parcel"}},"pickup":{"$ref":"#/components/schemas/Pickup"},"delivery":{"$ref":"#/components/schemas/Delivery"},"payerType":{"type":"string","description":"* `S` : Sender * `R` : Receiver * `3` : 3rd party ","enum":["S","R","3"]},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"shippingDate":{"type":"string","format":"date"}},"required":["numberOfParcels","parcel","receiver","sender"]},"ShipmentInfos":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Shipment ID Could be the ID of the first parcel of the list (master ID) or could be another ID specially created for that."},"shipmentIdCKey":{"type":"string","description":"Control character key compute from the shipmentId"},"productCode":{"type":"string","description":"DPD Product used for the shipment (\"101\" for DPD CLASSIC, ...)"},"serviceCode":{"type":"string","description":"Additional local service code, needed only in certain Business Units"},"additionalServiceCode":{"type":"string","description":"DPD Additional Service required for specific services, describing first and last mile handling"},"dimensions":{"$ref":"#/components/schemas/Dimensions"},"weight":{"type":"string","description":"Weight in grams units (e.g. 3000 equals 3kg)"},"exWorksDelivery":{"type":"boolean","description":"Specific field for DPD DE. Specifies if the recipient has to pay the consignment."}},"required":["productCode"]},"Response":{"type":"object","properties":{"collectionId":{"type":"string"},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/Debug"}},"parcelId":{"type":"string"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/Status"}}}},"PickupSchedule":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/CustomerInfos"},"shipmentNumbers":{"type":"array","description":"List of Shipment numbers for the Pickup","items":{"type":"string"}},"parcelNumbers":{"type":"array","description":"List of Parcel Numbers for the PickUp","items":{"type":"string"}},"pickup":{"$ref":"#/components/schemas/Pickup"},"numberOfParcels":{"type":"integer","format":"int32","description":"Quantity (Number) of Parcels"},"addressId":{"type":"string","description":"AddressId"},"pickupAddress":{"$ref":"#/components/schemas/Address"},"pickupContact":{"$ref":"#/components/schemas/ContactDetails"},"pickupWeight":{"type":"string","description":"Weight in grams units without decimal delimiter (e.g. 3000 equals 3kg) of all the parcels that will picked up"},"parcelMaxWeight":{"type":"string","description":"Weight in grams units without decimal delimiter (e.g. 3000 equals 3kg) of the heaviest parcel"},"parcelMaxDimensions":{"$ref":"#/components/schemas/Dimensions"},"comment":{"type":"string"},"references":{"type":"array","description":"Reference of the pickup request, defined by the customer","items":{"type":"string"}},"sendingDepot":{"type":"string","description":"GeoRouting depot code 7 digits - BU code 3 digits + 4 | specificy for BRT - fill with the ID given by your representative"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"Status":{"type":"object","properties":{"code":{"type":"string"},"info":{"type":"string"},"description":{"type":"string"}}},"Collection":{"type":"object","properties":{"requestId":{"type":"string","description":"The order of collection request."},"collectionInfos":{"$ref":"#/components/schemas/CollectionInfos"},"customerReferenceNumbers":{"type":"array","items":{"type":"string"}},"collectionPoint":{"$ref":"#/components/schemas/CollectionPoint"},"customer":{"$ref":"#/components/schemas/Customer"},"receiver":{"$ref":"#/components/schemas/Receiver"},"parcel":{"$ref":"#/components/schemas/Parcel"},"pickup":{"$ref":"#/components/schemas/Pickup"}},"required":["collectionPoint","parcel","receiver"]},"CollectionInfos":{"type":"object","properties":{"serviceCode":{"type":"string","description":"SEUR specificity. Possible values: 1, 31"},"dimensions":{"$ref":"#/components/schemas/Dimensions"},"weight":{"type":"string","description":"Weight in grams units without decimal delimiter (e.g. 3000 equals 3kg)"},"productCode":{"type":"string","description":"DPD Product used for the shipment (\"101\" for DPD CLASSIC, ...)"}}},"CollectionPoint":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/CustomerInfos"},"address":{"$ref":"#/components/schemas/Address"},"addressId":{"type":"string","description":"sender AddressId"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"accountOwner":{"type":"string","description":"Define the owner of the customer account customer. This owner is responsible to bill the parcel."},"legalEntity":{"$ref":"#/components/schemas/LegalEntity"}}},"Customer":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/CustomerInfos"},"address":{"$ref":"#/components/schemas/Address"},"addressId":{"type":"string","description":"Customer AddressId"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"accountOwner":{"type":"string","description":"Define the owner of the customer account customer. This owner is responsible to bill the parcel."},"legalEntity":{"$ref":"#/components/schemas/LegalEntity"}}},"shipment.Debug":{"type":"object","properties":{"request":{"type":"string"},"response":{"type":"string"},"methodName":{"type":"string"}}},"shipment.Label":{"type":"object","properties":{"base64Data":{"type":"string"},"media-type":{"type":"string"},"qrcode":{"type":"string","description":"BALTICS specificity, format always in PNG"},"pincode":{"type":"string","description":"BALTICS specificity"}}},"shipment.ParcelBarcode":{"type":"object","properties":{"parcel":{"type":"string","description":"Parcel number."},"barcode":{"type":"string"},"reference":{"type":"string"}}},"shipment.QrCode":{"type":"object","properties":{"base64Data":{"type":"string","description":"qr code data base64 encoded"},"media-type":{"type":"string","description":"format of the label"},"pincode":{"type":"string","description":"pin code"}}},"shipment.ShipmentResponse":{"type":"object","properties":{"warningMessage":{"type":"string"},"shipmentId":{"type":"string"},"parcelIds":{"type":"array","description":"List of parcel Ids","items":{"type":"string"}},"networkShipmentId":{"type":"string"},"networkParcelIds":{"type":"array","description":"List of parcel Ids","items":{"type":"string"}},"parcelBarcodes":{"type":"array","items":{"$ref":"#/components/schemas/shipment.ParcelBarcode"}},"label":{"$ref":"#/components/schemas/shipment.Label"},"qrcode":{"$ref":"#/components/schemas/shipment.QrCode"},"others":{"type":"array","description":"List of other label","items":{"$ref":"#/components/schemas/shipment.Label"}},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Debug"}}}},"shipment.Error":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"errorOrigin":{"type":"string","description":"Identifies where the error occurred.","enum":["META-API","BU-API"]},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Debug"}}}},"shipment.Address":{"type":"object","properties":{"companyName":{"type":"string","description":"Company Name"},"name1":{"type":"string","description":"Name"},"name2":{"type":"string","description":"Name"},"street":{"type":"string","description":"Street"},"houseNumber":{"type":"string","description":"House number (could be included into in the address field and not set)."},"addressLine2":{"type":"string","description":"Address Line 2"},"addressLine3":{"type":"string","description":"Address Line 3"},"interphoneName":{"type":"string","description":"Name on the interphone"},"floor":{"type":"string","description":"Information on the floor (e.g. if located in a huge office building)"},"doorCode":{"type":"string","description":"A code to open the door . It is possible to input 3 different codes separated by a /"},"building":{"type":"string","description":"Information of the building (e.g. when located on a big campus)."},"department":{"type":"string","description":"Information on the department (e.g. when located in a huge office-building with different departments on the same floor)."},"country":{"type":"string","description":"country (ISO 3166). All three ISO standards will be accepted: * ISO 3166-1: 2 Alpha Numerical Characters * ISO 3166-1: 3 Alpha Numerical Characters * ISO 3166-1: 3 Numerical Characters "},"state":{"type":"string","description":"State within the country, e.g. CA for California."},"zipCode":{"type":"string","description":"Destination zipcode of the parcel"},"city":{"type":"string","description":"city"},"siteId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Used for all address types."},"siteType":{"type":"string","description":"SPEEDY specificity. Site type can be used in conjunction with countryId and siteName to find unique site. Used for addresses of type 1 (local address)."},"siteName":{"type":"string","description":"SPEEDY specificity. Site type can be used in conjunction with countryId and siteName to find unique site. Used for all address types."},"streetId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Street identifier. If not provided, but street type and street name are provided - the system will try to find unique match by them in site. Used for addresses of type 1 (local address)."},"streetType":{"type":"string","description":"SPEEDY specificity. Street type. Used for addresses of type 1 (local address)."},"complexId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Complex identifier. If not provided, but complex type and complex name are provided - the system will try to find unique match by them in site. Used for addresses of type 1 (local address)."},"complexType":{"type":"string","description":"SPEEDY specificity. Complex type. Used for addresses of type 1 (local address)."},"complexName":{"type":"string","description":"SPEEDY specificity. Complex name. Used for addresses of type 1 (local address)."},"blockNo":{"type":"string","description":"SPEEDY specificity. Block No. Used for addresses of type 1 (local address)."},"entranceNo":{"type":"string","description":"SPEEDY specificity. Entrance. Used for addresses of type 1 (local address)."},"apartmentNo":{"type":"string","description":"SPEEDY specificity. Apartment. Used for addresses of type 1 (local address)."},"poiId":{"type":"integer","format":"int32","description":"SPEEDY specificity. Point of interest identifier. Used for addresses of type 1 (local address)."}}},"shipment.Amount":{"type":"object","properties":{"amount":{"type":"number","format":"float","description":"The number of decimal will depend of the currency (it could be from 0 to three digit).","example":48.831},"currency":{"type":"string","description":"Currency code (ISO 4217 alpha 3)"}},"required":["amount","currency"]},"shipment.Cifcost":{"type":"object","properties":{"amount":{"type":"number","format":"float","description":"The number of decimal will depend of the currency (it could be from 0 to three digit).","example":48.831},"currency":{"type":"string","description":"Currency code (ISO 4217 alpha 3)"}},"required":["amount","currency"]},"shipment.Cod":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/shipment.Amount"},"collectType":{"type":"string","description":"Collection type   * `s0` : cash   * `s1` : crossed cheque   * `s2` : credit card   * `s3` : ...   * `s9` : default (depending of the receiving BU)   * Values with uppercase are accepted as well: S0, S1, S2, S3, S9 "},"purpose":{"type":"string","description":"Intended use"},"bankCode":{"type":"string","description":"Bank Code"},"bankName":{"type":"string","description":"Bank Name"},"bankAccountNumber":{"type":"string","description":"Bank account number"},"bankAccountName":{"type":"string","description":"Account holder"},"iban":{"type":"string","description":"International account number"},"bic":{"type":"string","description":"Bank Code"}},"required":["amount"]},"shipment.ContactDetails":{"type":"object","properties":{"contactPerson":{"type":"string","description":"Name of the person to contact"},"phone1":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"phone2":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"fax":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"email":{"type":"string","description":"Email address"}}},"shipment.CustomerInfos":{"type":"object","properties":{"customerAccountNumber":{"type":"string","description":"BU’s Internal Customer’s Account Number"},"customerSubAccountNumber":{"type":"string","description":"Customer number SUBID"},"customerID":{"type":"string","description":"BU’s internal Unique Customer ID/Identifier"},"originalCustomerId":{"type":"string","description":"Original customer ID for Integration Customers in certain DPD Business Units"}}},"shipment.Delivery":{"type":"object","properties":{"dateFrom":{"type":"string","format":"date"},"dateTo":{"type":"string","format":"date"},"timeFrom":{"type":"string"},"timeTo":{"type":"string"},"timeSlotTariff":{"type":"string"}}},"shipment.Dimensions":{"type":"object","properties":{"length":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"width":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"height":{"type":"integer","format":"int32","description":"Dimmension in cm units"}}},"shipment.Document":{"type":"object","properties":{"documentType":{"type":"string"},"creationDateTime":{"type":"string","format":"date-time"}}},"shipment.Hazardous":{"type":"object","properties":{"classCode":{"type":"string","description":"Substance identification: Classification code"},"identificationClass":{"type":"string","description":"Substance identification: Class"},"substanceWeight":{"type":"string","description":"Net weight of the hazardous substance in Grams."},"factor":{"type":"integer","format":"int32","description":"Factor of the substance"},"notOtherwiseSpecified":{"type":"string","description":"Not else named"},"packingGroup":{"type":"string","description":"Substance identification: Packing group"},"subsidiaryRisk":{"type":"string","description":"Substance sub-danger"},"description":{"type":"string","description":"Substance description"},"hazardousWeight":{"type":"string","description":"Total weight of the hazardous articles in Grams."},"tunnelRestrictionCode":{"type":"string","description":"Tunnel restriction code"},"identificationUnNo":{"type":"string","description":"Substance identification: UN-No."},"packingCode":{"type":"string","description":"Packing code (see PACKINGCODE). Mandatory in case of hazardous parcel"}}},"shipment.Insurance":{"type":"object","properties":{"insuranceAmount":{"$ref":"#/components/schemas/shipment.Amount"},"insuranceParcelContent":{"type":"string","description":"Description of parcel for insurance"}}},"shipment.InterInvoiceLine":{"type":"object","properties":{"invoicePosition":{"type":"string","description":"Line number of the invoice"},"quantityOfItems":{"type":"string","description":"Quantity of items per article or invoice line even for low / mid / high value or any type of customer"},"content":{"type":"string","description":"Content (Depending of the destination system. Could be cut by some system to the first 35 characters)"},"amountOfPosition":{"type":"number","format":"float"},"manufacturedCountry":{"type":"string"},"netWeight":{"type":"string","description":"Total weight of the articles in the current line, excluding packaging, in grams."},"grossWeight":{"type":"string","description":"Total weight of the articles including packaging in the current line, in grams."},"customerProductCode":{"type":"string","description":"Internal Customer product code"},"productDescription":{"type":"string","description":"Short description of the product"},"fabricComposition":{"type":"string","description":"Description of fabric composition"},"importTarifCode":{"type":"string"},"exportTarifCode":{"type":"string"},"goodsWebPage":{"type":"string","format":"uri"},"parcelRank":{"type":"string","description":"Rank of the parcel within a multi-piece shipment. Set to one for the masterpiece of the shipment or for a single piece. Default = Blank"}}},"shipment.International":{"type":"object","properties":{"parcelType":{"type":"string","description":"Parcel type within the shipment. Different parcel types can't be mixed into one shipment * `D` : Document  * `P` : Non-Doc "},"customsAmount":{"$ref":"#/components/schemas/shipment.Amount"},"customsAmountEx":{"$ref":"#/components/schemas/shipment.Amount"},"customsTerms":{"type":"string","description":"Parcel type within the shipment Different parcel types can't be mixed into one shipment * `s01` : DAP, not cleared * `s02` : DDP, delivered duty paid (incl. duties and excl. taxes) * `s03` : DDP, delivered duty paid (incl. duties and taxes) * `s05` : ex works (EXW) * `s06` : DAP * `s07` : DAP & DDP enhanced, Duty and taxes were pre-paid by the receiver' ","enum":["s01","s02","s03","s04","s05","s06","s07"]},"customsPaper":{"type":"string","description":"Accompanying documents e.g. A | G | B Separator is \"|\" (a pipe) in case of multiple invoice documents * `A` : commercial invoice * `B` : pro forma invoice * `C` : export declaration * `D` : EUR1 * `E` : EUR2 * `F` : ATR * `G` : delivery note * `H` : third party billing * `I` : T1 document ","enum":["A","B","C","D","E","F","G","H","I"]},"clearanceStatus":{"type":"string","description":"Values:   * `N` : No  * `F` : Free  * `E` : Export Cleared  * `T` : Transit Cleared  * `I` : Import Cleared  * `H` : Hybrid ","enum":["N","F","E","T","I","H"]},"customsHighLowValue":{"type":"string","description":"(H)igh, (M)id (above 22€ and below 150€), (L)ow.  * `H` : High  * `M` : Medium   * `L` : Low  ","enum":["H","M","L"]},"customsInvoice":{"type":"string","description":"Invoice number Separator is \"|\" (a pipe) in case of multiple invoice numbers"},"customsInvoiceDates":{"type":"array","description":"Invoice dates","items":{"type":"string","format":"date"}},"importer":{"$ref":"#/components/schemas/shipment.InternationalImporter"},"mrn":{"type":"string","description":"MRN of the electronic export declaration Remarks: The \"|\" is the separator between two MRN."},"exporter":{"$ref":"#/components/schemas/shipment.InternationalExporter"},"numberOfArticles":{"type":"string","description":"This is the real number of commodities (ImportTarifCode / ExportTarifCode). The number of Interinvoicelines must equal the NumberOfArticles"},"destinationCountryRegistration":{"type":"string","description":"Destination country registration information : Registration number or FDA If destination is DPD UK : Applies to B2B and B2C (Not applicable for C2C) shipments with a goods value under £135 (Excludes shipping cost) and if the Incoterm is not DDP. This is expected to come into force March 19, however no official communication from HMRC yet."},"exportReason":{"type":"string","description":"Reason for export  * `s01` : sale  * `s02` : return/replacement  * `s03` : gift ","enum":["s01","s02","s03"]},"interInvoiceLines":{"type":"array","items":{"$ref":"#/components/schemas/shipment.InterInvoiceLine"}},"shipmentContent":{"type":"string","description":"A detailed description of the overall contents of the consignement (UK->EU export only)"}}},"shipment.InternationalExporter":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/shipment.Address"},"contact":{"$ref":"#/components/schemas/shipment.ContactDetails"},"eori":{"type":"string"}}},"shipment.InternationalImporter":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/shipment.Address"},"contact":{"$ref":"#/components/schemas/shipment.ContactDetails"},"gln":{"type":"string","description":"GLN number (Global location number)"},"vatNumber":{"type":"string"},"customerDefermentNumber":{"type":"string","description":"Customer deferment number with can be used for duty tax collection"},"eori":{"type":"string","description":"EORI number, dependency of the customs export regime."}}},"shipment.LegalEntity":{"type":"object","properties":{"businessType":{"type":"string","description":"Business Type:   * `P` : PRIVATE   * `B` : BUSINESS ","enum":["P","B"]},"eori":{"type":"string"},"vatNumber":{"type":"string"},"taxIdType":{"type":"string","description":"Type of document if businessType = B, this field becomes mandatory (dependency of the customs export regime) applicable or not according export customs clearance of origin country if businessType = P, this field is empty. Note - Data in this field to be captured based on the rules of each BU.   * `P` : PASSPORT Number   * `C` : CNPJ (ou CPF) Number (Brésil) ","enum":["P","C"]},"taxIdValue":{"type":"string","description":"Document information. Data in this field to be captured based on the rules of each BU. Become mandatory if IDType is filled"},"webSite":{"type":"string","format":"uri"},"FiscalVatRepresentant":{"type":"string","description":"Fiscal VAT number. This field should be left Blank / Empty and Only populated with the Fiscal VAT number if applicable / known"}}},"shipment.MaskedSender":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/shipment.Address"},"contact":{"$ref":"#/components/schemas/shipment.ContactDetails"}}},"shipment.Message":{"type":"object","properties":{"messageType":{"type":"string","description":"Notification type * `EMAIL` * `PHONE` * `SMS` * `APP` ","enum":["EMAIL","PHONE","SMS","APP"]},"messageDestination":{"type":"string","description":"Destination for the notification, e.g. telephone number, email address, etc. … The required data format for the pro active message types SMS, phone and FAX is as follows: \"+international country numberphone number\" Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX' "},"messageLanguage":{"type":"string","description":"Language of the proactive notification 2 (ISO 639-1 alpha 2 code, e.g. DE). MSG are maintain per BU. The list of available language is maintain by the BU which send the message.. Default language will be the one in the BU which send the message. "},"messageDestType":{"type":"string","description":"Destination stakeholder of the notification: * `s0` : Receiver / Consignee (default if not provided) * `s1` : Sender / Consignor * `s2` : Requester * `s3` : Other ","enum":["s0","s1","s2","s3"]},"senderCompany":{"type":"string"}}},"shipment.ModelReturn":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/shipment.CustomerInfos"},"address":{"$ref":"#/components/schemas/shipment.Address","description":"return Address"},"contact":{"$ref":"#/components/schemas/shipment.ContactDetails"},"comment":{"type":"string"},"depot":{"type":"string","description":"GeoRouting depot code 7 digits - BU code 3 digits + 4 | specificy for BRT - fill with the ID given by your representative"}}},"shipment.Parcel":{"type":"object","properties":{"parcelInfos":{"$ref":"#/components/schemas/shipment.ParcelInfos"},"parcelRank":{"type":"string","description":"Rank of the parcel within a multi-piece shipment. Set to one for the masterpiece of the shipment or for a single piece. Default = Blank"},"senderParcelRefs":{"type":"array","description":"List of sender parcels references","items":{"type":"string"}},"partnerParcelRefs":{"type":"array","description":"Partner´s own parcel reference field","items":{"type":"string"}},"insurance":{"$ref":"#/components/schemas/shipment.Insurance"},"hazardousLimitedQuantities":{"type":"boolean","description":"Limited quantities of hazardous goods parcel value. "},"hazardousPackingCode":{"type":"string","description":"Packing code * `0A` Thin sheet packing * `0A1` Thin sheet packing with non removable head * `0A2` Thin sheet packing with removable head * `1A` Steel barrel * `1A1` Steel barrel with non removable head * `1A2` Steel barrel with removable head * `1B` Aluminum barrel * `1B1` Aluminum barrel with non removable head * `1B2` Aluminum barrel with removable head * `1H` Plastics barrel * `1H1` Plastics barrel with non removable head * `1H2` Plastics barrel with removable head * `3A` Steel canister * `3A1` Steel canister with non removable head * `3A2` Steel canister with removable head * `3B` Aluminum canister * `3B1`  Aluminum canister with non removable head * `3B2` Aluminum canister with removable head * `3H` Plastics canister * `3H1` Plastics canister with non removable head * `3H2` Plastics canister with removable head * `4A` Steel crates * `4B` Aluminum crate * `4D` Plywood crate * `4G` Cardboard crate * `4H` Plastics crate * `4H1` Plastics crate-plastics expanded * `4H2` Plastics crate-plastics solid * `5H` Plastics bags * `5M` Paper bags * `6H` Combination packing "},"parcelContent":{"type":"string","description":"Content (Depending of the destination systems. Could be cut by some system to the first 35 characters) The language recommended in this field is English"},"cod":{"$ref":"#/components/schemas/shipment.Cod"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Message"}},"hazardous":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Hazardous"}},"reference":{"type":"string","description":"Field used only by PL customers to transmit the reference associated with the parcel number."}}},"shipment.ParcelInfos":{"type":"object","properties":{"parcelNumber":{"type":"string","description":"Parcel number."},"parcelNumberCcKey":{"type":"string","description":"Control character key compute from the parcel number."},"dimensions":{"$ref":"#/components/schemas/shipment.Dimensions"},"weight":{"type":"string"}}},"shipment.Person":{"type":"object","properties":{"personalDeliveryType":{"type":"string","description":"Personal delivery type:  * `s1` : department delivery (without personal identification)  * `s2` : personal delivery with personal identification (IDCheck)  * `s3` : personal delivery without personal identification at PUDO (e.g. Direct PUDO delivery)  * `s4` : personal delivery with personal identification at PUDO (e.g. Direct PUDO delivery)  * `s5` : personal delivery with personal identification at PUDO plus ID-Check (e.g. Direct PUDO delivery)  * `s6` : personal delivery with personal identification (ID Check) and recording of the ID. ","enum":["s1","s2","s3","s4","s5","s6"]},"personalAuthorizedName":{"type":"string"},"phone1":{"type":"string"},"phone2":{"type":"string"},"personalIdNumber":{"type":"string","description":"Real consignee's personal identification number."},"personalDateOfBirth":{"type":"string","format":"date"},"address":{"$ref":"#/components/schemas/shipment.Address"},"contact":{"type":"string","description":"Recipient contact person. Could be different of the consignee's name"},"fax":{"type":"string"},"email":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"comment":{"type":"string"}}},"shipment.Pickup":{"type":"object","properties":{"date":{"type":"string","format":"date"},"fromTime":{"type":"string"},"toTime":{"type":"string"}},"required":["date"]},"shipment.Receiver":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/shipment.CustomerInfos"},"pudoId":{"type":"string","description":"ID number of PUDO point (parcel shop, post office, customer network point, etc., .) This field must use the GeoPost standard PUDO definition (Mandatory for the Cross Border delivery) e.g: CC12345 with: CC: Country Code compliant with ISO 3166-1: 2 Alpha Numerical Characters 12345: PUDO Number' "},"address":{"$ref":"#/components/schemas/shipment.Address"},"contact":{"$ref":"#/components/schemas/shipment.ContactDetails"},"comment":{"type":"string"},"legalEntity":{"$ref":"#/components/schemas/shipment.LegalEntity"}}},"shipment.Sender":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/shipment.CustomerInfos"},"pudoId":{"type":"string","description":"ID number of PUDO point (parcel shop, post office, customer network point, etc., .) This field must use the GeoPost standard PUDO definition (Mandatory for the Cross Border delivery) e.g: CC12345 with: CC: Country Code compliant with ISO 3166-1: 2 Alpha Numerical Characters 12345: PUDO Number' "},"addressId":{"type":"string","description":"sender AddressId (for CZ, SK, SPEEDY, BALTICS)"},"address":{"$ref":"#/components/schemas/shipment.Address"},"contact":{"$ref":"#/components/schemas/shipment.ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"accountOwner":{"type":"string","description":"Define the owner of the customer account customer. This owner is responsible to bill the parcel."},"legalEntity":{"$ref":"#/components/schemas/shipment.LegalEntity"},"maskedSender":{"$ref":"#/components/schemas/shipment.MaskedSender"}}},"shipment.Shipment":{"type":"object","properties":{"return":{"$ref":"#/components/schemas/shipment.ModelReturn"},"shipmentInfos":{"$ref":"#/components/schemas/shipment.ShipmentInfos"},"customsReference":{"type":"string","description":"Consignment number for the customs point of view."},"sendingDepot":{"type":"string"},"mpsCompleteDelivery":{"type":"string","description":"Values :   * `s0` - Reserved for the future usage (default)   * `s1` - No complete delivery (MPS incomplete)   * `s2` - Complete delivery (MPS complete). It is mandatory for COD  ","enum":["s0","s1","s2"]},"mpsCompleteDeliveryLabel":{"type":"string","description":"Defines if the label for complete delivery is printed for pickup. Default value is false."},"customerReferenceNumbers":{"type":"array","items":{"type":"string"}},"customerBillingReference":{"type":"string","description":"Customer reference for billing or clearing"},"cifcost":{"$ref":"#/components/schemas/shipment.Cifcost"},"numberOfParcels":{"type":"string","description":"Number of parcels per shipment. A 0 value is acceptable in some BUs and will trigger an open multi-piece shipment, with automated or manual consolidation"},"sender":{"$ref":"#/components/schemas/shipment.Sender"},"receiver":{"$ref":"#/components/schemas/shipment.Receiver"},"international":{"$ref":"#/components/schemas/shipment.International"},"person":{"$ref":"#/components/schemas/shipment.Person"},"parcel":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Parcel"}},"pickup":{"$ref":"#/components/schemas/shipment.Pickup"},"delivery":{"$ref":"#/components/schemas/shipment.Delivery"},"payerType":{"type":"string","description":"* `S` : Sender * `R` : Receiver * `3` : 3rd party ","enum":["S","R","3"]},"documents":{"type":"array","items":{"$ref":"#/components/schemas/shipment.Document"}},"shippingDate":{"type":"string","format":"date"}},"required":["numberOfParcels","parcel","receiver","sender"]},"shipment.ShipmentInfos":{"type":"object","properties":{"shipmentId":{"type":"string","description":"Shipment ID Could be the ID of the first parcel of the list (master ID) or could be another ID specially created for that."},"shipmentIdCKey":{"type":"string","description":"Control character key compute from the shipmentId"},"productCode":{"type":"string","description":"DPD Product used for the shipment (\"101\" for DPD CLASSIC, ...)"},"serviceCode":{"type":"string","description":"Additional local service code, needed only in certain Business Units"},"additionalServiceCode":{"type":"string","description":"DPD Additional Service required for specific services, describing first and last mile handling"},"dimensions":{"$ref":"#/components/schemas/shipment.Dimensions"},"weight":{"type":"string","description":"Weight in grams units (e.g. 3000 equals 3kg)"},"exWorksDelivery":{"type":"boolean","description":"Specific field for DPD DE. Specifies if the recipient has to pay the consignment."}},"required":["productCode"]},"pickupscheduling.Debug":{"type":"object","properties":{"request":{"type":"string"},"response":{"type":"string"},"methodName":{"type":"string"}}},"pickupscheduling.Response":{"type":"object","properties":{"scheduledPickupResponse":{"type":"array","items":{"$ref":"#/components/schemas/pickupscheduling.ScheduledPickupResponse"}},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/pickupscheduling.Debug"}}}},"pickupscheduling.ScheduledPickupResponse":{"type":"object","properties":{"pickupreference":{"type":"string"},"statusCode":{"type":"string"},"statusDescription":{"type":"string"}}},"pickupscheduling.Error":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"errorOrigin":{"type":"string","description":"Identifies where the error occurred.","enum":["META-API","BU-API"]},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/pickupscheduling.Debug"}}}},"pickupscheduling.Address":{"type":"object","properties":{"companyName":{"type":"string","description":"Company Name"},"name1":{"type":"string"},"name2":{"type":"string"},"street":{"type":"string","description":"Street"},"houseNumber":{"type":"string","description":"House number (could be included into in the address field and not set)."},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"interphoneName":{"type":"string","description":"Name on the interphone"},"floor":{"type":"string","description":"Information on the floor (e.g. if located in a huge office building)"},"doorCode":{"type":"string","description":"A code to open the door . It is possible to input 3 different codes separated by a /"},"building":{"type":"string","description":"Information of the building (e.g. when located on a big campus)."},"department":{"type":"string","description":"Information on the department (e.g. when located in a huge office-building with different departments on the same floor)."},"country":{"type":"string","description":"country (ISO 3166). All three ISO standards will be accepted: * ISO 3166-1: 2 Alpha Numerical Characters * ISO 3166-1: 3 Alpha Numerical Characters * ISO 3166-1: 3 Numerical Characters "},"state":{"type":"string","description":"State within the country, e.g. CA for California."},"zipCode":{"type":"string","description":"Destination zipcode of the parcel"},"city":{"type":"string","description":"city"}},"required":["city","country","street","zipCode"]},"pickupscheduling.ContactDetails":{"type":"object","properties":{"contactPerson":{"type":"string","description":"Name of the person to contact"},"phone1":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"phone2":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"fax":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"email":{"type":"string","description":"Email address"}}},"pickupscheduling.CustomerInfos":{"type":"object","properties":{"customerAccountNumber":{"type":"string","description":"BU’s Internal Customer’s Account Number"},"customerSubAccountNumber":{"type":"string","description":"Customer number SUBID"},"customerID":{"type":"string","description":"BU’s internal Unique Customer ID/Identifier"}}},"pickupscheduling.Dimensions":{"type":"object","properties":{"length":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"width":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"height":{"type":"integer","format":"int32","description":"Dimmension in cm units"}}},"pickupscheduling.Message":{"type":"object","properties":{"messageType":{"type":"string","description":"Notification type * `EMAIL` * `PHONE` * `SMS` * `APP` ","enum":["EMAIL","PHONE","SMS","APP"]},"messageDestination":{"type":"string","description":"Destination for the notification, e.g. telephone number, email address, etc. … The required data format for the pro active message types SMS, phone and FAX is as follows: \"+international country numberphone number\" Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX' "},"messageLanguage":{"type":"string","description":"Language of the proactive notification 2 (ISO 639-1 alpha 2 code, e.g. DE). MSG are maintain per BU. The list of available language is maintain by the BU which send the message.. Default language will be the one in the BU which send the message. "},"senderCompany":{"type":"string"}}},"pickupscheduling.Pickup":{"type":"object","properties":{"date":{"type":"string","format":"date"},"fromTime":{"type":"string"},"toTime":{"type":"string"}},"required":["date"]},"pickupscheduling.PickupSchedule":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/pickupscheduling.CustomerInfos"},"shipmentNumbers":{"type":"array","description":"List of Shipment numbers for the Pickup","items":{"type":"string"}},"parcelNumbers":{"type":"array","description":"List of Parcel Numbers for the PickUp","items":{"type":"string"}},"pickup":{"$ref":"#/components/schemas/pickupscheduling.Pickup"},"numberOfParcels":{"type":"integer","format":"int32","description":"Quantity (Number) of Parcels"},"addressId":{"type":"string","description":"AddressId"},"pickupAddress":{"$ref":"#/components/schemas/pickupscheduling.Address"},"pickupContact":{"$ref":"#/components/schemas/pickupscheduling.ContactDetails"},"pickupWeight":{"type":"string","description":"Weight in grams units without decimal delimiter (e.g. 3000 equals 3kg) of all the parcels that will picked up"},"parcelMaxWeight":{"type":"string","description":"Weight in grams units without decimal delimiter (e.g. 3000 equals 3kg) of the heaviest parcel"},"parcelMaxDimensions":{"$ref":"#/components/schemas/pickupscheduling.Dimensions"},"comment":{"type":"string"},"references":{"type":"array","description":"Reference of the pickup request, defined by the customer","items":{"type":"string"}},"sendingDepot":{"type":"string","description":"GeoRouting depot code 7 digits - BU code 3 digits + 4 | specificy for BRT - fill with the ID given by your representative"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/pickupscheduling.Message"}}}},"label.Debug":{"type":"object","properties":{"request":{"type":"string"},"response":{"type":"string"},"methodName":{"type":"string"}}},"label.Label":{"type":"object","properties":{"base64Data":{"type":"string"},"mediaType":{"type":"string"}}},"label.LabelResponse":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/label.Label"},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/label.Debug"}}}},"label.Error":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"errorOrigin":{"type":"string","description":"Identifies where the error occurred.","enum":["META-API","BU-API"]},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/label.Debug"}}}},"label.CustomerInfos":{"type":"object","properties":{"customerAccountNumber":{"type":"string"},"customerSubAccountNumber":{"type":"string"},"customerID":{"type":"string"}}},"label.LabelRequest":{"type":"object","properties":{"shipment":{"$ref":"#/components/schemas/label.Shipment"},"customerInfos":{"$ref":"#/components/schemas/label.CustomerInfos"},"pudoId":{"type":"string"}},"required":["shipment"]},"label.Shipment":{"type":"object","properties":{"shipmentId":{"type":"string"},"parcelNumbers":{"type":"array","items":{"type":"string"}}},"required":["parcelNumbers"]},"colreq.Debug":{"type":"object","properties":{"request":{"type":"string"},"response":{"type":"string"},"methodName":{"type":"string"}}},"colreq.Response":{"type":"object","properties":{"collectionId":{"type":"string"},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/colreq.Debug"}},"parcelId":{"type":"string"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/colreq.Status"}}}},"colreq.Status":{"type":"object","properties":{"code":{"type":"string"},"info":{"type":"string"},"description":{"type":"string"}}},"colreq.Error":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"errorOrigin":{"type":"string","description":"Identifies where the error occurred.","enum":["META-API","BU-API"]},"debugList":{"type":"array","items":{"$ref":"#/components/schemas/colreq.Debug"}}}},"colreq.Address":{"type":"object","properties":{"companyName":{"type":"string","description":"Company Name"},"name1":{"type":"string"},"name2":{"type":"string"},"street":{"type":"string","description":"Street"},"houseNumber":{"type":"string","description":"House number (could be included into in the address field and not set)."},"addressLine2":{"type":"string","description":"Address Line 2"},"addressLine3":{"type":"string","description":"Address Line 3"},"country":{"type":"string","description":"country (ISO 3166). All three ISO standards will be accepted: * ISO 3166-1: 2 Alpha Numerical Characters * ISO 3166-1: 3 Alpha Numerical Characters * ISO 3166-1: 3 Numerical Characters "},"state":{"type":"string","description":"State within the country, e.g. CA for California."},"zipCode":{"type":"string","description":"Destination zipcode of the parcel"},"city":{"type":"string","description":"city"},"apartmentNo":{"type":"string","description":"ApartmentNo"}},"required":["city","country","street","zipCode"]},"colreq.Amount":{"type":"object","properties":{"amount":{"type":"number","format":"float","description":"The number of decimal will depend of the currency (it could be from 0 to three digit).","example":48.831},"currency":{"type":"string","description":"Currency code (ISO 4217 alpha 3)"}},"required":["amount","currency"]},"colreq.Cod":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/colreq.Amount"},"collectType":{"type":"string","description":"Collection type   * `s0` : cash   * `s1` : crossed cheque   * `s2` : credit card   * `s3` : ...   * `s9` : default (depending of the receiving BU) "},"purpose":{"type":"string","description":"Intended use"},"bankCode":{"type":"string","description":"Bank Code"},"bankName":{"type":"string","description":"Bank Name"},"bankAccountNumber":{"type":"string","description":"Bank account number"},"bankAccountName":{"type":"string","description":"Account holder"},"iban":{"type":"string","description":"International account number"},"bic":{"type":"string","description":"Bank Code"}},"required":["amount","collectType"]},"colreq.Collection":{"type":"object","properties":{"requestId":{"type":"string","description":"The order of collection request."},"collectionInfos":{"$ref":"#/components/schemas/colreq.CollectionInfos"},"customerReferenceNumbers":{"type":"array","items":{"type":"string"}},"collectionPoint":{"$ref":"#/components/schemas/colreq.CollectionPoint"},"customer":{"$ref":"#/components/schemas/colreq.Customer"},"receiver":{"$ref":"#/components/schemas/colreq.Receiver"},"parcel":{"$ref":"#/components/schemas/colreq.Parcel"},"pickup":{"$ref":"#/components/schemas/colreq.Pickup"}},"required":["collectionPoint","parcel","receiver"]},"colreq.CollectionInfos":{"type":"object","properties":{"serviceCode":{"type":"string","description":"SEUR specificity. Possible values: 1, 31"},"dimensions":{"$ref":"#/components/schemas/colreq.Dimensions"},"weight":{"type":"string","description":"Weight in grams units without decimal delimiter (e.g. 3000 equals 3kg)"},"productCode":{"type":"string","description":"DPD Product used for the shipment (\"101\" for DPD CLASSIC, ...)"}}},"colreq.CollectionPoint":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/colreq.CustomerInfos"},"address":{"$ref":"#/components/schemas/colreq.Address"},"addressId":{"type":"string","description":"sender AddressId"},"contact":{"$ref":"#/components/schemas/colreq.ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"accountOwner":{"type":"string","description":"Define the owner of the customer account customer. This owner is responsible to bill the parcel."},"legalEntity":{"$ref":"#/components/schemas/colreq.LegalEntity"}}},"colreq.ContactDetails":{"type":"object","properties":{"contactPerson":{"type":"string","description":"Name of the person to contact"},"phone1":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"phone2":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"fax":{"type":"string","description":"Telephone/Fax number formatted. Has to be encoded in one of the following ways: * XXXXXXXX * +intcodeXXXXXXXX * 00intcodeXXXXXXXX where:  * XXXXXXXX is numeric and means the phone/fax number * intcode is the numeric country code with a length from 1 to 4. Without international code, the phone number has to be understood as a domestic one.' "},"email":{"type":"string","description":"Email address"}}},"colreq.Customer":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/colreq.CustomerInfos"},"address":{"$ref":"#/components/schemas/colreq.Address"},"addressId":{"type":"string","description":"Customer AddressId"},"contact":{"$ref":"#/components/schemas/colreq.ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"accountOwner":{"type":"string","description":"Define the owner of the customer account customer. This owner is responsible to bill the parcel."},"legalEntity":{"$ref":"#/components/schemas/colreq.LegalEntity"}}},"colreq.CustomerInfos":{"type":"object","properties":{"customerAccountNumber":{"type":"string","description":"BU’s Internal Customer’s Account Number"},"customerSubAccountNumber":{"type":"string","description":"Customer number SUBID"},"customerID":{"type":"string","description":"BU’s internal Unique Customer ID/Identifier"}}},"colreq.Dimensions":{"type":"object","properties":{"length":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"width":{"type":"integer","format":"int32","description":"Dimmension in cm units"},"height":{"type":"integer","format":"int32","description":"Dimmension in cm units"}}},"colreq.Insurance":{"type":"object","properties":{"insuranceAmount":{"$ref":"#/components/schemas/colreq.Amount"},"insuranceParcelContent":{"type":"string","description":"Description of parcel for insurance"}}},"colreq.LegalEntity":{"type":"object","properties":{"businessType":{"type":"string","description":"Business Type:   * `P` : PRIVATE   * `B` : BUSINESS ","enum":["P","B"]},"eori":{"type":"string"},"vatNumber":{"type":"string"},"taxIdType":{"type":"string","description":"Type of document if businessType = B, this field becomes mandatory (dependency of the customs export regime) applicable or not according export customs clearance of origin country if businessType = P, this field is empty. Note - Data in this field to be captured based on the rules of each BU.   * `P` : PASSPORT Number   * `C` : CNPJ (ou CPF) Number (Brésil) ","enum":["P","C"]},"taxIdValue":{"type":"string","description":"Document information. Data in this field to be captured based on the rules of each BU. Become mandatory if IDType is filled"},"FiscalVatRepresentant":{"type":"string","description":"Fiscal VAT number. This field should be left Blank / Empty and Only populated with the Fiscal VAT number if applicable / known"}}},"colreq.Parcel":{"type":"object","properties":{"parcelInfos":{"$ref":"#/components/schemas/colreq.ParcelInfos"},"parcelRank":{"type":"string","description":"Rank of the parcel within a multi-piece shipment. Set to one for the masterpiece of the shipment or for a single piece. Default = Blank"},"senderParcelRefs":{"type":"array","description":"List of sender parcels references","items":{"type":"string"}},"partnerParcelRefs":{"type":"array","description":"Partner´s own parcel reference field","items":{"type":"string"}},"insurance":{"$ref":"#/components/schemas/colreq.Insurance"},"hazardousLimitedQuantities":{"type":"boolean","description":"Limited quantities of hazardous goods parcel value. "},"hazardousPackingCode":{"type":"string","description":"Packing code * `0A` Thin sheet packing * `0A1` Thin sheet packing with non removable head * `0A2` Thin sheet packing with removable head * `1A` Steel barrel * `1A1` Steel barrel with non removable head * `1A2` Steel barrel with removable head * `1B` Aluminum barrel * `1B1` Aluminum barrel with non removable head * `1B2` Aluminum barrel with removable head * `1H` Plastics barrel * `1H1` Plastics barrel with non removable head * `1H2` Plastics barrel with removable head * `3A` Steel canister * `3A1` Steel canister with non removable head * `3A2` Steel canister with removable head * `3B` Aluminum canister * `3B1`  Aluminum canister with non removable head * `3B2` Aluminum canister with removable head * `3H` Plastics canister * `3H1` Plastics canister with non removable head * `3H2` Plastics canister with removable head * `4A` Steel crates * `4B` Aluminum crate * `4D` Plywood crate * `4G` Cardboard crate * `4H` Plastics crate * `4H1` Plastics crate-plastics expanded * `4H2` Plastics crate-plastics solid * `5H` Plastics bags * `5M` Paper bags * `6H` Combination packing "},"parcelContent":{"type":"string","description":"Content (Depending of the destination systems. Could be cut by some system to the first 35 characters) The language recommended in this field is English"},"cod":{"$ref":"#/components/schemas/colreq.Cod"}}},"colreq.ParcelInfos":{"type":"object","properties":{"parcelNumber":{"type":"string","description":"Parcel number."},"parcelNumberCcKey":{"type":"string","description":"Control character key compute from the parcel number."},"dimensions":{"$ref":"#/components/schemas/colreq.Dimensions"},"weight":{"type":"string"}}},"colreq.Pickup":{"type":"object","properties":{"date":{"type":"string","format":"date"},"fromTime":{"type":"string"},"toTime":{"type":"string"},"tour":{"type":"integer","format":"int32","description":"Tour number (for core BUs)"},"comment":{"type":"string","description":"comment for Pickup"}},"required":["date"]},"colreq.Receiver":{"type":"object","properties":{"customerInfos":{"$ref":"#/components/schemas/colreq.CustomerInfos"},"pudoId":{"type":"string","description":"ID number of PUDO point (parcel shop, post office, customer network point, etc., .) This field must use the GeoPost standard PUDO definition (Mandatory for the Cross Border delivery) e.g: CC12345 with: CC: Country Code compliant with ISO 3166-1: 2 Alpha Numerical Characters 12345: PUDO Number' "},"address":{"$ref":"#/components/schemas/colreq.Address"},"addressId":{"type":"string","description":"receiver AddressId"},"contact":{"$ref":"#/components/schemas/colreq.ContactDetails"},"comment":{"type":"string"},"gln":{"type":"string","description":"GLN number (Global location number)"},"legalEntity":{"$ref":"#/components/schemas/colreq.LegalEntity"}}}},"securitySchemes":{"bearerAuth":{"type":"http","name":"bearerAuth","scheme":"bearer","bearerFormat":"JWT"}}}}