Reshipments

Use case

The reshipment functionality is thought to resolve the scenario when the shipment, sent by the Warehouse, was never received for the customer. These kind of scenarios are usually generated by a carrier mistake. In this case, the customer calls the customer service and after they double check that it is a carrier fault, customer service has the availability of sending again the lines affected to the customer.

{
    "reshipment": {
        "order_id": "100000000000001",
        "store_id": "Luma Retail Stores - Southeast",
        "lines": [
            {
                "id": "243",
                "line_number": "1"
            }
        ]
    }
}

Solution considerations

  1. The Reshipped items are associated with a new order.
  2. This new order is linked with the previous one, you could find the relationship in the order updated message in the field original_order_id. Please, find a message example of the magento.sales.order_management.updated with this information in the Specifications section .
    {
     "order": {
         "id": "R00080001",
         "original_order_id": "100000000000001",
    
  3. This new order have the ZEROPAY payment method and the payment amount will be 0 for this type of orders.
  4. The type of order is accessible in a field called origin with the constant ‘RE’
    {
     "order": {
         "id": "R00080001",
         "original_order_id": "100000000000001",
         "origin": "RE",
    

Configurable Reshipments features

The current reshipment features are available for all clients but should be activated/deactivated via feature flag.

Change shipping method

This feature allows to select a different shipping method for the reshipped order. This field is optional and in case that it is not specified, the order will be shipped with the previous shipping method.

Note: the change of the shipping address will not impact the amount captured to the customer. Please, remember that this is a zero price order. The shipping method must be part of the catalogue or available shipping methods.

{
    "reshipment": {
        "order_id": "100000000000001",
        "store_id": "Luma Retail Stores - Southeast",
        "new_shipping_method": "EXPRESS"
        "lines": [
            {
                "id": "243",
                "line_number": "1"
            }
        ]
    }
}

Change shipping address

This feature allows to select a different shipping address for the reshipped order. This field is optional and in case that it is not specified, the order will be shipped to the previous shipping address. Note: Magento Order Management is not doing address validation so in case that it is needed, this will need to be validated before call send the message.

Note: Magento OM is not doing address verification, so it’s responsibility of the system that trigger this messages, to do it if it is required.

{
    "reshipment": {
        "order_id": "100000000000001",
        "store_id": "Luma Retail Stores - Southeast",
        "lines": [
            {
                "id": "243",
                "line_number": "1"
            }
        ],
        "new_shipping_address": {
            "address1": "7700 W Parmer Ln",
            "address2": "",
            "city": "Austin",
            "company_name": "Magento",
            "first_name": "John",
            "last_name": "Doe",
            "state": "TX",
            "zip": "78729"
        }
    }
}

Order ID

This field allows that, in the case that the orders is generated in a different system, you could specify the external order id generated with the aim of maintain well synchronized the systems (please, we aware that the combination of store id / order id must be unique). In case that this field is not set, Magento OM will generate the order id automatically with a ‘R’ prefix.

{
    "reshipment": {
        "order_id": "100000000000001",
        "store_id": "Luma Retail Stores - Southeast",
        "new_order_id": "2000000000000101"
        "lines": [
            {
                "id": "243",
                "line_number": "1"
            }
        ]
    }
}

Interface

To know more about the way that this entities are displayed out of the box in the Magento OM interface, please take a look to the following user guide: Go to the User guide section