Product Guide
Start typing to search…

Shipping Label Scenarios - Overview of use cases

Your complete reference for creating shipping labels across multiple use cases and carrier services.

Label Creation Scenarios Overview

As outlined in the "How to Create Shipping Labels with the Labels API" and the "Labels API Parameter Reference" pages, the Labels API offers a wide range of parameters to cover various label creation scenarios. For most use cases, only a few specific parameters are typically required to create a label according to your needs.

Examples of Shipping Label Request Scenarios

Below you will find several tabs, each representing a different request scenario. The title of each tab indicates the scenario it covers. Please click on the tabs relevant to your integration to view the corresponding example requests. We aim to cover as many scenarios as possible. However, we recommend consulting your integration contact to confirm which scenario applies to your specific setup.

Standard Home Delivery - Outbound

Standard Home Delivery - Outbound

Listed below are the key parameters required to create an outbound home label.

{
  // Sender Address Data
  "warehouse": "Main Warehouse Vienna",
  "warehouse_address": "Lagerstraße 5, 1200 Wien, AT",

  // Recipient Address Data
  "recipient_first_name": "Anna",
  "recipient_last_name": "Müller",
  "recipient_company_name": "Müller Handels GmbH",
  "recipient_street": "Mariahilfer Straße",
  "recipient_house_no": "74/2",
  "recipient_address_details": "Top 12, Klingel: Müller",
  "recipient_zip": "1060",
  "recipient_city": "Wien",
  "recipient_country": "AT",
  "recipient_phone": "+436601234567",
  "recipient_email": "[email protected]",

  // Shipment & Order Data
  "reference_number": "your_unique_shipment_reference",
  "order": {
    "order_id": "your_order_id",
    "order_url": "https://www.your_order_url.at",
    "order_date": "2025-11-21T21:59:23.346Z",
    "boarding_complete": true,
    "language": "de"
  },

  // Base Shipping Label Specification
  "format": "zpl",
  "carrier": {
    "name": "dpd",
    "country": "at"
  },
  "carrier_service_id": "carrier_product_service",
    "return_parcel": "outbound",
    "weight": 3,
    "dimensions": {
      "height": 30,
      "length": 20,
      "width": 20
  }
}
{
  "reference_number": "your_unique_shipment_reference",
  "tracking_code": "061234567890123",
  "outbound": {
    "label_url": "https://api-uat.sevensenders.com/v2/label-download/12345678",
    "shipment_id": "123456789",
    "tracking_code": "061234567890123",
    "print_format": "A6",
    "mime_type": "application/octet-stream",
    "pickup_point_selected": false,
    "return_address": {
      "firstName": "Your Name",
      "lastName": "c/o Seven Senders",
      "company": null,
      "phone": null,
      "email": null,
      "street": "Return Street 12",
      "streetNo": null,
      "zipCode": "1000",
      "city": "Wien",
      "country": "AT",
      "addressDetails": null,
      "province": null
    },
    "carrier": {
      "name": "dpd",
      "country": "at"
    }
  },
  "goods_value": null,
  "goods_value_currency": null,
  "local_delivery": false,
  "return": null
}

API Parameter References - Home Outbound

Below is a simplified API parameter reference for this specific scenario. If you require more detailed information, please refer to the Labels API Parameter Reference page, where you will find comprehensive documentation.

ParameterRequired
warehouseNo
warehouse_addressNo
recipient_first_nameYes
recipient_last_nameYes — if you cannot supply this field, use the full name in recipient_first_name and send a hardcoded "." here.
recipient_company_nameNo
recipient_streetYes
recipient_house_noNo — this value can alternatively be populated in recipient_street.
recipient_address_detailsNo
recipient_zipYes
recipient_cityYes
recipient_countryYes
recipient_phoneConditional — required only for certain carrier services
recipient_emailConditional — required only for certain carrier services
reference_numberYes
order.order_idYes
order.order_urlNo
order.order_dateNo
order.boarding_completeNo
order.languageNo
formatYes
carrier.nameYes
carrier.countryYes
carrier_service_idConditional — we strongly recommend providing a value; without it, only one default service per carrier can be used.
return_parcelYes
dimensions.heightConditional — required only for certain carrier services
dimensions.lengthConditional — required only for certain carrier services
dimensions.widthConditional — required only for certain carrier services
weightYes
Standard PUDO Delivery - Outbound

PUDO Delivery - Outbound

Listed below are the key parameters required to create an outbound PUDO label.

