Skip to main content

Basic flows

There are several basic flows that a GeoAPI user may utilize when creating shipment.
In this section we devide each flow by the shipment type.

Shipments are divided into different types. More info about shipment types here

  • Standard - Shipment going from a registered address (usually a depot) to an arbitrary address.
  • Collection - A shipment that is collected on an arbitrary address and is delivered to a registered address (usually a depot).
  • Third Party Collection - A shipment that is collected on an arbitrary address and is also delivered to an arbitrary address.
  • Return - A shipment that is sent from a pickup point to a registered or arbitrary address.

All shipment types accept the same core parameters. These are also referred to as the shipment subjects.

note

These parameters are tightly coupled with the shipment type that is used (that is why we are mentioning them here).

We suggest that you go take a look at the shipment subjects section now.

A quick summary:

  • Sender
    • Represents the physical location of the shipment sender.
    • Can be a registered or an arbitrary address.
  • Receiver
    • Represents the physical location of the shipment receiver
    • Can be a registered or an arbitrary address.
  • Payer
    • The subject that will be financially responsible for the shipment.
    • This has to be a customer or a registered customer address

Standard shipments​

The following operations will be performed via the GeoAPI:

  1. Create a shipment
    • The shipment will be sent from a registered address and delivered to an arbitrary address
    • You will be able to get the parcel numbers in this step (they might be a part of the shipment request or they will be returned in the API response)
  2. Print labels for the shipment parcels
    • Based on the parcel numbers from the first step
    • The shipment is committed to the internal DPD systems at this point
  3. Create a pickup order on your customer address
    • Pickup orders cannot be ordered for a specific parcel, the courier will pick up all parcels that will be provided to him on the customer address location.
caution

You don't want to create a pickup order for every standard shipment.

If multiple shipments are created and are being sent from the same customer address a single pickup order will be enough.

Collection shipments​

The following operations will be performed via the GeoAPI:

  1. Create a shipment
    • The shipment will be collected by the courier from an arbitrary address and delivered to a registered address
    • You will be able to get the parcel numbers in this step (they might be a part of the shipment request or they will be returned in the API response)
  2. Order a pickup for the shipment parcels
    • Based on the parcel numbers from the first step
    • The shipment is committed to the internal DPD systems at this point
note

You will be unable to print labels for these shipments.

For more information see the detailed information about shipment types here

Third party collection shipments​

The following operations will be performed via the GeoAPI:

  1. Create a shipment
    • The shipment will be collected by the courier from an arbitrary address and delivered to an arbitrary address
    • You will be able to get the parcel numbers in this step (they might be a part of the shipment request or they will be returned in the API response)
  2. Order a pickup for the shipment parcels
    • Based on the parcel numbers from the first step
    • The shipment is committed to the internal DPD systems at this point
note

You will be unable to print labels for these shipments.

For more information see the detailed information about shipment types here

Return shipments​

The following operations will be performed via the GeoAPI:

  1. Create a shipment
    • The shipment will be sent from a pickup point and delivered to a registered or an arbitrary address
    • You will be able to get the parcel numbers in this step (they might be a part of the shipment request or they will be returned in the API response)
  2. Print labels for the shipment labels
    • Based on the parcel numbers from the first step
    • The shipment is committed to the internal DPD systems at this point
    • Only the PDF version of the labels will be available, the label will be sent to the sender. For more info see here
note

You will be unable to create a pickup order for this type of shipment.

For more information see the detailed information about shipment types here

Import shipments​

The following operations will be performed via the GeoAPI:

  1. Create a shipment
    • The shipment will be collected by the courier from an arbitrary address (non CZ) and delivered to an arbitrary address (CZ)
    • You will not be able to get the parcel numbers in this step (the shipment is processed in a different system)
    • You will be able to retrieve the GeoAPI parcel IDs in this step
  2. Order a pickup for the shipment parcels
    • Based on the GeoAPI parcel ID from the first step
    • The shipment is committed to the internal DPD systems at this point
note

You will be unable to print labels for these shipments.

For more information see the detailed information about shipment types here