CPL API
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. Příklady požadavků a odpovědí
  • Úvod
  • Obecné
  • Tvorba zásilek a objednávek
  • Historie verzí
  • Autentizace
    • Získání Bearer tokenu
  • API Metody
  • Příklady požadavků a odpovědí
    • Vícekusá zásilka
    • Více zásilek v jednom požadavku
    • Zásilka do zahraničí s dobírkou i bez - balíky v sadě
    • Odpověď – vyzvednutí etiket (PDF A4) z GET shipment/batch/{batchId}/label
    • Odpověď – vyzvednutí etiket (ZPL)
    • Odpověď – vyzvednutí etiket (JPG)
    • Spojování zásilek
  • Často kladené otázky
  • Postman kolekce
  • Postman flows
  • Schemas
    • Schemas
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ConnectHierarchyModel
      • AcceptLanguageSchema
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ConnectHierarchyResultModel
      • Eps.Api.MyApi2.Web.Models.Codelist.CountryModel
      • Eps.Api.MyApi2.Web.Models.Codelist.AgeCheckTypeModel
      • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentPhaseModel
      • Eps.Api.MyApi2.Web.Models.Routing.RouteModel
      • EmptyNullableObject
      • Eps.Api.Infrastructure.WebApi.Model.InfoModel
      • Eps.Api.Infrastructure.WebApi.Model.ProblemJsonBasicModel
      • Eps.Api.Infrastructure.WebApi.Model.ProblemJsonModel
      • Eps.Api.MyApi2.Business.Dto.VersionInformation.VersionInformationDto
      • Eps.Api.MyApi2.Business.Enums.ConstImportState
      • Eps.Api.MyApi2.Business.Enums.ConstPageSize
      • Eps.Api.MyApi2.Business.Enums.ConstRelationType
      • Eps.Api.MyApi2.Business.Enums.ConstReturnChannel
      • Eps.Api.MyApi2.Web.Constants.ConstLabelFormat
      • Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.OrderBy.enum
      • Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum
      • Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointCapacitySettingModel
      • Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointModel
      • Eps.Api.MyApi2.Web.Models.AccessPoint.AccessPointWorkHourModel
      • Eps.Api.MyApi2.Web.Models.AccessPoint.ConstMyApi2AccessPointType
      • Eps.Api.MyApi2.Web.Models.AccessPoint.CoordinatesModel
      • Eps.Api.MyApi2.Web.Models.AddressWhisper.AddressWhispModel
      • Eps.Api.MyApi2.Web.Models.AddressWhisper.CalledFrom
      • Eps.Api.MyApi2.Web.Models.Codelist.CurrencyModel
      • Eps.Api.MyApi2.Web.Models.Codelist.ProofOfIdentityTypeModel
      • Eps.Api.MyApi2.Web.Models.Codelist.ServicePriceLimitModel
      • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentExternalNumberTypeModel
      • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentProductType
      • Eps.Api.MyApi2.Web.Models.Codelist.ShipmentServiceModel
      • Eps.Api.MyApi2.Web.Models.Codelist.StatusModel
      • Eps.Api.MyApi2.Web.Models.Codelist.ValidationMessageModel
      • Eps.Api.MyApi2.Web.Models.Customer.AccountModel
      • Eps.Api.MyApi2.Web.Models.Customer.AddressModel
      • Eps.Api.MyApi2.Web.Models.Customer.CustomerModel
      • Eps.Api.MyApi2.Web.Models.CustomerAccess.CreateApiAccessModel
      • Eps.Api.MyApi2.Web.Models.CustomerAccess.CreateSandboxAccessModel
      • Eps.Api.MyApi2.Web.Models.CustomerAccess.ResendSandboxUserEmailModel
      • Eps.Api.MyApi2.Web.Models.Enum.OrderStates
      • Eps.Api.MyApi2.Web.Models.Enum.OrderType
      • Eps.Api.MyApi2.Web.Models.Integrator.AddressType
      • Eps.Api.MyApi2.Web.Models.Integrator.CodAccountModel
      • Eps.Api.MyApi2.Web.Models.Integrator.ContactType
      • Eps.Api.MyApi2.Web.Models.Integrator.CreateCustomerAddressModel
      • Eps.Api.MyApi2.Web.Models.Integrator.CreateCustomerContactModel
      • Eps.Api.MyApi2.Web.Models.Integrator.CreateCustomerModel
      • Eps.Api.MyApi2.Web.Models.Integrator.GetCustomerAddressModel
      • Eps.Api.MyApi2.Web.Models.Integrator.GetCustomerContactModel
      • Eps.Api.MyApi2.Web.Models.Integrator.GetCustomerModel
      • Eps.Api.MyApi2.Web.Models.Order.OrderModel
      • Eps.Api.MyApi2.Web.Models.Order.RecipientAddressModel
      • Eps.Api.MyApi2.Web.Models.Order.SenderAddressModel
      • Eps.Api.MyApi2.Web.Models.OrderBatch.CreateOrderBatchModel
      • Eps.Api.MyApi2.Web.Models.OrderBatch.OrderBatchResultModel
      • Eps.Api.MyApi2.Web.Models.OrderBatch.OrderModel
      • Eps.Api.MyApi2.Web.Models.OrderBatch.OrderResultItemModel
      • Eps.Api.MyApi2.Web.Models.OrderBatch.RecipientAddressModel
      • Eps.Api.MyApi2.Web.Models.OrderBatch.SenderAddressModel
      • Eps.Api.MyApi2.Web.Models.OrderEvent.CancelOrderEventModel
      • Eps.Api.MyApi2.Web.Models.Shipment.AccessPointFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel
      • Eps.Api.MyApi2.Web.Models.Shipment.BackShipmentFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.DormantShipmentFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel
      • Eps.Api.MyApi2.Web.Models.Shipment.RoutingFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentDeliveryFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentPaymentFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentSetFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentStates
      • Eps.Api.MyApi2.Web.Models.Shipment.ShipmentWeightFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.SpecificDeliveryFeatureModel
      • Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel
      • Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.BackAddressModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CashOnDeliveryFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelSettingsModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.CreateShipmentBatchModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DirectInjectionFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantExternalNumberModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantRecipientAddressModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantServiceModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantShipmentModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.DormantWeighedShipmentFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ExternalNumberModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.InsuranceFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelServiceModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.RecipientAddressModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderAddressModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.SenderMaskAddressModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ServiceModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentBatchResultModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultChildItemModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentResultItemModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentRoutingModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.ShipmentSetItemModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.SpecificDeliveryFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.UpdateShipmentBatchModel
      • Eps.Api.MyApi2.Web.Models.ShipmentBatch.WeighedShipmentFeatureModel
      • Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectRecipientAddressModel
      • Eps.Api.MyApi2.Web.Models.ShipmentEvent.RedirectShipmentEventModel
      • XCorrelationIdSchema
      • XLogLevelSchema
      • XPagingSchema
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. Příklady požadavků a odpovědí