{
  // Sender Address Data
  "warehouse": "Main Warehouse Vienna",
  "warehouse_address": "Lagerstraße 5, 1200 Wien, AT",

  // Recipient Address Data
  "recipient_first_name": "Anna",
  "recipient_last_name": "Müller",
  "recipient_company_name": "Müller Handels GmbH",
  "recipient_street": "Mariahilfer Straße",
  "recipient_house_no": "74/2",
  "recipient_address_details": "Top 12, Klingel: Müller",
  "recipient_zip": "1060",
  "recipient_city": "Wien",
  "recipient_country": "AT",
  "recipient_phone": "+436601234567",
  "recipient_email": "[email protected]",

  // PUDO (Pickup & Dropoff Point) Address Data
  "pudo_id": "75689",
  "collection_point_name1": "Paketshop Mariahilfer Straße",
  "collection_point_name2": "im Tabak-Trafik",
  "collection_point_name3": "gegenüber U3",
  "collection_point_membership_id": "PUDO123456",
  "collection_point_street": "Mariahilfer Straße",
  "collection_point_house_no": "76",
  "collection_point_zip": "1060",
  "collection_point_city": "Wien",
  "collection_point_country": "AT",

  // Shipment & Order Data
  "reference_number": "your_unique_shipment_reference",
  "order": {
    "order_id": "your_order_id",
    "order_url": "https://www.your_order_url.at",
    "order_date": "2025-11-21T21:59:23.346Z",
    "boarding_complete": true,
    "language": "de"
  },

  // Base Shipping Label Specification
  "format": "zpl",
  "carrier": {
    "name": "dpd",
    "country": "AT"
  },
  "carrier_service_id": "b5829462-a792-4441-9f74-f365a07cf41a",
  "return_parcel": "outbound",
  "weight": 3,
  "dimensions": {
    "height": 30,
    "length": 20,
    "width": 20
  }
}

{
  "reference_number": "your_unique_shipment_reference",
  "tracking_code": "061234567890123",
  "outbound": {
    "label_url": "https://api-uat.sevensenders.com/v2/label-download/12345678",
    "shipment_id": "123456789",
    "tracking_code": "061234567890123",
    "print_format": "A6",
    "mime_type": "application/octet-stream",
    "pickup_point_selected": true,
    "return_address": {
      "firstName": "Your Name",
      "lastName": "c/o Seven Senders",
      "company": null,
      "phone": null,
      "email": null,
      "street": "Return Street 12",
      "streetNo": null,
      "zipCode": "1000",
      "city": "Wien",
      "country": "AT",
      "addressDetails": null,
      "province": null
    },
    "carrier": {
      "name": "dpd",
      "country": "at"
    }
  },
  "goods_value": null,
  "goods_value_currency": null,
  "local_delivery": false,
  "return": null
}

API Parameter References - PUDO Outbound

Below is a simplified API parameter reference for this specific scenario. If you require more detailed information, please refer to the Labels API Parameter Reference page, where you will find comprehensive documentation.

ParameterRequired
warehouseNo
warehouse_addressNo
recipient_first_nameYes
recipient_last_nameYes — if you cannot supply this field, use the full name in recipient_first_name and send "."
recipient_company_nameNo
recipient_streetYes
recipient_house_noNo — this value can alternatively be populated in recipient_street.
recipient_address_detailsNo
recipient_zipYes
recipient_cityYes
recipient_countryYes
recipient_phoneConditional — required only for certain carrier services
recipient_emailConditional — required for 95% of all PUDO carrier services
pudo_idYes — else a fallback will apply
collection_point_name1N
collection_point_name2No
collection_point_name3No
collection_point_membership_idConditional
collection_point_streetNo
collection_point_house_noNo
collection_point_zipConditional
collection_point_cityNo
collection_point_countryConditional
reference_numberYes
order.order_idYes
order.order_urlNo
order.order_dateNo
order.boarding_completeNo
order.languageNo
formatYes
carrier.nameYes
carrier.countryYes
carrier_service_idConditional — strongly recommended to avoid fallback to default service
return_parcelYes
dimensions.heightConditional — required only for certain carrier services
dimensions.lengthConditional — required only for certain carrier services
dimensions.widthConditional — required only for certain carrier services
weightYes
Home Delivery with COD & Insurance - Outbound

Home Delivery with COD & Insurance - Outbound

Listed below are the key parameters required to create an outbound home delivery label that includes Cash on Delivery (COD) and/or insurance.

