Loading
Salesforce Enforces New Security Requirements in Summer 2026Read More
Marketing Cloud Next
Use the Order Shipment Status via API Event

You are here:

  1. Salesforce Help
  2. Docs
  3. Marketing Cloud Next

Use the Order Shipment Status via API Event

Trigger automation flows when order shipment statuses change in your external commerce system, such as when orders are shipped or delivered.

Required Editions

Available in: Salesforce Enterprise and Unlimited Editions with Marketing Cloud Next Growth or Advanced Edition
User Permissions Needed
To create and manage flows:

Marketing Cloud Admin permission set

OR

Marketing Cloud Manager permission set

The Order Shipment Status via API event enables you to automate marketing actions based on shipment and delivery updates. Use this event to notify customers when orders are shipped, in transit, out for delivery, or delivered.

  1. In Marketing Cloud Next, go to Flows.
  2. Create a flow with the Order Shipment Status event.
    1. Create a new flow and select Automation Event-Triggered Flow.
    2. In the Event Library, search for and select Order Shipment Status via API.
    3. Review the example payload to understand the available shipment status data fields.
      The payload includes required fields from these DMOs:
      Data Model Object (DMO) Required Fields
      Shipment DMO Shipment ID (Id__c)
      Sales Order DMO
      • Sales Order ID (ssot__SalesOrderId__c)
      • Sold To Customer ID (ssot__SoldToCustomerId__c)
      Individual DMO Individual ID (ssot__Id__c)
      Contact Point Email DMO Email ID (ssot__Id__c)
      Contact Point Phone DMO Telephone ID (ssot__Id__c)
      Shipment Product DMO Shipment Product ID (Id__c)
      Sales Order Product DMO Sales Order Product ID (ssot__Id__c)
      Return Order Product DMO Return Order Product ID (ssot__Id__c)
      Product DMO Product ID (ssot__Id__c)
      Here's the payload: 
      {
  "inputs": [
    {
      "$Event": {
        "Id__c": "String",
        "DataSourceObjectId__c": "String",
        "DataSourceId__c": "String",
        "KQ_Id__c": "String",
        "ssot__SalesOrder__dlm": {
          "ssot__CreatedDate__c": "DateTime",
          "ssot__DataSourceId__c": "String",
          "ssot__DataSourceObjectId__c": "String",
          "ssot__Id__c": "String",
          "ssot__InternalOrganizationId__c": "String",
          "ssot__Name__c": "String",
          "ssot__OrderNumber__c": "String",
          "ssot__OrderStartDate__c": "DateTime",
          "ssot__SalesOrderStatusId__c": "String",
          "ssot__SoldToCustomerId__c": "String",
          "ssot__TotalAmount__c": "Number",
          "KQ_Id__c": "String",
          "ssot__Individual__dlm": {
            "ssot__BirthDate__c": "DateTime",
            "ssot__CreatedDate__c": "DateTime",
            "ssot__DataSourceId__c": "String",
            "ssot__DataSourceObjectId__c": "String",
            "ssot__ExternalRecordId__c": "String",
            "ssot__ExternalSourceId__c": "String",
            "ssot__FirstName__c": "String",
            "ssot__Id__c": "String",
            "ssot__LastModifiedDate__c": "DateTime",
            "ssot__LastName__c": "String",
            "ssot__PersonName__c": "String",
            "ssot__Salutation__c": "String",
            "ssot__TitleName__c": "String",
            "KQ_Id__c": "String",
            "ssot__ContactPointEmail__dlm": [
              {
                "ssot__DataSourceId__c": "String",
                "ssot__DataSourceObjectId__c": "String",
                "ssot__EmailAddress__c": "String",
                "ssot__Id__c": "String",
                "ssot__PartyId__c": "String",
                "KQ_Id__c": "String",
                "KQ_PartyId__c": "String"
              }
            ],
            "ssot__ContactPointPhone__dlm": [
              {
                "ssot__DataSourceId__c": "String",
                "ssot__DataSourceObjectId__c": "String",
                "ssot__FormattedE164PhoneNumber__c": "String",
                "ssot__Id__c": "String",
                "ssot__PartyId__c": "String",
                "ssot__TelephoneNumber__c": "String",
                "KQ_Id__c": "String",
                "KQ_PartyId__c": "String"
              }
            ]
          }
        },
        "ShipmentProduct_std__dlm": [
          {
            "DataSourceObjectId__c": "String",
            "DataSourceId__c": "String",
            "Id__c": "String",
            "KQ_Id__c": "String",
            "ssot__SalesOrderProduct__dlm": {
              "ssot__CreatedDate__c": "DateTime",
              "ssot__DataSourceId__c": "String",
              "ssot__DataSourceObjectId__c": "String",
              "ssot__Id__c": "String",
              "ssot__OrderedQuantity__c": "Number",
              "ssot__ProductId__c": "String",
              "ssot__SalesOrderId__c": "String",
              "ssot__TotalPriceAmount__c": "Number",
              "ssot__UnitPriceAmount__c": "Number",
              "KQ_Id__c": "String",
              "KQ_SalesOrderId__c": "String",
              "KQ_ProductId__c": "String",
              "ssot__Product__dlm": {
                "ssot__CreatedDate__c": "DateTime",
                "ssot__DataSourceId__c": "String",
                "ssot__DataSourceObjectId__c": "String",
                "ssot__Description__c": "String",
                "ssot__Id__c": "String",
                "ssot__Name__c": "String",
                "ssot__PrimaryProductCategory__c": "String",
                "ssot__PrimaryProductImageURL__c": "String",
                "ssot__PrimaryProductSubCategoryName__c": "String",
                "ssot__ProductCode__c": "String",
                "ssot__ProductFamily__c": "String",
                "ssot__ProductSKU__c": "String",
                "ssot__ProductType__c": "String",
                "KQ_Id__c": "String"
              }
            },
            "ssot__ReturnOrderProduct__dlm": {
              "ssot__CreatedDate__c": "DateTime",
              "ssot__DataSourceId__c": "String",
              "ssot__DataSourceObjectId__c": "String",
              "ssot__Id__c": "String",
              "ssot__ProductId__c": "String",
              "ssot__ReturnOrderId__c": "String",
              "ssot__ReturnReasonCode__c": "String",
              "ssot__ReturnedQuantityCount__c": "Number",
              "KQ_Id__c": "String",
              "KQ_ReturnOrderId__c": "String",
              "KQ_ProductId__c": "String",
              "ssot__Product__dlm": {
                "ssot__CreatedDate__c": "DateTime",
                "ssot__DataSourceId__c": "String",
                "ssot__DataSourceObjectId__c": "String",
                "ssot__Description__c": "String",
                "ssot__Id__c": "String",
                "ssot__Name__c": "String",
                "ssot__PrimaryProductCategory__c": "String",
                "ssot__PrimaryProductImageURL__c": "String",
                "ssot__PrimaryProductSubCategoryName__c": "String",
                "ssot__ProductCode__c": "String",
                "ssot__ProductFamily__c": "String",
                "ssot__ProductSKU__c": "String",
                "ssot__ProductType__c": "String",
                "KQ_Id__c": "String"
              }
            }
          }
        ]
      }
    }
  ]
}
    4. Add flow elements to define the actions that should occur when shipment status changes.
      For example, add a Send Email Message element to send shipment notifications to customers.
      You can map event payload fields to message merge fields, including shipment statuses and shipment dates.
    5. If required, add decision elements to create different actions based on specific shipment statuses.
      For example, send different message templates for Shipped and Delivered statuses.
    6. Save the flow with a descriptive name and note the API name for your integration.
    7. Activate the flow to make it ready to receive API triggers.

Configure your external commerce system to trigger the flow when shipment status changes occur with a POST request: 

POST /services/data/<api_version>/actions/custom/flow/flowApiName
 
Loading
Salesforce Help | Article