Vícekusá zásilka

Pokud chcete v jedné zásilce odeslat více kusů balíků, je potřeba tento údaj uvést v poli shipmentSet.numberOfShipments. Níže je uveden příklad požadavku s třemi balíky v sadě.
Všimněte si také, že hodnota isCompleteLabelRequested je nastavena na true – díky tomu získáte jednu společnou url pro celou sadu etiket.
body požadavku POST shipment/batch na vytvoření zásilky s více kusy balíků v sadě
{
  "returnChannel": {
    "type": "Email",
    "address": "jakub.test@ppl.cz"
  },
  "labelSettings": {
    "format": "Pdf",
    "dpi": 300,
    "completeLabelSettings": {
      "isCompleteLabelRequested": true
    }
  },
  "shipments": [
    {
      "referenceId": "123456",
      "productType": "BUSS",
      "note": "poznamka k etiketě",
      "depot": "07",
      "shipmentSet": {
        "numberOfShipments": 3
      },
      "sender": {
        "name": "Mirek test",
        "street": "Testovaci 222",
        "city": "Praha",
        "zipCode": "11000",
        "country": "CZ",
        "phone": "123456789",
        "email": "kuba@seznam.cz"
      },
      "recipient": {
        "name": "Test recipient",
        "street": "HLinska 2",
        "city": "České Budějovice",
        "zipCode": "37001",
        "country": "CZ",
        "phone": "1236547895",
        "email": "xxx@email.cz"
      }
    }
  ]
}
Po vytvoření takovéto zásilky dostanete v metodě GET shipment/batch/{batchId} jako odpověď následující
odpověď z GET shipment/batch/{batchId}
{
  "completeLabel": {
      "labelUrls": [
          "https://api-dev.dhl.com/ecs/ppl/myapi2/shipment/batch/cdf7496e-02a3-4d48-9500-7608c7dcc5c2/label?pageSize=Default&position=1&limit=200&offset=0"
      ]
  },
  "items": [
      {
          "referenceId": "123456",
          "shipmentNumber": "80050527927",
          "labelUrl": "https://api-dev.dhl.com/ecs/ppl/myapi2/data/95d48050-f9ad-451c-7a22-08dd6b49c76d",
          "importState": "Complete",
          "relatedItems": [
              {
                  "shipmentNumber": "80050527928",
                  "labelUrl": "https://api-dev.dhl.com/ecs/ppl/myapi2/data/cb3abe84-3785-48b8-6385-08dd6b49c76c",
                  "importState": "Complete",
                  "relationType": "ShipmentSet"
              },
              {
                  "shipmentNumber": "80050527929",
                  "labelUrl": "https://api-dev.dhl.com/ecs/ppl/myapi2/data/1897234a-567c-4974-7a21-08dd6b49c76d",
                  "importState": "Complete",
                  "relationType": "ShipmentSet"
              }
          ]
      }
  ]
}
V horní části odpovědi se nachází objekt completeLabel. Ten je součástí odpovědi pouze tehdy, pokud v požadavku nastavíte "isCompleteLabelRequested":true a jeho url obsahuje všechny etikety v sadě.
{
  "completeLabel": {
      "labelUrls": [
          "https://api-dev.dhl.com/ecs/ppl/myapi2/shipment/batch/cdf7496e-02a3-4d48-9500-7608c7dcc5c2/label?pageSize=Default&position=1&limit=200&offset=0"
      ]
  },
  
image.png
Pod completeLabel jsou potom jednotlivé balíky, z nichž první je vždy nosná zásilka a ostatní jsou balíky v sadě. Každý balík poté obsahuje vlastní labelUrl s příslušící etiketou.
Zde je ukázka nosné zásilky:
"items": [
       {
           "referenceId": "123456",
           "shipmentNumber": "80050527927",
           "labelUrl": "https://api-dev.dhl.com/ecs/ppl/myapi2/data/95d48050-f9ad-451c-7a22-08dd6b49c76d",
           "importState": "Complete",
   
image.png
Modified at 2025-04-09 08:47:53
Previous
API Metody
Next
Více zásilek v jednom požadavku