Salesforce Order Management System Integration Guide

POS Flows

• Sale Transactions
  • In-Store Order
  • Endless Aisle Order
  • Mixed Cart Order
• POS In-Store Returns
• POS Exchanges

Omnichannel Flows

• BORIS - Buy Online Return In Store
• BOPIS - Buy Online Pickup In Store
  • BOPIS
    • What happens if the customer does not pick up? When a BOPIS order is created, it goes into the packing stage in fulfillment. If the item isn't picked up. then the order can be canceled. SF OMS is then notified of the cancellation.

    • What happens if the item is not available? Similar to the example above, the order can be canceled and SF OMS is notified.

  • Ship to Store
    • Inventory handling via ASN
    • Inventory receiving in store
• BOFIS - Buy Online Fulfill In Store

  • What happens if the store cannot fulfill the order? Similar to BOPIS, SF OMS is notified that the store cannot fulfill the order.

Salesforce OMS APIs

Authorization

OAUTH Access Token based authorization is used for API calls.

Reference: REST API Developer Guide

Posting Transactions via SF Object APIs

SOBJECTS /services/data/<apiVersion>/sobjects/<Object>

a. <Object> can be Order, Account, OrderItem, Pricebook2, PricebookEntry, Product2, OrderDeliveryGroup, OrderPaymentSummary, OrderDeliveryGroupSummary, OrderItemSummary, FulfillmentOrder, FulfillmentOrderLineItem, Location, CardPaymentMethod, OrderDeliveryMethod, SalesChannel, PaymentGroup, PaymentAuthorization, OrderItemTaxLineItem, OrderAdjustmentGroup, OrderItemAdjustmentLineItem, Payment, PaymentMethod, Shipment, DigitalWallet, PaymentGateway

Reference: Order Management Objects

Cancel Order

/services/data/<apiVersion>/commerce/order-management/order-summaries/%s/actions/submit-cancel

{
  "changeItems": [
    {
      "orderItemSummaryId": "10uxx0000004FYDAA2",
      "quantity": 1.0,
      "reason": "Wrong Item",
      "shippingReductionFlag": true
    }
  ]
}

{
  "changeItems": [
    {
      "orderItemSummaryId": "10uxx0000004FYDAA2",
      "quantity": 1.0,
      "reason": "Wrong Item",
      "shippingReductionFlag": true
    }
  ]
}

Return Order Items

/services/data/<apiVersion>/commerce/order-management/order-summaries/%s/actions/submit-return

{
  "changeItems": [
    {
      "orderItemSummaryId": "10uxx0000004FYDAA2",
      "quantity": 1.0,
      "reason": "Wrong Item",
      "shippingReductionFlag": true
    }
  ]
}

{
  "changeItems": [
    {
      "orderItemSummaryId": "10uxx0000004FYDAA2",
      "quantity": 1.0,
      "reason": "Wrong Item",
      "shippingReductionFlag": true
    }
  ]
}

Cancel Order Item

/services/data/<apiVersion>/commerce/fulfillment/fulfillment-orders/%s/actions/cancel-item

{
"fulfillmentOrderLineItemsToCancel" : [
  {   
    "fulfillmentOrderLineItemId" : "0a4xx00000000W0001",
    "quantity":1
  },
  {   
    "fulfillmentOrderLineItemId" : "0a4xx00000000W0002",
    "quantity":2
  }
]
}

{
"fulfillmentOrderLineItemsToCancel" : [
  {   
    "fulfillmentOrderLineItemId" : "0a4xx00000000W0001",
    "quantity":1
  },
  {   
    "fulfillmentOrderLineItemId" : "0a4xx00000000W0002",
    "quantity":2
  }
]
}

Create Credit Memo

/commerce/order-management/order-summaries/orderSummaryId/actions/create-credit-memo

{ "changeOrderIds": [ "801R0000000EAAkIAO" ]

{
  "creditMemoId": "50gR000000000JNIAY"
}

Create Credit Memo

/commerce/order-management/order-summaries/orderSummaryId/async-actions/ensure-refunds-async

{
  "creditMemoId": "50gR000000000JNIAY"
}

{
"background​OperationId":"21212121",
"success" : true
}

Update Order Details (Change Order Summary)

Use this API to submit changes to an existing order summary, such as edits to order item summary details, through Salesforce Order Management. This API supports API version 66.0 and later.

Before you use this API, complete these prerequisites.

• Make sure that Salesforce OMS is the system of record. After you post an order to Salesforce OMS, submit updates through OMS actions on the order summary. Don't edit the base order records directly.
• Enable the OrgPermissions.changeOrderSummary org permission in your Salesforce OMS org. This permission gives you access to the Change Order Summary API.
• Add a change reason code, such as POS Edit Order, to the Reason field on the Order Product Summary Change object (OrderItemSummaryChange). Your change requests need a valid reason.

/services/data/v66.0/commerce/order-management/order-summaries/%s/actions/submit-change

Salesforce OMS Event Listener

BOPIS / BOFIS - For Omni orders that are to be picked or fulfilled from stores, Point of Sale leverages the Salesforce Fulfilment Order Subscription Channel.

/event/FOStatusChangedEvent

Streaming API (CometD) is used for long polling and real-time streaming.

Reference: Developer Documentation

Custom Platform Events for BOFIS - For Buy Online Fulfill In Store (BOFIS) orders that need custom status update handling, you can use custom Platform Events to receive updates from the POS system.

Fulfillment_Status_Change__e

This custom Platform Event enables POS to send fulfillment status changes for BOFIS orders, particularly for SHIPPED status updates. When configured, the POS system posts events to this endpoint to trigger status updates in Salesforce OMS.

Example endpoint: /services/data/v52.0/sobjects/Fulfillment_Status_Change__e

Custom Field: Quantity_Fulfilled__c - For tracking fulfilled quantities on individual fulfillment order line items during BOFIS flows, add the custom field Quantity_Fulfilled__c to the FulfillmentOrderLineItem object. This field tracks the quantity fulfilled for each line item when POS sends PATCH requests to update fulfillment status.

For a list of events that Point of Sale can stream, refer to Point of Sale Data Exports.

Salesforce OMS to Point of Sale OMS Object Mapping

This diagram explains the object mapping. For a detailed field-level mapping, see POS Fields in Configure the Salesforce (SF) Order Management System (OMS) in CMS.