Create Return Shipment Booking

Overview

The Create Return Shipment Booking step books a return shipment with the configured shipping provider and generates a return shipping label. This allows customers to ship items back using a pre-paid or pre-arranged shipping label.

Identifier

Configuration Properties

This step reads properties from the return request. The CreateReturnLabel property must be set to "true" for the step to execute.

Behavior

What It Does

1. Checks if return label creation was requested
2. Retrieves shipping provider configuration
3. Books return consignment with carrier
4. Generates return shipping label (PDF/ZPL)
5. Stores tracking information on return
6. Makes label available for customer/notification

Prerequisites

• CreateReturnLabel setting must be enabled
• Return must have CreateReturnLabel property = "true"
• Shipping provider must support return bookings
• Valid return address configured

Side Effects

• Creates shipment booking with carrier
• Generates shipping label document
• Stores tracking number on return
• May incur shipping costs

Business Cases

When to Use

• Providing pre-paid return labels to customers
• Automated return logistics
• Carrier integration for returns
• Tracking return shipments

Example Scenarios

Pre-Paid Return Customer requests return with shipping label. Step books return with carrier, generates label, and includes in customer notification.

Drop-off Return Label generated for customer to drop at carrier location. Tracking number provided for visibility.

Pick-up Arrangement Some carriers support pick-up bookings. Step creates booking and provides pick-up confirmation.

Label Formats

Return labels can be generated in various formats depending on carrier:

• PDF - Standard printable format
• ZPL - Thermal printer format
• PNG - Image format

Sample Workflow Configuration

{
  "Name": "New",
  "WorkflowSteps": [
    {
      "Name": "CreateReturnShipmentBooking",
      "Active": true,
      "TranslateKey": "WorkflowStep_CreateReturnLabel",
      "Properties": [
        { "Name": "ShippingMethod", "Value": "PostNord" }
      ]
    },
    {
      "Name": "Notification",
      "Active": true,
      "TranslateKey": "WorkflowStep_SendReturnLabel"
    }
  ]
}

Error Handling

Related Steps

• Notification - Send label to customer
• Complete Shipment - Mark shipment complete on arrival
• Ensure RMA - RMA number for tracking