Chatter REST API Developer Guide

Chatter REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Action Links Resources
Activity Reminders
Announcements Resources
Async Query Resources
Clean Resources
Batch Resource
Chatter Resources
Comments Resources
Commerce Payments Resources
Communities Resources
Communities Knowledge Resources
Communities Moderation Resources
Connect Resources
Content Workspace Permissions Resource
Custom Recommendation Audience Resources
Custom Recommendation Definition Resources
Dashboard Component Snapshot Resource
Datacloud Resources
Data Integration Resources
Duplicate Resources
Environment Hub Resources
Email Merge Field Services Resource
External Email Services Resource
Feed Elements Resources
Feeds Resources
Files Connect Repository Resources
Files Resources
Folders Resources
Forecasts Resources
Groups Resources
Influence Resource
Knowledge Article View Stat Resource
Lightning Scheduler Resources
Likes Resource
List Share Resources
Managed Content Resources
Managed Topics Resources
Mentions Resources
Messaging Channels Resource
Missions Resources
Motifs Resources
Navigation Menu Items
Next Best Action Resources
Notification Settings Resources
Personalization Resources
Push Notifications Resource
Question and Answers Resources
Records Resources
Salesforce Order Management Resources
Fulfillment Orders
Fulfillment Orders, Cancel Item
Fulfillment Orders, Create Invoice
Order Payment Summaries
Order Summaries
Order Summaries, Create Credit Memo
Order Summaries, Ensure Funds Async
Order Summaries, Ensure Refunds Async
Order Summaries, Preview Cancel
Order Summaries, Preview Return
Order Summaries, Submit Cancel
Order Summaries, Submit Return
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/order-management/order-payment-summaries Create an OrderPaymentSummary for an OrderSummary. Specify a payment authorization or payments that share the same payment method.
/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.
/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 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.