Salesforce Order Management System Integration Guide

Flow Diagram for Creating Order Objects in SF OMS

This uses a Composite Graph API.

SObject Details

The following Salesforce objects are used duringthe order creation process.

Account

Point of Sale looks up an account by the customer email and if it isn't found, it falls back to the default account. If a default account isn't found, Retail CKoud creates one during runtime.

Get Account Details By Customer Email:

Get Default Account Details:

Create Default Account:

{
"id" : "00105000009frZPAAY",
"success" : true,
"errors" : [ ]
}

Pricebook2

Point of Sale looks up the price book by the merchant ID, locale, and region (MerchantID-Locale-Region). If it isn't found, Point of Sale creates one during run time.

Get Pricebook Details:

Create Pricebook Account:

{“Name”:”SHOPNOW20140910-en_US-US”, “Description”:”SHOPNOW20140910-en_US-US”, “IsActive”: true}

{
"id" : "01s050000004p3HAAQ",
"success" : true,
 "errors" : [ ]
}

SalesChannel

Point of Sale looks up the sales channel with the name “POS”. If it isn't found, Retail CLoud falls back to the default sales channel named MerchantId-Locale-Region-POS. If a default sales channel isn't found, Point of Sale creates it during run time.

Get:

Create:

{
 "id" : "01s050000004p3HAAA",
"success" : true,
"errors" : [ ]
}

OrderDeliveryMethod

DeliveryMethodName is derived as FulfillmentType-FulfillmentSubType. See the "OrderDeliveryMethod by order type" section below for details.

Get:

{"totalSize":1,"done":true,"records":[{"attributes":{"type":"OrderDeliveryMethod","url":"/services/data/v49.0/sobjects/OrderDelivery-Method/01s050000004X86AAE"},"Id":"01s050000004X86AAE"}]}

Create:

{
 "id" : "01s050000004p3HAAA",
"success" : true,
"errors" : [ ]
}

OrderDeliveryGroup

Create:

{
 "id" : "01s050000004p3HAAA",
"success" : true,
 "errors" : [ ]
}

PaymentGroup

Create:

CardPaymentMethod

CardPaymentMethod and Payment are created with the processing mode as “External” as the payment is completed in the POS.

Note: As part of the 8.10.1 app build, PaymentGatewayID was added to the CardPaymentMethod object to support payment capture in OM.

Create:

{"PaymentGatewayId":"0b0050000004C9IAAU", "PaymentGroupId":"9zx050000004PCeAAM","PaymentMethodId":"03O050000-0005CbEAI","ProcessingMode":"External","Status":"Processed","Amount":6.10,"AccountId":"00-105000005tmJFAAY","Type":"Sale"}

DigitalWallet

CardPaymentMethod and Payment are created with processing mode as “External” as the payment is completed in the external system.

{"PaymentGatewayId":"0b0050000004C9IAAU","ProcessingMode":"External", "Status":"Active","AccountId":"00105000005tmJFAAY","Type":"Cash"}

Payment

Payment status is “Processed” as the payment is processed at the POS Register.

{"PaymentGatewayId":"0b0050000004C9IAAU","PaymentGroupId":"9zx050000004P7PAAU", "PaymentMethodId":"1DW05000000028qGAA","ProcessingMode":"External", "Status":"Processed","Amount":10.17,"AccountId":"00105000005tmJFAAY","Type":"Sale"}

PriceBookEntry

{"Pricebook2Id":"01s050000004X86AAE","Product2Id":"01t05000000VsvzAAC", "UnitPrice":20.00,"UseStandardPrice":false}

OrderItem - Create

When processing in-store orders via SF OMS Connector, there may be inconsistencies in the LineNumber value, which uniquely identifies items within an order. This is due to differences in the way LineNumbers are generated in SF OMS, using an indexing system rather than the OrderItemId.

During the return order posting process, two distinct methods can be employed:

• SF OMS Connector: Utilizes externalOrderItemId for return processing and preserves the original LineNumber (LineNumber: 1 -> LineNumber: 1)

• Point of Sale Order SPI: Point of Sale handles complete return orders and SF OMS updates the LineNumber according to the OrderItemId (LineNumber: 1 -> LineNumber: 2)

Point of Sale does not support dual-mode order postings, for example, SF OMS and SPI. It is recommended to either go with a full SPI or full SF OMS approach.

{"OrderDeliveryGroupId":"2Dg050000004PY6CAM","OrderId":"80105000000-28FxAAI", "PricebookEntryId":"01u05000001meKIAAY","LineNumber":1,"Quan-tity":1,"UnitPrice":20.00,"Type":"Order Product"}

{"id":"80205000000W5qoAAC","success":true,"errors":[]}

12. OrderItemTaxLineItem

{"Name":"HST","Amount":0.90,"Rate":13.0,"TaxEffectiveDate":"2021-01-03T19:48:20.790Z","OrderItemId":"80205000000Vy7ZAAS","Type":"Actual"}

OrderItemAdjustmentLineItem

{"Name":"PRICE_OVERRIDE_abn-petrowhat-rio-15ml","OrderId":"8010500000022A3AAI","Type":"Header","Descript-ion":"PRICE_OVERRIDE_abn-petrowhat-rio-15ml"}

OrderDeliverMethod By Order Type

This information is configurable in the CMS:

Special Data Mapping

Note After the order is “Activated”, the Salesforce process flow can be triggered to perform custom workflows. Typically, this workflow creates the necessary fulfillment order and related objects.

Fetch fulfillment orders

Point of Sale subscribed to FOStatusChangedEvent of SF OMS. This triggers an order import process as soon as the fulfillment order is in an appropriate state.

There are a set of configurable conditions that are available to control when a fulfillment order can be imported into Point of Sale.

Here is the flow that shows the objects that are pulled in for a BOPIS order:

Pick / Pack / Shipped Events Push Into SF OMS

API to update the fulfillment order status:

Cancel Events Push Into OMS

API to update the fulfillment order status:

Advanced Cancellation:

There can be line item cancellation and also order-level cancellation. The Cancel API is used along with the Cancel Event to support line item level cancellations.

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

Scheduled Jobs:

1. If the order is not packed in intervals of X minutes the fulfillment order is canceled. This job is scheduled to run on Point of Sale.

BOFIS Differences:

Store associates generate the FedEx receipt, capture the tracking number, and pass it to OMS. Send this tracking number to OMS when the status is updated to "delivered".

Order Search

• Search the order using SOQL REST API.
• Example query: SELECT id FROM Order WHERE Name LIKE 'Amanda Freeman%’.

{ "totalSize" : 1, "done" : true, "records" : [ { "attributes" : { "type" : "Order", "url" : "/services/data/v50.0/sobjects/Order/801050000001XEXAA2" }, "Name" : "testingca big zenkraft" } ]}

Tip: For details on the support capability for BORIS returns to credit card payments, please refer to this article.

Order Return / Cancellations

Refunds

For orders originating from PS OMS, Point of Sale performs refunds. For orders originating from SF OMS, SF OMS performs refunds.

Order Search

{
"totalSize" : 1
"done" : true,
"records" : [ {
 "attributes" : {
"type" : "Order",
"url" : "/services/data/v50.0/sobjects/Order/801050000001XEXAA2"
},
 "Name" : "testingca big zenkraft"
} ]
}

• Search the order using SOQL REST API.
• Example query: SELECT id FROM Order WHERE Name LIKE 'Amanda Freeman%’.
• Supported search fields: OrderNumber, FirstName, LastName, BillingEmailAddress, BillToContactId.
• Response fields: emailId, OrderID, Total, orderDate, count, OrderstatusText.