Synchronize shipping methods

When a new shipping method is enabled in Magento Commerce (MC), it needs to be synchronized with your Order Management System (OMS) in order to correctly import orders with these new shipping methods.

  1. A new message magento.catalog.product_management.updated is sent to OMS and the shipping method is created as a SKU in your OMS catalog.
  2. Orders placed with this new shipping method contain the SKU of the defined shipping method to be processed correctly in your OMS.
  3. The flat rate shipping method is exported always as STANDARD.

New shipping method created

As mentioned earlier, when a MC client enables a new carrier integration, a new shipping method is enabled in MC. Once that is done, message magento.catalog.product_management.updated is sent to OMS to be enabled as well there. This contains the SKU of each shipping method, which is the name of the carrier plus the shipping method, i.e. UPS-NextDayAirEarlyAM.

Example

{
  "product": {
    "id": "UPS-NextDayAirEarlyAM",
    "type": "shipping",
    "sku": "UPS-NextDayAirEarlyAM",
    "name": [
      {
        "value": "UPS Next Day Air Early AM",
        "channel": "string",
        "locale": "string"
      }
    ],
    "status": "active"
  }
}

Process order with new shipping method

After the new shipping method is created, the order is processed with that new method:

{
    "order": {
        "customer_service_agent": null,
        "id": "3000000072",
        "ip": "80.169.76.250",
        "language": "en_US",
        "lines": [
            ...
            {

                "id": "SHIPPING",
                "line_number": 3,
                "product_name": "UPS Next Day Air Early AM",
                "product_type": "SHIPPING",
                "sku": "UPS-NextDayAirEarlyAM",
                "shipping_address_reference": "339",
                "amount": {
                    "currency": "USD",
                    "gross_amount": 0,
                    "net_amount": 0,
                    "tax_amount": 0,
                    "tax_rate": 0,
                    "taxes": [
                        {
                            "amount": 0,
                            "rate": 0,
                            "type": "NO TAX"
                        }
                    ]
                },
             ...
            }

Shipping method is exported

If the flat rate method is enabled, an order is created using this flat rate. Then, the exported order has shipping line with the STANDARD SKU.