{
  // Sender Address Data
  "warehouse": "Main Warehouse Vienna",
  "warehouse_address": "Lagerstraße 5, 1200 Wien, AT",

  // Recipient Address Data
  "recipient_first_name": "Anna",
  "recipient_last_name": "Müller",
  "recipient_company_name": "Müller Handels GmbH",
  "recipient_street": "Mariahilfer Straße",
  "recipient_house_no": "74/2",
  "recipient_address_details": "Top 12, Klingel: Müller",
  "recipient_zip": "1060",
  "recipient_city": "Wien",
  "recipient_country": "AT",
  "recipient_phone": "+436601234567",
  "recipient_email": "[email protected]",

  // Shipment & Order Data
  "reference_number": "your_unique_shipment_reference",
  "order": {
    "order_id": "your_order_id",
    "order_url": "https://www.your_order_url.at",
    "order_date": "2025-11-21T21:59:23.346Z",
    "boarding_complete": true,
    "language": "de"
  },

  // Base Shipping Label Specification
  "format": "zpl",
  "carrier": {
    "name": "dpd",
    "country": "at"
  },
  "carrier_service_id": "carrier_product_service",
    "return_parcel": "outbound", 
    "weight": 3,
    "dimensions": {
      "height": 30,
      "length": 20,
      "width": 20
  },


  // Goods Value (for Insurance) & Cash on Delivery Data
  "goods_value": 10.5,
  "goods_value_currency": "EUR",
  "cod": true,
  "cod_value": "10.5",
  "cod_currency": "EUR",
  "cod_reference": "COD-REF-12345"
}
  {
    "reference_number": "your_unique_shipment_reference",
    "tracking_code": "061234567890123",
    "outbound": {
      "label_url": "https://api-uat.sevensenders.com/v2/label-download/12345678",
      "shipment_id": "123456789",
      "tracking_code": "061234567890123",
      "print_format": "A6",
      "mime_type": "application/octet-stream",
      "pickup_point_selected": false,
      "return_address": {
        "firstName": "Your Name",
        "lastName": "c/o Seven Senders",
        "company": null,
        "phone": null,
        "email": null,
        "street": "Return Street 12",
        "streetNo": null,
        "zipCode": "1000",
        "city": "Wien",
        "country": "AT",
        "addressDetails": null,
        "province": null
      },
      "carrier": {
        "name": "dpd",
        "country": "at"
      }
    },
    "goods_value": 10,5,
    "goods_value_currency": "EUR",
    "local_delivery": false,
    "return": null
  }

API Parameter References - Home Delivery with COD/Insurance

Below is a simplified API parameter reference for this specific scenario. If you require more detailed information, please refer to the Labels API Parameter Reference page, where you will find comprehensive documentation.

ParameterRequired
warehouseNo
warehouse_addressNo
recipient_first_nameYes
recipient_last_nameYes — if you cannot supply this field, use the full name in recipient_first_name and send a hardcoded "." here.
recipient_company_nameNo
recipient_streetYes
recipient_house_noNo — this value can alternatively be populated in recipient_street.
recipient_address_detailsNo
recipient_zipYes
recipient_cityYes
recipient_countryYes
recipient_phoneConditional — required only for certain carrier services
recipient_emailConditional — required only for certain carrier services
reference_numberYes
order.order_idYes
order.order_urlNo
order.order_dateNo
order.boarding_completeNo
order.languageNo
formatYes
carrier.nameYes
carrier.countryYes
carrier_service_idConditional — we strongly recommend providing a value; without it, only one default service per carrier can be used.
return_parcelYes
dimensions.heightConditional — required only for certain carrier services
dimensions.lengthConditional — required only for certain carrier services
dimensions.widthConditional — required only for certain carrier services
weightYes
goods_valueConditional — required only when insurance is used
goods_value_currencyConditional — required when goods_value is provided
codConditional — required for Cash on Delivery (COD)
cod_valueConditional — required when cod is true
cod_currencyConditional — required when cod is true
cod_referenceNo — optional reference for COD
Returns (physical Label & printerless)

Returns Delivery (physical Label and printerless)

Listed below are the key parameters required to create an Returns Label (physical Label and printerless).

