Connect REST API Developer Guide
jNewer Version Available
Salesforce Order Management Resources
Manage orders and the order fulfillment process. Available in Salesforce Order
Management orgs.
Available resources are:
| Resource | Description |
|---|---|
| /commerce/fulfillment/fulfillment-orders | Create one or more FulfillmentOrders and FulfillmentOrderLineItems for an OrderDeliveryGroupSummary, which defines a delivery method and recipient for an OrderSummary. You specify the OrderItemSummaries to allocate, which can be fulfilled from different locations. Specifying multiple fulfillment groups creates one FulfillmentOrder for each location. For each OrderItemSummary, a FulfillmentOrderLineItem is created and assigned to the corresponding FulfillmentOrder. |
| /commerce/fulfillment/fulfillment-orders/fulfillmentOrderId/actions/cancel-item | Cancel FulfillmentOrderLineItems from a FulfillmentOrder. This action doesn’t cancel the associated OrderItemSummaries, so reallocate the canceled quantities to a new FulfillmentOrder. |
| /commerce/fulfillment/fulfillment-orders/fulfillmentOrderId/actions/create-invoice | Create an invoice for a FulfillmentOrder that doesn’t have one. |
| /commerce/fulfillment/actions/create-multiple | Create FulfillmentOrders for multiple OrderDeliveryGroups in a single request. |
| /commerce/order-management/order-payment-summaries | Create an OrderPaymentSummary for an OrderSummary. Specify a payment authorization or payments that share the same payment method. In an org with the multicurrency feature enabled, the OrderPaymentSummary inherits the CurrencyIsoCode value from the OrderSummary. |
| /commerce/order-management/order-summaries | Create an OrderSummary based on an order. That order is considered the original order for the OrderSummary. Subsequent change orders that apply to the OrderSummary are also represented as orders. You can specify whether the order is managed in Salesforce Order Management or by an external system. Most Salesforce Order Management APIs can run only on orders that it manages. |
| /commerce/order-management/order-summaries/orderSummaryId/actions/create-credit-memo | Create a credit memo to represent the refund for one or more change orders associated with an OrderSummary. |
| /commerce/order-management/order-summariesorderSummaryId/async-actions/ensure-funds-async | Ensure funds for an invoice and apply them to it. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status. |
| /commerce/order-management/order-summaries/orderSummaryId/async-actions/ensure-refunds-async | Ensure refunds for a credit memo or excess funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status. |
| /commerce/order-management/order-summaries/orderSummaryId/actions/preview-cancel | Retrieve the expected change order values for canceling one or more OrderItemSummaries from an OrderSummary, without actually executing the cancel. |
| /commerce/order-management/order-summaries/orderSummaryId/actions/preview-return | Retrieve the expected change order values for returning one or more OrderItemSummaries from an OrderSummary, without actually executing the return. |
| /commerce/order-management/order-summaries/orderSummaryId/actions/submit-cancel | Cancel one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order. |
| /commerce/order-management/order-summaries/orderSummaryId/actions/submit-return | Return one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order. |
| /commerce/returns/return-orders/ | Create a ReturnOrder and ReturnOrderLineItems for items belonging to an OrderSummary. |
| /commerce/returns/return-orders/returnOrderId/actions/return-items | Process ReturnOrderLineItems belonging to a ReturnOrder. Processing a ReturnOrderLineItem generates a change Order and makes that ReturnOrderLineItem read-only. If a processed ReturnOrderLineItem has any remaining expected quantity, then the API creates a separate ReturnOrderLineItem representing that quantity. |
| /commerce/order-management/routing/actions/find-routes-with-fewest-splits | Returns combinations of inventory locations that can fulfill an order within a specified limit of shipment splits. |
| /commerce/order-management/routing/actions/find-routes-with-fewest-splits-using-oci | For one or more order summaries, find inventory availability using Omnichannel Inventory and identify the fulfillment routes with fewest splits. This method combines the functionality of the Get Inventory Availability and Find Routes With Fewest Splits resources. |
| /commerce/order-management/routing/actions/rank-byaverage-distance | Calculates the average distance from sets of inventory locations to an order recipient, and ranks them. Use this method to compare the average shipping distances for different sets of locations that can fulfill an order. |