Connect REST API Developer Guide
jNewer Version Available
B2B Commerce for Lightning Resources
Get, create, update, and delete your commerce data. Work with carts, orders, products,
wishlists, and search settings.
Available resources are:
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/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/messages/actions/set-visibility | Set the visibility for cart messages. |
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/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 price 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. |
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. |