{
  // Sender Address Data
  "warehouse": "Main Warehouse Vienna",
  "warehouse_address": "Lagerstraße 5, 1200 Wien, AT",

  // Recipient Address Data
  "recipient_first_name": "Anna",
  "recipient_last_name": "Müller",
  "recipient_company_name": "Müller Handels GmbH",
  "recipient_street": "Mariahilfer Straße",
  "recipient_house_no": "74/2",
  "recipient_address_details": "Top 12, Klingel: Müller",
  "recipient_zip": "1060",
  "recipient_city": "Wien",
  "recipient_country": "AT",
  "recipient_phone": "+436601234567",
  "recipient_email": "[email protected]",

  // Shipment & Order Data
  "reference_number": "your_unique_shipment_reference",
  "order": {
    "order_id": "your_order_id",
    "order_url": "https://www.your_order_url.at",
    "order_date": "2025-11-21T21:59:23.346Z",
    "language": "de"
  },

  // Base Shipping Label Specification
  "format": "pdf", // submit "png" for printerless
  "carrier": {
    "name": "dpd",
    "country": "AT"
  },
  "carrier_service_id": "b5829462-a792-4441-9f74-f365a07cf41a",
  "return_parcel": "return",
  "weight": 3,
  "dimensions": {
    "height": 30,
    "length": 20,
    "width": 20
  }
}

{
    "reference_number": "your_unique_shipment_reference",
    "tracking_code": "061234567890123",
    "outbound": null,
    "goods_value": null,
    "goods_value_currency": null,
    "local_delivery": true,
    "return": {
        "label_url": "https://api-uat.sevensenders.com/v2/label-download/12345678",
        "shipment_id": "123456789",
        "tracking_code": "061234567890123",
        "print_format": "A6",
        "mime_type": "application/pdf",
        "pickup_point_selected": true,
        "return_address": {
            "firstName": "Your Name",
            "lastName": "Seven Senders",
            "company": null,
            "phone": null,
            "email": null,
            "street": "Return Street 12",
            "streetNo": null,
            "zipCode": "1000",
            "city": "Wien",
            "country": "AT",
            "addressDetails": null,
            "province": null
        },
        "carrier": {
            "name": "dpd",
            "country": "AT"
        }
    }
}

API Parameter References - Returns (physical and printerless)

Below is a simplified API parameter reference for this specific scenario. If you require more detailed information, please refer to the Labels API Parameter Reference page, where you will find comprehensive documentation.

🚧

Returns particularities

  • Note that the parameters recipient.x refers to the parcel recipient (end customer), not to the actual return recipient (sender of the return label).
  • For printerless returns, please set the format parameter to "png".
ParameterRequired
warehouseNo
warehouse_addressNo
recipient_first_nameYes
recipient_last_nameYes — if you cannot supply this field, use the full name in recipient_first_name and send a hardcoded "." here.
recipient_company_nameNo
recipient_streetYes
recipient_house_noNo — this value can alternatively be populated in recipient_street.
recipient_address_detailsNo
recipient_zipYes
recipient_cityYes
recipient_countryYes
recipient_phoneConditional — required only for certain carrier services
recipient_emailConditional — required only for certain carrier services
reference_numberYes
order.order_idYes
order.order_urlNo
order.order_dateNo
order.languageNo
formatYes — submit "png" for printerless labels
carrier.nameYes
carrier.countryYes
carrier_service_idConditional — we strongly recommend providing a value; otherwise only the default service per carrier can be used.
return_parcelYes — submit return
dimensions.heightConditional — required only for certain carrier services
dimensions.lengthConditional — required only for certain carrier services
dimensions.widthConditional — required only for certain carrier services
weightYes
Outbound & Returns - Returns in the Outboundbox

Both Outbound & Return simultaneously - (Returnlabel in the Outbound)

