TABLE OF CONTENTS

• Create a label
  • Parameters
    • Format
    • Order ID
    • Carrier
    • Recipient Email
    • Recipient Phone
    • Sender Address
    • Return Parcel
    • Cash on delivery (COD)
    • Pickup/Drop-off Point (PUDO)
• Download a label

Create a label

Carrier Labels are created by using the POST labels method.

Parameters

[1] When creating a stand-alone return label, the recipient parameters need to be filled in with the sender of the return shipment, since 7S will automatically switch the address at the point of label creation.

Format

The format of the result label file. Supported values are: 'pdf', 'zpl', 'zpl300'. The 'zpl' option returns a 203 DPI ZPL, while 'zpl300' returns a 300 DPI ZPL file. The recommended format is zpl.

Order ID

The order should be created via API before generating a label.

Order Object 

With this order object, an order containing all order information can be created during the label creation process. When we perform request validation we will check:

• If order_id is defined and valid, we will accept this value and accept the request. Else, 
• If order_id is not defined, then we will check if the order_id is defined under the order object and has valid fields. If yes accept the request and take the value from here, else
• If none of them are defined or invalid we will throw a validation exception as it is today.

Carrier

The carrier parameter contains a pair of carrier name and country. These values are predefined. You can receive them via GET carrier API request. Learn more here: Available Carriers

Recipient Email

This field is required for last-mile carriers and also to enable the Notifications and Claims service.

Recipient Phone

Typically, this field is not mandatory. Depending on the selected carrier services, this might be relevant.

Sender Address

Senders address fields are not mandatory, by default this data is stored in the configuration on Seven Senders side.

Return Parcel

The field may contain one of the following options: 

• 'outbound' - to generate an outbound label. 
• 'return' - to generate a return label only. 
• 'both' - both outbound and matching return labels are generated. The response will contain an array in this case.

Cash on delivery (COD)

If set to true, fields cod_value (amount) and cod_currency (currency code) fields become mandatory.

Pickup/Drop-off Point (PUDO)

In the case of delivery to a PUDO (pick up - drop off) point, it depends on the carrier whether the full collection point addresses + pudo_id or just the PUDO ID needs to be provided.

For certain carriers, we have to possibility to automatically select the nearest PUDO point based on the provided address parameters. For more information, please refer to the table below:

Download a label

Once a label was requested, you can download it using GET label-download method with label ID as a parameter received after the label creation. The method with return a file in PDF or ZPL format.

Delete label

In case a label is no longer needed you can use the Delete Label request with a label ID as parameter. This method will delete the label and automatically delete the shipment behind the label.