---
schema_version: "1"
id: 66a392eb544813f91152d31064a471aec419ddefb6529142ecb77692a4daf6d0
title: Use the Order Shipment Status via API Event
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/mktg/264-0-0/mktg_admin_api_event_shipment_status.md
canonical_url: https://help.salesforce.com/s/articleView?id=mktg.mktg_admin_api_event_shipment_status.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: ad8d2c83596a985dc3bef05b4617db2dff646494686692c01295272395fc6407
description: Trigger automation flows when order shipment statuses change in your external commerce system, such as when orders are shipped or delivered.
products:
  - Marketing
release: "264"
---
# 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

[View supported editions](https://help.salesforce.com/s/articleView?id=mktg.mktg_editions.htm&release=264.0.0&type=5 "Marketing Cloud Next is available in Growth and Advanced editions, and requires Salesforce Enterprise or Unlimited editions. Some features are limited by edition or purchased add-on. All functionality is available in Lightning Experience only.").

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
        <colgroup>
          <col style="width:50%">
          <col style="width:50%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="colgroup" class="slds-cell-wrap" colspan="2" style="text-align:center;vertical-align:top;" id="d86811e47">User Permissions
              Needed</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e47 ">To create and manage flows:</td>

            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e47 ">
              <p>Marketing Cloud Admin permission set</p>
              <p>OR</p>
              <p style="margin-bottom:0;">Marketing Cloud Manager
                permission set</p>
            </td>

          </tr>
        </tbody>
      </table>

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: <table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
                <colgroup>
                  <col style="width:37.5%">
                  <col style="width:62.5%">
                </colgroup>
                <thead class="slds-text-title_caps ">
                  <tr class="">
                    <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d86811e135">Data Model Object (DMO)</th>
                    <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d86811e138">Required Fields</th>
                  </tr>
                </thead>
                <tbody>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-si-shipmentdmo-dmo.html" target="_blank">Shipment DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Shipment ID (<code>Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-sales-order-dmo.html" target="_blank">Sales Order DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">
                      <ul>
                        <li>Sales Order ID (<code>ssot__SalesOrderId__c</code>)</li>

                        <li>Sold To Customer ID (<code>ssot__SoldToCustomerId__c</code>)</li>

                      </ul>
                    </td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-individual-dmo.html" target="_blank">Individual DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Individual ID (<code>ssot__Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-contact-point-email-dmo.html" target="_blank">Contact Point Email DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Email ID (<code>ssot__Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-contact-point-phone-dmo.html" target="_blank">Contact Point Phone DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Telephone ID (<code>ssot__Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-si-shipmentproductdmo-dmo.html" target="_blank">Shipment Product DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Shipment Product ID (<code>Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-sales-order-product-dmo.html" target="_blank">Sales Order Product DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Sales Order Product ID (<code>ssot__Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-si-returnorderproductdmo-dmo.html" target="_blank">Return Order Product DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Return Order Product ID (<code>ssot__Id__c</code>)</td>

                  </tr>
                  <tr class="">
                    <td data-label="Data Model Object (DMO)" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e135 "><a href="https://developer.salesforce.com/docs/data/data-cloud-dmo-mapping/guide/c360dm-si-productdmo-dmo.html" target="_blank">Product DMO</a></td>

                    <td data-label="Required Fields" class="slds-cell-wrap" style="vertical-align:top;" headers="d86811e138 ">Product ID (<code>ssot__Id__c</code>)</td>

                  </tr>
                </tbody>
              </table>
        
        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
```