Below are the key parameters required to generate an outbound label and a return label simultaneously (return label included in the outbound box).

  • If your outbound label should be a PUDO label, please submit the PUDO Data
  • If your outbound shipment should be a Home Delivery, simply omit the PUDO parameters.
{
  // Sender Address Data
  "warehouse": "Main Warehouse Vienna",
  "warehouse_address": "Lagerstraße 5, 1200 Wien, AT",

  // Recipient Address Data
  "recipient_first_name": "Anna",
  "recipient_last_name": "Müller",
  "recipient_company_name": "Müller Handels GmbH",
  "recipient_street": "Mariahilfer Straße",
  "recipient_house_no": "74/2",
  "recipient_address_details": "Top 12, Klingel: Müller",
  "recipient_zip": "1060",
  "recipient_city": "Wien",
  "recipient_country": "AT",
  "recipient_phone": "+436601234567",
  "recipient_email": "[email protected]",

  // PUDO (Pickup & Dropoff Point) Address Data
  "pudo_id": "75689",
  "collection_point_name1": "Paketshop Mariahilfer Straße",
  "collection_point_name2": "im Tabak-Trafik",
  "collection_point_name3": "gegenüber U3",
  "collection_point_membership_id": "PUDO123456",
  "collection_point_street": "Mariahilfer Straße",
  "collection_point_house_no": "76",
  "collection_point_zip": "1060",
  "collection_point_city": "Wien",
  "collection_point_country": "AT",

  // Shipment & Order Data
  "reference_number": "your_unique_shipment_reference",
  "order": {
    "order_id": "your_order_id",
    "order_url": "https://www.your_order_url.at",
    "order_date": "2025-11-21T21:59:23.346Z",
    "boarding_complete": true,
    "language": "de"
  },

  // Base Shipping Label Specification
  "format": "pdf",
  "carrier": {
    "name": "dpd",
    "country": "AT"
  },
  "carrier_service_id": "b5829462-a792-4441-9f74-f365a07cf41a",
  "return_parcel": "both",
  "weight": 3,
  "dimensions": {
    "height": 30,
    "length": 20,
    "width": 20
  }
}
{
  "reference_number": "your_unique_shipment_reference",
  "tracking_code": "061234567890124",
  // In the case of outbound only, the outbound tracking number is returned.
  // For returns only, the return tracking number is provided.
  // For both, only the return tracking number is used as the main reference.
  "outbound": {
    "label_url": "https://api-uat.sevensenders.com/v2/label-download/98765431",
    "shipment_id": "98765431",
    "tracking_code": "061234567890123",
    "print_format": "A6",
    "mime_type": "application/pdf",
    "pickup_point_selected": true,
    "return_address": {
      "firstName": "Max",
      "lastName": "Mustermann",
      "company": "Muster GmbH",
      "phone": "+43123456789",
      "email": "[email protected]",
      "street": "Senderstraße",
      "streetNo": "10",
      "zipCode": "1010",
      "city": "Wien",
      "country": "AT",
      "addressDetails": null,
      "province": null
    },
    "carrier": {
      "name": "dpd",
      "country": "AT"
    }
  },
  "goods_value": 10.5,
  "goods_value_currency": "EUR",
  "local_delivery": false,
  "return": {
    "label_url": "https://api-uat.sevensenders.com/v2/label-download/98765432",
    "shipment_id": "98765432",
    "tracking_code": "061234567890124",
    "print_format": "A6",
    "mime_type": "application/pdf",
    "pickup_point_selected": true,
    "return_address": {
      "firstName": "Max",
      "lastName": "Mustermann",
      "company": "Muster GmbH",
      "phone": "+43123456789",
      "email": "[email protected]",
      "street": "Senderstraße",
      "streetNo": "10",
      "zipCode": "1010",
      "city": "Wien",
      "country": "AT",
      "addressDetails": null,
      "province": null
    },
    "carrier": {
      "name": "dpd",
      "country": "AT"
    }
  }
}
🚧

Both Labels particularities

  • The only difference in the request for the both option is that you set return_parcel to both.
  • In the response, the difference is that two sets of label data are returned — the outbound label data and the return label data.

API Parameter References - Both (Outbound & Returns)

Below is a simplified API parameter reference for this specific scenario. If you require more detailed information, please refer to the Labels API Parameter Reference page, where you will find comprehensive documentation.

ParameterRequired
warehouseNo
warehouse_addressNo
recipient_first_nameYes
recipient_last_nameYes — if you cannot supply this field, use the full name in recipient_first_name and send a hardcoded "." here.
recipient_company_nameNo
recipient_streetYes
recipient_house_noNo — this value can alternatively be populated in recipient_street.
recipient_address_detailsNo
recipient_zipYes
recipient_cityYes
recipient_countryYes
recipient_phoneConditional — required only for certain carrier services
recipient_emailConditional — required only for certain carrier services
pudo_idYes — required for PUDO labels (else Fallback)
collection_point_name1No
collection_point_name2No
collection_point_name3No
collection_point_membership_idNo
collection_point_streetNo
collection_point_house_noNo
collection_point_zipNo
collection_point_cityNo
collection_point_countryNo
reference_numberYes
order.order_idYes
order.order_urlNo
order.order_dateNo
order.boarding_completeNo
order.languageNo
formatYes
carrier.nameYes
carrier.countryYes
carrier_service_idConditional — we strongly recommend providing a value; otherwise only the default service per carrier can be used.
return_parcelYes - in this scenario both
dimensions.heightConditional — required only for certain carrier services
dimensions.lengthConditional — required only for certain carrier services
dimensions.widthConditional — required only for certain carrier services
weightYes
Shipping Dangerous Goods

When creating labels for shipments that contain dangerous goods, additional carrier-specific requirements apply. The decision path for the parameters that need to be transmitted — as well as the permissible values — differs between carriers. Therefore, a dedicated subpage is available for the Dangerous Goods use case — see here.

Updated 3 months ago