Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Action Links Resources
Activity Reminders
Announcements Resources
Async Query Resources
B2B and B2B2C Commerce Resources
Batch Resource
Briefcase Priming Records Resource
Call Coaching Resources
Chatter Resources
Clean Resources
CMS Managed Content Resources
Comments Resources
Commerce Einstein Resources
Commerce Payments Resources
Connect Resources
Content Workspace Permissions Resource
Conversations Resources
Custom Recommendation Audience Resources
Custom Recommendation Definition Resources
Customer Asset Lifecycle Management Resources
Dashboard Component Snapshot Resource
Data Integration Resources
Duplicate Resources
Einstein Prediction Service Resources
Einstein Recommendation Resources
Employee Profiles Resources
Environment Hub Resources
Email Merge Field Services Resource
Experience Cloud Microsites Resources
Experience Cloud Site Resources
Experience Cloud Site Search Resource (Beta)
Experience Cloud Sites Knowledge Resources
Experience Cloud Sites Moderation Resources
External Email Services Resource
Feed Elements Resources
Feeds Resources
Field Service Recordset Filter Criteria Resource
Field Service Shifts from Pattern Resource
Files Resources
Files Connect Repository Resources
Folders Resources
Forecasts Resources
Groups Resources
Influence Resource
Knowledge Article View Stat Resource
Likes Resource
List Share Resources
Managed Topics Resources
Mentions Resources
Messaging Channels Resource
Microbatching Resources
Missions Resources
Motifs Resources
Named Credential Resources
Navigation Menu Items
Next Best Action Resources
Notification Settings Resources
Notifications Resources
Orchestration Resource
Pardot Business Unit Context Resource
Personalization Resources
Private Connect Resources
Push Notifications Resource
Question and Answers Resources
Quick Text Resource
Quip Related Records Resource
Records Resources
Salesforce CDP Resources
Salesforce Omnichannel Inventory Resources
Salesforce Order Management Resources
Fulfillment Orders
Fulfillment Orders, Cancel Item
Fulfillment Orders, Create Invoice
Fulfillment Orders, Create Multiple
Fulfillment Orders, Create Multiple Invoices
Order Payment Summaries
Order Summaries
Order Summaries, Create Credit Memo
Order Summaries, Ensure Funds Async
Order Summaries, Ensure Refunds Async
Order Summaries, Preview Adjust
Order Summaries, Preview Cancel
Order Summaries, Preview Return
Order Summaries, Submit Adjust
Order Summaries, Submit Cancel
Order Summaries, Submit Return
Repricing, Product Details
Return Orders, Return Items
Return Orders
Routing, Confirm Held Capacity
Routing, Find Routes with Fewest Splits
Routing, Find Routes with Fewest Splits Using OCI
Routing, Get Capacity Values
Routing, Hold Capacity
Routing, Rank By Average Distance
Routing, Release Held Capacity
Salesforce Scheduler Resources
Salesforce Surveys Invitation Emails Resource
Scheduled Custom Recommendations Resources
Share Captured Activity Resource
Social Engagement Resources
Social Engagement Setup Resources
Subscriptions Resource
Subscriptions Notifications Member Resource
Topics Resources
User Profiles Resources
Users Resources
Zones Resources
Request Bodies
Response Bodies
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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/fulfillment/actions/​create-multiple-invoices Create Invoices for multiple FulfillmentOrders.
/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-summaries/​orderSummaryId/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/adjust-item-preview Retrieve the expected results of adjusting the price of one or more OrderItemSummaries from an OrderSummary, without actually executing the adjustment. The response data contains the financial changes that would result from submitting the proposed adjustment.
/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 a simple return of one or more OrderItemSummaries from an OrderSummary, without actually executing the return.
/commerce/order-management/order-summaries/​orderSummaryId/actions/adjust-item-submit Adjust the price of one or more OrderItemSummaries from an OrderSummary, and create corresponding change orders.
/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. This return is a simple return that creates a change order but not a ReturnOrder.
/commerce/order-management/webstores/webstoreId/​products/skuOrProductId Get details of a product in a web store.
/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/​fulfillment-order-capacity/actions/​confirm-held-capacity Confirm held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity and increases its assigned fulfillment order count. Confirm held capacity when you assign a fulfillment order to a location.
/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/​fulfillment-order-capacity/actions/​get-capacity-values Get information about the current fulfillment order capacity of one or more locations.
/commerce/order-management/routing/​fulfillment-order-capacity/actions/​hold-capacity Hold fulfillment order capacity at a location. Holding capacity at a location reserves a space for a fulfillment order that you’ll assign to it.
/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.
/commerce/order-management/routing/​​fulfillment-order-capacity/actions/​release-held-capacity Release held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity without changing its assigned fulfillment order count. Release held capacity when you cancel the assignment of a fulfillment order to a location.