--- schema_version: "1" id: 9aa46e0480dcba7d31090e2d4e104607060e3492657cca8c8ef81b28aeaf4c0e title: Salesforce Commerce Cart API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/commerce-cloud/salesforce-commerce/references/generated-api-specs/comm-cart-ref.md canonical_url: https://developer.salesforce.com/docs/commerce/salesforce-commerce/references/comm-cart-ref source_site: developer.salesforce.com content_type: documentation content_hash: 003154e846e7d986899802a8709f8c02e35b4c89a9ffe989088d5a9c4a6cd3c0 products: - B2B Commerce Developer Guide - Salesforce APIs --- Salesforce Commerce Cart API # Salesforce Commerce Cart API Salesforce Commerce Cart Connect APIs enable developers to effortlessly perform various tasks, including creating, updating, and managing carts. Key functionalities encompass adding or removing items, adjusting quantities, transferring items to wishlists, applying promotions, using coupons, and splitting a cart into multiple delivery groups. **Note:** The Salesforce Commerce Cart APIs aren’t supported in preview mode. **Version:** 67.0 ## Servers * `https://{yourinstance}.salesforce.com/services/data/{version}` * `version (default v67.0)` ## Operations ### POST Set the visibility for cart messages. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/messages/actions/set-visibility` Operation ID: `postCartMessagesVisibility`. Updates the visibility for cart level messages associated a single WebCart. The visibility settings for cart messages enable real-time updates and notifications, ensuring customers stay informed about changes to their carts, such as item availability, price adjustments, or promotional offers. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartMessagesVisibilityInputRepresentation`. _Example: Example_ Set the visibility for cart messages. ``` { "visibility": true } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartMessagesVisibilityResultRepresentation`. ### POST Add a batch of up to 100 items to a cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items/batch` Operation ID: `postCartItemBatchCollection`. Allows batch adding of cart items. Buyers with read access to carts can add items to carts. Adding items to a cart respects the buyer's view product entitlements, and only users entitled to view product data can access it. **Note:** The `postCartItemBatchCollection` resource doesn't support dynamic bundles or dynamic attributes for configurable products. To apply or update configurations for these bundles, use the [`postCartItemsFromConfiguration`](https://developer.salesforce.com/docs/commerce/salesforce-commerce/references/comm-cart-ref?meta=postCartItemsFromConfiguration) resource instead. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `object`. * `inputs` (_array of object_) * `richInput` (_sfdc.commerce.cart.connect.api.input.CartItemInputRepresentation_) _Example: RichInput_ Rich input example ``` { "inputs": [ { "richInput": { "quantity": 2, "productId": "01txx0000006i2SAAQ", "type": "Product" } }, { "richInput": { "quantity": 15, "productId": "01txx0000006i3AAAQ", "type": "Product" } } ] } ``` _Example: BinaryPartInput_ Binary part input example ``` { "inputs": [ { "binaryPartNames": "bin1", "richInput": { "subjectId": "me", "body": { "messageSegments": [ { "type": "Text", "text": "Please accept this receipt" } ] }, "capabilities": { "content": { "description": "Receipt for expenses", "title": "receipt.pdf" } }, "feedElementType": "FeedItem" } } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `core.connect.api.output.common.BatchRepresentation`. _Example: Example_ Example of the successful cart items creation response. ``` { "hasErrors": false, "results": [ { "statusCode": 201, "result": { "billingFrequency": null, "cartData": null, "cartDeliveryGroupId": "0a7xx000000023RAAQ", "cartId": "0a6xx000000023RAAQ", "cartItemId": "0a9xx00000003ifAAA", "childProductCount": 0, "currencyIsoCode": "USD", "customFields": [], "firstPymtTotalAmount": null, "firstPymtTotalListPrice": "49.98", "firstPymtTotalPrice": "41.00", "firstPymtTotalTax": null, "isConfigurationAllowed": false, "isShippingChargeNotApplicable": false, "itemizedAdjustmentAmount": "0.00", "listPrice": "24.99", "messagesSummary": { "errorCount": null, "hasErrors": null, "limitedMessages": [], "relatedEntityId": null, "totalLineItemsWithErrors": null }, "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "parentCartItemId": null, "productClass": "Simple", "productDetails": { "dynamicAttributes": {}, "fields": {}, "isConfigurationAllowed": null, "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "productClass": null, "productId": "01txx0000006i2SAAQ", "productSubscriptionInformation": null, "productUrlName": null, "purchaseQuantityRule": null, "sku": "6010009", "thumbnailImage": null, "variationAttributes": {} }, "productId": "01txx0000006i2SAAQ", "productSellingModelId": null, "promotionDisplayName": null, "quantity": "2", "quoteLineItemId": null, "salesPrice": "20.50", "sellingModelType": null, "subType": null, "subscriptionTerm": null, "totalAdjustmentAmount": "0.00", "totalAmount": null, "totalListPrice": "49.98", "totalPrice": "41.00", "totalTax": null, "type": "Product", "unitAdjustedPrice": "20.50", "unitAdjustedPriceWithItemAdj": "20.50", "unitAdjustmentAmount": "0", "unitItemAdjustmentAmount": "0.00" } } ] } ``` ### POST Evaluate the shipping costs for a cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/evaluate-shipping` Operation ID: `postCartEvaluateShipping`. Evaluates the shipping costs for an existing cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) Optional. The ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartEvaluateShippingInputRepresentation`. _Example: CartEvaluateShippingInput_ Example of the cart evaluate shipping input. ``` { "customFields": [ { "attributes": { "type": "WebCart" }, "WebCartCustomField1__c": "Foo" }, { "attributes": { "type": "CartItem" }, "id": "0a9xx0000000002CI1", "CartItemCustomField1__c": "CI1_Field1Value", "CartItemCustomField2__c": "CI1_Field2Value" }, { "attributes": { "type": "CartItem" }, "id": "0a9xx0000000002CI2", "CartItemCustomField1__c": "CI2_Field1Value", "CartItemCustomField2__c": "CI2_Field2Value" }, { "attributes": { "type": "CartDeliveryGroup" }, "id": "0a7xx000000000CDG1", "CartDeliveryGroupCustomField1__c": "CDG1_Field1Value", "CartDeliveryGroupCustomField2__c": "CDG1_Field2Value" } ], "shippingAddress": { "name": "Alan Johnson", "firstName": "Alan", "id": "0a6xx0000000000", "lastName": "Johnson", "region": "CA", "country": "US", "city": "San Francisco", "street": "415 Mission St", "postalCode": 94105 } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryResultRepresentation`. ### GET Retrieve cart items of a specific product. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/products/{productId}` Operation ID: `getProductCartItem`. A collection of cartitems for a given product in the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `productId` (path, string (Id), required) The ID of the product. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `productFields` (query, string) The comma-separated list of up to 15 product fields. Results include fields that you have access to. Some product fields (such as productName and sku) are returned even when not included in the productFields parameter. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ProductCartItemRepresentation`. ### PUT Create and update an inventory reservation from the cart. `PUT /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/inventory-reservations` Operation ID: `putCartInventoryReservation`. Handle Inventory Reservations. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartInventoryReservationInputRepresentation`. _Example: Example_ Example of the cart inventory reservation input. ``` { "durationInSeconds": 100 } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartInventoryReservationOutputRepresentation`. _Example: Example_ Example of the cart inventory reservation response. ``` { "errorCode": null, "errorMessage": "Success", "inventoryItemReservations": [ { "errorCode": null, "errorMessage": "Success", "id": "2pmSG000005k7q3YAA", "itemReservationSourceId": null, "productId": "01tSG000003uisiYAA", "quantity": 3, "reservedAtLocationId": null } ], "reservationIdentifier": null, "success": true } ``` * **400** Bad Request Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartInventoryReservationOutputRepresentation`. _Example: Example_ Client error. ``` [ { "errorCode": "JSON_PARSER_ERROR", "message": "Unexpected character. Expected a valid value." } ] ``` ### DELETE Delete an inventory reservation from the cart. `DELETE /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/inventory-reservations` Operation ID: `deleteCartInventoryReservation`. Handle Inventory Reservations. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success ### GET Retrieve the items in a cart, sorted by product ID. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/products` Operation ID: `getProductCartItemCollection`. A collection of items grouped by product in the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `pageNumber` (query, integer) Specifies the requested page number. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25. * `productFields` (query, string) The comma-separated list of up to 15 product fields. Results include fields that you have access to. Some product fields (such as productName and sku) are returned even when not included in the productFields parameter. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ProductCartItemCollectionRepresentation`. * **400** Bad Request Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ProductCartItemCollectionRepresentation`. _Example: Example_ Example of 400 Bad Requests ``` [ { "errorCode": "ILLEGAL_QUERY_PARAMETER_VALUE", "message": "You must log in to browse our store." } ] ``` ### POST Copy the products from a cart to a wishlist. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/add-cart-to-wishlist` Operation ID: `postCartToWishlist`. Used to copy products from Cart to Wishlist. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartToWishlistInputRepresentation`. _Example: Example_ Successfully added cart items to wishlist. ``` { "wishlistId": "3orxx00000000A1" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartToWishlistResultRepresentation`. _Example: Example_ Successfully moved cart items to a wishlist. ``` { "productsAddedCount": 10, "wishlistId": "3orxx00000000A1" } ``` ### POST Clone an existing cart to create a secondary. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/clone` Operation ID: `postCartClone`. Clones an existing cart to create a secondary, read-only cart to support Pay Now functionality. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store. This creates a secondary, read-only cart to support Pay Now functionality. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `targetEffectiveAccountId` (query, string (Id)) The effective account ID associated with the cloned cart. * `targetType` (query, string) The type of the cloned cart. Value is PayNowReadOnly. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. ### POST Make a secondary cart a primary cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/make-primary` Operation ID: `postCartMakePrimary`. Makes a secondary cart a primary cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CommerceActionResultRepresentation`. ### DELETE Delete a coupon from a cart. `DELETE /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-coupons/{cartCouponId}` Operation ID: `deleteCartCoupon`. Used to delete single cart coupon. If your store has simplified cart cleanup enabled, a DELETE request can remove a coupon from a cart without canceling checkout. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `cartCouponId` (path, string (Id), required) The ID of the cart coupon code. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success ### POST Evaluate taxes for a cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/evaluate-taxes` Operation ID: `postCartEvaluateTax`. Evaluates taxes for an existing cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartEvaluateTaxInputRepresentation`. _Example CartEvaluateTaxInput: same as POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/evaluate-shipping request._ Example of the cart evaluate tax input. _Example: CartEvaluateTaxInput_ Example of the cart evaluate tax input. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryResultRepresentation`. ### GET Retrieve the items in a cart. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items` Operation ID: `getCartItemCollection`. A collection of items in the cart. If there isn’t a current cart, it returns an empty cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `includeCoupons` (query, boolean) Indicates whether to include coupons (True) or not (False). * `includePromotions` (query, boolean) Indicates whether to include promotions (True) or not (False). * `page` (query, string) Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as currentPageToken or nextPageToken. If you don’t specify a value, the first page is returned. * `pageNumber` (query, integer) Specifies the requested page number. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25. * `productFields` (query, string) The comma-separated list of up to 15 product fields. Results include fields that you have access to. Some product fields (such as productName and sku) are returned even when not included in the productFields parameter. * `sort` (query, sfdc.commerce.cart.connect.api.enums.ConnectCartItemSortOrderEnum) #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartItemCollectionRepresentation`. _Example: Example_ Example of the fetch cart items response. ### POST Add an item to a cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items` Operation ID: `postCartItemCollection`. A collection of items in the cart. Buyers with read access to carts can add items in carts. Adding items to a cart respects buyer View Product entitlements and only users entitled to view product data can access it. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `productFields` (query, string) The comma-separated list of up to 15 product fields. Results include fields that you have access to. * `includeCartData` (query, boolean) Specify to include complete cart data in the response. This is available ONLY when in sync mode. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartItemInputRepresentation`. _Example: Example_ Example of the cart item input. ``` { "customFields": [ { "attributes": { "type": "CartItem" }, "connectCustomLocation__c": { "latitude": 3.456, "longitude": 7.89 }, "connectCustomCurrency__c": 23.4, "connectCustomCheckbox__c": true, "connectCustomDate__c": "2025-02-17", "connectCustomText__c": "sample", "connectCustomAddress__c": { "city": "city", "country": null, "geocodeAccuracy": null, "latitude": -10, "longitude": 1.5, "postalCode": "postalCode", "state": null, "street": "street" } } ], "productId": "01t000000000000000", "quantity": 5, "type": "Product" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartItemRepresentation`. _Example: Example_ Example of the add an item to a cart response. ``` { "billingFrequency": null, "cartData": null, "cartDeliveryGroupId": "0a7VW0000001WkDYAU", "cartId": "0a6VW0000001WgzYAE", "cartItemId": "0a9VW0000002lZ7YAI", "childProductCount": 0, "currencyIsoCode": "USD", "customFields": [ { "attributes": { "type": "CartItem" }, "connectCustomLocation__c": { "latitude": 3.456 }, "longitude": 7.89, "connectCustomDate__c": "2025-02-17", "connectCustomAddress__c": { "city": "city", "country": null, "geocodeAccuracy": null, "latitude": -10, "longitude": 1.5, "postalCode": "postalCode", "state": null, "street": "street" }, "connectCustomCurrency__c": 23.4, "connectCustomCheckbox__c": true, "connectCustomText__c": "sample" } ], "firstPymtTotalAmount": null, "firstPymtTotalListPrice": 45, "firstPymtTotalPrice": 45, "firstPymtTotalTax": null, "itemizedAdjustmentAmount": 0, "listPrice": 22.5, "messagesSummary": { "errorCount": null, "hasErrors": null, "limitedMessages": [], "relatedEntityId": null, "totalLineItemsWithErrors": null }, "name": "YetiBar Tart Cherry/Bison Paleo 2oz bar", "parentCartItemId": null, "productClass": "Simple", "productDetails": { "fields": null, "name": "YetiBar Tart Cherry/Bison Paleo 2oz bar", "productId": "01tVW000001TP1WYAW", "productSubscriptionInformation": null, "purchaseQuantityRule": null, "sku": 6010056, "thumbnailImage": null, "variationAttributes": null }, "productId": "01tVW000001TP1WYAW", "productSellingModelId": null, "quantity": 2, "salesPrice": 22.5, "sellingModelType": null, "subscriptionTerm": null, "totalAdjustmentAmount": 0, "totalAmount": null, "totalListPrice": 45, "totalPrice": 45, "totalTax": null, "type": "Product", "unitAdjustedPrice": 22.5, "unitAdjustedPriceWithItemAdj": 22.5, "unitAdjustmentAmount": 0, "unitItemAdjustmentAmount": 0 } ``` * **400** Bad Request Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartItemRepresentation`. _Example: Example_ Client error. ``` [ { "errorCode": "JSON_PARSER_ERROR", "message": "Value doesn't match expected type." } ] ``` ### GET Retrieves all child items associated with a specified cart item. This API is supported only for product bundles. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items/{cartItemId}/children` Operation ID: `getChildCartItemCollection`. Retrieves all child items associated with a specified cart item in the cart. A maximum of 200 child items is allowed per parent cart item. #### Parameters * `cartItemId` (path, string (Id), required) The ID of the parent cart item whose child items you want to retrieve. * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the account for which this request is made. Specify this account ID when the purchase is intended for an account other than the one associated with the current user context. If unspecified, the default value is determined from context. * `page` (query, string) Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as currentPageToken or nextPageToken. If you don’t specify a value, the first page is returned. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 200. The default value is 200. * `productFields` (query, string) The comma-separated list of product field names to include in the response. If this list is empty or not specified, a basic set of fields is returned. To include all fields, use '\*'. There is no limit to the number of fields you can specify; however, the total number of fields and the length of field names may impact the URL size limit. * `sort` (query, sfdc.commerce.cart.connect.api.enums.ConnectCartItemSortOrderEnum) #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ChildCartItemCollectionRepresentation`. _Example: Example_ Example of the child items associated with a specified cart item. ``` { "childCartItems": [ { "cartItem": { "billingFrequency": null, "cartData": null, "cartDeliveryGroupId": "0a7xx00000000pdAAA", "cartId": "0a6xx00000000pdAAA", "cartItemId": "0a9xx00000000zPAAQ", "childProductCount": 0, "currencyIsoCode": "USD", "customFields": [], "firstPymtTotalAmount": "20.00", "firstPymtTotalListPrice": "30.00", "firstPymtTotalPrice": "20.00", "firstPymtTotalTax": "0.00", "isConfigurationAllowed": false, "isShippingChargeNotApplicable": false, "itemizedAdjustmentAmount": "0.00", "listPrice": "30.0", "messagesSummary": { "errorCount": null, "hasErrors": null, "limitedMessages": [], "relatedEntityId": null, "totalLineItemsWithErrors": null }, "name": "Bag", "parentCartItemId": null, "productClass": "Simple", "productDetails": { "fields": { "LastModifiedDate": "2025-10-23T11:33:37Z", "FulfillmentQtyCalcMethod": null, "Description": null, "SpecificationType": "Commercial", "IsActive": "true", "LastReferencedDate": null, "StockKeepingUnit": "NHKB", "Name": "Bag", "ShippingWeightUnitOfMeasure": null, "CreatedById": "005xx000001XBov", "CloneSourceId": null, "RecordTypeId": "012xx0000005qmC", "DiscontinuedDate": null, "ProductClass": "Simple", "CanRamp": "false", "DisplayUrl": null, "IsDeleted": "false", "IsAssetizable": "true", "ProductCode": null, "UsageModelType": null, "ExternalId": null, "ProductPurpose": "Sell", "LastViewedDate": null, "UserRecordAccessId": null, "HelpText": null, "CurrencyIsoCode": "USD", "AvailabilityDate": null, "SystemModstamp": "2025-10-23T11:33:37Z", "IsArchived": "false", "DecompositionScope": null, "Type": null, "EndOfLifeDate": null, "IsShippingChargeNotApplicable": "false", "QuantityUnitOfMeasure": null, "CreatedDate": "2025-10-23T11:33:37Z", "Family": null, "UnitOfMeasureId": null, "ShippingWeight": null, "LastModifiedById": "005xx000001XBov", "IsSoldOnlyWithOtherProds": "false" }, "isConfigurationAllowed": null, "name": "Bag", "productClass": null, "productId": "01txx0000006kf1AAA", "productSubscriptionInformation": null, "productUrlName": null, "purchaseQuantityRule": null, "sku": "NHKB", "thumbnailImage": { "alternateText": "bag.jpeg", "contentVersionId": null, "id": "2pmxx000000000RAAQ", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "bag.jpeg", "url": "/cms/delivery/media/MCQMDS7T446NC7XKVP6JOJK2HMSA?version=1.1&channelId=0apxx0000000003&oid=00Dxx00ThLVJ544" }, "variationAttributes": {} }, "productId": "01txx0000006kf1AAA", "productSellingModelId": null, "promotionDisplayName": null, "quantity": "1.0", "salesPrice": "20.0", "sellingModelType": null, "subType": null, "subscriptionTerm": null, "totalAdjustmentAmount": "0.00", "totalAmount": "20.00", "totalListPrice": "30.00", "totalPrice": "20.00", "totalTax": "0.00", "type": "Product", "unitAdjustedPrice": "20.0", "unitAdjustedPriceWithItemAdj": "20.0", "unitAdjustmentAmount": "0.0", "unitItemAdjustmentAmount": "0" }, "message": null, "status": "Success" }, { "cartItem": { "billingFrequency": null, "cartData": null, "cartDeliveryGroupId": "0a7xx00000000pdAAA", "cartId": "0a6xx00000000pdAAA", "cartItemId": "0a9xx00000000zKAAQ", "childProductCount": 0, "currencyIsoCode": "USD", "customFields": [], "firstPymtTotalAmount": "2.99", "firstPymtTotalListPrice": "3.99", "firstPymtTotalPrice": "2.99", "firstPymtTotalTax": "0.00", "isConfigurationAllowed": false, "isShippingChargeNotApplicable": false, "itemizedAdjustmentAmount": "0.00", "listPrice": "3.99", "messagesSummary": { "errorCount": null, "hasErrors": null, "limitedMessages": [], "relatedEntityId": null, "totalLineItemsWithErrors": null }, "name": "Wired Mouse", "parentCartItemId": null, "productClass": "Simple", "productDetails": { "fields": { "LastModifiedDate": "2025-10-23T11:33:37Z", "FulfillmentQtyCalcMethod": null, "Description": "Wired mouse", "SpecificationType": "Commercial", "IsActive": "true", "LastReferencedDate": null, "StockKeepingUnit": "NHKWM", "Name": "Wired Mouse", "ShippingWeightUnitOfMeasure": null, "CreatedById": "005xx000001XBov", "CloneSourceId": null, "RecordTypeId": "012xx0000005qmC", "DiscontinuedDate": null, "ProductClass": "Simple", "CanRamp": "false", "DisplayUrl": null, "IsDeleted": "false", "IsAssetizable": "false", "ProductCode": null, "UsageModelType": null, "ExternalId": null, "ProductPurpose": "Sell", "LastViewedDate": null, "UserRecordAccessId": null, "HelpText": null, "CurrencyIsoCode": "USD", "AvailabilityDate": null, "SystemModstamp": "2025-10-23T11:33:37Z", "IsArchived": "false", "DecompositionScope": null, "Type": null, "EndOfLifeDate": null, "IsShippingChargeNotApplicable": "false", "QuantityUnitOfMeasure": null, "CreatedDate": "2025-10-23T11:33:37Z", "Family": null, "UnitOfMeasureId": null, "ShippingWeight": null, "LastModifiedById": "005xx000001XBov", "IsSoldOnlyWithOtherProds": "false" }, "isConfigurationAllowed": null, "name": "Wired Mouse", "productClass": null, "productId": "01txx0000006kexAAA", "productSubscriptionInformation": null, "productUrlName": null, "purchaseQuantityRule": null, "sku": "NHKWM", "thumbnailImage": { "alternateText": "mouse.jpg", "contentVersionId": null, "id": "2pmxx000000000JAAQ", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "mouse.jpg", "url": "/cms/delivery/media/MCWAVWDLQILBFMFIG2LGAY5F3XYU?version=1.1&channelId=0apxx0000000003&oid=00Dxx00ThLVJ544" }, "variationAttributes": {} }, "productId": "01txx0000006kexAAA", "productSellingModelId": null, "promotionDisplayName": null, "quantity": "1.0", "salesPrice": "2.99", "sellingModelType": null, "subType": null, "subscriptionTerm": null, "totalAdjustmentAmount": "0.00", "totalAmount": "2.99", "totalListPrice": "3.99", "totalPrice": "2.99", "totalTax": "0.00", "type": "Product", "unitAdjustedPrice": "2.99", "unitAdjustedPriceWithItemAdj": "2.99", "unitAdjustmentAmount": "0.0", "unitItemAdjustmentAmount": "0" }, "message": null, "status": "Success" } ], "count": 2, "currentPageToken": null, "currentPageUrl": null, "hasErrors": false, "nextPageToken": null, "nextPageUrl": null, "previousPageToken": "2025-10-23T13:49:07Z,0a9xx00000000zPAAQ,CreatedDateAsc", "previousPageUrl": "/services/data/v66.0/commerce/webstores/0ZExx00000000mP/carts/current/cart-items/0a9xx00000000zJ/children?page=2025-10-23T13%3A49%3A07Z%2C0a9xx00000000zPAAQ%2CCreatedDateAsc&pageSize=200&productFields=*&sort=CreatedDateAsc" } ``` * **400** Bad Request Media type: `application/json`. Schema: `object`. * `errorCode` (_string_) * `message` (_string_) _Example: InvalidParameter_ ``` { "errorCode": "INVALID_OPERATION", "message": "Currency ISO code not available: '\"INR\"'." } ``` * **404** Not Found Media type: `application/json`. Schema: `object`. * `errorCode` (_string_) * `message` (_string_) _Example_ ``` { "CartNotFound": { "value": { "errorCode": "CART_NOT_FOUND", "message": "Cart not found." } } } ``` * **500** Internal Server Error - Unexpected system error occurred Media type: `application/json`. Schema: `object`. * `errorCode` (_string_) * `message` (_string_) _Example: InvalidParameter_ ``` { "errorCode": "UNKNOWN_EXCEPTION", "message": "Invalid parameter value." } ``` ### POST Applies a saved configuration context to a cart item. This API adds, updates, or deletes the cart item based on product configuration retrieved using a specified context ID. This API is supported only for dynamic product bundles. Merchants must ensure that the Product Configurator setup is complete before using this API. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items/actions/apply-configuration` Operation ID: `postCartItemsFromConfiguration`. Applies a saved configuration context to a cart item. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartItemsConfigurationInputRepresentation`. _Example: CartItemsConfigurationInput_ Applies the product configuration to the cart items. ``` { "contextId": "0000000c27nc17g001317606221363347ae616c7632d4266a1a108e90d10d983" } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartItemsConfigurationOutputRepresentation`. * **400** Bad Request Media type: `application/json`. Schema: `object`. * `message` (_string_) _Example: invalidContextId_ Invalid ContextId ``` { "message": "Invalid context ID." } ``` _Example: cartValidationFailed_ Cart validation failed ``` { "message": "Cart validation failed." } ``` _Example: productClassInvalid_ Product class is invalid ``` { "message": "Invalid product class." } ``` _Example: sellingModelInvalid_ Product selling model is invalid ``` { "message": "Invalid product selling model." } ``` _Example: maxCartLimitExceeded_ Max cart limit exceeded ``` { "message": "Cart item limit exceeded." } ``` * **401** UnAuthorized Media type: `application/json`. Schema: `object`. * `message` (_string_) _Example_ ``` { "message": "Authentication failed." } ``` * **403** Forbidden Media type: `application/json`. Schema: `array of object`. Array of `object`. * `errorCode` (_string_) * `message` (_string_) _Example: invalidOperation_ Invalid operation ``` { "errorCode": "INVALID_OPERATION", "message": "The requested operation isn't allowed for this cart." } ``` _Example: invalidInput_ Invalid input ``` { "errorCode": "INVALID_INPUT", "message": "Invalid configuration parameters were provided." } ``` _Example: insufficientAccess_ Insufficient access ``` { "errorCode": "INSUFFICIENT_ACCESS_OR_READONLY", "message": "You don't have sufficient permissions to perform this operation." } ``` _Example: cartInCheckoutState_ Cart in invalid state ``` { "errorCode": "INVALID_OPERATION", "message": "The cart context can't be configured while the cart is in the checkout state." } ``` * **404** Not Found Media type: `application/json`. Schema: `object`. * `message` (_string_) _Example_ ``` { "message": "Cart not found." } ``` * **409** Conflict Media type: `application/json`. Schema: `object`. * `message` (_string_) _Example_ ``` { "message": "The request couldn’t be completed due to a conflict with the current cart state. Review your cart and try again." } ``` * **412** Precondition Failed Media type: `application/json`. Schema: `array of object`. Array of `object`. * `errorCode` (_string_) * `message` (_string_) _Example: apexFailed_ Apex calculation failed ``` { "errorCode": "APEX_FAILED", "message": "The cart summary calculation failed due to an internal Apex error." } ``` _Example: ccaExecutionFailed_ CCA execution failed ``` { "errorCode": "APEX_FAILED", "message": "Unable to calculate cart totals and promotions." } ``` * **500** Internal Server Error Media type: `application/json`. Schema: `array of object`. Array of `object`. * `errorCode` (_string_) * `message` (_string_) _Example: unknownException_ Unknown exception ``` { "errorCode": "UNKNOWN_EXCEPTION", "message": "An unexpected error occurred while processing the request." } ``` _Example: systemError_ System error ``` { "errorCode": "UNKNOWN_EXCEPTION", "message": "An internal system error occurred while configuring the cart context." } ``` _Example: unhandledException_ Unhandled exception ``` { "errorCode": "UNKNOWN_EXCEPTION", "message": "An error occurred while configuring the cart context." } ``` * **503** Service Unavailable Media type: `application/json`. Schema: `array of object`. Array of `object`. * `errorCode` (_string_) * `message` (_string_) _Example: maintenanceMode_ System in maintenance mode ``` { "errorCode": "INSERT_UPDATE_DELETE_NOT_ALLOWED_DURING_MAINTENANCE", "message": "The system is currently in maintenance mode and can't process requests. Try again later." } ``` _Example: readOnlyMode_ System in read-only mode ``` { "errorCode": "INSERT_UPDATE_DELETE_NOT_ALLOWED_DURING_MAINTENANCE", "message": "The system is currently in read-only mode and can't process updates. Try again later." } ``` ### POST Distribute cart items into delivery groups. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups/actions/itemDistributions` Operation ID: `postCartItemMove`. Distribute cart items into delivery groups. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartItemMoveCollectionInputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.BatchResultRepresentation`. ### GET Retrieve promotions associated with a cart. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/promotions` Operation ID: `getCartPromotionCollection`. Used to get all promotions associated with the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartPromotionCollectionRepresentation`. ### POST Create a cart. `POST /commerce/webstores/{webstoreId}/carts` Operation ID: `postCartCollection`. Gets a list of Carts or used for creating a cart. Only buyers with read access to carts can create carts. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartInputRepresentation`. _Example: CreateCartInput_ Example of the cart input to create a cart for the specified account using the provided currency, USD, in an org with the multicurrency feature enabled. ``` { "name": "MyCart", "type": "Cart", "currencyIsoCode": "USD", "effectiveAccountId": "001OL000002LC0qYAG" } ``` _Example: CreateCartWithCustomFieldsInput_ Example of the cart input to create a cart with custom fields from the WebCart sObject. Custom fields are optional and must be previously defined for the sObject. ``` { "name": "MyCart", "type": "Cart", "currencyIsoCode": "USD", "effectiveAccountId": "001OL000002LC0qYAG", "customFields": { "attributes": { "type": "WebCart" }, "MyCustomTextField__c": "Text", "MyCustomNumberField__c": 12.34, "MyCustomPercentField__c": 0.2345, "MyCustomGeolocationField__c": { "latitude": 33.345, "longitude": 45.567 } } } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. _Example: Example_ Successfully created cart. ``` { "accountId": "3K0SG000000OTaQ0AW", "asyncOperationStatus": null, "cartId": "0a6SG000001qGHpYAM", "currencyIsoCode": "USD", "customFields": [], "firstPymtGrandTotalAmount": 0, "firstPymtTotalAmount": 0, "firstPymtTotalListPrice": 0, "firstPymtTotalTaxAmount": 0, "grandTotalAmount": 0, "isSecondary": false, "messagesSummary": { "errorCount": null, "hasErrors": null, "limitedMessages": [], "relatedEntityId": null, "totalLineItemsWithErrors": null }, "name": "My Cart", "orderOwnerId": null, "ownerId": "005SG00000Gjt8oYAB", "purchaseOrderNumber": null, "status": "Active", "taxType": "Automatic", "totalAmountWithItemAdjustment": 0, "totalCartLevelAdjustmentAmount": 0, "totalChargeAmount": 0, "totalChargeAmountWithItemAdjustment": 0, "totalListPrice": 0, "totalProductAmount": 0, "totalProductAmountAfterAdjustments": 0, "totalProductCount": 0, "totalProductLineItemCount": 0, "totalProductListAmount": 0, "totalPromotionalAdjustmentAmount": 0, "totalSubProductCount": 0, "totalTaxAmount": 0, "type": "Cart", "uniqueProductCount": 0, "webstoreId": "0ZESG000001n96S4AQ" } ``` * **404** Client Error Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. _Example: Example_ Client error. ``` [ { "errorCode": "NOT_FOUND", "message": "The requested resource doesn't exist." } ] ``` * **500** Internal Server Error Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. _Example: Example_ Internal server error. ``` [ { "errorCode": "UNKNOWN_EXCEPTION", "message": "Invalid parameter value \\\"3K0SG000000OT\\\" for parameter \\\"id\\\"." } ] ``` ### DELETE Delete an item in a cart. `DELETE /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items/{cartItemId}` Operation ID: `deleteCartItem`. Used to update or delete single cart item. Only buyers with read access to carts can delete items in carts. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `cartItemId` (path, string (Id), required) The ID of the cart item. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success ### PATCH Update an item in a cart. `PATCH /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items/{cartItemId}` Operation ID: `patchCartItem`. Used to update or delete single cart item. Buyers with read access to carts can update items in carts. Updating items in a cart respects buyer view product entitlements, and only users entitled to view product data can access it. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `cartItemId` (path, string (Id), required) The ID of the cart item. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `includeCartData` (query, boolean) Specify to include complete cart data in the response. This is available ONLY when in sync mode. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartItemInputRepresentation`. _Example: UpdateCartItemsInput_ This cart input updates an item in a cart. ``` { "quantity": 7 } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartItemRepresentation`. _Example: Example_ Successfully updated cart. ``` { "billingFrequency": null, "cartDeliveryGroupId": "0a7SG000001vIajYAE", "cartId": "0a6SG000001rCgnYAE", "cartItemId": "0a9SG000005Lm0LYAS", "childProductCount": 0, "currencyIsoCode": "USD", "customFields": [], "firstPymtTotalAmount": null, "firstPymtTotalListPrice": 49.98, "firstPymtTotalPrice": 41, "firstPymtTotalTax": null, "itemizedAdjustmentAmount": 0, "listPrice": 24.99, "messagesSummary": { "errorCount": null, "hasErrors": null, "limitedMessages": [], "relatedEntityId": null, "totalLineItemsWithErrors": null }, "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "parentCartItemId": null, "productClass": "Simple", "productDetails": { "fields": {}, "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "productId": "01tSG000003uisfYAA", "productSubscriptionInformation": null, "purchaseQuantityRule": null, "sku": 6010009, "thumbnailImage": { "alternateText": null, "contentVersionId": null, "id": "2pmSG000005k7q3YAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg" }, "variationAttributes": {} }, "productId": "01tSG000003uisfYAA", "productSellingModelId": null, "quantity": 2, "salesPrice": 20.5, "sellingModelType": null, "subType": null, "subscriptionTerm": null, "totalAdjustmentAmount": 0, "totalAmount": null, "totalListPrice": 49.98, "totalPrice": 41, "totalTax": null, "type": "Product", "unitAdjustedPrice": 20.5, "unitAdjustedPriceWithItemAdj": 20.5, "unitAdjustmentAmount": 0, "unitItemAdjustmentAmount": 0 } ``` ### GET Retrieve details of a delivery group in the cart. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups/{deliveryGroupId}` Operation ID: `getDeliveryGroup`. Delivery group in the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `deliveryGroupId` (path, string (Id), required) The ID of the delivery group. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) Optional. The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `page` (query, string) Optional. The page token to use to view a page of information. Page tokens are returned as part of the response, such as currentPageToken or nextPageToken. If you don’t specify a value, the first page is returned. * `pageSize` (query, integer) Optional. The number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25. * `sort` (query, sfdc.commerce.cart.connect.api.enums.ConnectCartItemSortOrderEnum) #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.DeliveryGroupRepresentation`. ### DELETE Delete a delivery group in the cart. `DELETE /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups/{deliveryGroupId}` Operation ID: `deleteDeliveryGroup`. Delivery group in the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `deliveryGroupId` (path, string (Id), required) The ID of the delivery group. * `webstoreId` (path, string (Id), required) The ID of the web store. * `deleteCartItems` (query, boolean) Optional. Indicates whether to delete cart items associated with the delivery group (True) or not (False) * `effectiveAccountId` (query, string (Id)) Optional. The ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. #### Responses * **200** Success ### PATCH Update a delivery group in the cart. `PATCH /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups/{deliveryGroupId}` Operation ID: `patchDeliveryGroup`. Delivery group in the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `deliveryGroupId` (path, string (Id), required) The ID of the delivery group. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.common.connect.api.input.DeliveryGroupV2InputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.DeliveryGroupRepresentation`. ### POST Perform a complete cart calculation based on the cart status. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/calculate` Operation ID: `postCartCalculate`. Calculates an existing cart. Possible calculations include computing prices, evaluating promotions, checking the inventory, computing shipping costs, evaluating shipping promotions, applying post shipping adjustments, and computing taxes. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) Optional. The ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartCalculateInputRepresentation`. _Example: cartCalculateInput_ Here's an example of the cart calculation POST request. ``` { "customFields": [ { "attributes": { "type": "WebCart" }, "WebCartCustomField1__c": "Foo" }, { "attributes": { "type": "CartItem" }, "id": "0a9xx0000000002CI1", "CartItemCustomField1__c": "CI1_Field1Value", "CartItemCustomField2__c": "CI1_Field2Value" }, { "attributes": { "type": "CartItem" }, "id": "0a9xx0000000002CI2", "CartItemCustomField1__c": "CI2_Field1Value", "CartItemCustomField2__c": "CI2_Field2Value" }, { "attributes": { "type": "CartDeliveryGroup" }, "id": "0a7xx000000000CDG1", "CartDeliveryGroupCustomField1__c": "CDG1_Field1Value", "CartDeliveryGroupCustomField2__c": "CDG1_Field2Value" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryResultRepresentation`. ### GET Retrieve summary for a cart. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}` Operation ID: `getCartSummary`. Create Cart/ Get Cart Summary/ Delete Cart During asynchronous cart processing, if enabled, GET response headers include Location and Retry-After. While the cart is processing, GET requests return a 202 status and may include stale, null, or 0 pricing data. When cart processing is complete, requests return a 200 status with up-to-date pricing data. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. ### PUT Create an active cart `PUT /commerce/webstores/{webstoreId}/carts/{activeCartOrId}` Operation ID: `putCartSummary`. Create Cart/ Get Cart Summary/ Delete Cart If one doesn’t exist. Buyers with read access to carts can create carts. The PUT request doesn’t require parameters nor a request body. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. ### DELETE Delete a cart. `DELETE /commerce/webstores/{webstoreId}/carts/{activeCartOrId}` Operation ID: `deleteCartSummary`. Create Cart/ Get Cart Summary/ Delete Cart Only buyers with read access to carts can delete carts. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success ### PATCH patchCartSummary `PATCH /commerce/webstores/{webstoreId}/carts/{activeCartOrId}` Operation ID: `patchCartSummary`. Create Cart/ Get Cart Summary/ Delete Cart Update name and description for the cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id), required) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `object`. * `name` (_string_, required) The name of the cart. The name can have up to 250 Unicode characters. Avoid using special characters in the cart name, including `\"'<>@!$#&%\\{[]}`. * `description` (_string_) The description for the cart. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation`. * **400** Bad Request - Invalid input parameters or request data. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ErrorOutputRepresentation`. _Example: InvalidEffectiveAccountId_ ``` { "errors": [ { "code": "INVALID_API_INPUT", "message": "The provided EffectiveAccountId parameter is invalid or malformed." } ] } ``` * **404** Not Found - Requested resource doesn't exist. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ErrorOutputRepresentation`. _Example: WebstoreNotFound_ ``` { "errors": [ { "code": "WEBSTORE_NOT_FOUND", "message": "The specified webstore doesn't exist or isn't accessible." } ] } ``` * **500** Internal Server Error - Unexpected system error occurred. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.ErrorOutputRepresentation`. _Example: InternalServerError_ ``` { "errors": [ { "code": "INTERNAL_SERVER_ERROR", "message": "An unexpected error occurred while processing the request." } ] } ``` ### GET Retrieve compact cart summary for an existing cart. `GET /commerce/webstores/{webstoreId}/carts/compact-summary` Operation ID: `getCartBadge`. The compact cart summary for an existing cart. #### Parameters * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartSummaryCompactRepresentation`. * **400** Webstore not found Media type: `application/json`. _Example_ ``` [ { "errorCode": "INVALID_INPUT", "message": "Invalid webstoreId" } ] ``` ### POST Retrieve all promotions associated with the cart items. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-items/promotions` Operation ID: `postCartItemPromotionCollection`. Retrieve all promotions associated with the cart items. POST methods typically create an item, but for this resource POST is used to retrieve information. Both POST and GET retrieve the same information. However, GET calls can be cached. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartItemPromotionCollectionInputRepresentation`. _Example: Example_ Example of the cart item promotion collection input. ``` { "items": [ { "cartItemId": "0a9xx000000000GAAQ" }, { "cartItemId": "0a9xx000000000GBCQ" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartItemPromotionCollectionOutputRepresentation`. ### POST Preserve cart contents when a guest logs in as an authenticated customer. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/actions/preserve` Operation ID: `postPreserveCart`. Allows preserving the guest cart. When a guest user adds products to a cart and then logs in, the API creates a new authorized cart and transfers the guest cart’s items and applied coupons to it. The API doesn’t transfer delivery details, tax calculations, or custom fields. It deletes the guest cart after a successful transfer. If the customer already has an existing cart from a prior authenticated session, the API sets the newly authorized cart as the primary cart and retains the previous cart as a secondary cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.PreserveCartOutputRepresentation`. ### POST Arrange cart items into delivery groups. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups/actions/arrange-items` Operation ID: `postCartItemArrange`. Arrange cart items among delivery groups #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `deleteEmptyDeliveryGroups` (query, boolean) Specifies whether to delete delivery groups with no cart items (true) or not (false). If unspecified, the default value is true. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.ItemArrangementsInputRepresentation`. _Example: Example_ Delivery group collection. ``` { "arrangements": [ { "deliveryGroupId": "0a7xx000000004rAAA", "cartItemId": "0a9xx000000004rAAA", "quantity": 5 } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.DeliveryGroupCollectionRepresentation`. ### GET Retrieve coupons associated with a cart. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-coupons` Operation ID: `getCartCouponCollection`. Apply a coupon code to a cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartCouponCollectionRepresentation`. ### POST Apply a coupon code to a cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/cart-coupons` Operation ID: `postCartCouponCollection`. Apply a coupon code to a cart. In API version 63.0 and later, if your store has simplified cart cleanup enabled, a POST request can apply a coupon to a cart without canceling checkout. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `currencyIsoCode` (query, string) The three-letter ISO 4217 currency code of the cart. * `effectiveAccountId` (query, string (Id)) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CartCouponInputRepresentation`. _Example: Example_ Apply coupon. ``` { "couponCode": "COUP10", "customFields": [ { "attributes": { "type": "WebCartAdjustmentBasis" }, "Test__C": "test@salesforce.com" } ] } ``` #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartCouponCollectionRepresentation`. ### GET Retrieve a collection of delivery groups in a cart. `GET /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups` Operation ID: `getDeliveryGroupCollection`. Create a collection of delivery groups in a cart. Use CartItemLimit query param to limit the number of cart items included in each delivery group #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `cartItemLimit` (query, integer) The limit of items in a cart. * `effectiveAccountId` (query, string (Id)) The ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. * `page` (query, string) Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as currentPageToken or nextPageToken. If you don’t specify a value, the first page is returned. * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25. * `sort` (query, sfdc.commerce.cart.connect.api.enums.ConnectCartItemSortOrderEnum) #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.DeliveryGroupCollectionRepresentation`. ### POST Create a collection of delivery groups in a cart. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/delivery-groups` Operation ID: `postDeliveryGroupCollection`. Create a collection of delivery groups in a cart. #### Parameters * `activeCartOrId` (path, string, required) The valid value is—cartId (ID of the cart), active (this value is only to be used for authenticated users), or current (cart that isn’t closed or pending deletion). Use active only for B2B Aura stores; all other stores must use current. * `webstoreId` (path, string (Id), required) The ID of the web store. * `effectiveAccountId` (query, string (Id)) The ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. #### Request body Media type: `application/json`. Schema: `sfdc.commerce.common.connect.api.input.DeliveryGroupV2InputRepresentation`. #### Responses * **200** Success Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.DeliveryGroupRepresentation`. ### POST Create a new quote from an active cart by converting cart items into quote line items. `POST /commerce/webstores/{webstoreId}/carts/{activeCartOrId}/quotes` Operation ID: `postQuoteFromCart`. This API is used on the Cart page of the B2B storefront to create a quote from the active cart, retaining pricing and customer details. Buyers can also specify an expiration date and add comments for negotiation. To access these resources, your org must have the B2B Commerce license. This API is available only to authenticated users. **Note:** The Commerce Quotes APIs don't support product bundles. Only simple products can be included in quote. To access this API, your org must have the B2B Commerce license. This API is available only to authenticated users. This API is used on the Cart page of the B2B storefront to create a quote from the active cart, retaining pricing and customer details. Buyers can also specify an expiration date and add comments for negotiation. **Note:** Carts must contain at least one product to create a quote. Empty carts return an error. Promotions and bonus products aren't supported. Supported product types by license: * Simple products: Supported with B2B Commerce Only or B2B Commerce and Revenue Cloud licenses. * Static bundles: Supported only with the B2B Commerce and Revenue Cloud licenses. * Dynamic bundles: Supported only with the B2B Commerce and Revenue Cloud licenses. * Subscription products: Not supported with either B2B Commerce Only or B2B Commerce and Revenue Cloud licenses. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. * `activeCartOrId` (path, string (Id), required) The valid value is the cart ID of an active cart only. #### Request body (required) Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CreateQuoteFromCartInputRepresentation`. _Example_ ``` { "comments": "Provide bulk pricing for orders of 100+ units. We are interested in a long-term partnership.", "additionalFields": { "ExpirationDate": "2025-12-31", "BuyerEmail__c": "procurement@company.com" }, "deleteCart": false } ``` #### Responses * **200** Success — Quote created from cart. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CreateQuoteFromCartOutputRepresentation`. _Example: Success_ ``` { "quoteId": "0Q0xx0000000001EAA", "errors": [] } ``` * **400** Bad Request - Invalid input parameters or request data. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CreateQuoteFromCartOutputRepresentation`. _Example: InvalidCart_ ``` { "errors": [ { "code": "INVALID_INPUT", "message": "The specified context ID is invalid." } ] } ``` _Example: InvalidCustomFields_ ``` { "errors": [ { "code": "INVALID_CUSTOM_FIELDS", "message": "One or more custom field values are invalid or don't meet required criteria." } ] } ``` _Example: BundlesNotSupported_ ``` { "errors": [ { "code": "BUNDLES_NOT_SUPPORTED", "message": "This request doesn't support product bundles." } ] } ``` * **404** Not Found - Requested resource doesn't exist. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CreateQuoteFromCartOutputRepresentation`. _Example: CartNotFound_ ``` { "errors": [ { "code": "CART_NOT_FOUND", "message": "The specified cart doesn't exist or you don't have access to it." } ] } ``` _Example: WebstoreNotFound_ ``` { "errors": [ { "code": "WEBSTORE_NOT_FOUND", "message": "he specified web store doesn't exist or you do not have access to it." } ] } ``` * **500** Internal Server Error - Unexpected system error occurred. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CreateQuoteFromCartOutputRepresentation`. _Example: InternalServerError_ ``` { "errors": [ { "code": "INTERNAL_SERVER_ERROR", "message": "An unexpected error occurred while processing the request." } ] } ``` ### POST Create a cart from an approved quote, or duplicate a draft quote into a cart by converting the quote into cart items. `POST /commerce/webstores/{webstoreId}/quotes/{quoteId}/cart` Operation ID: `postCartFromQuote`. This API performs one of the following operations based on the quote status: * Create Cart from Quote: * Create a cart from a quote only when its status is Approved or Accepted, as initiated by the Accept & Buy action on the My Quotes page of the B2B storefront. * All items are added at the negotiated and discounted prices. * A quote can be converted to a cart only once if the resulting cart is used to place an order. After the order is placed, the same quote can't be reused. * If the cart is cleared after conversion (before placing an order), the quote can be converted to a cart again. * Duplicate Quote to Cart: * Duplicate the quote to cart, as initiated by the Duplicate to Cart action on the My Quotes page of the B2B storefront. This operation isn't supported only for quotes in Approved or Accepted status. * All items are added at their original prices. Duplicate-to-cart and convert-to-cart operations succeed only when the cart has no matching products. For example, if both the quote and the cart contain Product A, the API returns an error. Partial conversion or duplication, promotions, and bonus products aren't supported. Supported product types by license: * Simple products: Supported with B2B Commerce only or B2B Commerce and Revenue Cloud licenses. * Static bundles: Supported with B2B Commerce only or B2B Commerce and Revenue Cloud licenses. * Dynamic bundles: Supported only with the B2B Commerce and Revenue Cloud license. * Subscription products: Not supported with either B2B Commerce Only or B2B Commerce and Revenue Cloud licenses. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. * `quoteId` (path, string (Id), required) The ID of the quote record to convert to a cart. #### Request body (required) Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.input.CreateCartFromQuoteInputRepresentation`. _Example_ ``` { "operationType": "CONVERT_TO_CART" } ``` #### Responses * **200** Success — Cart created from quote. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartFromQuoteOutputRepresentation`. _Example: Success_ ``` { "cartId": "0Q0xx0000000001EAA", "errors": [] } ``` * **400** Bad Request - Invalid input parameters or request data. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartFromQuoteOutputRepresentation`. _Example: InvalidOperationType_ ``` { "errors": [ { "code": "INVALID_OPERATION_TYPE", "message": "The provided operationType isn't supported." } ] } ``` * **404** Not Found - Requested resource doesn't exist. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartFromQuoteOutputRepresentation`. _Example: QuoteNotFound_ ``` { "errors": [ { "code": "QUOTE_NOT_FOUND", "message": "The specified quote doesn't exist or isn't accessible." } ] } ``` _Example: WebstoreNotFound_ ``` { "errors": [ { "code": "WEBSTORE_NOT_FOUND", "message": "The specified webstore doesn't exist or isn't accessible." } ] } ``` * **500** Internal Server Error - Unexpected system error occurred. Media type: `application/json`. Schema: `sfdc.commerce.cart.connect.api.output.CartFromQuoteOutputRepresentation`. _Example: ProcessingError_ ``` { "errors": [ { "code": "INTERNAL_SERVER_ERROR", "message": "An unexpected error occurred while creating the cart from the quote." } ] } ``` ## Schemas ### sfdc.commerce.cart.connect.api.input.CartMessagesVisibilityInputRepresentation Input for updating a message visibility status. * `visibility` (_boolean_) Indicates whether to set cart messages as visible (true) or not (false). ### sfdc.commerce.cart.connect.api.output.CartMessagesVisibilityResultRepresentation Represents the updated visibility value for the cart messages. * `visibility` (_boolean_) Indicates whether cart messages are set to visible (true) or not (false). ### sfdc.commerce.cart.connect.api.input.CartItemInputRepresentation Details of a cart item input. * `cartDeliveryGroupId` (_string_) The ID of the cart delivery group associated with the cart item. * `customFields` (_array of object_) An array of sObjects and custom fields for the sObjects. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, only the CartItem sObject is supported. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. The custom fields can be of type Checkbox, Currency, Date, Email, LongTextArea, Number, Percent, Phone, Text, TextArea, Url, Address, or Location. The customFields property isn't supported in stores built on an Aura template. Additional properties: `any`. * `productId` (_string_) The ID of the product. * `productSellingModelId` (_string_) The ID of the product selling model associated with Product2. * `quantity` (_string_) The quantity of the cart item. Use a value that can be converted to BigDecimal. * `subscriptionTerm` (_integer_) The total number of terms in the subscription period. * `type` (_any_) The type of item in a cart. This field isn't supported for the PATCH method. ### core.connect.api.output.common.BatchRepresentation Result of an entire batch request operation. Results are ordered in the same order in which the requests were given. Results are either a successful result with a response body, a successful result without a response body, or an error result without a response body. Success and error are determined by the status code in each result. * `hasErrors` (_boolean_) Indicates whether at least one of the results is an error status code in the 400 or 500 range (true) or not (false). * `results` (_array of sfdc.commerce.cart.connect.api.output.BatchResultRepresentation_) The collection of batch result items. ### sfdc.commerce.cart.connect.api.input.CartEvaluateShippingInputRepresentation Details of the cart calculate evaluate shipping input request. * `customFields` (_array of object_) Array of sObjects and custom fields for the sObjects. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, the WebCart, CartItem, and CartDeliveryGroup sObjects are supported. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. * `shippingAddress` (_sfdc.commerce.common.connect.api.input.CartShippingAddressInputRepresentation_) ### sfdc.commerce.cart.connect.api.output.CartSummaryResultRepresentation Result of calculating a cart. Includes all fields of `sfdc.commerce.cart.connect.api.output.CommerceResultRepresentationBase`. * `data` (_sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation_) ### sfdc.commerce.cart.connect.api.output.ProductCartItemRepresentation Cart items of a specific product type. * `cartItems` (_array of sfdc.commerce.cart.connect.api.output.CartItemResultRepresentation_) The collection of items in a cart. * `product` (_sfdc.commerce.cart.connect.api.output.CartProductSummaryRepresentation_) ### sfdc.commerce.cart.connect.api.input.CartInventoryReservationInputRepresentation Details of the create a reservation input request. * `durationInSeconds` (_integer_, required) Reservation duration in seconds. ### sfdc.commerce.cart.connect.api.output.CartInventoryReservationOutputRepresentation An inventory reservation. * `errorCode` (_string_) The error code for this reservation. * `errorMessage` (_string_) The error message for this reservation. * `inventoryItemReservations` (_array of sfdc.commerce.cart.connect.api.output.CartInventoryItemReservationOutputRepresentation_) The collection of inventory item reservations. * `reservationIdentifier` (_string_) The reservation identifier. * `success` (_boolean_) Indicates whether the transaction was successful (true) or not (false). ### sfdc.commerce.cart.connect.api.output.ProductCartItemCollectionRepresentation Items in the cart, grouped by product type. * `count` (_integer_) The number of cart items returned on the current page. * `currentPage` (_integer_) The current page of cart items. The value matches the requested page number, unless the requested page number exceeds the total number of pages. In this scenario, the current page is the highest available page number. * `hasErrors` (_boolean_) Indicates whether at least one of the results contains an error (True) or not (False). * `products` (_array of sfdc.commerce.cart.connect.api.output.ProductCartItemRepresentation_) The collection of products in the cart. * `totalItemCount` (_integer_) The total number of unique products in the cart. * `totalNumberOfPages` (_integer_) The total number of pages for the given page size. ### sfdc.commerce.cart.connect.api.input.CartToWishlistInputRepresentation Details of products to be copied from a cart to a wishlist. * `wishlistId` (_string_) The ID of the wishlist to copy cart products to. ### sfdc.commerce.cart.connect.api.output.CartToWishlistResultRepresentation Result of copying products from a cart to a wishlist. * `productsAddedCount` (_integer_) The number of products copied from the cart to the wishlist. * `wishlistId` (_string (Id)_) The ID of the wishlist that cart products were copied to. ### sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation Summary of information about a cart and its contents. * `accountId` (_string (Id)_) The ID of account for the cart. * `asyncOperationStatus` (_sfdc.commerce.cart.connect.api.enums.ConnectCartAsyncOperationStatusEnum_) * `cartId` (_string (Id)_) The ID of the cart. * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code associated with the cart. * `customFields` (_array of object_) Array of sObjects and viewable custom fields for the sObjects. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. If no custom fields were specified, returns an empty collection. Additional properties: `any`. * `firstPymtGrandTotalAmount` (_string_) First payment amount for subscription products, plus the total payment amount for non-subscription products, including taxes. * `firstPymtTotalAmount` (_string_) The total amount on the first payment of the cart. * `firstPymtTotalListPrice` (_string_) The total list price on the first payment of the cart. * `firstPymtTotalTaxAmount` (_string_) Tax amount on the first payment for any subscription products, plus the total tax amount on non-subscription products. * `grandTotalAmount` (_string_) Grand total amount including shipping and tax for items in the cart, in the currency of the cart. and tax). * `isSecondary` (_boolean_) Indicates whether the cart is secondary (true) or not (false). * `messagesSummary` (_sfdc.commerce.cart.connect.api.output.CartMessagesSummaryRepresentation_) * `name` (_string_) The name for the cart. The name can have up to 250 Unicode characters. Avoid using special characters in the cart name, including `\"'<>@!$#&%\\{[]}`. If unspecified, a cart name is generated automatically using the pattern, `Untitled Cart - [Date] [Time]`. * `description` (_string_) The description for the cart. * `orderOwnerId` (_string (Id)_) The ID of the owner of the cart. * `ownerId` (_string (Id)_) The ID of the owner of the order. * `purchaseOrderNumber` (_string_) The purchase order for the cart. * `status` (_sfdc.commerce.cart.connect.api.enums.ConnectCartStatusEnum_) * `taxType` (_sfdc.commerce.cart.connect.api.enums.ConnectCartTaxTypeEnum_) * `totalAmountWithItemAdjustment` (_string_) The total amount, including both tier and item level discounts but excluding cart level discounts, for all items in the cart. * `totalCartLevelAdjustmentAmount` (_string_) The total cart level discount amount for the cart. * `totalChargeAmount` (_string_) The total amount for shipping and other charges in the currency of the cart. Includes adjustments from shipping promotions. * `totalChargeAmountWithItemAdjustment` (_string_) The total amount with shipping item level adjustment on cart. * `totalListPrice` (_string_) The total list price for the cart. * `totalProductAmount` (_string_) The total including discounts, but excluding shipping and tax, for product items in the cart. * `totalProductAmountAfterAdjustments` (_string_) The total product amount when promotion is turned off and sum of total product amount and total promotional adjustment amount with promotions turned on. * `totalProductCount` (_string_) The total count of items in the cart. This field may not be accurate when faster add-to-cart is turned on and quantity rules are enabled for products in the cart. * `totalProductLineItemCount` (_integer_) The total count of line items, of the type Product, in the cart. cart. * `totalProductListAmount` (_string_) The total list amount for products in the cart. * `totalPromotionalAdjustmentAmount` (_string_) The total promotional adjustment amount for items in the cart. This is the sum of all Itemized adjustment amounts and distributed adjustment amounts in the cart. * `totalSubProductCount` (_string_) The total quantity of all cart items with the selling model type Evergreen or Term-Defined. * `totalTaxAmount` (_string_) The total tax amount for the cart, including tax on shipping, if applicable. * `type` (_sfdc.commerce.cart.connect.api.enums.ConnectCartTypeEnum_) * `uniqueProductCount` (_integer_) The total count of unique items, or SKUs, in the cart. This field is supported when faster add-to-cart is turned off. * `webstoreId` (_string (Id)_) The ID of the webstore of the cart. ### sfdc.commerce.cart.connect.api.output.CommerceActionResultRepresentation Result of executing a commerce action. * `isSuccess` (_boolean_) Indicates whether the action is a success (true) or not (false). * `message` (_string_) The action result message. ### sfdc.commerce.cart.connect.api.input.CartEvaluateTaxInputRepresentation Details of the evaluate tax input request. * `customFields` (_array of object_) Array of sObjects and custom fields for the sObjects. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, the WebCart, CartItem, and CartDeliveryGroup sObjects are supported. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. * `shippingAddress` (_sfdc.commerce.common.connect.api.input.CartShippingAddressInputRepresentation_) ### sfdc.commerce.cart.connect.api.enums.ConnectCartItemSortOrderEnum The sort order for items in a cart. Type: `string`. Allowed values: `CreatedDateAsc—Sorts by oldest creation date.`, `CreatedDateDesc—Sorts by most recent creation date.`, `NameAsc—Sorts by name in ascending alphabetical order (A–Z).`, `NameDesc—Sorts by name in descending alphabetical order (Z–A).`, `SalesPriceAsc—Sorts from lowest to highest negotiated price.`, `SalesPriceDesc—Sorts from highest to lowest negotiated price.`. ### sfdc.commerce.cart.connect.api.output.CartItemCollectionRepresentation Details of the collection of items in a cart. * `cartCoupons` (_sfdc.commerce.cart.connect.api.output.CartCouponCollectionRepresentation_) * `cartItems` (_array of sfdc.commerce.cart.connect.api.output.CartItemResultRepresentation_) The collection of items in a cart. * `cartPromotions` (_sfdc.commerce.cart.connect.api.output.CartPromotionCollectionRepresentation_) * `cartSummary` (_sfdc.commerce.cart.connect.api.output.CartSummaryRepresentation_) * `approachingDiscounts` (_array of string_) The list of approaching discount messages. * `count` (_integer_) The number of cart items returned on the current page. * `currentPage` (_integer_) The current page of cart items. The value matches the requested page number, unless the requested page number exceeds the total number of pages. In this scenario, the current page is the highest available page number. * `currentPageToken` (_string_) The token identifying the current page. * `currentPageUrl` (_string_) The URL identifying the current page. * `hasErrors` (_boolean_) Indicates whether at least one of the results contains an error (true) or not (false). * `nextPageToken` (_string_) The token identifying the next page, or null if there isn’t a next page. * `nextPageUrl` (_string_) The URL identifying the next page, or null if there isn’t a next page. * `previousPageToken` (_string_) The token identifying the previous page, or null if there isn’t a previous page. * `previousPageUrl` (_string_) The URL identifying the previous page, or null if there isn’t a previous page. * `total` (_integer_) The total number of unique products in the cart. * `totalNumberOfPages` (_integer_) The total number of pages for the given page size. ### sfdc.commerce.cart.connect.api.output.CartItemRepresentation Details of an item in a cart. Includes all fields of `sfdc.commerce.cart.connect.api.output.AbstractCartItemRepresentation`. * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code of the cart. * `firstPymtTotalAmount` (_string_) For subscription items, the first payment amount after adjustments and taxes. For non-subscription products, the value is the same as totalAmount. * `firstPymtTotalListPrice` (_string_) For subscription items, the total list price of the first payment. For non-subscription items, the value is the same as totalListPrice. * `firstPymtTotalPrice` (_string_) For subscription items, the first term price, including adjustments but excluding taxes. For non-subscription items, the total price, including adjustments but excluding taxes. * `firstPymtTotalTax` (_string_) For subscription items, the tax amount on the first payment. For non-subscription products, the value is the same as totalTax. * `itemizedAdjustmentAmount` (_string_) Total itemized adjustment amount for the item, including promotions and excluding taxes. * `listPrice` (_string_) List price for the item. * `productClass` (_commerce.catalog.connect.api.enumeration.ConnectProductClassEnum_) * `salesPrice` (_string_) Sales price for the item. * `totalAdjustmentAmount` (_string_) Total adjustment amount for the item. * `totalAmount` (_string_) Total amount for the item. * `totalListPrice` (_string_) Total list price for the item. * `totalPrice` (_string_) Total price for the item including adjustments but excluding taxes. * `totalTax` (_string_) Total tax for the item. * `unitAdjustedPrice` (_string_) Unit price, including tier level discounts, for the item. This value is informational only and isn’t used in pricing calculations. * `unitAdjustedPriceWithItemAdj` (_string_) Unit price, including both tier and item level discounts, for the item. For bundle products, this value represents the aggregate price of both exclusive and inclusive products. This value is informational only and isn’t used in pricing calculations. * `unitAdjustmentAmount` (_string_) Tier level adjustments made to the unit price for the item. This value is informational only and isn’t used in pricing calculations. * `unitItemAdjustmentAmount` (_string_) Item level adjustments made to the unit price for the item. This value is informational only and isn’t used in pricing calculations. ### sfdc.commerce.cart.connect.api.output.ChildCartItemCollectionRepresentation Collection of child cart items associated with the parent cart item. * `childCartItems` (_array of sfdc.commerce.cart.connect.api.output.CartItemResultRepresentation_) The collection of items in a cart. * `count` (_integer_) The number of cart items returned on the current page. * `currentPageToken` (_string_) The token identifying the current page of cart items. * `currentPageUrl` (_string_) The URL to the current page of cart items. * `hasErrors` (_boolean_) Indicates whether at least one of the results contains an error (True) or not (False). * `nextPageToken` (_string_) The token identifying the next page of cart items. * `nextPageUrl` (_string_) The URL to the next page of cart items. * `previousPageToken` (_string_) The token identifying the previous page of cart items. * `previousPageUrl` (_string_) The URL to the previous page of of cart items. ### sfdc.commerce.cart.connect.api.input.CartItemsConfigurationInputRepresentation Represents the input payload used to configure a cart item based on the provided context ID. * `contextId` (_string_) Specifies the unique transaction context ID for the product configuration instance. ### sfdc.commerce.cart.connect.api.output.CartItemsConfigurationOutputRepresentation Represents the response details returned from cart configuration operations. ### sfdc.commerce.cart.connect.api.input.CartItemMoveCollectionInputRepresentation Collection of cart items to be moved into delivery groups. * `cartItems` (_array of sfdc.commerce.cart.connect.api.input.CartItemMoveInputRepresentation_) An array of cart items to be moved into delivery groups. ### sfdc.commerce.cart.connect.api.output.BatchResultRepresentation Batch result item. * `batchResult` (_array of sfdc.commerce.cart.connect.api.output.CartItemMoveRepresentation_) The details of an item in a cart. ### sfdc.commerce.cart.connect.api.output.CartPromotionCollectionRepresentation Promotions associated with a cart. * `cartId` (_string (Id)_) The ID of the cart. * `cartStatus` (_sfdc.commerce.cart.connect.api.enums.ConnectCartStatusEnum_) * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code associated with the cart. * `promotions` (_sfdc.commerce.cart.connect.api.output.CartPromotionListRepresentation_) ### sfdc.commerce.cart.connect.api.input.CartInputRepresentation Details of the create cart input request. * `currencyIsoCode` (_string_) The currency ISO code of the cart. * `customFields` (_array of object_) An array of sObjects and custom fields for the sObjects. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, only the WebCart sObject is supported. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. * `effectiveAccountId` (_string_) The ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. * `isSecondary` (_boolean_) Indicates whether the cart is secondary (true) or not (false). If unspecified, defaults to false. * `name` (_string_) The name of the cart. The name can have up to 250 Unicode characters. Avoid using special characters in the cart name, including `\"'<>@!$#&%\\{[]}`. If no cart name is specified, a default name is generated. When Multi Cart Management is enabled, the generated cart name uses the format `Untitled Cart - [Date] [Time]`. For assistance with Multi Cart Management, contact Salesforce Customer Support. * `orderOwnerId` (_string_) The ID of the owner of the order. * `type` (_sfdc.commerce.cart.connect.api.enums.ConnectCartTypeEnum_) * `typeAsString` (_string_) The type of the cart provided as a string. ### sfdc.commerce.cart.connect.api.output.DeliveryGroupRepresentation Delivery group for a Commerce store checkout. * `availableDeliveryMethods` (_array of sfdc.commerce.cart.connect.api.output.DeliveryMethodRepresentation_) The list of available delivery methods. When Shipping is disabled for your web store, the delivery methods list is empty. * `cartId` (_string_) The ID of the cart. * `cartItems` (_sfdc.commerce.cart.connect.api.output.CartItemCollectionRepresentation_) * `deliveryAddress` (_sfdc.commerce.common.connect.api.output.CheckoutAddressV2Representation_) * `desiredDeliveryDate` (_string (date)_) The date when the customer wants the items delivered. * `errors` (_array of sfdc.commerce.common.connect.api.output.CheckoutErrorRepresentation_) Errors * `id` (_string (Id)_) The ID for the delivery group. * `isDefault` (_boolean_) Indicates whether the delivery group is the default (True) or not (False). The default value is False. * `name` (_string_) The name of the delivery group. * `selectedDeliveryMethod` (_sfdc.commerce.cart.connect.api.output.DeliveryMethodRepresentation_) * `shippingInstructions` (_string_) Special shipping and handling instructions. * `totalCartItemCount` (_integer_) The number of cart items, including their quantities, of the type Product in the delivery group. * `totalCartItemQuantity` (_number (double)_) The total quantity of all product-type cart items within a delivery group. Supports up to four decimal places. The `totalCartItemCount` field truncates to integers. **Note:** Support for four decimal places is available for the Shipping service. Use of this precision may vary across other product types and checkout flows, such as tax and order processing, based on their handling of fractional quantities. For details, see the [Cart Calculate API](https://developer.salesforce.com/docs/commerce/salesforce-commerce/guide/cart-calculate-api.html). * `totalProductAmount` (_string_) The sum of all the cart items’ totalPrice for cart items of the type Product in the delivery group. * `isGift` (_boolean_) Indicates whether the delivery group is a gift (`true`) or not (`false`). The default value is False. * `giftMessage` (_string_) The gift message for the delivery group. * `giftToName` (_string_) The name of the gift recipient. ### sfdc.commerce.common.connect.api.input.DeliveryGroupV2InputRepresentation Representation of the checkout delivery group input. * `id` (_string_) The ID of the delivery group. * `deliveryMethodId` (_string_) The ID of the delivery method. * `desiredDeliveryDate` (_string (date)_) The delivery date of the delivery group. * `shippingInstructions` (_string_) The shipping instructions for the delivery group. * `deliveryAddress` (_sfdc.commerce.common.connect.api.input.CheckoutAddressInputV2Representation_) * `name` (_string_) Cart Delivery Group Name * `isGift` (_boolean_) Indicates whether the delivery group is a gift (true) or not (false). The default value is False. * `giftMessage` (_string_) The gift message for the delivery group. * `giftToName` (_string_) The name of the gift recipient. ### sfdc.commerce.cart.connect.api.input.CartCalculateInputRepresentation Calculate cart input request. * `customFields` (_array of object_) An array of sObjects and custom fields for the sObjects. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, the WebCart, CartItem, and CartDeliveryGroup sObjects are supported. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. ### sfdc.commerce.cart.connect.api.output.ErrorOutputRepresentation Representation of the error response. * `code` (_string_, required) The error code identifying the type of error. Example: `INVALID_INPUT`. * `message` (_string_, required) The message stating the reason for error, if any. Example: `The provided parameter is invalid or malformed`. ### sfdc.commerce.cart.connect.api.output.CartSummaryCompactRepresentation A compact cart summary for an existing cart. * `cartId` (_string_) The ID of the cart. * `currencyIsoCode` (_string_) The currency code associated with this cart. * `totalProductCount` (_string_) The total count of all the items in the cart. * `uniqueProductCount` (_integer_) The total count of unique items (SKUs) in the cart. ### sfdc.commerce.cart.connect.api.input.CartItemPromotionCollectionInputRepresentation Representation of the cart item promotion input. * `items` (_array of sfdc.commerce.cart.connect.api.input.CartItemPromotionInputRepresentation_) The list of cart items to get the associated promotions. ### sfdc.commerce.cart.connect.api.output.CartItemPromotionCollectionOutputRepresentation CartItemPromotionCollection representation includes all the promotions associated with the cart items. * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code associated with the cart. * `items` (_object_) The map of cart items to promotions. Additional properties: `sfdc.commerce.cart.connect.api.output.CartPromotionListRepresentation`. ### sfdc.commerce.cart.connect.api.output.PreserveCartOutputRepresentation Representation of a preserve cart. * `cartId` (_string (Id)_) The ID of the authenticated cart. * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code of the authenticated cart. * `failedCartItems` (_array of sfdc.commerce.cart.connect.api.output.CartItemBasicResultRepresentation_) The list of products that weren’t successfully transferred from the guest cart to the authenticated cart. * `numberOfProducts` (_integer_) The total number of products in the guest cart. * `numberOfProductsWithError` (_integer_) The total number of products that weren’t successfully transferred from the guest cart to the authenticated cart. * `numberOfProductsWithSuccess` (_integer_) The total number of products successfully transferred from the guest cart to the authenticated cart. * `succeededCartItems` (_array of sfdc.commerce.cart.connect.api.output.CartItemBasicResultRepresentation_) The list of products successfully transferred from the guest cart to the authenticated cart. ### sfdc.commerce.cart.connect.api.input.ItemArrangementsInputRepresentation Representation of the cart item arrange input. * `arrangements` (_array of sfdc.commerce.cart.connect.api.input.ItemArrangeInputRepresentation_) The set of instructions to arrange cart items into delivery groups. ### sfdc.commerce.cart.connect.api.output.DeliveryGroupCollectionRepresentation Collection of delivery groups for a Commerce store checkout. * `count` (_integer_) The number of delivery group items returned on the current page. * `currentPageToken` (_string_) The token identifying the current page of delivery group items. * `currentPageUrl` (_string_) The URL to the current page of delivery group items. * `errors` (_array of sfdc.commerce.common.connect.api.output.CheckoutErrorRepresentation_) The list of any errors. * `id` (_string (Id)_) The ID for the delivery group. * `items` (_array of sfdc.commerce.cart.connect.api.output.DeliveryGroupRepresentation_) The list of delivery groups. * `nextPageToken` (_string_) The token identifying the next page of delivery group items. * `nextPageUrl` (_string_) The URL to the next page of delivery group items. * `previousPageToken` (_string_) The token identifying the previous page of delivery group items. * `previousPageUrl` (_string_) The URL to the previous page of delivery group items. * `sortOrder` (_string_) The sort order for delivery groups. Valid values are CreatedDateDesc and CreatedDateAsc. * `total` (_integer_) The total amount for all the cart items in the delivery groups. ### sfdc.commerce.cart.connect.api.output.CartCouponCollectionRepresentation Collection of coupons associated with the cart. * `cartCoupons` (_sfdc.commerce.cart.connect.api.output.CartCouponListRepresentation_) * `cartId` (_string (Id)_) The ID of the cart. * `cartStatus` (_sfdc.commerce.cart.connect.api.enums.ConnectCartStatusEnum_) * `ownerId` (_string (Id)_) The ID of the user who owns this cart. ### sfdc.commerce.cart.connect.api.input.CartCouponInputRepresentation Representation of the apply coupon input. * `couponCode` (_string_) The coupon code to apply on Cart. * `customFields` (_array of object_) An array of sObjects and their associated custom fields. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, only the WebCart and WebCartAdjustmentBasis sObjects is supported. Field-level security rules configured by the web store admin in the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. ### sfdc.commerce.cart.connect.api.input.CreateQuoteFromCartInputRepresentation Representation for creating a quote from a cart. * `comments` (_string_) Optional. The comments submitted by the buyer when requesting a quote. Example: `Provide bulk pricing for orders of 100+ units.`. * `additionalFields` (_object_) Map of standard and custom Quote fields, such as expiration date and buyer email. Additional properties: `string`. _Example_ ``` { "ExpirationDate": "2024-12-31", "BuyerEmail__c": "buyer@company.com" } ``` * `deleteCart` (_boolean_) Indicate whether to delete the cart (`true`) or not (`false`) after the quote is created. Example: `false`. ### sfdc.commerce.cart.connect.api.output.CreateQuoteFromCartOutputRepresentation Output representation for quote created from cart. * `quoteId` (_string (Id)_, nullable) The ID of the quote created from the cart. The newly created quote is in Draft status. * `errors` (_array of sfdc.commerce.cart.connect.api.output.ErrorOutputRepresentation_) List of errors encountered during quote creation. Returns an empty array on success. ### sfdc.commerce.cart.connect.api.input.CreateCartFromQuoteInputRepresentation Representation for creating a cart from a quote. * `operationType` (_string_) The operation type for creating a cart from a quote. Valid values: * CONVERT\_TO\_CART—Create a cart from a quote only when its status is `Approved` or `Accepted`. When the user completes checkout by converting the quote to a cart, the API sets the `QuoteId` field on the [Order](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_order.htm) using the quote ID. * DUPLICATE\_TO\_CART—Duplicate the quote to a cart. Allowed values: `CONVERT_TO_CART`, `DUPLICATE_TO_CART`. ### sfdc.commerce.cart.connect.api.output.CartFromQuoteOutputRepresentation Output representation for cart created from quote. * `cartId` (_string (Id)_, nullable) The ID of the cart created from the quote. * `errors` (_array of sfdc.commerce.cart.connect.api.output.ErrorOutputRepresentation_) List of errors encountered during cart creation. Returns an empty array on success. ### sfdc.commerce.common.connect.api.input.CartShippingAddressInputRepresentation Details of the shipping address input request. * `city` (_string_) The shipping address city. * `companyName` (_string_) The shipping address company name. * `country` (_string_) The shipping address country. * `firstName` (_string_) The shipping address first name. * `lastName` (_string_) The shipping address last name. * `name` (_string_) The name of the contact. * `id` (_string_) The ID of the shipping address. * `postalCode` (_string_) The zip code or postal code for the shipping address. * `region` (_string_) The shipping address state. * `shipToPhoneNumber` (_string_) The shipping address phone number. * `street` (_string_) The shipping address street. ### sfdc.commerce.cart.connect.api.output.CommerceResultRepresentationBase Abstract representation class for a request result. * `message` (_string_) The message related to the request. * `status` (_sfdc.commerce.cart.connect.api.enums.ConnectCartAsyncOperationStatusEnum_) ### sfdc.commerce.cart.connect.api.output.CartItemResultRepresentation Cart item result. * `cartItem` (_sfdc.commerce.cart.connect.api.output.AbstractCartItemRepresentation_) * `message` (_string_) The message when the request isn’t successful. * `status` (_string_) The status for the request. ### sfdc.commerce.cart.connect.api.output.CartProductSummaryRepresentation Product summary for a cart item. * `fields` (_object_) The map of product fields and values. Additional properties: `string`. * `name` (_string_) The name of the product. * `productId` (_string (Id)_) The ID of the product. * `productClass` (_string_) The class of the Product. Allowed values: `Simple`, `Variation`, `VariationParent`, `Bundle`, `Set`. * `productUrlName` (_string_) The friendly URL name for the product, used for SEO purposes. * `productSubscriptionInformation` (_any_) Reserved for future use. * `purchaseQuantityRule` (_commerce.catalog.connect.api.output.PurchaseQuantityRuleRepresentation_) * `sku` (_string_) The SKU of the product. * `thumbnailImage` (_commerce.catalog.connect.api.output.ProductMediaRepresentation_) * `variationAttributes` (_object_) The variation attributes associated to this product Additional properties: `sfdc.commerce.cart.connect.api.output.CartProductAttributeRepresentation`. * `dynamicAttributes` (_object_) The dynamic attributes associated with this product. Additional properties: `sfdc.commerce.common.connect.api.output.CommerceProductDynamicAttributeRepresentation`. ### sfdc.commerce.cart.connect.api.output.CartInventoryItemReservationOutputRepresentation Inventory item reservation. * `errorCode` (_string_) The error code for this reservation item. * `errorMessage` (_string_) The error message for this reservation item. * `id` (_string_) The ID for this reservation item. * `itemReservationSourceId` (_string_) The item reservation source ID for this reservation item. * `productId` (_string_) The product ID for this reservation item. * `quantity` (_number (double)_) The quantity for this reservation item. * `reservedAtLocationId` (_string_) The reserved at location or group ID for this reservation item. ### sfdc.commerce.cart.connect.api.enums.ConnectCartAsyncOperationStatusEnum An asynchronous processing status of the cart, if asynchronous processing is enabled for the store. Type: `string`. Allowed values: `Completed`, `Errored`, `Processing`. ### sfdc.commerce.cart.connect.api.output.CartMessagesSummaryRepresentation Messages summary for the item. * `errorCount` (_integer_) In the Cart Item Result, the count of messages with the Error severity level. * `hasErrors` (_boolean_) Indicates whether there are messages related to the object (true) or not (false). * `limitedMessages` (_array of sfdc.commerce.cart.connect.api.output.CartMessageRepresentation_) In the Cart Item Result, a limited list of messages related to the cart item. In the Cart Summary, each message can be related to the cart or to another cart-related object, and each message supports multiple languages. * `relatedEntityId` (_string (Id)_) In the Cart Item Result, the ID of the related cart item. In the Cart Summary, each message can be related to the cart or to another cart-related object. * `totalLineItemsWithErrors` (_integer_) In the Cart Item Result, either null if the cart item has no errors or 1 if the cart item has errors. In the Cart Summary, the total number of product line items that contain errors. ### sfdc.commerce.cart.connect.api.enums.ConnectCartStatusEnum The status of a cart. Type: `string`. Allowed values: `Active—Cart is created and available for modifications, like adding or removing products or promotions.`, `Checkout—Cart is in checkout. If the customer modifies the cart, the current checkout session is canceled.`, `Closed—Checkout is complete and an order was created. The cart can't be modified.`, `PendingClosed—Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified.`, `PendingDelete—Cart is marked for delete, but the request isn't completed yet. The cart can’t be modified.`, `Processing—Cart is processing. For example, taxes are being calculated. The cart can’t be modified.`. ### sfdc.commerce.cart.connect.api.enums.ConnectCartTaxTypeEnum Tax type of the cart. Type: `string`. Allowed values: `Automatic—Automatic taxation policy.`, `Gross—Gross taxation policy.`, `Net—Net taxation policy.`. ### sfdc.commerce.cart.connect.api.enums.ConnectCartTypeEnum The type of cart. If unspecified, defaults to Cart. Type: `string`. Allowed values: `Cart—Cart created by a customer.`, `PayNowReadOnly—Clone of a Template cart that the customer can check out with using the Pay Now feature.`, `ReadOnly—Cart created is read-only.`, `Template—Cart created by an internal user.`. ### sfdc.commerce.cart.connect.api.output.AbstractCartItemRepresentation The abstract representation class for cart item * `billingFrequency` (_sfdc.commerce.cart.connect.api.enums.ConnectBillingFrequencyEnum_) * `cartDeliveryGroupId` (_string (Id)_) The ID of the cart delivery group. * `cartId` (_string (Id)_) The ID of the cart. * `cartItemId` (_string (Id)_) The ID of the item. If asynchronous cart processing is enabled, this value returns null for POST requests. * `childProductCount` (_integer_) The number of child products in the cart that are associated with the item. A cart item can have child products if the productClass of the item is Bundle. For nested bundles, which include a child product that's also a bundle, childProductCount includes all child products. * `customFields` (_array of object_) An array of sObjects and viewable custom fields for the sObjects. Standard fields are ignored. Currently, only the CartItem sObject is supported. Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. * `messagesSummary` (_sfdc.commerce.cart.connect.api.output.CartMessagesSummaryRepresentation_) * `name` (_string_) The name of the item. * `parentCartItemId` (_string (Id)_) The ID of the item’s parent cart item. The value is empty if the item is a top-level cart item. * `productDetails` (_sfdc.commerce.cart.connect.api.output.CartProductSummaryRepresentation_) * `productId` (_string (Id)_) The ID of the product for this cart item. * `productSellingModelId` (_string_) The ID of the product selling model associated with Product2. * `promotionDisplayMessage` (_string_) The display name for the bonus product only. * `quantity` (_string_) The quantity of the cart item. * `sellingModelType` (_commerce.catalog.connect.api.enumeration.ConnectSellingModelTypeEnum_) * `subscriptionTerm` (_integer_) The total number of terms in the subscription period. * `type` (_sfdc.commerce.cart.connect.api.enums.ConnectCartItemTypeEnum_) * `subType` (_sfdc.commerce.cart.connect.api.enums.ConnectCartItemSubTypeEnum_) * `cartData` (_sfdc.commerce.cart.connect.api.output.CartItemCollectionRepresentation_) * `IsShippingChargeNotApplicable` (_boolean_) Indicates whether to waive shipping charges (true) or not (false). When set to true, the cart item is classified as a digital good; otherwise, it is treated as a physical good. Default: `false`. Example: `false`. ### commerce.catalog.connect.api.enumeration.ConnectProductClassEnum Specifies the class of product. Type: `string`. Allowed values: `Simple`, `Variation`, `VariationParent`, `Bundle`, `Set`. ### sfdc.commerce.cart.connect.api.input.CartItemMoveInputRepresentation Details of cart items to be moved into delivery groups. * `sourceCartItemId` (_string_) The ID of the item in the source cart. * `targetDeliveryGroups` (_array of sfdc.commerce.cart.connect.api.input.TargetDeliveryGroupInputRepresentation_) The target delivery groups for moving the cart items. ### sfdc.commerce.cart.connect.api.output.CartItemMoveRepresentation Details for cart items moved into delivery groups. * `error` (_sfdc.commerce.common.connect.api.output.CheckoutErrorRepresentation_) * `sourceCartItemId` (_string_) The ID of the source cart item. * `targetCartItemId` (_array of string_) An arrary of IDs of cart item in the target delivery group. ### sfdc.commerce.cart.connect.api.output.CartPromotionListRepresentation Collection of promotions for a cart. * `promotions` (_array of sfdc.commerce.cart.connect.api.output.CartPromotionOutputRepresentation_) The promotion for a cart. ### sfdc.commerce.cart.connect.api.output.DeliveryMethodRepresentation Details of the delivery method for a Commerce store checkout. * `adjustedShippingFee` (_string_) The shipping fee, including totalAdjustmentAmount, for the delivery. * `carrier` (_string_) The carrier for the delivery. * `classOfService` (_string_) The class of service for the delivery. * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code associated with the delivery. * `earliestEstimatedDeliveryTime` (_string (date)_) The earliest estimated delivery date and time for the delivery in ISO 8601 format. Determined by the time at checkout, plus processTime, plus transitTimeMin. * `id` (_string (Id)_) The ID of the delivery method. * `latestEstimatedDeliveryTime` (_string (date)_) The latest estimated delivery date and time for the delivery in ISO 8601 format. Determined by the time at checkout, plus processTime, plus transitTimeMax. * `name` (_string_) The name of the delivery method. * `processTime` (_integer_) The merchant-specified process time for the delivery. Process time includes the time between when an order is placed and when the shipment is given to the shipping carrier. * `processTimeUnit` (_sfdc.commerce.shipping.connect.api.common.ConnectShippingTimeUnitEnum_) The unit of time used to define processTime. * `shippingFee` (_string_) The shipping fee for the delivery. * `totalAdjustmentAmount` (_string_) The adjustment amount of a promotion applicable to the delivery method. * `transitTimeMax` (_integer_) The maximum estimate of transit time for the delivery. Transit time includes the time between when a shipping carrier receives a shipment and when the shipment arrives at the delivery address. * `transitTimeMin` (_integer_) The minimum estimate of transit time for the delivery. Transit time includes the time between when a shipping carrier receives a shipment and when the shipment arrives at the delivery address. * `transitTimeUnit` (_sfdc.commerce.shipping.connect.api.common.ConnectShippingTimeUnitEnum_) The unit of time used to define transit​TimeMax and transit​TimeMin. ### sfdc.commerce.common.connect.api.output.CheckoutAddressV2Representation Checkout Address Representation * `city` (_string_) City * `companyName` (_string_) CompanyName * `country` (_string_) Country * `firstName` (_string_) FirstName * `lastName` (_string_) LastName * `name` (_string_) Name * `id` (_string_) Id * `postalCode` (_string_) Postal Code * `region` (_string_) Region * `shipToPhoneNumber` (_string_) Shipping Phone Number * `street` (_string_) Street ### sfdc.commerce.common.connect.api.output.CheckoutErrorRepresentation Checkout Error Representation * `type` (_string_) The type of error. * `title` (_string_) The brief summary of the error. * `detail` (_string_) The detailed information about the error. * `instance` (_string_) An URI reference that identifies the specific occurrence of the problem. * `invalidParameters` (_array of sfdc.commerce.common.connect.api.output.InvalidParameterRepresentation_) The list of invalid parameters. ### sfdc.commerce.common.connect.api.input.CheckoutAddressInputV2Representation Details of the checkout address input request. * `city` (_string_) The address city. * `companyName` (_string_) The company name of the contact. * `country` (_string_) The ISO code of the address country. Must match one of the valid ISO codes defined within the org’s State-Country picklist. * `firstName` (_string_) The first name of the contact. * `lastName` (_string_) The last name of the contact. * `name` (_string_) The name of the contact. * `id` (_string_) The ID of the contact. * `postalCode` (_string_) The zip code or postal code for the address. * `region` (_string_) The ISO code of the address region. Must match one of the valid ISO codes defined within the org’s State-Country picklist. * `shipToPhoneNumber` (_string_) The phone number of the contact. Don't include a value for this field when submitting an address to the payment API. All default payment components strip phone numbers from the address before submitting to the payment API. * `street` (_string_) The address street. ### sfdc.commerce.cart.connect.api.input.CartItemPromotionInputRepresentation Cart item promotion input. * `cartItemId` (_string_) Required. The ID of the item associated with the cart. ### sfdc.commerce.cart.connect.api.output.CartItemBasicResultRepresentation A representation of the result of a Cart API request. It includes basic cart item information, the status code for the request, and a message if the request isn't successful. * `cartItem` (_sfdc.commerce.cart.connect.api.output.CartItemBasicRepresentation_) * `message` (_string_) The error message when the request isn't successful. * `status` (_string_) The status for the request. ### sfdc.commerce.cart.connect.api.input.ItemArrangeInputRepresentation Instructions to arrange a cart item into a delivery group. * `cartItemId` (_string_) The ID of the cart item. * `deliveryAddress` (_sfdc.commerce.common.connect.api.input.CheckoutAddressInputV2Representation_) * `deliveryAddressId` (_string_) The ID of the contact pint address used to set the delivery address. * `deliveryGroupId` (_string_) The ID of the delivery group. * `deliveryGroupName` (_string_) The name of the delivery group. * `productId` (_string_) The ID of the product to create a new cart item for. * `quantity` (_string_) The quantity of the cart item. ### sfdc.commerce.cart.connect.api.output.CartCouponListRepresentation List of coupons associated with a cart. * `coupons` (_array of sfdc.commerce.cart.connect.api.output.CartCouponRepresentation_) List of coupons associated with a cart ### commerce.catalog.connect.api.output.PurchaseQuantityRuleRepresentation Rule that restricts the quantity of a product that can be purchased. * `maximum` (_string_) The maximum quantity that can be purchased. * `minimum` (_string_) The minimum quantity that can be purchased. * `increment` (_string_) The increment value of the quantity that can be purchased. ### commerce.catalog.connect.api.output.ProductMediaRepresentation Media associated with a product. * `alternateText` (_string_) An alternative text for the product media. * `contentVersionId` (_string_) The ID of the latest published content version if the media is stored as a ContentDocument. If the image is a customer-provided external URL, the value is null. Not supported in enhanced CMS workspaces. * `id` (_string_) The ID of the product image. * `mediaType` (_commerce.catalog.connect.api.enumeration.ConnectProductMediaTypeEnum_) The type of the product media. * `sortOrder` (_integer_) The sort order of a media item within a media group. * `thumbnailUrl` (_string_) The URL of the thumbnail for product media. If a value exists, it should be used for the thumbnail whether the image is natively uploaded or hosted externally. Not supported in enhanced CMS workspaces. * `title` (_string_) The title of the product media. * `url` (_string_) The URL of the product media. ### sfdc.commerce.cart.connect.api.output.CartProductAttributeRepresentation Product attribute for a cart item. * `label` (_string_) The label or display name of the attribute. * `sequence` (_integer_) The sequence of the attribute within the attribute set. * `value` (_string_) The display value of the attribute. ### sfdc.commerce.common.connect.api.output.CommerceProductDynamicAttributeRepresentation Represents the dynamic product attributes. * `name` (_string_) The name of attribute. * `displayValue` (_string_) The display value of attribute. * `value` (_string_) The value of attribute. * `type` (_string_) The type of the attribute value. * `unitOfMeasure` (_sfdc.commerce.common.connect.api.output.UnitOfMeasureRepresentation_) ### sfdc.commerce.cart.connect.api.output.CartMessageRepresentation Cart message. * `message` (_string_) Cart message. * `messageId` (_string (Id)_) ID of the object supplying the message. * `relatedEntityId` (_string (Id)_) ID of the object, for example, cart, cart item, or cart tax, associated with the message. * `severity` (_sfdc.commerce.cart.connect.api.enums.ConnectCartMessageSeverityEnum_) * `type` (_string_) Type of message. Standard values include Inventory, Taxes, Pricing, Shipping, Entitlement, SystemError, and Other. * `visible` (_boolean_) Indicates whether the message is visible (true) or dismissed (false). ### sfdc.commerce.cart.connect.api.enums.ConnectBillingFrequencyEnum Specifies the billing frequency. Type: `string`. Allowed values: `Annual`, `Monthly`. ### commerce.catalog.connect.api.enumeration.ConnectSellingModelTypeEnum Indicates the Selling Model Type enum values. Type: `string`. Allowed values: `OneTime`, `TermDefined`, `Evergreen`. ### sfdc.commerce.cart.connect.api.enums.ConnectCartItemTypeEnum Type of item in a cart. Value is Product. This field is required when when adding an item to a cart (POST). This fiels isn't supported when updating an item in a cart (PATCH). Type: `string`. Allowed values: `DeliveryCharge`, `Product`. ### sfdc.commerce.cart.connect.api.enums.ConnectCartItemSubTypeEnum The sub type of cart item. Type: `string`. Allowed values: `Bonus`, `Gift`. ### sfdc.commerce.cart.connect.api.input.TargetDeliveryGroupInputRepresentation Target delivery groups for moving the cart items. * `deliveryGroupId` (_string_) The ID of the target delivery group. * `quantity` (_number (double)_) The quantity of the cart item. ### sfdc.commerce.cart.connect.api.output.CartPromotionOutputRepresentation Promotion for a cart. * `adjustmentAmount` (_string_) The adjustment amount of the promotion. * `couponCode` (_string_) The coupon code for a promotion. A coupon code is available only for manual promotions, not for automatic promotions. * `currencyIsoCode` (_string_) The three-letter ISO 4217 currency code of the cart. * `displayName` (_string_) The localized display name of the promotion. * `promotionId` (_string (Id)_) The ID of the promotion. * `targetType` (_sfdc.commerce.cart.connect.api.enums.ConnectCartTargetTypeEnum_) * `termsAndConditions` (_string_) The localized terms and conditions for the promotion. ### sfdc.commerce.shipping.connect.api.common.ConnectShippingTimeUnitEnum The unit of time used to define processTime or transit​TimeUnit. Type: `string`. Allowed values: `Days`, `Hours`, `Weeks`. ### sfdc.commerce.common.connect.api.output.InvalidParameterRepresentation List of invalid parameters. * `name` (_string_) The name of the invalid parameter. * `detail` (_string_) The detailed message about the invalid parameter. * `value` (_string_) The value of the invalid parameter. ### sfdc.commerce.cart.connect.api.output.CartItemBasicRepresentation A basic cart item. * `cartItemId` (_string (Id)_) The ID of the cart item. * `name` (_string_) The name of the cart item. description. * `productId` (_string (Id)_) The ID of the product for this cart item. * `quantity` (_string_) The quantity of the cart item. * `type` (_sfdc.commerce.cart.connect.api.enums.ConnectCartItemTypeEnum_) ### sfdc.commerce.cart.connect.api.output.CartCouponRepresentation Details of the cart coupon. * `cartCouponId` (_string (Id)_) The ID for the cart coupon code * `couponCode` (_string_) TThe coupon code a buyer can use to manually apply a promotion to the cart. * `customFields` (_array of object_) An array of sObjects and their associated custom fields. Standard fields are ignored. The custom fields must already be defined for the sObject. Currently, only the WebCart and WebCartAdjustmentBasis sObjects is supported. Field-level security rules configured by the web store admin in the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. Additional properties: `any`. ### commerce.catalog.connect.api.enumeration.ConnectProductMediaTypeEnum The type of product media. Type: `string`. Allowed values: `Document`, `Image`, `Video`. ### sfdc.commerce.common.connect.api.output.UnitOfMeasureRepresentation Represents the unit of measure for the attribute. * `unitCode` (_string_) The code for the unit of measure. * `scale` (_string_) The scale for the unit of measure. * `roundingMethod` (_string_) The rounding method for the unit of measure. ### sfdc.commerce.cart.connect.api.enums.ConnectCartMessageSeverityEnum The severity of cart message. Type: `string`. Allowed values: `Error`, `Info`, `Warning`. ### sfdc.commerce.cart.connect.api.enums.ConnectCartTargetTypeEnum The promotion target type. Type: `string`. Allowed values: `Cart—Promotion targets a cart.`, `Item—Promotion targets an item in a cart.`. ### sfdc.commerce.cart.connect.api.output.CartItemWithoutPriceRepresentation A cart item without pricing information. Includes all fields of `sfdc.commerce.cart.connect.api.output.AbstractCartItemRepresentation`. ### sfdc.commerce.cart.connect.api.input.CartItemInputList Wraps a list of CartItemIds to get the associated promotions. * `items` (_array of sfdc.commerce.cart.connect.api.input.CartItemPromotionInputRepresentation_) The list of CartItemIds to get the associated promotions. ### sfdc.commerce.cart.connect.api.input.CustomFieldsListInputRepresentation ConnectSObject list input representation wrapper for custom fields. ### commerce.catalog.connect.api.output.ProductSellingModelRepresentation Product selling model with subscription term rules. * `id` (_string_) ID of the Product Selling Model. * `name` (_string_) Name of the Product Selling Model. * `sellingModelType` (_commerce.catalog.connect.api.enumeration.ConnectSellingModelTypeEnum_) * `pricingTerm` (_integer_) Pricing Term of the Product Selling Model. * `pricingTermUnit` (_commerce.catalog.connect.api.enumeration.ConnectPricingTermUnitEnum_) Pricing Term Unit of the Product Selling Model. * `subscriptionTermRule` (_commerce.catalog.connect.api.output.SubscriptionTermRuleRepresentation_) Represents a rule that restricts the subscription term of a subscription product that may be subscribed to. * `displayName` (_string_) Name of the Product Selling Model Option. * `description` (_string_) Description of the Product Selling Model Option. ### commerce.catalog.connect.api.enumeration.ConnectPricingTermUnitEnum Indicates the Pricing Term Unit enum values. Type: `string`. Allowed values: `Months`, `Annual`. ### commerce.catalog.connect.api.output.SubscriptionTermRuleRepresentation Represents a rule that restricts the subscription term of a subscription product that may be subscribed to. * `maximum` (_integer_) Maximum subscription term that can be subscribed to. * `minimum` (_integer_) Minimum subscription term that can be subscribed to. * `increment` (_integer_) Indicates the number of pricing term units that can be used to increase the Subscription Term.