Skip Navigation

Newer Version Available

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

B2B Commerce on Lightning Experience Resources

Get, create, update, and delete your commerce data. Work with address management, carts, checkouts (beta), orders, products, promotions, wishlists, and search settings.

Available resources are:

Address Management

Resource	Description
`/commerce/webstores/webstoreId/accounts/accountId/addresses`	Create a Commerce account address for a webstore, or retrieve a collection of addresses for a webstore account.
`/commerce/webstores/webstoreId/accounts/accountId/addresses/addressId`	Update or delete an address for a Commerce account associated with a webstore.

Carts

Resource	Description
`/commerce/webstores/webstoreId/carts`	Create a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId`	Get a cart. Delete a cart. Create an active cart, if one doesn’t exist.
`/commerce/webstores/webstoreId/carts/cartStateOrId/actions/add-cart-to-wishlist`	Copy the products from a cart to a wishlist.
`/commerce/webstores/webstoreId/carts/cartStateOrId/actions/make-primary`	Make a secondary cart a primary cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/cart-coupons`	Get coupons associated with a cart, and apply a coupon code to a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/cart-coupons/cartCouponId`	Delete a coupon from a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/messages/actions/set-visibility`	Set the visibility for cart messages.
`/commerce/webstores/webstoreId/carts/cartStateOrId/promotions`	Get promotions associated with a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/cart-items`	Get the items in a cart. Add an item to a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/cart-items/batch`	Add a batch of up to 100 items to a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/cart-items/cartItemId`	Update or delete an item in a cart.
`/commerce/webstores/webstoreId/carts/cartStateOrId/cart-items/promotions`	Get promotions associated with items in a cart.

Checkouts (Beta)

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Resource	Description
`/commerce/webstores/webstoreId/checkouts`	Get, delete, or update a Commerce store checkout.
`/commerce/webstores/webstoreId/checkouts/activeOrCheckoutId/payments`	Payment for a Commerce store checkout.
`/commerce/webstores/webstoreId/checkouts/activeOrCheckoutId`	Place an order for a Commerce store checkout.
`/commerce/webstores/webstoreId/checkouts`	Start a Commerce store checkout.
`/commerce/webstores/webstoreId/payments/token`	Tokenize a payment for a Commerce store checkout.

Context

Resource	Description
`/commerce/webstores/webstoreId/application-context`	Get application context information for a Commerce store.
`/commerce/webstores/webstoreId/session-context`	Get session context information for a Commerce store.

Externally Managed Accounts

Resource	Description
`/commerce/webstores/webstoreId/external-managed-accounts`	Get a collection of externally managed accounts.

Orders

Resource	Description
`/commerce/webstores/webstoreId/order-summaries`	Get order summaries.
`/commerce/webstores/webstoreId/order-summaries/orderSummaryId/delivery-groups`	Get order delivery groups.
`/commerce/webstores/webstoreId/order-summaries/orderSummaryId/items`	Get order items.
`/commerce/webstores/webstoreId/order-summaries/orderSummaryId/shipments`	Get order shipments.
`/commerce/webstores/webstoreId/shipments/shipmentId/items`	Get shipment items.

Products, Product Categories, Product Prices, Product Searches

Resource	Description
`/commerce/webstores/webstoreId/products`	Get fields, prices, and default images for a list of products.
`/commerce/webstores/webstoreId/products/productId`	Get a product.
`/commerce/webstores/webstoreId/product-categories/children`	Get product categories for a specific parent product category or get all the top-level product categories for the store.
`/commerce/webstores/webstoreId/product-categories/productCategoryId`	Get a product category.
`/commerce/webstores/webstoreId/product-category-path/product-categories/productCategoryId`	Get the product category path from the root category to the current category.
`/commerce/webstores/webstoreId/pricing/products`	Get the prices for multiple products.
`/commerce/webstores/webstoreId/pricing/products/productId`	Get the list and buyer price for a product.
`/commerce/webstores/webstoreId/search/product-search`	Search products.
`/commerce/webstores/webstoreId/search/sort-rules`	Get sort rules for the live index.
`/commerce/webstores/webstoreId/search/suggestions`	Get suggestions for product searches.

Promotions

Resource	Description
`/commerce/webstores/webstoreId/promotions/actions/associate`	Gets the associated promotions and price adjustments for a cart and its items. Only the 50 highest priority eligible promotions are processed.
`/commerce/webstores/webstoreId/promotions/actions/execute`	Applies associated promotion discounts to a cart and its items.

Wishlists

Resource	Description
`/commerce/webstores/webstoreId/wishlists`	Get wishlists and create a wishlist.
`/commerce/webstores/webstoreId/wishlists/wishlistId`	Get, update the name of, and delete a wishlist.
`/commerce/webstores/webstoreId/wishlists/wishlistId/actions/add-wishlist-to-cart`	Add a wishlist to a cart.
`/commerce/webstores/webstoreId/wishlists/wishlistId/wishlist-items`	Get wishlist items or add items to the wishlist.
`/commerce/webstores/webstoreId/wishlists/wishlistId/wishlist-items/wishlistItemId`	Delete a wishlist item.

Search Settings

Resource	Description
`/commerce/management/webstores/webstoreId/search/attribute-settings/facetable-fields`	Get and update facetable attributes.
`/commerce/management/webstores/webstoreId/search/attribute-settings/searchable-fields`	Get and update searchable attributes.
`/commerce/management/webstores/webstoreId/search/indexes`	Get indexes and create an index of a product catalog.
`/commerce/management/webstores/webstoreId/search/indexes/indexId`	Get a search index.
`/commerce/management/webstores/webstoreId/search/product-settings`	Get and update product search settings.
`/commerce/management/webstores/webstoreId/search/sort-rules`	Create or retrieve sort rules for a webstore.