--- schema_version: "1" id: 41b071c4766b3aa469719927770374e9e79b5edd7de28462c75b60ee389cdb7b title: Commerce Connect REST API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/connect-rest/connect-rest-api/references/generated-api-specs/connect-rest-api-commerce.md canonical_url: https://developer.salesforce.com/docs/platform/connect-rest-api/references/connect-rest-api-commerce source_site: developer.salesforce.com content_type: documentation content_hash: 498ffd2d3078f5c398866d290224fbe27ff22ac157c0c9088c34241e94cdb790 products: - Connect REST API Developer Guide - Connect REST APIs --- Commerce Connect REST API # Commerce Connect REST API > **Note**: The API Reference has a new three-panel layout. Browse grouped endpoints on the left, review endpoint details in the center, and access examples on the right. **Important**: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. **Version:** v67.0 ## Servers * `https://{MyDomainName}.my.salesforce.com/services/data/v67.0` API server for your Salesforce org. * ``MyDomainName (default None) Your org's My Domain name, which is used as a subdomain for the URLs that Salesforce uses to serve your org. For example, if your Lightning URL is `https://yourcompanyname.lightning.force.com`, then your My Domain name is `yourcompanyname`. Find your My Domain name and login URL on the My Domain page in Setup, or use the `getMyDomainName()` method in the Apex Domain class.`` ## Tags ### Commerce B2B Resources Get, create, update, and delete your commerce data. Work with address management, carts, checkouts, orders, products, promotions, taxes, wishlists, and search settings. ### Commerce Einstein Webstore Resources Get the status of a Commerce Einstein deployment. Get the Commerce Einstein configuration. Export and purge Commerce Einstein activity. Get Commerce Einstein product recommendations. ### Salesforce Omnichannel Inventory Resources Manage inventory across locations. Available in Salesforce Omnichannel Inventory. ### Salesforce Order Management Resources Manage orders and the order fulfillment process. Available in Salesforce Order Management orgs. ### Salesforce Payments Resources Information about Salesforce Payments, including content, rendered version, and sharing. **Note**: For the most updated Payments API documentation, see the [Salesforce Payments APIs](https://developer.salesforce.com/docs/commerce/salesforce-commerce/references/comm-payments-ref?meta=Summary) and the [Salesforce Commerce Payments APIs](https://developer.salesforce.com/docs/commerce/salesforce-commerce/references/comm-ccs-payments-ref?meta=Summary) in the B2B Commerce and D2C Commerce Developer Guide. To access Salesforce Payments resources whose endpoints begin `/commerce/payments`, your org must have one or more of these licenses: * Salesforce Payments * Salesforce Order Management * B2B Commerce, or D2C Commerce ## Operations ### PUT Commerce Webstore Checkouts `PUT /commerce/webstores/{webstoreId}/checkouts` Operation ID: `putCheckoutStartV2`. Tags: Commerce B2B Resources. Start Checkout Session V2 Start a Commerce store checkout. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v55.0_ **Note:** PUT is supported in version 57.0 and later. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v55.0_ #### Request body Input to start a Commerce store checkout for a cart. _Available in: v55.0_ Media type: `application/json`. Schema: `CheckoutStartInput`. _Example: example\_1_ Payload 1 ``` { "cartId": "0a6456789012345AAA", "customFields": [ { "attributes": { "type": "WebCart" }, "CartCustomNumberField__c": 1, "CartCustomTextField__c": "Text1" }, { "attributes": { "type": "CartDeliveryGroup" }, "CdgDistrict__c": "District1" }, { "attributes": { "type": "CartDeliveryGroup" }, "id": "0a7xx000000006TAAQ", "CdgWardField__c": 8 } ] } ``` #### Responses * **200** _Checkout_ Checkout for a Commerce store. Media type: `application/json`. Schema: `CheckoutSessionV2`. _Example: example\_1_ Payload 1 Here’s an example for POST. ``` { "checkoutId": "2z9R000000008LfIAI" } ``` _Example: example\_2_ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. ``` { "checkoutId": "2z9R000000008LfIAI", "deliveryGroups": { "count": 1, "items": [ { "deliveryAddress": { "name": "Alan Johnson", "firstName": "Alan", "lastName": "Johnson", "region": "CA", "country": "US", "city": "San Francisco", "street": "415 Mission St", "companyName": "Salesforce", "postalCode": "94105" }, "availableDeliveryMethods": [ { "id": "2Dmxx0000004CFVCA2", "name": "Delivery Method 1", "shippingFee": "3.14", "currencyIsoCode": "USD", "carrier": "UPS", "classOfService": "Same day UPS Ground" }, { "id": "2Dmxx0000005DEWDB3", "name": "Delivery Method 2", "shippingFee": "2.03", "currencyIsoCode": "USD", "carrier": "UPS", "classOfService": "Next day UPS Ground" } ], "id": "0a7xx0000000000CA2", "isDefault": true, "name": "Default Delivery", "desiredDeliveryDate": "2021-05-28T16:41:41.090Z", "shippingInstructions": "type code 1234 on gate keypad", "customFields": [ { "attributes": { "type": "CartDeliveryGroup" }, "MyCustomTextField__c": "Text", "MyCustomNumberField__c": 12345, "MyCustomPhoneField__c": "4145551212", "MyCustomAddressField__c": { "street": "415 Mission St", "postalCode": "94105", "city": "San Francisco", "state": "California", "stateCode": "US_CA", "country": "United States", "countryCode": "US", "geocodeAccuracy": "City", "latitude": 34, "longitude": 85.9 } } ] } ] }, "customFields": [ { "attributes": { "type": "WebCart" }, "MyCustomTextField__c": "Text", "MyCustomNumberField__c": 12.34, "MyCustomPercentField__c": 0.2345, "MyCustomGeolocationField__c": { "latitude": 33.345, "longitude": 45.567 } } ] } ``` ### POST Commerce Webstore Checkouts `POST /commerce/webstores/{webstoreId}/checkouts` Operation ID: `postCheckoutStartV2`. Tags: Commerce B2B Resources. Start Checkout Session V2 Start a Commerce store checkout. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v55.0_ #### Request body Input to start a Commerce store checkout for a cart. _Available in: v55.0_ Media type: `application/json`. Schema: `CheckoutStartInput`. _Example example\_1: same as PUT /commerce/webstores/{webstoreId}/checkouts request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Checkout_ Checkout for a Commerce store. Media type: `application/json`. Schema: `CheckoutSessionV2`. _Example example\_2: same as PUT /commerce/webstores/{webstoreId}/checkouts 200 response._ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. _Example: example\_1_ Payload 1 Here’s an example for POST. ``` { "checkoutId": "2z9R000000008LfIAI" } ``` _Example: example\_2_ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. ### GET Commerce Webstore Checkout `GET /commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}` Operation ID: `getCheckoutV2`. Tags: Commerce B2B Resources. Checkout Operations V2 Get a Commerce store checkout. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v55.0_ If you want to use this resource with a WebStore of type B2CE, open a case with Salesforce Support and provide this information: Salesforce organization ID Tenant ID (You can find this ID on the Manage Cloud-to-Cloud Connections page in Setup) B2C Commerce Business Manager login URL B2C Commerce site IDs **Note**: During the checkout process, you must make a GET request to `/commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}` or `/commerce/webstores/{webstoreId}/checkouts/{checkoutId}` at least once after making a PATCH request to `/commerce/webstores/{webstoreId}/checkouts`. We recommend continuously polling the GET request until the API returns a `200 OK` status, indicating that the response is ready for consumption. **Note:** To resolve a [409](/docs/platform/connect-rest-api/guide/connect_error_responses) error returned on a PATCH or DELETE request, retry your request until it returns a 2xx status with updated data. To avoid returning a 409 error on PATCH or DELETE requests, make sure that you don’t have any custom code that modifies the cart or a checkout session while calling PATCH or DELETE. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. _Available in: v55.0_ Pattern: ^(0ZE)\\w\*. * `activeOrCheckoutId` (path, string, required) Values for `{activeOrCheckoutId}` are: * `{checkoutId}` —ID of the checkout. * `active` —Active checkout. _Available in: v55.0_ * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v51.0_ #### Responses * **200** _Checkout_ Checkout for a Commerce store. Media type: `application/json`. Schema: `CheckoutSessionV2`. _Example example\_2: same as PUT /commerce/webstores/{webstoreId}/checkouts 200 response._ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. _Example: example\_1_ Payload 1 Here’s an example for POST. ``` { "checkoutId": "2z9R000000008LfIAI" } ``` _Example: example\_2_ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZESG000001n96S4AQ/checkouts/2z9R000000008LfIAI ``` ### DELETE Commerce Webstore Checkout `DELETE /commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}` Operation ID: `deleteCheckoutV2`. Tags: Commerce B2B Resources. Checkout Operations V2 Delete a Commerce store checkout. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v55.0_ If you want to use this resource with a WebStore of type B2CE, open a case with Salesforce Support and provide this information: Salesforce organization ID Tenant ID (You can find this ID on the Manage Cloud-to-Cloud Connections page in Setup) B2C Commerce Business Manager login URL B2C Commerce site IDs **Note**: During the checkout process, you must make a GET request to `/commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}` or `/commerce/webstores/{webstoreId}/checkouts/{checkoutId}` at least once after making a PATCH request to `/commerce/webstores/{webstoreId}/checkouts`. We recommend continuously polling the GET request until the API returns a `200 OK` status, indicating that the response is ready for consumption. **Note:** To resolve a [409](/docs/platform/connect-rest-api/guide/connect_error_responses) error returned on a PATCH or DELETE request, retry your request until it returns a 2xx status with updated data. To avoid returning a 409 error on PATCH or DELETE requests, make sure that you don’t have any custom code that modifies the cart or a checkout session while calling PATCH or DELETE. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. _Available in: v55.0_ Pattern: ^(0ZE)\\w\*. * `activeOrCheckoutId` (path, string, required) Values for `{activeOrCheckoutId}` are: * `{checkoutId}` —ID of the checkout. * `active` —Active checkout. _Available in: v55.0_ * `effectiveAccountId` (query, string (Id)) Pattern: ^(001)\\w\*. #### Responses * **204** _Successful Delete_ Success ### PATCH Commerce Webstore Checkout `PATCH /commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}` Operation ID: `patchCheckoutV2`. Tags: Commerce B2B Resources. Checkout Operations V2 Update a Commerce store checkout. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v55.0_ If you want to use this resource with a WebStore of type B2CE, open a case with Salesforce Support and provide this information: Salesforce organization ID Tenant ID (You can find this ID on the Manage Cloud-to-Cloud Connections page in Setup) B2C Commerce Business Manager login URL B2C Commerce site IDs **Note**: During the checkout process, you must make a GET request to `/commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}` or `/commerce/webstores/{webstoreId}/checkouts/{checkoutId}` at least once after making a PATCH request to `/commerce/webstores/{webstoreId}/checkouts`. We recommend continuously polling the GET request until the API returns a `200 OK` status, indicating that the response is ready for consumption. **Note:** To resolve a [409](/docs/platform/connect-rest-api/guide/connect_error_responses) error returned on a PATCH or DELETE request, retry your request until it returns a 2xx status with updated data. To avoid returning a 409 error on PATCH or DELETE requests, make sure that you don’t have any custom code that modifies the cart or a checkout session while calling PATCH or DELETE. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. _Available in: v55.0_ Pattern: ^(0ZE)\\w\*. * `activeOrCheckoutId` (path, string, required) Values for `{activeOrCheckoutId}` are: * `{checkoutId}` —ID of the checkout. * `active` —Active checkout. _Available in: v55.0_ * `effectiveAccountId` (query, string (Id)) Pattern: ^(001)\\w\*. #### Request body Input for a Commerce store checkout. Media type: `application/json`. Schema: `CheckoutSessionV2Input`. _Example: example\_1_ Payload 1 Here’s an example of a request including contact information and Cart custom fields: The PATCH request fails if it includes contact information with Cart Delivery Group custom fields or with both Cart and Cart Delivery Group custom fields. ``` { "contactInfo": { "firstName": "Alan", "lastName": "Johnson", "email": "al**@jo*****.com", "phoneNumber": "******3944" }, "customFields": [ { "attributes": { "type": "WebCart" }, "Id": "0a6xx0000000000", "MyCustomTextField__c": "Foo", "MyCustomNumberField__c": 12.34, "MyCustomPercentField__c": 0.2345, "MyCustomGeolocationField__c": { "latitude": 33.345, "longitude": 45.567 } } ] } ``` _Example: example\_2_ Payload 2 Here’s an example of a request including shipping information (`deliveryAddress`, `desiredDeliveryDate`, and `shippingInstructions`) without custom fields: Any combination of these three sub-resources is valid if custom fields aren’t included in the request. ``` { "deliveryAddress": { "name": "Alan Johnson", "firstName": "Alan", "lastName": "Johnson", "region": "CA", "country": "US", "city": "San Francisco", "street": "415 Mission St", "postalCode": "94105" }, "desiredDeliveryDate": "2021-05-28T16:41:41.090Z", "shippingInstructions": "type code 1234 on gate keypad" } ``` _Example: example\_3_ Payload 3 Here’s an example of a request for a guest user, including contact information and delivery address: ``` { "contactInfo": { "firstName": "Alan", "lastName": "Johnson", "email": "al**@jo*****.com", "phoneNumber": "******3944" }, "deliveryAddress": { "name": "Alan Johnson", "firstName": "Alan", "lastName": "Johnson", "region": "CA", "country": "US", "city": "San Francisco", "street": "415 Mission St", "postalCode": "94105" } } ``` #### Responses * **200** _Checkout_ Checkout for a Commerce store. Media type: `application/json`. Schema: `CheckoutSessionV2`. _Example example\_2: same as PUT /commerce/webstores/{webstoreId}/checkouts 200 response._ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. _Example: example\_1_ Payload 1 Here’s an example for POST. ``` { "checkoutId": "2z9R000000008LfIAI" } ``` _Example: example\_2_ Payload 2 Here’s an example for PUT when delivery methods and delivery groups are present. #### Code samples _Example: Example 1 · HTTP_ ``` # Here’s an example of a request including delivery method and custom fields. A # PATCH request that includes `deliveryMethodId` clears all payment information # for the checkout, including `WebCart.BillingAddress`. { "deliveryMethodId": "7cdLT000000EzA5YAK", "customFields": [ { "attributes": { "type": "WebCart" }, "Id": "0a6xx0000000000", "MyCustomTextField__c": "Foo", "MyCustomNumberField__c": 12.34, "MyCustomPercentField__c": 0.2345, "MyCustomGeolocationField__c": { "latitude": 33.345, "longitude": 45.567 } }, { "attributes": { "type": "CartDeliveryGroup" }, "Id": "0a7SB000000oBujYAE", "MyCustomTextField__c": "Bar", "MyCustomNumberField__c": 4.55, "MyCustomPhoneField__c": "******1212", "MyCustomAddressField__c": { "street": "100 Folsom Street", "city": "San Francisco", "state": "California", //This field isn't currently supported in custom fields. "stateCode": "US_CA", "postalCode": "93555", "country": "United States", //This field isn't currently supported in custom fields. "countryCode": "US", "geocodeAccuracy": "City", "latitude": 34, "longitude": 85.9 } } ] } ``` _Example: Example 2 · HTTP_ ``` # Here’s an example of a request including shipping information # (deliveryAddress, desiredDeliveryDate, and shippingInstructions) and custom # fields. The PATCH request fails if it includes only shipping instructions # along with custom fields for either Cart or Cart Delivery Group. { "deliveryAddress": { "name": "Alan Johnson", "firstName": "Alan", "lastName": "Johnson", "region": "CA", "country": "US", "city": "San Francisco", "street": "415 Mission St", "postalCode": "94105" }, "desiredDeliveryDate": "2021-05-28T16:41:41.090Z", "shippingInstructions": "type code 1234 on gate keypad", "customFields": [ { "attributes": { "type": "WebCart" }, "Id": "0a6xx0000000000", "MyCustomTextField__c": "Foo", "MyCustomNumberField__c": 12.34, "MyCustomPercentField__c": 0.2345, "MyCustomGeolocationField__c": { "latitude": 33.345, "longitude": 45.567 } }, { "attributes": { "type": "CartDeliveryGroup" }, "Id": "0a7SB000000oBujYAE", "MyCustomTextField__c": "Bar", "MyCustomNumberField__c": 4.55, "MyCustomPhoneField__c": "******1212", "MyCustomAddressField__c": { "street": "100 Folsom Street", "city": "San Francisco", "state": "California", //This field isn't currently supported in custom fields. "stateCode": "US_CA", "postalCode": "93555", "country": "United States", //This field isn't currently supported in custom fields. "countryCode": "US", "geocodeAccuracy": "City", "latitude": 34, "longitude": 85.9 } } ] } ``` _Example: Example 3 · HTTP_ ``` { "deliveryAddress": { "name": "Alan Johnson", "firstName": "Alan", "lastName": "Johnson", "region": "CA", "country": "US", "city": "San Francisco", "street": "415 Mission St", "postalCode": "94105" }, "desiredDeliveryDate": "2021-05-28T16:41:41.090Z", "shippingInstructions": "type code 1234 on gate keypad", "customFields": [ { "attributes": { "type": "WebCart" }, "Id": "0a6xx0000000000", "MyCustomTextField__c": "Foo", "MyCustomNumberField__c": 12.34, "MyCustomPercentField__c": 0.2345, "MyCustomGeolocationField__c": { "latitude": 33.345, "longitude": 45.567 } }, { "attributes": { "type": "CartDeliveryGroup" }, "Id": "0a7SB000000oBujYAE", "MyCustomTextField__c": "Bar", "MyCustomNumberField__c": 4.55, "MyCustomPhoneField__c": "4145551212", "MyCustomAddressField__c": { "street": "100 Folsom Street", "city": "San Francisco", "state": "California", //This field isn't currently supported in customFields. "stateCode": "US_CA", "postalCode": "93555", "country": "United States", //This field isn't currently supported in customFields. "countryCode": "US", "geocodeAccuracy": "City", "latitude": 34, "longitude": 85.9 } } ] } ``` ### POST Commerce Webstore Checkout Orders `POST /commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}/orders` Operation ID: `postCheckoutOrderV2`. Tags: Commerce B2B Resources. Checkout Place Order Operations v2 Place an order for a Commerce store checkout. _Available in: v55.0_ #### Error responses An invalid POST request to [Commerce Webstore Checkout Orders](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/postCheckoutOrderV2) can return several HTTP response codes depending upon the type of error. * [409](/docs/platform/connect-rest-api/guide/connect_error_responses) indicates that you have custom code that's modifying the cart after a payment-autorization request. To resolve the error, make sure that you don’t have custom code that modifies the cart or a checkout session while calling POST. * In version 63.0 and later, [412](/docs/platform/connect-rest-api/guide/connect_error_responses) indicates that there’s an issue with a precondition, such as incomplete contact information or an inventory reservation error. To resolve the error, make sure that all required contact information is provided and that inventory reservations are correctly processed before calling POST. * In version 63.0 and later, [422](/docs/platform/connect-rest-api/guide/connect_error_responses) indicates a validation error such as an unauthorized payment method or missing delivery method. For 422 errors, a localized error message is included in the Checkout Order response body. To resolve the error, address the provided error message. For example, verify that the payment method is authorized or ensure that an order delivery method is provided during the checkout process. **Note**: POST doesn’t take request parameters or a request body. #### Parameters * `activeOrCheckoutId` (path, string, required) Values for `{activeOrCheckoutId}` are: * `{checkoutId}` —ID of the checkout. * `active` —Active checkout. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Checkout Order_ Order for a Commerce store checkout. Media type: `application/json`. Schema: `CheckoutOrderV2`. _Example: example\_1_ Payload 1 ``` { "orderReferenceNumber": "ER37G-VYS2M-6GPHH-HG4DE" } ``` _Example: example\_2_ Payload 2 (with errors) ``` { "errors": [ { "type": "/commerce/errors/shipping-failure", "title": "We are unable to place the order. Please correct the error and try again.", "detail": "There are no configured Order Delivery Methods." } ], "order​Reference​Number": "ER37G-VYS2M-6GPHH-HG4DE" } ``` ### POST Commerce Webstore Checkout, Place Order Action `POST /commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}/orders/actions` Operation ID: `postCheckoutOrderAction`. Tags: Commerce B2B Resources. Checkout Place Order Action Operations Place an order for a Commerce store checkout. _Available in: v64.0_ #### Parameters * `activeOrCheckoutId` (path, string, required) Values for `{activeOrCheckoutId}` are: * `{checkoutId}` —ID of the checkout. * `active` —Active checkout. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If not specified, it defaults to the account ID for the context user. _Available in: v64.0_ #### Request body Input representation of the Commerce store checkout.request. _Available in: v64.0_ Media type: `application/json`. Schema: `CheckoutOrderActionListInput`. _Example: example\_1_ Payload 1 Example request for the prepare action in a place order request: ``` { "actions": [ { "action": "prepare" } ] } ``` _Example: example\_2_ Payload 2 Example request for the submit action in a place order request: ``` { "actions": [ { "action": "submit" } ] } ``` #### Responses * **200** _Checkout Order Action Collection_ Output representation of the Commerce store checkout request. Media type: `application/json`. Schema: `CheckoutOrderActionCollection`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/checkouts/2z9R000000008LfIAI/orders/actions Content-Type: application/json { "actions": [ { "action": "prepare" } ] } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/checkouts/2z9R000000008LfIAI/orders/actions Content-Type: application/json { "actions": [ { "action": "submit" } ] } ``` _Example: Example 3 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/checkouts/active/orders/actions Content-Type: application/json { "actions": [ { "action": "prepare" } ] } ``` _Example: Example 4 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/checkouts/active/orders/actions Content-Type: application/json { "actions": [ { "action": "submit" } ] } ``` _Example: Example 5 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/checkouts/active/orders/actions?effectiveAccountId=001xx000003GYv5AAG Content-Type: application/json { "actions": [ { "action": "prepare" } ] } ``` _Example: Example 6 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/checkouts/active/orders/actions?effectiveAccountId=001xx000003GYv5AAG Content-Type: application/json { "actions": [ { "action": "submit" } ] } ``` ### POST Commerce Webstore Checkout Payments `POST /commerce/webstores/{webstoreId}/checkouts/{activeOrCheckoutId}/payments` Operation ID: `postCheckoutPayment`. Tags: Commerce B2B Resources. Checkout Payment Operations Payment for a Commerce store checkout. To access this resource, you need a B2B or D2C Commerce license and the system permissions included in either the Buyer (B2B stores only) or Shopper (D2C stores only) [preconfigured permission set](https://help.salesforce.com/s/articleView?id=commerce.comm_preconfigured_perm_sets.htm&type=5). In API version 63.0 and later, the Commerce Webstore Checkout Payments API is reenterable. If a payment already exists for a cart, a POST request handles the existing payment as follows. * If the payment is a PaymentAuthorization, the authorization is reversed. * If the payment is captured, a refund is issued. * If the payment is a simple purchase order, the purchase order number is replaced. Reentrance for simple purchase orders is supported in API version 64.0 and later. You can update the billing address with a reentrant request. However, you can't change the payment type. For example, if a payment authorization or capture was performed, you can't make a new request with a requestType of `SimplePurchaseOrder`. _Available in: v55.0_ #### Parameters * `activeOrCheckoutId` (path, string, required) Values for `{activeOrCheckoutId}` are: * `{checkoutId}` —ID of the checkout. * `active` —Active checkout. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Payment input for a Commerce store checkout. Media type: `application/json`. Schema: `CheckoutPaymentInput`. _Example: example\_1_ Payload 1 Authorized payment ``` { "requestType": "Auth", "paymentToken": "cardPaymentMethodId", "billingAddress": { "name": "John Doe", "street": "123 Acme Drive", "city": "Los Angeles", "region": "CA", "country": "US", "postalCode": "90001" } } ``` _Example: example\_2_ Payload 2 Simple purchase order ``` { "requestType": "SimplePurchaseOrder", "paymentToken": 348957393223, "billingAddress": { "name": "John Doe", "street": "123 Acme Drive", "city": "Los Angeles", "region": "CA", "country": "US", "postalCode": "90001" } } ``` #### Responses * **200** _Checkout Payment_ Payment response for a Commerce store checkout. Media type: `application/json`. Schema: `CheckoutPaymentOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "requestType":"PostAuth", "paymentToken": 'pi_0swefj329r4ljsdfk', "billingAddress":{ "name":"John Doe", "street":"123 Acme Drive", "city":"Los Angeles", "region":"CA", "country":"US", "postalCode":"90001" } } ``` ### POST Commerce Webstore Payments Token `POST /commerce/webstores/{webstoreId}/payments/token` Operation ID: `postPaymentToken`. Tags: Commerce B2B Resources. Payment token resource wrapper specific to payment api Tokenize a payment for a Commerce store checkout. To access this resource, you need a B2B Commerce license and the system permissions included in the Buyer (B2B stores only) [preconfigured permission set](https://help.salesforce.com/s/articleView?id=commerce.comm_preconfigured_perm_sets.htm&type=5). _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string (Id)) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. Pattern: ^(001)\\w\*. #### Request body Input to tokenize a credit card payment method for a Commerce store checkout. Media type: `application/json`. Schema: `PaymentTokenInput`. #### Responses * **200** _Payment Token_ Represents a payment token for a Commerce store checkout. Media type: `application/json`. Schema: `PaymentToken`. #### Code samples _Example: Example 1 · HTTP_ ``` { "billingAddress":{ "name":"John Doe", "street":"123 Acme Drive", "city":"Los Angeles", "region":"CA", "country":"US", "postalCode":"90001" } "cardPaymentMethod":{ "cardHolderName":"John Doe", "cardNumber":"4242424242424242", "expiryMonth":"12", "expiryYear":"24", "cvv":"141", "cardType":"Visa" } "hasSubscriptionProduct": true, } ``` ### GET Commerce Webstore Wishlists `GET /commerce/webstores/{webstoreId}/wishlists` Operation ID: `getWishlist`. Tags: Commerce B2B Resources. Used to create a Wishlist and takes optional products to add to this Wishlist. Get wishlists. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ * `includeDisplayedList` (query, boolean) Specifies whether to include the displayed list (`true`) or not (`false`). If unspecified, defaults to `false` . _Available in: v49.0_ * `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. _Available in: v51.0_ * `productFields` (query, string) Comma-separated list of custom product fields. Fields aren’t case-sensitive. For example, `ProductCode` and `productcode` return the same results. If `includeDisplayedList` is unspecified or `false`, `productFields` is ignored. _Available in: v51.0_ * `sortItemsBy` (query, ConnectWishlistItemSortOrderEnum) Sort order for wishlist items. Values are: * `CreatedDateAsc` —Sorts by oldest creation date. * `CreatedDateDesc` —Sorts by most recent creation date. The default sort order is `CreatedDateDesc`. If `includeDisplayedList` is unspecified or `false`, `sortItemsBy` is ignored. _Available in: v51.0_ * `wishlistId` (query, string) ID of the wishlist. If unspecified, all the wishlist summaries are returned. _Available in: v49.0_ #### Responses * **200** _Wishlist Summaries_ List of wishlist summaries and the displayed list for the context user. Media type: `application/json`. Schema: `WishlistSummaries`. ### POST Commerce Webstore Wishlists `POST /commerce/webstores/{webstoreId}/wishlists` Operation ID: `postWishlist`. Tags: Commerce B2B Resources. Used to create a Wishlist and takes optional products to add to this Wishlist. Create a wishlist. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ #### Request body Wishlist to create. _Available in: v49.0_ Media type: `application/json`. Schema: `WishlistInput`. _Example: example\_1_ Payload 1 ``` { "name": "My List", "products": [ { "productId": "01tRM000000Osl0YAC" }, { "productId": "01tRM000000Oi92YAC" }, { "productId": "01tRM000000NJCeYAO" } ] } ``` #### Responses * **200** _Wishlist_ Wishlist, including summary and items. Media type: `application/json`. Schema: `Wishlist`. ### GET Commerce Webstore Wishlist `GET /commerce/webstores/{webstoreId}/wishlists/{wishlistId}` Operation ID: `getWishlistSummary`. Tags: Commerce B2B Resources. Used to edit, delete or get a specific Wishlist. Get a wishlist. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ * `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. _Available in: v51.0_ * `productFields` (query, string) Comma-separated list of custom product fields. Fields aren’t case-sensitive. For example, `ProductCode` and `productcode` return the same results. _Available in: v51.0_ * `sortItemsBy` (query, ConnectWishlistItemSortOrderEnum) Sort order for wishlist items. Values are: * `CreatedDateAsc` —Sorts by oldest creation date. * `CreatedDateDesc` —Sorts by most recent creation date. The default sort order is `CreatedDateDesc`. _Available in: v51.0_ #### Responses * **200** _Wishlist_ Wishlist, including summary and items. Media type: `application/json`. Schema: `Wishlist`. ### DELETE Commerce Webstore Wishlist `DELETE /commerce/webstores/{webstoreId}/wishlists/{wishlistId}` Operation ID: `deleteWishlistSummary`. Tags: Commerce B2B Resources. Used to edit, delete or get a specific Wishlist. Delete a wishlist. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v51.0_ #### Responses * **204** _Successful Delete_ Success ### PATCH Commerce Webstore Wishlist `PATCH /commerce/webstores/{webstoreId}/wishlists/{wishlistId}` Operation ID: `patchWishlistSummary`. Tags: Commerce B2B Resources. Used to edit, delete or get a specific Wishlist. Update the name of a wishlist. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ **Note:** PATCH is supported in version 50.0 and later. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v50.0_ #### Request body Wishlist name to update. _Available in: v50.0_ Media type: `application/json`. Schema: `WishlistUpdateInput`. _Example: example\_1_ Payload 1 ``` { "name": "My List" } ``` #### Responses * **200** _Wishlist Summary_ Summary of a wishlist. Media type: `application/json`. Schema: `WishlistSummary`. ### POST Commerce Webstore Wishlist, Add to Cart `POST /commerce/webstores/{webstoreId}/wishlists/{wishlistId}/actions/add-wishlist-to-cart` Operation ID: `postWishlistAddToCart`. Tags: Commerce B2B Resources. Used to add products from a Wishlist to a Cart. Add a wishlist to a cart. Adding wishlists to carts respects buyer View Product entitlements and only users entitled to view product data can access it. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `cartId` (query, string) ID of the cart. If unspecified, wishlist items are added to the active cart. _Available in: v49.0_ * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ #### Responses * **200** _Wishlist to Cart Result_ Result of adding a wishlist to a cart. Media type: `application/json`. Schema: `WishlistToCartResult`. ### GET Commerce Webstore Wishlist Items `GET /commerce/webstores/{webstoreId}/wishlists/{wishlistId}/wishlist-items` Operation ID: `getWishlistItemCollection`. Tags: Commerce B2B Resources. Used to add and read items from Wishlist Item Collection. Get wishlist items. Adding items to wishlists respects buyer View Product entitlements and only users entitled to view product data can access it. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ * `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. _Available in: v49.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 200. If unspecified, the default size is 25. _Available in: v49.0_ * `productFields` (query, string) Comma-separated list of custom product fields. Fields aren’t case-sensitive. For example, `ProductCode` and `productcode` return the same results. _Available in: v51.0_ * `sortItemsBy` (query, ConnectWishlistItemSortOrderEnum) Sort order for wishlist items. Values are: * `CreatedDateAsc` —Sorts by oldest creation date. * `CreatedDateDesc` —Sorts by most recent creation date. The default sort order is `CreatedDateDesc`. _Available in: v51.0_ #### Responses * **200** _Wishlist Item Collection_ Collection of wishlist items. Media type: `application/json`. Schema: `WishlistItemCollection`. ### POST Commerce Webstore Wishlist Items `POST /commerce/webstores/{webstoreId}/wishlists/{wishlistId}/wishlist-items` Operation ID: `postWishlistItemCollection`. Tags: Commerce B2B Resources. Used to add and read items from Wishlist Item Collection. Add items to the wishlist. Adding items to wishlists respects buyer View Product entitlements and only users entitled to view product data can access it. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ #### Request body Item to update or add to a wishlist. _Available in: v49.0_ Media type: `application/json`. Schema: `WishlistItemInput`. _Example: example\_1_ Payload 1 ``` { "productId": "01tRM000000NJCeYAO" } ``` #### Responses * **200** _Wishlist Item_ Item in a wishlist to create. Media type: `application/json`. Schema: `WishlistItem`. ### DELETE Commerce Webstore Wishlist Item `DELETE /commerce/webstores/{webstoreId}/wishlists/{wishlistId}/wishlist-items/{wishlistItemId}` Operation ID: `deleteWishlistItem`. Tags: Commerce B2B Resources. Used to update or delete single Wishlist Item. Delete a wishlist item. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `wishlistId` (path, string (Id), required) ID of the wishlist. Pattern: ^(3or)\\w\*. * `wishlistItemId` (path, string (Id), required) ID of the wishlist item. Pattern: ^(3os)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ #### Responses * **200** _Status Codes and Error Responses_ The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred. ### GET Commerce Webstore Account Addresses `GET /commerce/webstores/{webstoreId}/accounts/{accountId}/addresses` Operation ID: `getCommerceAddress`. Tags: Commerce B2B Resources. Commerce Account address management. Retrieve a collection of addresses for a webstore account. _Available in: v54.0_ #### Parameters * `accountId` (path, string, required) ID of the account. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `addressId` (query, string) ID of the account address. _Available in: v56.0_ * `addressType` (query, array of string) List of address types (for example, “Shipping” or “Billing”). _Available in: v54.0_ * `defaultOnly` (query, boolean) Indicate if you only want the default address ( `true` ) or all addresses for the account ( `false` ). The default value is `false` . _Available in: v54.0_ * `excludeUnsupportedCountries` (query, boolean) Indicate if you want to retrieve all addresses ( `false` ) or only addresses of type Shipping that are in countries included in the store’s shipToCountries list ( `true` ). The default value is `false` . _Available in: v57.0_ * `fields` (query, array of string) A list of custom fields for the address. _Available in: v54.0_ * `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. _Available in: v54.0_ * `pageToken` (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. _Available in: v54.0_ * `shouldShowDefaultAddrFirst` (query, boolean) * `sortOrder` (query, ConnectCommerceAddressSortOrderEnum) Sort order for Commerce addresses. Values are: * `CreatedDateAsc` —Sort in ascending order of created date. * `CreatedDateDesc` —Sort in descending order of created date. * `NameAsc` —Sort in ascending order of name. * `NameDesc` —Sort in descending order of name. _Available in: v54.0_ #### Responses * **200** _Commerce Address Collection_ A collection of commerce addresses. Media type: `application/json`. Schema: `CommerceAddressCollection`. ### POST Commerce Webstore Account Addresses `POST /commerce/webstores/{webstoreId}/accounts/{accountId}/addresses` Operation ID: `postCommerceAddress`. Tags: Commerce B2B Resources. Commerce Account address management. Create a Commerce account address for a webstore. _Available in: v54.0_ #### Parameters * `accountId` (path, string, required) ID of the account. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Commerce address input. Media type: `application/json`. Schema: `CommerceAddressInput`. #### Responses * **200** _Commerce Address_ Address for a Commerce account. Media type: `application/json`. Schema: `CommerceAddressOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "addressId":"81Wxx0000000001EAA", "city":"Boston", "country":"US", "isDefault":true, "name":"Home Address", "postalCode":"01234", "region":"MA", "street":"1 Milk Street", “addressType”: “Billing”, "commerceAddressFieldInputList": { "fields" : [ { "dataName" : "options__c", "text" : "alpha" } ] } } ``` ### DELETE Commerce Webstore Account Address `DELETE /commerce/webstores/{webstoreId}/accounts/{accountId}/addresses/{addressId}` Operation ID: `deleteCommerceAddressPatchDelete`. Tags: Commerce B2B Resources. Commerce Account address management. Delete an address for a Commerce account associated with a webstore. _Available in: v54.0_ #### Parameters * `accountId` (path, string, required) ID of the account. * `addressId` (path, string (Id), required) ID of the address. Pattern: ^(8lW)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** Success ### PATCH Commerce Webstore Account Address `PATCH /commerce/webstores/{webstoreId}/accounts/{accountId}/addresses/{addressId}` Operation ID: `patchCommerceAddressPatchDelete`. Tags: Commerce B2B Resources. Commerce Account address management. Update an address for a Commerce account associated with a webstore. _Available in: v54.0_ #### Parameters * `accountId` (path, string, required) ID of the account. * `addressId` (path, string (Id), required) ID of the address. Pattern: ^(8lW)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Commerce address input. Media type: `application/json`. Schema: `CommerceAddressInput`. #### Responses * **200** _Commerce Address_ Address for a Commerce account. Media type: `application/json`. Schema: `CommerceAddressOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "addressId":"81Wxx0000000001EAA", "city":"Boston", "country":"US", "isDefault":true, "name":"Home Address", "postalCode":"01234", "region":"MA", "street":"1 Milk Street", “addressType”: “Billing”, "commerceAddressFieldInputList": { "fields" : [ { "dataName" : "options__c", "text" : "alpha" } ] } } ``` ### POST Commerce Webstore Buyer Registration `POST /commerce/webstores/{webstoreId}/buyers/registrations` Operation ID: `postBuyerRegistration`. Tags: Commerce B2B Resources. Initiates buyer registration process for a guest user Lets a guest shopper register an account with a merchant. This resource is for use with one-click checkout with Salesforce Payments and Salesforce Commerce. Before the shopper completes their order, they can choose to save their payment and shipping information for future use. This resource creates a Person account, user record, and a contact point address for saving shipping information. To use this API, complete these store configurations: * Enable Person Accounts * Configure self-registration * Enable guest user access to the webstore _Available in: v61.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Provides a customer’s account registration information for your store. Media type: `application/json`. Schema: `BuyerRegistrationInput`. #### Responses * **200** _Buyer Registration_ The ID of the registered buyer that is returned in the response. Media type: `application/json`. Schema: `BuyerRegistration`. #### Code samples _Example: Example 1 · HTTP_ ``` { "captchaToken": "EXAMPLE_CAPTCHA_TOKEN_VALUE", "email": "jdoe@salesforce.com", "phoneNumber": "+18585559876", "firstName": "Jose", "lastName": "Figueroa", "addressList": { "addresses": [ { "city": "San Ysidro", "companyName": "", "country": "US", "firstName": "Jose", "lastName": "Figueroa", "name": "Jose Figueroa", "postalCode": "92143", "region": "MA", "street": "1 Main St" } ] } ``` ### GET Commerce Webstore My Profile `GET /commerce/webstores/{webstoreId}/myprofile` Operation ID: `getBuyerProfile`. Tags: Commerce B2B Resources. Fetch a buyer profile. Retrieve the buyer's account details. The `Commerce Webstore My Profile Initiate OTP` and `Commerce Webstore My Profile Verify OTP` APIs integrate with the myprofile API to securely manage updates to a buyer's profile information—specifically their email and phone number. These APIs enforce re-authentication before any changes are made, ensuring that only authorized users can modify contact details and that the new information is verified as belonging to the buyer. _Available in: v52.0_ **Note:** GET is supported in API version 52.0 and later. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** Success Media type: `application/json`. Schema: `BuyerProfile`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000005rGAA/myprofile ``` ### PATCH Commerce Webstore My Profile `PATCH /commerce/webstores/{webstoreId}/myprofile` Operation ID: `patchBuyerProfile`. Tags: Commerce B2B Resources. Fetch a buyer profile. Update buyer account details. Updates the registered buyer’s details by identifying the buyer user’s ID within the logged-in context. The `Commerce Webstore My Profile Initiate OTP` and `Commerce Webstore My Profile Verify OTP` APIs integrate with the myprofile API to securely manage updates to a buyer's profile information—specifically their email and phone number. These APIs enforce re-authentication before any changes are made, ensuring that only authorized users can modify contact details and that the new information is verified as belonging to the buyer. _Available in: v52.0_ **Note:** PATCH is supported in API version 59.0 and later. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Input details for the buyer profile update request. Media type: `application/json`. Schema: `BuyerProfileInput`. _Example: example\_1_ Payload 1 Here's an example of a request that includes both email and phone number updates when two-factor authentication is disabled: ``` { "firstName": "Morton", "lastName": "Strosin", "email": "Ma**********@vi*****.info", "phoneNumber": "********7740", "verificationInput": {} } ``` _Example: example\_2_ Payload 2 Here's an example of a request that includes an email update when two-factor authentication is enabled: ``` { "firstName": "Morton", "lastName": "Strosin", "email": "Ma**********@vi*****.info", "verificationInput": { "reCaptchaToken": "EXAMPLE_RECAPTCHA_TOKEN_VALUE", "stepUpVerificationIdentifier": "hjdfghjdfgj768" } } ``` _Example: example\_3_ Payload 3 Here's an example of a request that includes a phone number update when two-factor authentication is enabled: ``` { "firstName": "Morton", "lastName": "Strosin", "phoneNumber": "********7740", "verificationInput": { "reCaptchaToken": "EXAMPLE_RECAPTCHA_TOKEN_VALUE", "stepUpVerificationIdentifier": "hjdfghjdfgj768" } } ``` #### Responses * **200** _Buyer Profile Update_ Output details for a buyer profile update request. Media type: `application/json`. Schema: `BuyerProfilePatch`. _Example: example\_1_ Payload 1 Here's an example of a response when two-factor authentication is disabled: ``` { "firstName": "Morton", "isEmailVerified": "true", "isPhoneVerified": "true", "lastName": "Strosin", "email": "Ma**********@vi*****.info", "phoneNumber": "********7740", "userName": "morton.Strosin10@salesforce.com", "verificationResponse": {} } ``` _Example: example\_2_ Payload 2 Here's an example of a response when two-factor authentication is enabled: ``` { "firstName": "Morton", "isEmailVerified": "true", "isPhoneVerified": "true", "lastName": "Strosin", "email": "Ma**********@vi*****.info", "phoneNumber": "********7740", "userName": "morton.Strosin10@salesforce.com", "verificationResponse": { "identifier": "z9jOsN8Buj8bRISupnbg", "message": "Ok", "method": "Sms", "recipient": "(***) ***-6705", "status": "Success" } } ``` ### POST Commerce Webstore My Profile Initiate OTP `POST /commerce/webstores/{webstoreId}/myprofile/actions/initOTP` Operation ID: `postBuyerProfileInit`. Tags: Commerce B2B Resources. This API will be consumed for verify action on Email and Phone field. This will internally trigger the OTP on the unverified email/phone. Initiate the one-time password (OTP) via the specified method, such as SMS or Email. The API returns a unique identifier associated with the OTP request. This process make sures that any changes to buyer's critical information, such as email and phone number, are securely verified before the update using the [Commerce Webstore My Profile](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getBuyerProfile) PATCH method. _Available in: v64.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Input details for a buyer profile OTP initiate request. Media type: `application/json`. Schema: `BuyerProfileInitInput`. _Example: example\_1_ Payload 1 ``` { "method": "SMS", "reCaptchaToken": "EXAMPLE_RECAPTCHA_TOKEN_VALUE", "type": "Verify" } ``` #### Responses * **200** _Buyer Profile Initiate OTP Output_ Output details for the buyer profile OTP initiate request. Media type: `application/json`. Schema: `BuyerProfileInitOutput`. _Example: example\_1_ Payload 1 ``` { "identifier": "z9jOsN8Buj8bRISupnbg", "message": "The update request was successful.", "recipient": "(***) ***-6705", "status": "Success" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000005rGAA/myprofile/actions/initOTP Content-Type: application/json { "method": "SMS", "reCaptchaToken": "EXAMPLE_RECAPTCHA_TOKEN_VALUE", "type": "Verify" } ``` ### POST Commerce Webstore My Profile Verify OTP `POST /commerce/webstores/{webstoreId}/myprofile/actions/verify` Operation ID: `postBuyerProfileVerify`. Tags: Commerce B2B Resources. Verifies the code entered by User for Step-Up Verification and Email/Phone Number verification. Validate the one-time-password (OTP) provided by the buyer. The OTP is initiated through the [Commerce Webstore My Profile Initiate OTP](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/postBuyerProfileInit) API, which is triggered when there is a change in the buyer's email or phone number. This API must be called before updating the buyer's email and phone number using the [Commerce Webstore My Profile](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getBuyerProfile) PATCH method. Upon successful verification, the buyer's email or phone number is updated, and the corresponding verification fields, including `hasUserVerifiedEmail` or `hasUserVerifiedPhoneNumber` are set to true in the API response. _Available in: v64.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Input details for the buyer profile verify request. Media type: `application/json`. Schema: `BuyerProfileVerifyInput`. _Example: example\_1_ Payload 1 ``` { "code": "87XXXX", "identifier": "z9jOsN8Buj8bRISupnbg" } ``` #### Responses * **200** _Buyer Profile Verify Output_ Output details for the buyer profile verify request. Media type: `application/json`. Schema: `BuyerProfileVerifyOutput`. _Example: example\_1_ Payload 1 ``` { "identifier": "z9jOsN8Buj8bRISupnbg", "message": "The verification request was successful.", "status": "Success" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000005rGAA/myprofile/actions/verify Content-Type: application/json { "code": "87XXXX", "identifier": "z9jOsN8Buj8bRISupnbg" } ``` ### GET Commerce Webstore Order Summaries `GET /commerce/webstores/{webstoreId}/order-summaries` Operation ID: `getOrderSummaryCollection`. Tags: Commerce B2B Resources. Fetch collection of order summaries. Get order summaries. This API is available only to registered users. _Available in: v51.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `earliestDate` (query, string) Oldest created or ordered date, depending on the `sortOrder` value, for order summaries to return. Results include any orders on and after this date.. The supported date format is `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For example, 2001-07-04T12:08:56.235-0700 , 2001-07-04T12:08:56.235+0700, or 2001-07-04T12:08:56.235-0000 (UTC). See [Valid Date and DateTime Formats](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_valid_date_formats.htm). _Available in: v51.0_ * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v51.0_ * `fields` (query, array of string) List of up to 35 additional order summary fields to display in the UI in each item row. For example, `fields=orderNumber, status, orderLifeCycleType` . These order summary fields are returned regardless of fields specified. * `createdDate` * `orderSummaryId` * `orderNumber` * `orderedDate` * `ownerId` * `status` * `totalAmount` _Available in: v51.0_ * `includeAdjustmentDetails` (query, boolean) Specifies whether to fetch price adjustment details based on their type (`true`). If unspecified, defaults to `false`. _Available in: v56.0_ * `includeProducts` (query, boolean) Specifies whether to include product media in order summaries (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v61.0_ * `latestDate` (query, string) Most recent created or ordered date, depending on the `sortOrder` value, for order summaries to return. Results include any orders before this date. The supported date format is `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. For example, 2001-07-04T12:08:56.235-0700 , 2001-07-04T12:08:56.235+0700, or 2001-07-04T12:08:56.235-0000 (UTC). See [Valid Date and DateTime Formats](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_valid_date_formats.htm). _Available in: v51.0_ * `ownerScoped` (query, boolean) Specifies whether the results are scoped to orders owned by the context user (`true`) or to orders owned by and shared with the context user (`false`). If unspecified, defaults to `true`. _Available in: v51.0_ * `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. _Available in: v51.0_ * `pageToken` (query, string) Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned. _Available in: v51.0_ * `sortOrder` (query, ConnectOrderSummarySortEnum) Sort order for order summaries. Values are: * `CreatedDateAsc` —Sorts by the oldest created date. * `CreatedDateDesc` —Sorts by the most recent created date. * `OrderedDateAsc` —Sorts by the oldest ordered date. * `OrderedDateDesc` —Sorts by the most recent ordered date. If unspecified, defaults to `OrderedDateDesc`. If you’re sorting by ordered date, make sure the ordered date is populated on your order summary records. A `null` value isn’t supported and results in an error. _Available in: v51.0_ #### Responses * **200** _Order Summary Collection_ Collection of order summaries. Media type: `application/json`. Schema: `OrderSummaryCollection`. _Example: example\_1_ Payload 1 ``` { "count": 2, "currentPageToken": null, "currentPageUrl": "/services/data/v67.0/commerce/webstores/0ZEOK00000008vK/order-summaries?​effectiveAccountId=001OK000001o5Ft&fields=AccountId&includeAdjustmentDetails=false&includeProducts=true​&ownerScoped=false&pageSize=25&sortOrder=OrderedDateDesc", "nextPageToken": null, "nextPageUrl": null, "orderSummaries": [ { "adjustmentAggregates": null, "createdDate": "2024-03-08T07:28:32.000Z", "currencyIsoCode": "USD", "fields": { "AccountId": { "label": "Account ID", "text": "001OK000001o5FtYAI", "type": "reference" } }, "orderNumber": "00000110", "orderSummaryId": "1OsOK00000006Sh0AI", "orderedDate": "2023-10-02T11:03:27.000Z", "ownerId": "005OK000000JZklYAG", "products": [ { "canViewProduct": true, "errorCode": null, "errorMessage": null, "fields": {}, "id": "01tOK000000EUprYAG", "media": { "alternateText": "Default Image", "contentVersionId": null, "id": null, "mediaType": null, "sortOrder": null, "thumbnailUrl": "/img/b2b/default-product-image.svg", "title": null, "url": null }, "variationAttributes": {} } ], "status": "Created", "totalAmount": "26.98" }, { "adjustmentAggregates": null, "createdDate": "2024-03-08T07:28:32.000Z", "currencyIsoCode": "USD", "fields": { "AccountId": { "label": "Account ID", "text": "001OK000001o5FtYAI", "type": "reference" } }, "orderNumber": 109, "orderSummaryId": "1OsOK00000006Sg0AI", "orderedDate": "2023-10-02T11:02:06.000Z", "ownerId": "005OK000000JZklYAG", "products": [ { "canViewProduct": true, "errorCode": null, "errorMessage": null, "fields": {}, "id": "01tOK000000EUpmYAG", "media": { "alternateText": "Default Image", "contentVersionId": null, "id": null, "mediaType": null, "sortOrder": null, "thumbnailUrl": "/img/b2b/default-product-image.svg", "title": null, "url": null }, "variationAttributes": {} } ], "status": "Created", "totalAmount": "561.98" } ], "previousPageToken": null, "previousPageUrl": null, "sortOrder": "OrderedDateDesc" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx0000000002GAA/order-summaries ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZEOK00000008vK4AQ/order-summaries?effectiveAccountId=001OK000001o5FtYAI&ownerScoped=false&fields=AccountId&includeProducts=true ``` ### POST Commerce Webstore Add Order Summaries to Cart v2 `POST /commerce/webstores/{webstoreId}/order-summaries/actions/add-order-to-cart` Operation ID: `postAddOrderToCartResourceV2`. Tags: Commerce B2B Resources. Performs add-order-to-cart action on an OrderSummary Add an order summary to an active or a current cart. The API includes products from the existing order summary, with the same quantity and configuration details, such as the product selling model. This API is available to both registered and guest users. For registered users, this API uses the webstore’s order summary ID or reference number. For guest users, provide an order summary reference number. Authenticated users can reorder simple, variant, bundle, and configurable products, whereas guest users can't reorder configurable products. Support for reordering configurable products is available starting from API version 67.0 and later, and requires a Revenue Lifecycle Management license in addition to the B2B Commerce license. This API authorizes guest users using either a session cookie, an access token generated via the [Commerce Webstore Order Summary Authorization](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/postOrderSummaryAuthorization) API, or a `verification` object (email, last name, or phone). If both an access token and verification input are provided along with the session cookie, the API authorizes using whichever one is valid. **Note**: Session cookie authorization is only available on Salesforce-hosted stores. If the existing order summary includes a gift-wrap item, this API only adds the other items to the cart, ignoring the gift-wrap item. For example, if you have eight order item summaries and a gift-wrap item summary in an order summary, only these eight products are added to the cart when you reorder. However, buyers can choose to add gift wrap for the new order during checkout. **Note**: Gift wrap applies to the entire order summary with a single delivery address and isn't for a specific order item summary. _Available in: v59.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. This field is required only for authenticated or registered shoppers. _Available in: v59.0_ #### Request body Input for adding an order to a cart. _Available in: v59.0_ Media type: `application/json`. Schema: `AddOrderToCartInput`. _Example: example\_1_ Payload 1 Here’s a sample request for a registerd user: ``` { "cartStateOrId": "active", "orderSummaryIdOrRefNumber": "Oder_Summary_ID" } ``` _Example: example\_2_ Payload 2 Here’s a sample request with verification for a guest user: ``` { "cartStateOrId": "active", "orderSummaryIdOrRefNumber": "GJA4C-MUVBN-6ZT4P-V6CSB", "verification": { "email": "Ma**********@vi*****.info", "lastName": "Strosin", "phoneNumber": "********7740" } } ``` #### Responses * **200** _Order to Cart Result_ Result of action adding an order to a cart. Media type: `application/json`. Schema: `OrderToCartResult`. _Example: example\_1_ Payload 1 ``` { "cartId": "0a6RO0000000146YAA", "totalSucceededProductCount": 3, "totalFailedProductCount": 2, "unaddedProducts": [ { "productId": "01txx00000034cv", "productName": "Sample Product Name 1", "productSKU": "00001", "errorCode": "ERROR_MAX_LIMIT_EXCEEDED", "errorMessage": "Sample Error Message 1", "media": { "alternateText": null, "contentVersionId": null, "id": "2pmRO00000000x2YAA", "mediaType": null, "sortOrder": null, "thumbnailUrl": null, "title": "tshirt 5", "url": "/cms/delivery/media/MC2KSOOFJGRZDDJGQG4QJHLKHTZQ?recordId=01tRO000000FVNB&buyerId=001RO000001npBo" } }, { "productId": "01txx00000034cw", "productName": "Sample Product Name 2", "productSKU": "00002", "errorCode": "ERROR_SAVING_CARTITEM", "errorMessage": "Sample Error Message 2", "media": { "alternateText": null, "contentVersionId": null, "id": "2pmRO00000000x2YAB", "mediaType": null, "sortOrder": null, "thumbnailUrl": null, "title": "tshirt 3", "url": "/cms/delivery/media/MC2KSOOFJGRZDDJGQG4QJHLKHTZQ?recordId=01tRO000000FVNB&buyerId=001RO000001npBo" } } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` # Here’s a sample request with access token for a guest user: { "cartStateOrId": "active", "orderSummaryIdOrRefNumber": "GJA4C-MUVBN-6ZT4P-V6CSB", "accessToken": "U2FsdGVkX1+kp1d8aQKHsqZJv1shF8Jx4Nc0kOdN+L5gViQa/sZtU5NHMDpIUEhz" } } ``` ### POST Commerce Webstore Order Summary Authorization `POST /commerce/webstores/{webstoreId}/order-summaries/actions/authorize` Operation ID: `postOrderSummaryAuthorization`. Tags: Commerce B2B Resources. Authorize guest users by validating the Guest PII for requested orderSummary Authorize guest users by verifying their personally identifiable information to access the requested order summary. This API is specifically for guest users. This API is used to authorize a guest user and retrieve an access token, which can then be used as input for the Commerce Webstore Order Summary Lookup GET API to retrieve the requested order summary record. The access token is valid for 60 minutes. _Available in: v64.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Input representation to authorize guest access for the requested order summary record. Media type: `application/json`. Schema: `OrderSummaryAuthorizationInput`. _Example: example\_1_ Payload 1 ``` { "email": "Ma**********@vi*****.info", "lastName": "Strosin", "orderSummaryRefNumber": "GJA4C-MUVBN-6ZT4P-V6CSB", "phoneNumber": "********7740" } ``` #### Responses * **200** _Order Summary Authorization Output_ Result of the authorize guest user request. Media type: `application/json`. Schema: `OrderSummaryAuthorizationOutput`. _Example: example\_1_ Payload 1 ``` { "accessToken": "U2FsdGVkX1+kp1d8aQKHsqZJv1shF8Jx4Nc0kOdN+L5gViQa/sZtU5NHMDpIUEhz" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000005rGAA/order-summaries/actions/authorize Content-Type: application/json { "email": "Ma**********@vi*****.info", "lastName": "Strosin", "orderSummaryRefNumber": "GJA4C-MUVBN-6ZT4P-V6CSB", "phoneNumber": "********7740" } ``` ### GET Commerce Webstore Order Summary Lookup `GET /commerce/webstores/{webstoreId}/order-summaries/actions/lookup` Operation ID: `getOrderSummaryLookup`. Tags: Commerce B2B Resources. Lookup details about an OrderSummary Look up details about an order summary, including its line items and relevant order amount fields. This API is available to both registered and guest users. _Available in: v58.0_ **Note**: Session cookie authorization is only available on Salesforce-hosted stores. **Note:** GET is supported in API version 64.0 and later. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `accessToken` (query, string) Encrypted access token, retrieved from the Comerce Webstore Order Summary Authorization API after successful verification for guest users. This access token is valid for 60 minutes. This is required for guest users if the request doesn't include a valid session cookie. _Available in: v64.0_ * `deliveryGroupId` (query, string) ID of the delivery group associated with the order summary. _Available in: v64.0_ * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user or, for guest users, the guest user profile ID of the current store. ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. This field is required only for authenticated or registered users. _Available in: v64.0_ * `excludeParameters` (query, array of string) List of fields to exclude from the API response, including `AdjustmentAggregates` , `Adjustments` , `DeliveryGroups` , `LineItems` , and `Payments` . _Available in: v64.0_ * `fields` (query, array of string) List of specific fields, including custom fields, to return in the response along with default fields. For example, `OrderSummary.TotalAmount` , `OrderItemSummary.Quantity` , `Product2.Description` ,​ `OrderDeliveryGroupSummary.GrandTotalAmount` , `OrderDeliveryMethod.Carrier` . _Available in: v64.0_ * `orderSummaryIdOrRefNumber` (query, string, required) Either the order summary ID or reference number. For guest users, use the order summary reference number. _Available in: v64.0_ #### Responses * **200** _Order Summary Lookup Output_ Order summary lookup output. Media type: `application/json`. Schema: `OrderSummaryLookupOutput`. _Example: example\_1_ Payload 1 ``` { "adjustmentAggregates": null, "adjustments": [ { "amount": "-1.1", "basisReferenceDisplayName": null, "currencyIsoCode": "USD", "displayName": "@product_details_with_promotion 10% OFF GoGoo Blueberry Caffeinated", "targetType": "SplitLine", "type": "Promotion" } ], "currencyIsoCode": "USD", "deliveryGroups": [ { "currencyIsoCode": "USD", "deliveryMethod": { "fields": { "TransitTimeMin": { "dataName": "TransitTimeMin", "dataType": "xsd:int", "label": "Minimum Transit Time", "text": "3", "type": "int" }, "TransitTimeUnit": { "dataName": "TransitTimeUnit", "dataType": "xsd:string", "label": "Unit of Transit Time", "text": "Days", "type": "picklist" }, "AdjustedShippingFee": { "dataName": "AdjustedShippingFee", "dataType": "xsd:double", "label": "Adjusted Shipping Fee", "text": "11.99", "type": "currency" }, "TransitTimeMax": { "dataName": "TransitTimeMax", "dataType": "xsd:int", "label": "Maximum Transit Time", "text": "5", "type": "int" }, "ProcessTimeUnit": { "dataName": "ProcessTimeUnit", "dataType": "xsd:string", "label": "Unit of Order Processing Time", "text": "Days", "type": "picklist" }, "TotalAdjustmentAmount": { "dataName": "TotalAdjustmentAmount", "dataType": "xsd:double", "label": "Total Adjustment Amount", "text": "0.0", "type": "currency" }, "ProcessTime": { "dataName": "ProcessTime", "dataType": "xsd:int", "label": "Order Processing Time", "text": "1", "type": "int" }, "LatestEstimatedDeliveryDate": { "dataName": "LatestEstimatedDeliveryDate", "dataType": "xsd:date", "label": "Latest Estimated Delivery Date", "text": "2024-12-08T19:37:42Z", "type": "date" }, "EarliestEstimatedDeliveryDate": { "dataName": "EarliestEstimatedDeliveryDate", "dataType": "xsd:date", "label": "Earliest Estimated Delivery Date", "text": "2024-12-06T19:37:42Z", "type": "date" }, "ShippingFee": { "dataName": "ShippingFee", "dataType": "xsd:double", "label": "Shipping Fee", "text": "11.99", "type": "currency" }, "Name": { "dataName": "Name", "dataType": "xsd:string", "label": "Name", "text": "Shipping Method 1", "type": "string" } }, "id": null }, "fields": { "DeliverToCountry": { "dataName": "DeliverToCountry", "dataType": "xsd:string", "label": "Country", "text": "US", "type": "string" }, "DeliverToCity": { "dataName": "DeliverToCity", "dataType": "xsd:string", "label": "City", "text": "San Francisco", "type": "string" }, "DeliverToState": { "dataName": "DeliverToState", "dataType": "xsd:string", "label": "State/Province", "text": "CO", "type": "string" }, "DeliverToPostalCode": { "dataName": "DeliverToPostalCode", "dataType": "xsd:string", "label": "Zip", "text": "94105", "type": "string" }, "DeliverToStreet": { "dataName": "DeliverToStreet", "dataType": "xsd:string", "label": "Address", "text": "415 Mission St, San Francisco, CA 94105", "type": "textarea" }, "DesiredDeliveryDate": { "dataName": "DesiredDeliveryDate", "dataType": "xsd:dateTime", "label": "Desired Delivery Date", "text": "2025-01-01T19:36:44Z", "type": "datetime" }, "Name": { "dataName": "Name", "dataType": "xsd:string", "label": "Cart Name", "text": "Shipment 1", "type": "string" } }, "id": null, "lineItems": [ { "adjustmentAggregates": null, "adjustments": [], "associatedLineItems": [], "currencyIsoCode": "USD", "fields": { "Description": { "dataName": "Description", "dataType": "xsd:string", "label": "Description", "text": "GoGoo Blueberry Caffeinated, 1oz - 6 pack", "type": "string" }, "OrderDeliveryGroupSummaryId": { "dataName": "OrderDeliveryGroupSummaryId", "dataType": "tns:ID", "label": "Order Delivery Group Summary ID", "text": "0a7SG000001ax93YAA", "type": "reference" }, "UnitAdjustedPriceWithItemAdj": { "dataName": "UnitAdjustedPriceWithItemAdj", "dataType": "xsd:double", "label": "Unit price that includes both tier and item level discounts for this cart item", "text": "9.89", "type": "currency" }, "TotalListPrice": { "dataName": "TotalListPrice", "dataType": "xsd:double", "label": "Total List Price", "text": "11.5", "type": "currency" }, "Quantity": { "dataName": "Quantity", "dataType": "xsd:double", "label": "Quantity", "text": "1.0", "type": "double" }, "StockKeepingUnit": { "dataName": "StockKeepingUnit", "dataType": "xsd:string", "label": "Product Sku", "text": "6010032", "type": "string" }, "ListPrice": { "dataName": "ListPrice", "dataType": "xsd:double", "label": "List Price", "text": "11.5", "type": "currency" }, "TotalLineAdjustmentAmount": { "dataName": "TotalLineAdjustmentAmount", "dataType": "xsd:double", "label": "Line Adjustments", "text": "-1.1", "type": "currency" }, "ReferencePrice": { "dataName": "ReferencePrice", "dataType": "xsd:double", "label": "Reference Price", "text": "11.5", "type": "currency" }, "Name": { "dataName": "Name", "dataType": "xsd:string", "label": "Name", "text": "GoGoo Blueberry Caffeinated, 1oz - 6 pack", "type": "string" }, "ItemizedAdjustmentAmount": { "dataName": "ItemizedAdjustmentAmount", "dataType": "xsd:double", "label": "Item Promotions Total", "text": "-1.1", "type": "currency" }, "TotalLineTaxAmount": { "dataName": "TotalLineTaxAmount", "dataType": "xsd:double", "label": "Line Subtotal Tax", "text": "0.0", "type": "currency" }, "UnitPrice": { "dataName": "UnitPrice", "dataType": "xsd:double", "label": "Unit Price", "text": "10.99", "type": "currency" }, "Type": { "dataName": "Type", "dataType": "xsd:string", "label": "Type", "text": "Product", "type": "picklist" }, "Product2Id": { "dataName": "Product2Id", "dataType": "tns:ID", "label": "Product ID", "text": "01tSG000000MTlTYAW", "type": "reference" }, "TotalPrice": { "dataName": "TotalPrice", "dataType": "xsd:double", "label": "Pretax Total", "text": "10.99", "type": "currency" }, "TotalLineAmount": { "dataName": "TotalLineAmount", "dataType": "xsd:double", "label": "Line Subtotal", "text": "10.99", "type": "currency" } }, "id": null, "itemClass": "Simple", "processExceptions": [], "product": { "canViewProduct": true, "errorCode": null, "errorMessage": null, "fields": { "Description": { "dataName": "Description", "dataType": "STANDARD", "label": "Description", "text": "Alpine Sport Energy GoGoo Caffeinated Gel Pack. Performance and Endurance when you need it.", "type": "TEXTAREA" }, "StockKeepingUnit": { "dataName": "StockKeepingUnit", "dataType": "STANDARD", "label": "StockKeepingUnit", "text": "6010032", "type": "STRING" }, "Name": { "dataName": "Name", "dataType": "STANDARD", "label": "Name", "text": "GoGoo Blueberry Caffeinated, 1oz - 6 pack", "type": "STRING" } }, "id": "01tSG000000MTlTYAW", "media": { "alternateText": "", "contentVersionId": null, "id": "2pmSG0000006MS0YAM", "mediaType": null, "sortOrder": null, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine-energy-gogoo-blueberry-caffeinefree.jpg" }, "variationAttributes": {} }, "productSellingModel": null } ] } ], "fields": { "UniqueProductCount": { "dataName": "UniqueProductCount", "dataType": "xsd:int", "label": "Unique Products (SKUs) in the Cart", "text": "1", "type": "int" }, "TaxLocaleType": { "dataName": "TaxLocaleType", "dataType": "xsd:string", "label": "Tax Locale Type", "text": "Net", "type": "picklist" }, "TotalAdjustedDeliveryAmount": { "dataName": "TotalAdjustedDeliveryAmount", "dataType": "xsd:double", "label": "Shipping", "text": "11.99", "type": "currency" }, "TotalListAmount": { "dataName": "TotalListAmount", "dataType": "xsd:double", "label": "Total List Amount in Cart", "text": "23.49", "type": "currency" }, "AccountId": { "dataName": "AccountId", "dataType": "tns:ID", "label": "Account ID", "text": "001SG00000lpQ2DYAU", "type": "reference" }, "TotalCartLevelAdjAmount": { "dataName": "TotalCartLevelAdjAmount", "dataType": "xsd:double", "label": "Total cart level adjustment amount for all the items in the cart. Includes discount and surcharge.", "text": "0.0", "type": "currency" }, "OwnerId": { "dataName": "OwnerId", "dataType": "tns:ID", "label": "Owner ID", "text": "005SG000004wdi2YAA", "type": "reference" }, "TotalProductAmount": { "dataName": "TotalProductAmount", "dataType": "xsd:double", "label": "Product Subtotal", "text": "10.99", "type": "currency" }, "TotalTaxAmount": { "dataName": "TotalTaxAmount", "dataType": "xsd:double", "label": "Tax", "text": "0.0", "type": "currency" }, "SalesStoreId": { "dataName": "SalesStoreId", "dataType": "tns:ID", "label": "Sales Store ID", "text": "0ZESG000000z1bt4AA", "type": "reference" }, "GrandTotalAmount": { "dataName": "GrandTotalAmount", "dataType": "xsd:double", "label": "Total", "text": "21.88", "type": "currency" } }, "id": null, "orderNumber": "EYWFU-7BIS4-DVLY7-GVJFV", "owner": { "email": "mo****.*******@abc.com", "firstName": "Morgan", "lastName": "Sholace", "phoneNumber": "********0753", "userName": null }, "payments": [ { "fields": {}, "paymentMethod": { "fields": { "PaymentMethodType": { "dataName": "PaymentMethodType", "dataType": "xsd:string", "label": "Payment Method Type", "text": "ACH", "type": "picklist" }, "BillingCountry": { "dataName": "BillingCountry", "dataType": "xsd:string", "label": "Billing Country", "text": "US", "type": "string" }, "BillingStreet": { "dataName": "BillingStreet", "dataType": "xsd:string", "label": "Billing Street", "text": "415 Mission St, San Francisco, CA 94105", "type": "textarea" }, "BillingCity": { "dataName": "BillingCity", "dataType": "xsd:string", "label": "Billing City", "text": "San Francisco", "type": "string" }, "BillingPostalCode": { "dataName": "BillingPostalCode", "dataType": "xsd:string", "label": "Billing Zip", "text": "94105", "type": "string" }, "Id": { "dataName": "Id", "dataType": "tns:ID", "label": "Alternative Payment Method ID", "text": "8Z7SG0000006fLR0AY", "type": "id" }, "PaymentMethodSubType": { "dataName": "PaymentMethodSubType", "dataType": "xsd:string", "label": "Payment Method Sub Type", "text": "STRIPE TEST BANK", "type": "string" }, "PaymentMethodDetails": { "dataName": "PaymentMethodDetails", "dataType": "xsd:string", "label": "Payment Method Details", "text": "6789", "type": "string" }, "BillingState": { "dataName": "BillingState", "dataType": "xsd:string", "label": "Billing State", "text": "CO", "type": "string" } }, "id": null } } ], "status": null } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores​/0ZExx00000000l2/order-summaries/actions/lookup?effectiveAccountId=001xx000003GYl8AAG&deliveryGroupId=0agxx000000003cAAA https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores​/0ZExx00000000l2/order-summaries/actions/lookup?accessToken=U2FsdGVkX1+kp1d8aQKHsqZJv1shF8Jx4Nc0kOdN+L5gViQa/sZtU5NHMDpIUEhz &excludeParameters=Adjustments,DeliveryGroups ``` ### POST Commerce Webstore Order Summary Lookup `POST /commerce/webstores/{webstoreId}/order-summaries/actions/lookup` Operation ID: `postOrderSummaryLookup`. Tags: Commerce B2B Resources. Lookup details about an OrderSummary Look up details about an order summary, including its line items and relevant order amount fields. This API is available to both registered and guest users. _Available in: v58.0_ **Note**: Session cookie authorization is only available on Salesforce-hosted stores. **Note:** POST methods usually create records, but for this resource, POST is used to retrieve the requested order summary record. Both POST and GET methods retrieve the same information. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `deliveryGroupId` (query, string) ID of the delivery group associated with the order summary. _Available in: v58.0_ * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user or, for guest users, the guest buyer profile ID of the current store. _Available in: v58.0_ * `excludeAdjustmentAggregates` (query, boolean) Specifies whether to exclude ( `true` ) or return ( `false` ) adjustment aggregates associated with an order summary. Adjustment aggregates include fields detailing promotional amounts by price, tax, and total. Aggregates are calculated asynchronously and result returned to the order summary. If unspecified, the default value is `false` . _Available in: v58.0_ * `excludeAdjustments` (query, boolean) Specifies whether to exclude ( `true` ) or return ( `false` ) adjustments associated with an order summary. Adjustments include promotional discounts. If unspecified, the default value is `false` . _Available in: v58.0_ * `excludeDeliveryGroups` (query, boolean) Specifies whether to exclude delivery groups from the response. If unspecified, the default value is `false` . _Available in: v58.0_ * `excludeLineItems` (query, boolean) Specifies whether to exclude line items from the response. If unspecified, the default value is `false` . _Available in: v58.0_ * `excludePayments` (query, boolean) Specifies whether to exclude payment information from the response. If unspecified, the default value is `false` . _Available in: v63.0_ * `fields` (query, array of string) List of specific fields, including custom fields, to return in the response along with default fields. For example, `OrderSummary.TotalAmount` , `OrderItemSummary.Quantity` , `Product2.Description` ,​ `OrderDeliveryGroupSummary.GrandTotalAmount` , `OrderDeliveryMethod.Carrier` . _Available in: v58.0_ #### Request body Order summary lookup input. _Available in: v58.0_ Media type: `application/json`. Schema: `OrderSummaryLookupInput`. _Example: example\_1_ Payload 1 Here's an example where the request for registered buers include the order summary ID: ``` { "orderSummaryIdOrRefNumber": "1Osxx0000004DypCAE" } ``` #### Responses * **200** _Order Summary Lookup Output_ Order summary lookup output. Media type: `application/json`. Schema: `OrderSummaryLookupOutput`. _Example example\_1: same as GET /commerce/webstores/{webstoreId}/order-summaries/actions/lookup 200 response._ Payload 1 _Example: example\_1_ Payload 1 #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores​/0ZExx00000000l2/order-summaries/actions/lookup https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores​/0ZExx00000000l2/order-summaries/actions/lookup?effectiveAccountId=001xx000003GYl8AAG&deliveryGroupId=0agxx000000003cAAA Content-Type: application/json { "orderSummaryIdOrRefNumber": "1Osxx0000004DypCAE" } ``` _Example: Example 2 · HTTP_ ``` # Here’s an example where the request for guest shoppers includes the order # summary reference number and verification details: { "orderSummaryIdOrRefNumber":"GJA4C-MUVBN-6ZT4P-V6CSB", "verification":{ "lastName":”Strosin”, "email":”Ma**********@vi*****.info”, "phoneNumber":"********7740" } } ``` ### POST Commerce Webstore Order Summaries, Adjustment Aggregates `POST /commerce/webstores/{webstoreId}/order-summaries/async-actions/adjustment-aggregates` Operation ID: `postOrderSummaryAdjustmentAggregatesAsync`. Tags: Commerce B2B Resources. Submit a job to calculate adjustment aggregates for provided order summary ids, and the return status URL Submit a job to calculate adjustment aggregates for a list of order summary IDs. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Order summary IDs for calculating adjustment aggregates. Media type: `application/json`. Schema: `OrderSummaryAdjustmentAggregatesAsyncInput`. _Example: example\_1_ Payload 1 ``` { "orderSummaryIds": [ "1Osxx0000004CDsCAM", "1Osxx0000004CH6CAM" ] } ``` #### Responses * **200** _Order Summary Adjustment Aggregates Async Output_ Async adjustment aggregates output. Media type: `application/json`. Schema: `OrderSummaryAdjustmentAggregatesAsyncOutput`. ### GET Commerce Webstore Order Summary `GET /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}` Operation ID: `getOrderSummaryDetail`. Tags: Commerce B2B Resources. Fetch details of an Order Summary. Get an order summary. This API is available only to registered users. **Note**: We recommend using the enhanced [Commerce Webstore Order Summary Lookup](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getOrderSummaryLookup) API, which is accessible to both registered and guest users. _Available in: v55.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v55.0_ * `fields` (query, array of string) List of up to 35 additional order summary fields to display in the UI in each item row. These order summary fields are returned regardless of fields specified. * `createdDate` * `orderSummaryId` * `orderNumber` * `orderedDate` * `ownerId` * `status` * `totalAmount` _Available in: v55.0_ * `includeAdjustmentDetails` (query, boolean) Specifies whether to return adjustment details (`true`) or not (`false`). If unspecified, the default value is `false`. _Available in: v55.0_ #### Responses * **200** _Order Summary_ Order summary information. Media type: `application/json`. Schema: `OrderSummary`. _Example: example\_1_ Payload 1 ``` [ { "adjustmentAggregates": null, "createdDate": "2024-03-08T07:28:32.000Z", "currencyIsoCode": "USD", "fields": { "AccountId": { "label": "Account ID", "text": "001OK000001o5FtYAI", "type": "reference" } }, "orderNumber": "00000110", "orderProductTopLevelLineCount": 1, "orderSummaryId": "1OsOK00000006Sh0AI", "orderedDate": "2023-10-02T11:03:27.000Z", "ownerId": "005OK000000JZklYAG", "products": [ { "canViewProduct": true, "errorCode": null, "errorMessage": null, "fields": {}, "id": "01tOK000000EUprYAG", "media": { "alternateText": "Default Image", "contentVersionId": null, "id": null, "mediaType": null, "sortOrder": null, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine-blends-gobrew-coffee-wholebean-frenchroast.jpg" }, "variationAttributes": {} } ], "status": "Created", "totalAmount": "26.98" }, { "adjustmentAggregates": null, "createdDate": "2024-03-08T07:28:32.000Z", "currencyIsoCode": "USD", "fields": { "AccountId": { "label": "Account ID", "text": "001OK000001o5FtYAI", "type": "reference" } }, "orderNumber": 109, "orderProductTopLevelLineCount": 1, "orderSummaryId": "1OsOK00000006Sg0AI", "orderedDate": "2023-10-02T11:02:06.000Z", "ownerId": "005OK000000JZklYAG", "products": [ { "canViewProduct": true, "errorCode": null, "errorMessage": null, "fields": {}, "id": "01tOK000000EUpmYAG", "media": { "alternateText": "Default Image", "contentVersionId": null, "id": null, "mediaType": null, "sortOrder": null, "thumbnailUrl": "/img/b2b/default-product-image.svg", "title": null, "url": null }, "variationAttributes": {} } ], "status": "Created", "totalAmount": "561.98" } ] ``` _Example: example\_2_ Payload 2 ``` [ { "adjustmentAggregates": null, "createdDate": "2024-05-06T06:02:18.000Z", "currencyIsoCode": "USD", "fields": { "Status": { "label": "Status", "text": "Created", "type": "picklist" } }, "orderNumber": "IIW3K-TRKFO-7TE3D-S3UCC", "orderProductTopLevelLineCount": 1, "orderSummaryId": "1Osxx0000004CAaCAM", "orderedDate": "2023-12-21T14:38:12.000Z", "ownerId": "005xx000001X7rlAAC", "products": [ { "canViewProduct": false, "errorCode": null, "errorMessage": null, "fields": {}, "id": "01txx0000006i2eAAA", "media": { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000000RAAQ", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/alpine-blends-gobrew-coffee-wholebean-frenchroast.jpg" }, "variationAttributes": {} } ], "status": "Created", "totalAmount": "25.98" } ] ``` ### POST Commerce Webstore Add Order Summaries to Cart v1 `POST /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}/actions/add-order-to-cart` Operation ID: `postAddOrderToCart`. Tags: Commerce B2B Resources. Performs add-order-to-cart action on an OrderSummary Use a webstore’s order summary to add an order to a cart. This API is available only to registered users. **Note**: We recommend using the enhanced [Commerce Webstore Add Order Summaries to Cart](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/postAddOrderToCartResourceV2) API, which is accessible to both registered and guest users. _Available in: v57.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If `null`, defaults to the account ID for the context user. _Available in: v57.0_ #### Request body Input for action adding an order to a cart. _Available in: v57.0_ Media type: `application/json`. Schema: `OrderToCartInput`. _Example: example\_1_ Payload 1 ``` { "cartStateOrId": "0a6xx0000000cwXAAQ" } ``` #### Responses * **200** _Order to Cart Result_ Result of action adding an order to a cart. Media type: `application/json`. Schema: `OrderToCartResult`. _Example example\_1: same as POST /commerce/webstores/{webstoreId}/order-summaries/actions/add-order-to-cart 200 response._ Payload 1 _Example: example\_1_ Payload 1 #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/vXX.X/commerce/webstores/0ZExx000000005rGAA/order-summaries/orderSummaryId/actions/add-order-to-cart Content-Type: application/json { "cartStateOrId": "0a6xx0000000cwXAAQ" } ``` ### GET Commerce Webstore Order Summary, Adjustments `GET /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}/adjustments` Operation ID: `getOrderSummaryAdjustmentCollection`. Tags: Commerce B2B Resources. Fetch Adjustments related to a given order summary. Get adjustments for an order summary. _Available in: v53.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v53.0_ #### Responses * **200** _Order Summary Adjustment Collection_ Collection of adjustments for an order summary. Media type: `application/json`. Schema: `OrderSummaryAdjustmentCollection`. ### GET Commerce Webstore Order Delivery Groups `GET /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}/delivery-groups` Operation ID: `getOrderDeliveryGroupSummaryCollection`. Tags: Commerce B2B Resources. A collection of order item delivery groups. Get order delivery groups. This API is available only to registered users. **Note**: We recommend using the enhanced [Commerce Webstore Order Summary Lookup](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getOrderSummaryLookup) API, which is accessible to both registered and guest users. _Available in: v51.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v51.0_ * `fields` (query, array of string) List of up to 15 order delivery group summary or order delivery method fields to display in the UI in each item row. For example, `fields=OrderDeliveryGroupSummary.DeliveryAddress, OrderDeliveryMethod.Name`. _Available in: v51.0_ * `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. _Available in: v51.0_ * `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. _Available in: v51.0_ * `sort` (query, ConnectOrderDeliveryGroupSummarySortEnum) Sort order for order delivery group summaries. Values are: * `IdAsc` —Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc` —Sorts by ID in descending alphanumeric order (Z–A, 9–0). If unspecified, `IdAsc` is the default sort order. _Available in: v51.0_ #### Responses * **200** _Order Delivery Group Summary Collection_ Collection of order delivery group summaries. Media type: `application/json`. Schema: `OrderDeliveryGroupSummaryCollection`. ### GET Commerce Webstore Order Items `GET /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}/items` Operation ID: `getOrderItemSummaryCollection`. Tags: Commerce B2B Resources. Represents collection of order item summaries. Get order items. This API is available only to registered users. **Note**: We recommend using the enhanced [Commerce Webstore Order Summary Lookup](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getOrderSummaryLookup) API, which is accessible to both registered and guest users. _Available in: v51.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v51.0_ * `fields` (query, array of string) List of up to 15 order item summary or product fields to display in the UI in each item row. For example, `fields=OrderItemSummary.Tax, OrderItemSummary.Total, OrderItemSummary.Quantity, Product2.StockKeepingUnit` . _Available in: v51.0_ * `includeAdjustmentDetails` (query, boolean) Specifies whether to return adjustment details (`true`) or not (`false`). If unspecified, the default value is `false`. _Available in: v55.0_ * `orderDeliveryGroupSummaryId` (query, string) ID of the order delivery group summary. _Available in: v51.0_ * `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. _Available in: v51.0_ * `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. _Available in: v51.0_ * `sort` (query, ConnectOrderItemSummarySortEnum) Sort order for order item summaries. Values are: * `IdAsc` —Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc` —Sorts by ID in descending alphanumeric order (Z–A, 9–0). If unspecified, `IdAsc` is the default sort order. _Available in: v51.0_ #### Responses * **200** _Order Item Summary Collection_ Collection of order item summaries. Media type: `application/json`. Schema: `OrderItemSummaryCollection`. ### POST Commerce Webstore Order Items, Adjustments `POST /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}/items/adjustments` Operation ID: `postOrderItemSummaryAdjustmentCollection`. Tags: Commerce B2B Resources. Fetch collection of adjustments for given OrderItemSummary IDs. Get adjustments for order items. _Available in: v53.0_ **Note:** POST methods typically create an item, but for this resource POST is used to retrieve information. GET calls can be cached. #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v53.0_ #### Request body Collection of order item summaries. _Available in: v53.0_ Media type: `application/json`. Schema: `OrderItemSummaryAdjustmentCollectionInput`. _Example: example\_1_ Payload 1 ``` { "orderItemSummaries": [ { "orderItemSummaryId": "10uxx00000000W0001" }, { "orderItemSummaryId": "10uxx00000000W0054" } ] } ``` #### Responses * **200** _Order Item Summary Adjustment Collection_ Collection of adjustments for order item summaries. Media type: `application/json`. Schema: `OrderItemSummaryAdjustmentCollection`. ### GET Commerce Webstore Order Shipments `GET /commerce/webstores/{webstoreId}/order-summaries/{orderSummaryId}/shipments` Operation ID: `getOrderShipmentCollection`. Tags: Commerce B2B Resources. A collection of Shipments. Get order shipments. _Available in: v52.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) ID of the order summary. Pattern: ^(1Os)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v52.0_ * `fields` (query, array of string) List of up to 15 additional shipment and order delivery method fields to display in the UI in each item row. For example, `fields=Shipment.Status, OrderDeliveryMethod.Name` . _Available in: v52.0_ * `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. _Available in: v52.0_ * `pageToken` (query, string) Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned. _Available in: v52.0_ * `sortOrder` (query, ConnectOrderShipmentSortEnum) Sort order for shipments. Values are: * `ExpectedDeliveryDateAsc` —Sorts by the oldest expected delivery date. * `ExpectedDeliveryDateDesc` —Sorts by the most recent expected delivery date. * `ShipmentNumberAsc` —Sorts by shipment number in ascending order (0–9). * `ShipmentNumberDesc` —Sorts by shipment number in descending order (9–0). If unspecified, defaults to `ShipmentNumberAsc`. If you’re sorting by expected delivery date, make sure the expected delivery date is populated on your shipment records. A `null` value isn’t supported and results in an error. _Available in: v52.0_ #### Responses * **200** _Order Shipment Collection_ Collection of order shipments. Media type: `application/json`. Schema: `OrderShipmentCollection`. ### GET Commerce Webstore Shipment Items `GET /commerce/webstores/{webstoreId}/shipments/{shipmentId}/items` Operation ID: `getOrderShipmentItemCollection`. Tags: Commerce B2B Resources. A collection of Shipment Items. Get shipment items. _Available in: v52.0_ #### Parameters * `shipmentId` (path, string (Id), required) ID of the shipment. Pattern: ^(0OB)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v52.0_ * `fields` (query, array of string) List of up to 15 additional shipment items, order item summary, and product fields to display in the UI in each item row. For example, `fields=ShipmentItems.Status, Product2.Name, OrderItemSummary.UnitPrice` . _Available in: v52.0_ * `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. _Available in: v52.0_ * `pageToken` (query, string) Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned. _Available in: v52.0_ * `sortOrder` (query, ConnectOrderShipmentItemSortEnum) Sort order for the shipment items. Values are: * `IdAsc` —Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc` —Sorts by ID in descending alphanumeric order (Z–A, 9–0). If unspecified, defaults to `IdAsc`. _Available in: v52.0_ #### Responses * **200** _Order Shipment Item Collection_ Collection of order shipment items. Media type: `application/json`. Schema: `OrderShipmentItemCollection`. ### GET Commerce Management Webstore Search, Facetable Attributes `GET /commerce/management/webstores/{webstoreId}/search/attribute-settings/facetable-fields` Operation ID: `getFacetableAttributes`. Tags: Commerce B2B Resources. Manages facetable search attributes in a webstore Get facetable attributes. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Facetable Attributes Collection_ Collection of facetable attributes. Media type: `application/json`. Schema: `FacetableAttributesCollectionOutput`. ### PUT Commerce Management Webstore Search, Facetable Attributes `PUT /commerce/management/webstores/{webstoreId}/search/attribute-settings/facetable-fields` Operation ID: `putFacetableAttributes`. Tags: Commerce B2B Resources. Manages facetable search attributes in a webstore Update facetable attributes. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Collection of facetable settings for search attributes. Media type: `application/json`. Schema: `FacetableAttributesCollectionInput`. _Example: example\_1_ Payload 1 ``` { "facetableAttributeSettings": [ { "type": "ProductCategory", "nameOrId": "Id", "displayRank": "1", "displayType": "CategoryTree" }, { "type": "Standard", "nameOrId": "Family", "displayRank": "2", "displayType": "MultiSelect" }, { "type": "Custom", "nameOrId": "color__c", "displayRank": "3", "displayType": "MultiSelect" } ] } ``` #### Responses * **200** _Facetable Attributes Collection_ Collection of facetable attributes. Media type: `application/json`. Schema: `FacetableAttributesCollectionOutput`. ### GET Commerce Management Webstore Search, Searchable Attributes `GET /commerce/management/webstores/{webstoreId}/search/attribute-settings/searchable-fields` Operation ID: `getSearchableAttributes`. Tags: Commerce B2B Resources. Manages searchable attributes in a webstore Get searchable attributes. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Searchable Attributes Collection_ Collection of searchable attributes. Media type: `application/json`. Schema: `SearchableAttributesCollectionOutput`. _Example: example\_1_ Payload 1 ``` { "searchableAttributeSettings": [ { "label": "Product Name", "nameOrId": "Name", "type": "Standard", "weight": 8 }, { "label": "Description", "nameOrId": "Description", "type": "Standard", "weight": 3 }, { "label": "SKU", "nameOrId": "StockKeepingUnit", "type": "Standard", "weight": 6 } ] } ``` ### PATCH Commerce Management Webstore Search, Searchable Attributes `PATCH /commerce/management/webstores/{webstoreId}/search/attribute-settings/searchable-fields` Operation ID: `patchSearchableAttributes`. Tags: Commerce B2B Resources. Manages searchable attributes in a webstore Update searchable attributes. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Collection of searchable attributes. Media type: `application/json`. Schema: `SearchableAttributesCollectionInput`. _Example: example\_1_ Payload 1 ``` { "searchableAttributeSettings": [ { "nameOrId": "Name", "type": "Standard", "isSearchable": true, "weight": 8 }, { "nameOrId": "Description", "type": "Standard", "isSearchable": true, "weight": 3 }, { "nameOrId": "StockKeepingUnit", "type": "Standard", "isSearchable": true, "weight": 6 } ] } ``` #### Responses * **200** _Searchable Attributes Collection_ Collection of searchable attributes. Media type: `application/json`. Schema: `SearchableAttributesCollectionOutput`. _Example example\_1: same as GET /commerce/management/webstores/{webstoreId}/search/attribute-settings/searchable-fields 200 response._ Payload 1 _Example: example\_1_ Payload 1 ### GET Commerce Webstore Search Boost and Bury Rules, Create `GET /commerce/management/webstores/{webstoreId}/search/boost-bury-rules` Operation ID: `getBoostBuryRulesCollectionManagement`. Tags: Commerce B2B Resources. Connect API resources for Search boost and bury rule Collection Get all boost and bury rules for a webstore. Keep these considerations in mind when using boost and bury rules to influence search results. * Boost and bury rules aren’t intended for precise control over ranking products in your search results. * Boost and bury rules influence how products are ranked in search results, but they don’t override them. * A product being boosted appears earlier and is ranked higher in the search results relative to its ranking without the rule and not relative to other products. * Boost and bury rules don’t guarantee that products with a higher boost value appear before products with a lower boost value. * Boost and bury rules only apply when the Best Match sort rule uses a relevance score to rank products. _Available in: v59.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Boost and Bury Rules Collection_ Collection of boost and bury rules. Media type: `application/json`. Schema: `SearchBoostBuryRulesCollectionOutput`. ### POST Commerce Webstore Search Boost and Bury Rules, Create `POST /commerce/management/webstores/{webstoreId}/search/boost-bury-rules` Operation ID: `postBoostBuryRulesCollectionManagement`. Tags: Commerce B2B Resources. Connect API resources for Search boost and bury rule Collection Create a boost and bury rule. Keep these considerations in mind when using boost and bury rules to influence search results. * Boost and bury rules aren’t intended for precise control over ranking products in your search results. * Boost and bury rules influence how products are ranked in search results, but they don’t override them. * A product being boosted appears earlier and is ranked higher in the search results relative to its ranking without the rule and not relative to other products. * Boost and bury rules don’t guarantee that products with a higher boost value appear before products with a lower boost value. * Boost and bury rules only apply when the Best Match sort rule uses a relevance score to rank products. _Available in: v59.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Boost and bury rule input. Media type: `application/json`. Schema: `SearchBoostBuryRuleInput`. _Example: example\_1_ Payload 1 ``` { "name": "Medium boost all Alpine products", "action": "Boost", "level": 70, "targetExpression": { "conditions": [ { "attributeNameOrId": "Id", "attributeType": "Product2", "values": [ "01txx0000006iiOAAQ", "01txx0000006ij4AAA" ] } ] }, "startDate": "2023-07-31T00:10:00.000Z", "endDate": "2023-08-31T00:10:00.000Z" } ``` #### Responses * **200** _Boost and Bury Rule_ Boost and bury rule information. Media type: `application/json`. Schema: `SearchBoostBuryRuleOutput`. ### GET Commerce Webstore Search Boost and Bury Rules, Manage `GET /commerce/management/webstores/{webstoreId}/search/boost-bury-rules/{ruleId}` Operation ID: `getBoostBuryRulesManagement`. Tags: Commerce B2B Resources. Connect API resources for Search boost and bury rules Get a boost and bury rule. _Available in: v59.0_ #### Parameters * `ruleId` (path, string (Id), required) ID of the rule. Pattern: ^(15O)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Boost and Bury Rule_ Boost and bury rule information. Media type: `application/json`. Schema: `SearchBoostBuryRuleOutput`. ### DELETE Commerce Webstore Search Boost and Bury Rules, Manage `DELETE /commerce/management/webstores/{webstoreId}/search/boost-bury-rules/{ruleId}` Operation ID: `deleteBoostBuryRulesManagement`. Tags: Commerce B2B Resources. Connect API resources for Search boost and bury rules Delete a boost and bury rule. _Available in: v59.0_ #### Parameters * `ruleId` (path, string (Id), required) ID of the rule. Pattern: ^(15O)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Commerce Management Webstore Search, Index Logs `GET /commerce/management/webstores/{webstoreId}/search/index-logs` Operation ID: `getCommerceSearchIndexLogs`. Tags: Commerce B2B Resources. Resource for retrieving search index logs for a webstore Get search index logs for a webstore. _Available in: v57.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `pageSize` (query, integer) Number of log records returned. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25. _Available in: v57.0_ #### Responses * **200** _Commerce Search Index Log Collection_ Collection of search index logs for a webstore. Media type: `application/json`. Schema: `CommerceSearchIndexLogCollection`. ### GET Commerce Management Webstore Search, Indexes `GET /commerce/management/webstores/{webstoreId}/search/indexes` Operation ID: `getCommerceSearchIndexCollection`. Tags: Commerce B2B Resources. Indexes information for a webstore Get indexes. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Commerce Search Index Collection_ Collection of indexes. Media type: `application/json`. Schema: `CommerceSearchIndexCollectionOutput`. ### POST Commerce Management Webstore Search, Indexes `POST /commerce/management/webstores/{webstoreId}/search/indexes` Operation ID: `postCommerceSearchIndexCollection`. Tags: Commerce B2B Resources. Indexes information for a webstore Create an index of a product catalog. _Available in: v49.0_ **Note**: POST doesn’t take request parameters or a request body. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `indexBuildType` (query, ConnectCommerceSearchIndexBuildTypeEnum) #### Responses * **200** _Commerce Search Index_ Index information. Media type: `application/json`. Schema: `CommerceSearchIndexOutput`. ### GET Commerce Management Webstore Search, Index `GET /commerce/management/webstores/{webstoreId}/search/indexes/{indexId}` Operation ID: `getCommerceSearchIndex`. Tags: Commerce B2B Resources. Index information for a webstore Get a search index. _Available in: v49.0_ #### Parameters * `indexId` (path, string (Id), required) ID of the index. Pattern: ^(0ax)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Commerce Search Index_ Index information. Media type: `application/json`. Schema: `CommerceSearchIndexOutput`. ### GET Commerce Management Webstore Search, Product Settings `GET /commerce/management/webstores/{webstoreId}/search/product-settings` Operation ID: `getSearchProductSetting`. Tags: Commerce B2B Resources. This accesses and manipulates product settings for search associated with a web store Get product search settings. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `ids` (query, array of string (Id), required) Comma-separated list of up to 250 18-character product IDs. _Available in: v49.0_ #### Responses * **200** _Search Product Setting Collection Output_ Collection of product search settings. Media type: `application/json`. Schema: `SearchProductSettingCollectionOutput`. ### PATCH Commerce Management Webstore Search, Product Settings `PATCH /commerce/management/webstores/{webstoreId}/search/product-settings` Operation ID: `patchSearchProductSetting`. Tags: Commerce B2B Resources. This accesses and manipulates product settings for search associated with a web store Update product search settings. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Collection of product search settings. Media type: `application/json`. Schema: `SearchProductSettingCollectionInput`. #### Responses * **200** _Search Product Setting Collection Output_ Collection of product search settings. Media type: `application/json`. Schema: `SearchProductSettingCollectionOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "searchProductSettings": [ { "id": "productId1", "searchable": true }, { "id": “productId2”, "searchable": false } ] } ``` ### GET Commerce Management Webstore Search, Include Rules `GET /commerce/management/webstores/{webstoreId}/search/results-rules` Operation ID: `getCommerceSearchResultsRulesManagement`. Tags: Commerce B2B Resources. Connect API resources for Search result rules Retrieve search include rules for a webstore. _Available in: v58.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `direction` (query, SortDirectionEnum) * `offset` (query, integer) * `sortByFieldApiName` (query, string) #### Responses * **200** _Search Results Rules Collection_ Collection of include search rules. Media type: `application/json`. Schema: `SearchResultsRulesCollectionOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/management/webstores/0ZExx000000005rGAA/search/results-rules ``` ### PUT Commerce Management Webstore Search, Include Rules `PUT /commerce/management/webstores/{webstoreId}/search/results-rules` Operation ID: `putCommerceSearchResultsRulesManagement`. Tags: Commerce B2B Resources. Connect API resources for Search result rules Create search include rules for a webstore. _Available in: v58.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Include search rules input collection information of a webstore. Media type: `application/json`. Schema: `SearchResultsRulesCollectionInput`. _Example: example\_1_ Payload 1 ``` { "searchResultsRules": [ { "type": "BidirectionalSynonym", "ruleDefinition": [ "decaffeinated", "decaf" ], "locales": [ "en_US" ] }, { "type": "UnidirectionalSynonym", "ruleDefinition": [ "dog", "puppy" ], "locales": [ "en_US" ] }, { "type": "BidirectionalSynonym", "ruleDefinition": [ "wintercoat", "jacket", "coat" ], "locales": [ "en_US" ] } ] } ``` #### Responses * **200** _Search Results Rules Collection_ Collection of include search rules. Media type: `application/json`. Schema: `SearchResultsRulesCollectionOutput`. ### POST Commerce Management Webstore Search, Include Rules `POST /commerce/management/webstores/{webstoreId}/search/results-rules` Operation ID: `postCommerceSearchResultsRulesManagement`. Tags: Commerce B2B Resources. Connect API resources for Search result rules Create search include rules for a webstore. _Available in: v58.0_ **Note:** POST is supported in version 66.0 and later. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Include search rule input. Media type: `application/json`. Schema: `SearchResultsRuleInput`. _Example: example\_1_ Payload 1 ``` { "searchResultsRules": [ { "type": "BidirectionalSynonym", "ruleDefinition": [ "shirt", "blouse", "top" ], "locales": [ "en_US" ] }, { "type": "UnidirectionalSynonym", "ruleDefinition": [ "jeans", "denim pants" ], "locales": [ "en_US" ] }, { "type": "BidirectionalSynonym", "ruleDefinition": [ "dress", "gown" ], "locales": [ "en_GB" ] } ] } ``` #### Responses * **200** _Include Search Rule_ Include search rule. Media type: `application/json`. Schema: `SearchResultsRuleOutput`. ### PUT Commerce Management Webstore Search, Include Rule `PUT /commerce/management/webstores/{webstoreId}/search/results-rules/{ruleId}` Operation ID: `putCommerceSearchResultRuleManagement`. Tags: Commerce B2B Resources. Connect API resources for managing a single Search result rule Update a single search include rule for a web store. _Available in: v66.0_ #### Parameters * `ruleId` (path, string (Id), required) ID of the rule. Pattern: ^(3d8)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Include search rule input. Media type: `application/json`. Schema: `SearchResultsRuleInput`. _Example example\_1: same as POST /commerce/management/webstores/{webstoreId}/search/results-rules request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Include Search Rule_ Include search rule. Media type: `application/json`. Schema: `SearchResultsRuleOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/management/webstores/0ZExx000000005rGAA/search/results-rules/ruleId Content-Type: application/json { "searchResultsRules": [ { "type": "BidirectionalSynonym", "ruleDefinition": [ "shirt", "blouse", "top" ], "locales": [ "en_US" ] }, { "type": "UnidirectionalSynonym", "ruleDefinition": [ "jeans", "denim pants" ], "locales": [ "en_US" ] }, { "type": "BidirectionalSynonym", "ruleDefinition": [ "dress", "gown" ], "locales": [ "en_GB" ] } ] } ``` ### DELETE Commerce Management Webstore Search, Include Rule `DELETE /commerce/management/webstores/{webstoreId}/search/results-rules/{ruleId}` Operation ID: `deleteCommerceSearchResultRuleManagement`. Tags: Commerce B2B Resources. Connect API resources for managing a single Search result rule Delete a single search include rule for a web store. _Available in: v66.0_ #### Parameters * `ruleId` (path, string (Id), required) ID of the rule. Pattern: ^(3d8)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **204** _Successful Delete_ Success ### GET Commerce Management Webstore Search, Sort Rules `GET /commerce/management/webstores/{webstoreId}/search/sort-rules` Operation ID: `getCommerceSearchSortRulesManagement`. Tags: Commerce B2B Resources. Resource to retrieve all sort rules for a webstore for an admin. Retrieve sort rules for a webstore. _Available in: v54.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Sort Rules Collection_ Collection of sort rules. Media type: `application/json`. Schema: `SortRulesCollection`. ### PUT Commerce Management Webstore Search, Sort Rules `PUT /commerce/management/webstores/{webstoreId}/search/sort-rules` Operation ID: `putCommerceSearchSortRulesManagement`. Tags: Commerce B2B Resources. Resource to retrieve all sort rules for a webstore for an admin. Create sort rules for a webstore. _Available in: v54.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Sort rules input collection information an admin can use to create sort rules for a webstore. Media type: `application/json`. Schema: `SortRulesCollectionInput`. _Example: example\_1_ Payload 1 ``` { "sortRules": [ { "type": "ProductBased", "sortStandardField": "Stock_Keeping_Unit", "direction": "Ascending", "labelSuffix": "Asc", "sortOrder": "1" } ] } ``` #### Responses * **200** _Sort Rules Collection_ Collection of sort rules. Media type: `application/json`. Schema: `SortRulesCollection`. ### POST Commerce Webstore Product Search `POST /commerce/webstores/{webstoreId}/search/product-search` Operation ID: `postProductSearch`. Tags: Commerce B2B Resources. Resource to perform product searches in a webstore. Search products. Searching products respects buyer View Product entitlements and only users entitled to view product data can access this resource. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ **Note**: In API version 58.0, this resource was superseded by the [Commerce Webstore Search Products](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getCommerceProductSearch) GET endpoint. To access the latest API features past version 58.0, we recommend using the GET endpoint. For example, only the GET endpoint can return product variation information or query a subset of searchable fields. **Note:** POST methods typically create an item, but for this resource POST is used to retrieve information. GET calls can be cached. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v49.0_ #### Request body Product search. _Available in: v49.0_ Media type: `application/json`. Schema: `ProductSearchInput`. #### Responses * **200** _Product Search Results_ Product search results. Media type: `application/json`. Schema: `ProductSearchResults`. #### Code samples _Example: Example 1 · HTTP_ ``` { "searchTerm": "lightweight", "categoryId": "0ZGxx000000006TGAQ", //categoryId for women’s running shoes "refinements": [ { "attributeType": "Custom", "nameOrId": "Color__c", "values": ["red", "blue"], "type": "DistinctValue" }, { "attributeType": "Custom", "nameOrId": "Size__c", "values": ["5"], "type": "DistinctValue" } ], "fields": ["Name", "Description", "StockKeepingUnit", "Size__c", "Arch__c"], "grouping": { "groupingOption": "VariationParent" }, "page" : 0, "pageSize" : 25} ``` ### GET Commerce Webstore Search Products `GET /commerce/webstores/{webstoreId}/search/products` Operation ID: `getCommerceProductSearch`. Tags: Commerce B2B Resources. Search for products by search term or category in a webstore. Search products by search term or category in a webstore. _Available in: v58.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `categoryId` (query, string) Category ID returns results for products in this category or its subcategories. Required if `searchTerm` isn’t specified _Available in: v58.0_ * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v58.0_ * `effectiveBuyerGroupIds` (query, array of string) List containing an ID of the buyer group for which the request is made. This parameter accepts only a single ID in the list. _Available in: v62.0_ * `fields` (query, array of string, required) Product fields to return in search results. Search results include fields you have access to. _Available in: v58.0_ * `grouping` (query, string) Grouping option for search results. If unspecified, the default is the value specified in **Search** **Results Display Settings** **Results Grouping**. Values are: * `NoGrouping` —Search results aren’t grouped. * `VariationParent` —Search results are grouped by the variation parent. _Available in: v58.0_ * `includeProductVariationInfo` (query, boolean) Specifies whether to include product variation information in search results (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v63.0_ * `includeQuantityRule` (query, boolean) Specifies whether to include purchase quantity rule information for products in search results (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v58.0_ * `page` (query, integer) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. _Available in: v58.0_ * `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 200. If unspecified, defaults to 20. When multiplying the `page` and `pageSize` property values together, they can’t exceed 5000. For example, for a `pageSize` of 20, you can specify a `page` value up to 250. _Available in: v58.0_ * `refinements` (query, string) List up to nine refinements (facets) for search results. Buyers or shoppers can select up to 20 values for each distinct value refinement, as well as minimum or maximum values for a range refinement. The `refinements` parameter is encoded as a Base64 string from the JSON representation of the Distinct Value Refinement Input or Range Refinement Input. _Available in: v58.0_ * `searchFields` (query, array of string) The subset of searchable fields to search. Only the fields specified in this parameter are searched. If you don't specify this parameter, or if the fields specified are invalid, all searchable fields are searched. To use the `searchFields` parameter, you must also specify the `searchTerm` parameter. The variation attribute field is not supported by the `searchFields` parameter. _Available in: v62.0_ * `searchTerm` (query, string) List of up to 32 space-separated search terms. Required if `categoryId` isn’t specified _Available in: v58.0_ * `skipDecoration` (query, boolean) * `sortRuleId` (query, string) ID of the sort rule that specifies the order of products in the search results. If unspecified, the default sort type is relevancy. _Available in: v58.0_ #### Responses * **200** _Commerce Product Search Results_ Product search results. Media type: `application/json`. Schema: `CommerceProductSearchResults`. ### GET Commerce Webstore Search, Sort Rules `GET /commerce/webstores/{webstoreId}/search/sort-rules` Operation ID: `getCommerceSearchSortRules`. Tags: Commerce B2B Resources. Resource to retrieve sort rules for a webstore on the live index. Get sort rules for the live index. _Available in: v52.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Sort Rules Collection_ Collection of sort rules. Media type: `application/json`. Schema: `SortRulesCollection`. ### GET Commerce Webstore Product Search Suggestions `GET /commerce/webstores/{webstoreId}/search/suggestions` Operation ID: `getProductSearchSuggestions`. Tags: Commerce B2B Resources. Resource to get suggestions for product searches in a webstore. Get suggestions for product searches. _Available in: v52.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v52.0_ * `includeSuggestedProducts` (query, boolean) Specifies whether a search term returns product suggestions (`true`) or not (`false`). If unspecified, defaults to `false`. If `true`, the service returns the suggested product IDs. _Available in: v58.0_ * `includeSuggestedTerms` (query, boolean) Specifies whether a request returns search term suggestions (`true`) or not (`false`). If unspecified, defaults to `true`. The value returned can include recent or popular term suggestions. At least one of `includeSuggestedTerms` or `includeSuggestedProducts` must be set to `true`. _Available in: v64.0_ * `maxResults` (query, integer) Maximum number of suggestions. Values are from 1 through 10. If unspecified, defaults to 10. _Available in: v52.0_ * `maxSuggestedProducts` (query, integer) Maximum number of product suggestions. Values are from 1 through 10. If unspecified, defaults to 6. _Available in: v58.0_ * `popularProductsCategoryId` (query, string) ID of the category that identifies a store's popular products. This category can be configured on the search input component. If `popularProductsCategoryId` is populated, the search term for a request is empty, and `includeSuggestedProducts` is `true`, product suggestions are returned from the specified category. If a search term is specified, `popularProductsCategoryId` is ignored and suggestions are based on the search term instead. _Available in: v64.0_ * `searchTerm` (query, string) Search term with up to 100 characters. If specified, the service returns autocomplete suggestions from the user’s recent searches. If unspecified, the service returns suggestions from the user’s recent searches. _Available in: v52.0_ * `suggestedFields` (query, array of string) List of field names recommended for inclusion in the response based on the search context. _Available in: v49.0_ #### Responses * **200** _Product Search Suggestions Results_ Product search suggestions results. Media type: `application/json`. Schema: `ProductSearchSuggestionsResults`. ### POST Commerce Webstore Promotions, Coupon Code Redemption, Decrease `POST /commerce/promotions/actions/decrease-use/coupon-codes` Operation ID: `postCouponCodeRedemptionDecreaseUse`. Tags: Commerce B2B Resources. Coupon Code Redemption Decrease Use Resource Get coupon code redemption usage to revert a previously redeemed coupon code. For example, use when an item that used a coupon code is returned so that the coupon code can be reverted. _Available in: v58.0_ #### Request body Input representation for coupon code redemption. Media type: `application/json`. Schema: `CouponCodeRedemptionInput`. _Example: example\_1_ Payload 1 ``` { "couponCodes": [ "code1", "code2", "code3", "code4" ], "transactionId": "0a6D20000004CETIA2", "buyer": "001xx000003GZ6NAAW" } ``` #### Responses * **200** _Coupon Code Redemption Collection_ Collection of coupon code redemption results. Media type: `application/json`. Schema: `CouponCodeRedemptionCollection`. ### POST Commerce Webstore Promotions, Evaluate Action `POST /commerce/promotions/actions/evaluate` Operation ID: `postPromotionEvaluationHS`. Tags: Commerce B2B Resources. Promotion Evaluation High Scale Resource Determine which promotions the customer is eligible for based on the store and buyer group, and compute the applicable price adjustments based on the coupons and the items in the cart. This API evaluates only the first 50 active manual promotions and first 50 active automatic promotions, based on priority. This API computes and returns applicable price adjustments, but it does not apply those adjustments to the webcart record. If you want to enable promotions based on shipping, contact Salesforce Customer Support. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v56.0_ #### Request body Find promotions that the customer is eligible for and compute their discounts. Media type: `application/json`. Schema: `PromotionEvaluationHSInput`. _Example: example\_1_ Payload 1 ``` { "cart": { "cartDeliveryGroups": [ { "cartDeliveryGroupId": "0a7xx000000001dAAA", "cartDeliveryGroupMethods": [ { "cartDeliveryMethodId": "2Dmxx0000004MMuCAM", "price": "25.00" }, { "cartDeliveryMethodId": "2Dmxx0000004MMuCAG", "price": "25.00" } ] } ], "currencyIsoCode": "USD", "id": "3z6xx000000001eAAA", "cartAdjustmentGroups": [ { "id": "0m9xx0000006j3SAAQ", "cartId": "3z6xx000000001eAAA", "priceAdjustmentCauseId": "0c8xx0000000001AAA", "adjustmentDescription": "test", "priority": 2, "adjustmentType": "AdjustmentPercentage", "adjustmentValue": -10, "baseAmount": -1.8, "adjustmentBasisReference": null } ], "cartItems": [ { "id": "01txx0000006i2SAAQ", "type": "Product", "product2Id": "01txx0000006i2SAAQ", "sku": null, "quantity": 1, "salesPrice": 20, "totalNetAmount": 18, "cartDeliveryGroupId": "0a7xx000000001dAAA", "cartItemPriceAdjustments": [ { "id": "0U1xx0000006f1DCAQ", "cartItemId": "01txx0000006i2SAAQ", "priceAdjustmentCauseId": "0c8xx0000000001AAA", "priority": 1, "adjustmentDescription": null, "adjustmentType": "AdjustmentAmount", "adjustmentAmountScope": "Total", "adjustmentTargetType": "Item", "adjustmentBasisReference": null, "baseAmount": -2, "adjustmentValue": -2 } ] } ] }, "couponCodes": [], "effectiveAccountId": null, "webStoreId": "0ZExx0000000002GAA", "isItemizeHeaderAdjustments": "false", "scope": "Delivery" } ``` #### Responses * **200** _Promotion Evaluation_ Results of a promotion evaluation. Media type: `application/json`. Schema: `PromotionEvaluationHS`. ### POST Commerce Webstore Promotions, Evaluate Products Action `POST /commerce/promotions/actions/evaluate-products` Operation ID: `postPromotionProductEvaluation`. Tags: Commerce B2B Resources. Promotion Product Evaluation Resource Determine which promotions apply to a product or set of products, and compute the applicable price adjustments. This API evaluates discrete products, including product variants and independent products but not parent products. Domain dependent and independent use cases are both supported. For example, a domain dependent call uses `webstoreId` and `effectiveAccountId` to evaluate products in a cart based on internal products or product categories. A domain independent call uses an external dataset based on SKUs or product categories. _Available in: v58.0_ #### Request body Finds promotions that products are eligible for and computes the discounts. Supports domain dependent requests based on `webstoreId` and `effectiveAccountId`, or domain independent requests using an external dataset based on SKUs or product categories. Media type: `application/json`. Schema: `PromotionProductEvaluationInput`. _Example: example\_1_ Payload 1 (domain dependent evaluation) ``` { "products": [ { "productId": "01txx000000001dAAA", "salesPrice": "60" }, { "productId": "01txx000000001dABB", "salesPrice": "50" } ], "effectiveAccountId": "3K0xx0000004CAeCAM", "webStoreId": "0ZExx000000001dGAA" } ``` _Example: example\_2_ Payload 2 (domain independent evaluation) ``` { "products": [ { "sku": "sku_1", "salesPrice": "60" }, { "sku": "sku_2", "salesPrice": "50" } ], "productCategories": { "sku_1": [ "category_1" ], "sku_2": [ "category_2" ] }, "segments": [ "segment1", "segment2" ] } ``` #### Responses * **200** _Promotion Product Evaluation_ Results of a promotion product evaluation. Media type: `application/json`. Schema: `PromotionProductEvaluationResults`. ### POST Commerce Webstore Promotions, Coupon Code Redemption, Increase `POST /commerce/promotions/actions/increase-use/coupon-codes` Operation ID: `postCouponCodeRedemptionIncreaseUse`. Tags: Commerce B2B Resources. Coupon Code Redemption Increase Use Resource Get coupon code redemption addition (increase) usage. _Available in: v58.0_ #### Request body Input representation for coupon code redemption. Media type: `application/json`. Schema: `CouponCodeRedemptionInput`. _Example: example\_1_ Payload 1 ``` { "couponCodes": [ "code1", "code2", "code3", "code4" ], "transactionId": "0a6D20000004CETIA2", "buyer": "001xx000003GZ6NAAW" } ``` #### Responses * **200** _Coupon Code Redemption Collection_ Collection of coupon code redemption results. Media type: `application/json`. Schema: `CouponCodeRedemptionCollection`. ### GET Commerce Webstore Composite Promotions `GET /commerce/promotions/composite-promotions` Operation ID: `getCompositePromotion`. Tags: Commerce B2B Resources. Composite Promotion Resource Retrieve the details of a specified promotion. _Available in: v58.0_ #### Parameters * `promotionId` (query, string) ID of the promotion record associated with the store. This is a required field if `templateId` and `webstoreId` aren’t specified. _Available in: v62.0_ * `templateId` (query, string) Unique Identifier for the template. If specified, the API returns the promotion data related to the template ID. _Available in: v62.0_ * `webstoreId` (query, string) ID of the store. This field is required if `templateId` is specified. _Available in: v62.0_ #### Responses * **200** _Composite Promotion_ Output representation of the composite promotion information. Media type: `application/json`. Schema: `CompositePromotion`. _Example: example\_1_ Payload 1 ``` { "name": "Buy Tennis racquet, and tennis shoes get 20% off and buy minimum of 2 tennis balls get 10% off", "description": "Buy Tennis racquet, and tennis shoes get 20% off and buy minimum of 2 tennis balls get 10% off", "currencyIsoCode": "USD", "areQualItemsExclFromDiscounts": true, "discountOrder": "MostExpensive", "discountRestriction": "None", "active": false, "MaximumUsageCount": 1, "PriorityNumber": null, "IsTiered": false, "Objective": "Upsell tennis products", "IsAutomatic": false, "startDateTime": "2022-05-09T20:00:00.000+0000", "endDateTime": "2022-05-17T19:00:00.000+0000", "displayName": { "default": "Buy Tennis racquet, and tennis shoes get 20% off and buy minimum of 2 tennis balls get 10% off", "translations": [ { "fr": "Achetez un p1, p2 ou p3, obtenez un 2e produit à 20 % de réduction" }, { "de": "Kaufen Sie ein p1, p2 oder p3 und erhalten Sie 20 % Rabatt auf ein zweites Produkt" } ] }, "termsAndConditions": { "default": "Buy Tennis racquet, and shoes get 20% off and buy tennis balls get 10% off", "translations": [ { "fr": "Achetez un p1, p2 ou p3, obtenez un 2e produit à 20 % de réduction, jusqu'à épuisement des stocks" }, { "de": "Kaufen Sie ein p1, p2 oder p3 und erhalten Sie 20% Rabatt auf ein zweites Produkt, solange der Vorrat reicht" } ] }, "qualifiers": [ { "qualifierType": "Quantity", "qualifierValue": "3", "currencyIsoCode": "USD", "qualifierReference": [ { "name": "Tennis racquet", "id": "ODDD12323432423", "itemReferenceType": "Product", "operatorType": "EQUALS_TO" }, { "name": "Tennis shoes", "id": "ODDD123234323422", "itemReferenceType": "Product", "operatorType": "EQUALS_TO" } ] }, { "qualifierType": "Amount", "qualifierValue": "100", "currencyIsoCode": "USD", "qualifierReference": [ { "name": "Tennis Balls", "id": "ODDD12323432423", "itemReferenceType": "Product", "operatorType": "EQUALS_TO" } ] } ], "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "20", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY_REQUIRED", "targetReferences": [ { "id": "ODDD12323432423", "itemReferenceType": "Product", "name": "Tennis racquet", "operatorType": "EQUAL_TO" } ] }, { "adjustmentType": "PercentageDiscount", "adjustmentValue": "10", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY_REQUIRED", "targetReferences": [ { "id": "ODDD12323432423", "itemReferenceType": "Product", "name": "Tennis Balls", "operatorType": "EQUAL_TO" } ] } ], "segments": [ { "webstoreId": "0ZExx0000000085GAA", "webstoreName": "ABC Store" } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v62.0​/commerce/promotions/composite-promotions?promotionId=ARDG76987698 https://yourInstance.salesforce.com/services/data/v62.0​/commerce/promotions/composite-promotions?webstoreId=ARDG76987698&templateId=10OFF ``` ### POST Commerce Webstore Composite Promotions `POST /commerce/promotions/composite-promotions` Operation ID: `postCompositePromotion`. Tags: Commerce B2B Resources. Composite Promotion Resource Create a new promotion and all of the associated objects, including segments, qualifiers, targets, and translations. The API returns the ID of the created promotion. _Available in: v58.0_ #### Request body Input representation of the create promotion request. Media type: `application/json`. Schema: `CompositePromotionInput`. _Example: example\_1_ Payload 1 ``` { "active": false, "areQualItemsExclFromDiscounts": false, "currencyIsoCode": "USD", "description": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack'", "discountOrder": "MostExpensive", "discountRestriction": "None", "displayName": { "translations": {}, "value": "Fall Promotion" }, "objective": "Upsell product in fall", "isTiered": true, "endDateTime": null, "exclusivityType": "Class", "maximumUsageCount": 1, "name": "Fall Promotion", "priorityNumber": null, "qualifierCriteria": "All", "segments": [ { "id": "0ZESB0000006vja4AA", "name": "Codecept B2B LWR Store", "segmentType": "Webstore" } ], "startDateTime": "2023-09-01T00:00:00Z", "targetCriteria": "Any", "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "10", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY", "targetReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ] } ], "qualifiers": [ { "currencyIsoCode": "USD", "qualifierReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ], "qualifierType": "Quantity", "qualifierValue": 2 } ], "termsAndCondition": { "translations": {}, "value": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack." } } ``` _Example: example\_2_ Payload 2 ``` { "active": false, "areQualItemsExclFromDiscounts": false, "currencyIsoCode": "USD", "description": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack'", "discountOrder": "MostExpensive", "discountRestriction": "None", "displayName": { "translations": {}, "value": "Fall Promotion" }, "objective": "Upsell product in fall", "isTiered": true, "endDateTime": null, "exclusivityType": "Class", "maximumUsageCount": 1, "name": "Fall Promotion", "priorityNumber": null, "qualifierCriteria": "All", "segments": [ { "id": "0ZESB0000006vja4AA", "name": "Codecept B2B LWR Store", "segmentType": "Webstore" } ], "startDateTime": "2023-09-01T00:00:00Z", "targetCriteria": "Any", "coupon": [ { "couponCode": "FALL", "redemptionLimitAllBuyers": 5, "redemptionLimitPerBuyer": 2 }, { "couponCode": "FALL1", "redemptionLimitAllBuyers": 5, "redemptionLimitPerBuyer": 2 } ], "tiers": [ { "name": "Tier 1", "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "10", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY_REQUIRED", "targetReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ] } ], "qualifiers": [ { "currencyIsoCode": "USD", "qualifierReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ], "ruleCriteriaType": "ANY_REQUIRED", "qualifierType": "Quantity", "qualifierValue": 2 } ] }, { "name": "Tier 2", "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "20", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY_REQUIRED", "targetReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUAL_TO" } ] } ], "qualifiers": [ { "currencyIsoCode": "USD", "qualifierReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ], "ruleCriteriaType": "ANY_REQUIRED", "qualifierType": "Quantity", "qualifierValue": 3 } ] } ], "termsAndCondition": { "translations": {}, "value": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack'" } } ``` #### Responses * **200** _Composite Promotion Result_ Output representation of composite promotion create request. Media type: `application/json`. Schema: `CompositePromotionResult`. _Example: example\_1_ Payload 1 ``` { "promotionId": "0c8RO0000000veWYAQ", "success": true, "errors": [] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/promotions/composite-promotions Content-Type: application/json { "active": false, "areQualItemsExclFromDiscounts": false, "currencyIsoCode": "USD", "description": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack'", "discountOrder": "MostExpensive", "discountRestriction": "None", "displayName": { "translations": {}, "value": "Fall Promotion" }, "objective": "Upsell product in fall", "isTiered": true, "endDateTime": null, "exclusivityType": "Class", "maximumUsageCount": 1, "name": "Fall Promotion", "priorityNumber": null, "qualifierCriteria": "All", "segments": [ { "id": "0ZESB0000006vja4AA", "name": "Codecept B2B LWR Store", "segmentType": "Webstore" } ], "startDateTime": "2023-09-01T00:00:00Z", "targetCriteria": "Any", "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "10", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY", "targetReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ] } ], "qualifiers": [ { "currencyIsoCode": "USD", "qualifierReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ], "qualifierType": "Quantity", "qualifierValue": 2 } ], "termsAndCondition": { "translations": {}, "value": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack." } } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/promotions/composite-promotions Content-Type: application/json { "active": false, "areQualItemsExclFromDiscounts": false, "currencyIsoCode": "USD", "description": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack'", "discountOrder": "MostExpensive", "discountRestriction": "None", "displayName": { "translations": {}, "value": "Fall Promotion" }, "objective": "Upsell product in fall", "isTiered": true, "endDateTime": null, "exclusivityType": "Class", "maximumUsageCount": 1, "name": "Fall Promotion", "priorityNumber": null, "qualifierCriteria": "All", "segments": [ { "id": "0ZESB0000006vja4AA", "name": "Codecept B2B LWR Store", "segmentType": "Webstore" } ], "startDateTime": "2023-09-01T00:00:00Z", "targetCriteria": "Any", "coupon": [ { "couponCode": "FALL", "redemptionLimitAllBuyers": 5, "redemptionLimitPerBuyer": 2 }, { "couponCode": "FALL1", "redemptionLimitAllBuyers": 5, "redemptionLimitPerBuyer": 2 } ], "tiers": [ { "name": "Tier 1", "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "10", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY_REQUIRED", "targetReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ] } ], "qualifiers": [ { "currencyIsoCode": "USD", "qualifierReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ], "ruleCriteriaType": "ANY_REQUIRED", "qualifierType": "Quantity", "qualifierValue": 2 } ] }, { "name": "Tier 2", "targets": [ { "adjustmentType": "PercentageDiscount", "adjustmentValue": "20", "currencyIsoCode": "USD", "isMinItemCountRequired": false, "restrictionQuantity": null, "ruleCriteriaType": "ANY_REQUIRED", "targetReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUAL_TO" } ] } ], "qualifiers": [ { "currencyIsoCode": "USD", "qualifierReferences": [ { "id": "01tSB0000002p01YAA", "itemReferenceType": "Product", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "operatorType": "EQUALS_TO" } ], "ruleCriteriaType": "ANY_REQUIRED", "qualifierType": "Quantity", "qualifierValue": 3 } ] } ], "termsAndCondition": { "translations": {}, "value": "This is fall promotion.Get 10% off on Product 'Alpine Energy Drink Chai Post 0.5L PET - 6 pack'" } } ``` ### GET Commerce Webstore Application Context `GET /commerce/webstores/{webstoreId}/application-context` Operation ID: `getApplicationContext`. Tags: Commerce B2B Resources. Returns application context information for the current WebStore Get application context information for a Commerce store. _Available in: v54.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Application Context_ Application context for a Commerce store. Media type: `application/json`. Schema: `ApplicationContext`. _Example: example\_1_ Payload 1 ``` { "cartCalculateEnabled": true, "checkoutSettings": { "isManagedCheckoutEnabled": false, "isMngCheckoutAutoPublished": true, "paymentConfiguration": { "businessAchEnabled": false, "paymentMethodManualCaptureEnabled": false, "paymentMethodSetDevName": "" }, "shippingMethodsEnabled": true }, "country": "US", "defaultCurrency": "USD", "giftingConfig": { "isGiftMessageEnabled": false, "isGiftWrapEnabled": false, "isGiftingEnabled": false }, "guestBrowsingEnabled": false, "guestCartCheckoutEnabled": true, "guestCartEnabled": true, "guestCheckoutEnabled": true, "inventoryConfiguration": { "isInventoryEnabled": false }, "managedCheckoutVersion": "0.117.0", "markets": [], "orderStatuses": [ { "apiName": "Created", "displayValue": "Created" } ], "placeOrderV2Enabled": true, "productConfig": { "configuratorFlowApiName": "Commerce_Product_Configurator_Flow" }, "propertiesEx": { "shopperCopilotUIEnabled": false, "highScaleCartEnabled": false }, "sessionDrivenCurrency": true, "shippingCountries": [ "US" ], "shopperConsentEnabled": false, "skipPhoneNumberValidationEnabled": false, "splitShipmentEnabled": false, "subscriptionConfig": { "commerceSubscriptionARCUIEnabled": false, "rlmSubscriptionEnabled": false, "subscriptionPlusEnabled": false }, "supportedCurrencies": [ "USD" ], "taxType": "Gross", "usesSingleEntitlementPolicy": false, "usesUniversalPricebooks": false } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZESG000002PLXz4AO/application-context ``` ### GET Commerce Webstore Session Context `GET /commerce/webstores/{webstoreId}/session-context` Operation ID: `getSessionContext`. Tags: Commerce B2B Resources. Returns session context information for the current WebStore Get session context information for a Commerce store. _Available in: v54.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) #### Responses * **200** _Session Context_ Session context for a shopper using a Commerce store. Media type: `application/json`. Schema: `SessionContext`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/webstoreId/session-context ``` ### GET Shipping Profiles `GET /commerce/webstores/{webstoreId}/shipping-profiles` Operation ID: `getCommerceShippingProfileCollection`. Tags: Commerce B2B Resources. Commerce Shipping Profile collection Resource Retrieve a list of native shipping profiles for a webstore. Currently, this API returns only one shipping profile, which is the default shipping profile of a webstore. _Available in: v62.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Shipping Profile Collection_ Output representation of the shipping profile collection. Media type: `application/json`. Schema: `ShippingProfileCollection`. _Example: example\_1_ Payload 1 ``` { "count": 1, "total": 1, "items": [ { "id": "7LAxxxxxxxxxx1", "name": "General Shipping Profile", "isDefault": true, "ShippingRateGroups": [ { "id": "8Ni000000000001", "name": "Shipping rate group 1", "shippingZones": [ { "Id": "12h000000000100", "countries": [ { "isoCode": "US", "label": "United States" }, { "isoCode": "CA", "label": "Canada" } ], "StandardShippingRates": [ { "conditionFactor": "ORDER_PRICE", "conditionRangeMax": 50, "conditionRangeMin": 0, "currencyIsoCode": "USD", "id": "5fy000000000001", "name": "ShippingRate1", "price": 10, "transitTimeMax": 5, "transitTimeMin": 2, "transitTimeUnit": "days", "weightUnit": "Pounds" }, { "conditionFactor": "ORDER_PRICE", "conditionRangeMax": 50, "conditionRangeMin": 10, "currencyIsoCode": "USD", "id": "5fy000000000002", "name": "ShippingRate2", "price": 5, "transitTimeMax": 5, "transitTimeMin": 2, "transitTimeUnit": "days", "weightUnit": "Pounds" } ] } ] } ] } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZESG000001E9aj4AC/shipping-profiles ``` ### POST Commerce Webstore Calculate Taxes `POST /commerce/webstores/{webstoreId}/taxes/actions/calculate-taxes` Operation ID: `postCalculateTaxes`. Tags: Commerce B2B Resources. Resource endpoint to Calculate Taxes for Commerce Calculate taxes for a Commerce webstore. _Available in: v58.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) #### Request body Calculate tax input. Media type: `application/json`. Schema: `CalculateTaxesInput`. _Example: example\_1_ Payload 1 ``` { "currencyIsoCode": "USD", "calculatebyTaxClass": false, "lineItemGroups": [ { "shipToAddress": { "countryIsoCode": "US", "stateIsoCode": "CA" }, "lineItems": [ { "lineId": "lineId1", "productId": "01txx0000006pTkAAI", "quantity": "1", "unitPrice": "100", "totalPrice": "100", "adjustments": [ { "id": "lineAdjustment1", "type": "promotional", "amount": "-10" }, { "id": "lineAdjustment2", "type": "tiered", "amount": "-5" } ] }, { "lineId": "lineId2", "productId": "01txx0000006pTlAAI", "quantity": "4", "unitPrice": "50", "totalPrice": "50" } ] } ] } ``` #### Responses * **200** _Calculate Taxes_ List tax classes. Media type: `application/json`. Schema: `CalculateTaxes`. ### GET Commerce Webstore Taxes `GET /commerce/webstores/{webstoreId}/taxes/products/{productId}` Operation ID: `getGetStoreTaxesInfo`. Tags: Commerce B2B Resources. Resource endpoint to get Store Taxes Info Get taxes for a product based on the store, state, country, and buyer account or guest profile ID. _Available in: v56.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `productId` (path, string (Id), required) ID of the product. Pattern: ^(01t)\\w\*. * `countryIsoCode` (query, string, required) ISO code of the country. Must match one of the valid ISO codes defined within the org’s State-Country picklist. For example, US for United States. If unspecified, the default value is the default country for the webstore. _Available in: v56.0_ * `effectiveAccountId` (query, string, required) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v56.0_ * `stateIsoCode` (query, string) ISO code of the state. Must match one of the valid ISO codes defined within the org’s State picklist. For example, CA for California state. _Available in: v56.0_ #### Responses * **200** _Store Taxes Info_ Output representation of the tax type along with a collection of tax details about a product. Media type: `application/json`. Schema: `GetStoreTaxesInfo`. _Example: example\_1_ Payload 1 ``` { "taxLocaleType": "Gross", "taxesInfo": { "01tPI0000003fLBYAY": { "taxesInfoList": [ { "countryIsoCode": "US", "priority": 1, "stateIsoCode": "CA", "taxRatePercentage": "10.00", "taxTreatmentDescription": "Created for test purposes.", "taxTreatmentName": "Default Tax treatment" } ] } } } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZEPI0000000j8Q4AQ/taxes/products/01tPI0000003fLBYAY?effectiveAccountId=001PI0000025YckYAE&countryIsoCode=US&stateIsoCode=CA ``` ### POST Commerce Webstore Composite Products, Create `POST /commerce/management/webstore/{webstoreId}/composite-products` Operation ID: `postCompositeCommerceProductCreate`. Tags: Commerce B2B Resources. Create Composite Commerce Product and associate with given Categories, Media etc. Add a product to your store and associate it with the specified category and media records. When a store is created, these default records are automatically created: DefaultBuyerGroupId (maps to: [BuyerGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyergroup.htm)), DefaultEntitlementPolicyId (maps to: CommerceEntitlementPolicy), DefaultManagedContentSpaceId (maps to: [ManagedContentSpace](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_managedcontentspace.htm)), DefaultPriceBookId (maps to: [PriceBook2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebook2.htm)), DefaultProductCatalogId (maps to: [ProductCatalog](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_productcatalog.htm)), and DefaultStrikeThroughPricebookId (maps to: [PriceBook2](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_pricebook2.htm)). This API works within the store's context, so when you make a create request, it automatically associates the product to default buyer group, entitlement policy, and price book records created during store setup, along with the current store's catalog. It also associates the specified category and media in the request. This streamlines product creation and enhances the efficiency of your online retail tasks. If the API faces a problem associating the product to any store default records, it won't add the product with incomplete default store records. Instead, it cancels the product addition and rollbacks the creation request. **Note**: Currently, you can’t modify the default association of the product with these default records created during the store’s setup. _Available in: v61.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Input representation of the composite product create request. Media type: `application/json`. Schema: `CompositeCommerceProductInput`. #### Responses * **200** _Composite Product_ Representation of the composite product create or upsert request. Media type: `application/json`. Schema: `CompositeCommerceProductOutput`. _Example: example\_1_ Payload 1 Here’s an example if the request is successful: ``` { "productId": "generatedProductId123", "success": true, "error": [] } ``` _Example: example\_2_ Payload 2 Here's an example if the request has errors: ``` { "productId": null, "success": false, "errors": [ { "errorCode": "Invalid_Input", "message": "Failed to create/update the product" }, { "errorCode": "Invalid_Input", "message": "Failed to create/update the price" } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` { "productFields": { "Name": "Sample Product", "Type": "Base", // This is required when creating a variant parent "Description": "This is a sample product", "StockKeepingUnit": "110000", "CustomField1__c": 9999, "CustomField2__c": "some custom text" }, "categoryIds": [ "0ZGxx0000000007GAA", "0ZGxx0000000008GAA" ], "productMedia": [ { "mediaId": "20Yxx0000011QskEAE", "developerName": "productDetailImage" }, { "mediaId": "20Yxx0000011QslEAE", "developerName": "productListImage" } ], "attributeSetInfo": { "id": "0iYxx0000000001EAA", // present if using an existing set "name": "Apparel", // present if creating a new set "attributes": [ // present if creating a new set "Color__c", "Size__c" ] } } ``` ### PUT Commerce Webstore Composite Products, Update `PUT /commerce/management/webstore/{webstoreId}/composite-products/{productId}` Operation ID: `putCompositeCommerceProductUpdate`. Tags: Commerce B2B Resources. Update Composite Commerce Product and associations with given Categories, Media etc. Update an existing product record with the specified category and media records. When updating a product record, you need to include both the existing category and media records that are already linked to it, along with any new ones you want to add. For example, if a product record has two categories and three media records associated with it, the API will delete and then reinsert all the category and media records. If you don't specify the existing associated category and media records, the API removes their association with the product. _Available in: v61.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `productId` (path, string (Id), required) ID of the product. Pattern: ^(01t)\\w\*. #### Request body Input representation of the composite product create request. Media type: `application/json`. Schema: `CompositeCommerceProductInput`. #### Responses * **200** _Composite Product_ Representation of the composite product create or upsert request. Media type: `application/json`. Schema: `CompositeCommerceProductOutput`. _Example example\_2: same as POST /commerce/management/webstore/{webstoreId}/composite-products 200 response._ Payload 2 Here's an example if the request has errors: _Example: example\_1_ Payload 1 Here’s an example if the request is successful: ``` { "productId": "generatedProductId123", "success": true, "error": [] } ``` _Example: example\_2_ Payload 2 Here's an example if the request has errors: #### Code samples _Example: Example 1 · HTTP_ ``` { "productFields": { "Name": "Sample Product", "Type": "Base", // This is required when creating a variant parent "Description": "This is a sample product", "StockKeepingUnit": "110000", "CustomField1__c": 9999, "CustomField2__c": "some custom text" }, "categoryIds": [ "0ZGxx0000000007GAA", "0ZGxx0000000008GAA" ], "productMedia": [ { "mediaId": "20Yxx0000011QskEAE", "developerName": "productDetailImage" }, { "mediaId": "20Yxx0000011QslEAE", "developerName": "productListImage" } ], "attributeSetInfo": { "id": "0iYxx0000000001EAA", // present if using an existing set "name": "Apparel", // present if creating a new set "attributes": [ // present if creating a new set "Color__c", "Size__c" ] } } ``` ### POST Commerce Webstore Composite Product Variations, Create `POST /commerce/management/webstore/{webstoreId}/composite-variations` Operation ID: `postCompositeCommerceVariationUpsert`. Tags: Commerce B2B Resources. Create or Update variation products for a given variation parent with provided media and pricing. Create variation products with media and pricing details for a given parent product. _Available in: v62.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Input representation of product variation details. Media type: `application/json`. Schema: `CompositeCommerceVariationInput`. #### Responses * **200** _Composite Product Variation_ Composite product variation create request response. Media type: `application/json`. Schema: `CompositeCommerceVariationOutput`. ### GET Commerce Webstore Category Menu Items `GET /commerce/webstores/{webstoreId}/category-menu-items` Operation ID: `getCategoryMenuItem`. Tags: Commerce B2B Resources. Fetch product category menu items for the given parent item and store Retrieve product category menu items for the given parent item and store. _Available in: v64.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `addHomeMenuItem` (query, boolean) Indicates if a home menu item should be included. The default value is false. _Available in: v64.0_ * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v64.0_ * `includeImageUrl` (query, boolean) Indicates if the image URL should be included for root items. _Available in: v64.0_ * `maxItems` (query, integer) Maximum number of category items to be retrieved. _Available in: v64.0_ * `maxLevels` (query, integer) Maximum number of hierarchical levels to be retrieved. _Available in: v64.0_ * `publishStatus` (query, string) Publish status of the storefront. _Available in: v64.0_ #### Responses * **200** _Navigation Menu Item Collection_ Collection of navigation menu items. Media type: `application/json`. Schema: `NavigationMenuItemCollection`. ### GET Commerce Webstore Product Categories Children `GET /commerce/webstores/{webstoreId}/product-categories/children` Operation ID: `getProductCategoryCollection`. Tags: Commerce B2B Resources. Returns List of Product category information including fields and related media, etc based of the parent product category Id. Get product categories for a specific parent product category or get all the top-level product categories for the store. _Available in: v52.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v52.0_ * `excludeFields` (query, boolean) Specifies whether the fields are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v52.0_ * `excludeMedia` (query, boolean) Specifies whether the media groups and default images of the product are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v52.0_ * `fields` (query, array of string) Comma-separated list of field names. If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If `excludeFields` and `fields` are specified, the `excludeFields` parameter takes precedence. _Available in: v52.0_ * `mediaGroups` (query, array of string) Comma-separated list of developer names of media group records. If this list is empty or unspecified, all media groups are returned. If `excludeMedia` and `mediaGroups` are specified, the `excludeMedia` parameter takes precedence. _Available in: v52.0_ * `parentProductCategoryId` (query, string) ID of the product category for which you want to get all the children product categories. If unspecified, returns all the top-level product categories for the store. _Available in: v52.0_ #### Responses * **200** _Product Category Detail Collection_ Collection of product category details. Media type: `application/json`. Schema: `ProductCategoryDetailCollection`. ### GET Commerce Webstore Product Category `GET /commerce/webstores/{webstoreId}/product-categories/{productCategoryId}` Operation ID: `getCategoryView`. Tags: Commerce B2B Resources. Returns category information including fields and related media, etc. Get a product category. _Available in: v49.0_ #### Parameters * `productCategoryId` (path, string (Id), required) ID of the product category. Pattern: ^(0ZG)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v49.0_ * `excludeFields` (query, boolean) Specifies whether the fields are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v49.0_ * `excludeMedia` (query, boolean) Specifies whether the media groups of the category are returned ( `false` ) or not ( `true` ). If unspecified, defaults to `false` . _Available in: v49.0_ * `fields` (query, array of string) Comma-separated list of field names. If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If `excludeFields` and `fields` are specified, the `excludeFields` parameter takes precedence. _Available in: v49.0_ * `mediaGroups` (query, array of string) Comma-separated list of developer names of media group records. If this list is empty or unspecified, all media groups are returned. If `excludeMedia` and `mediaGroups` are specified, the `excludeMedia` parameter takes precedence. _Available in: v49.0_ #### Responses * **200** _Product Category Detail_ Details of a product category. Media type: `application/json`. Schema: `ProductCategoryDetail`. ### GET Commerce Webstore Product Category Path `GET /commerce/webstores/{webstoreId}/product-category-path/product-categories/{productCategoryId}` Operation ID: `getCategoryPath`. Tags: Commerce B2B Resources. Returns the category path from the root category to the current category. Get the product category path from the root category to the current category. Getting product category paths respects buyer View Product entitlements and only users entitled to view product data can access it. _Available in: v49.0_ #### Parameters * `productCategoryId` (path, string (Id), required) ID of the product category. Pattern: ^(0ZG)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string (Id)) #### Responses * **200** _Product Category Path_ List of product categories in a path. Media type: `application/json`. Schema: `ProductCategoryPath`. ### GET Commerce Webstore Products `GET /commerce/webstores/{webstoreId}/products` Operation ID: `getProductOverviewCollection`. Tags: Commerce B2B Resources. Used to fetch standard field data, custom field data, price and default image for a list of Products(20). Get fields and default images for a list of products. **Note**: Dynamic bundles are supported only in Commerce B2B stores. _Available in: v54.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v54.0_ * `excludeMedia` (query, boolean) Specifies whether default images are returned for the products ( `false` ) or not ( `true` ). The default is `false` . _Available in: v54.0_ * `fields` (query, array of string) Comma-separated list of field names to return for each product. If the list is empty or not specified, all fields are returned. You can specify any number of fields. _Available in: v54.0_ * `ids` (query, array of string (Id)) List of product IDs. Specify either a list of product IDs or SKUs, but not both. Either `ids` or `skus` is required, but not both. _Available in: v54.0_ * `includeAttributeSetInfo` (query, boolean) Indicates whether the attribute set information for the product is returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v63.0_ * `includeGroupByAttributeVariationInfo` (query, boolean) Indicates whether the attribute variation information for the product is returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v63.0_ * `includeProductSellingModels` (query, boolean) Indicates whether product selling model options are returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v63.0_ * `includeQuantityRule` (query, boolean) Indicates whether the quantity rule information for the product is returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v63.0_ * `noCache` (query, string) * `skus` (query, array of string) List of SKUs. Specify either a list of SKUs or product IDs, but not both. Either `skus` or `ids` is required, but not both. _Available in: v54.0_ * `excludePrices` (query, boolean) Specifies whether prices are returned for the products ( `false` ) or not ( `true` ). The default is `false` . In version 58 and later, prices aren’t returned for products regardless of this request parameter. To get pricing information for products in version 58.0 and later, use [Commerce Webstore Pricing Products](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getMultiProductPrice). _Available in: v54.0–57.0_ #### Responses * **200** _Product Overview Collection_ A collection of product overviews. Media type: `application/json`. Schema: `ProductOverviewCollection`. _Example: example\_1_ Payload 1 ``` { "products": [ { "defaultImage": { "alternateText": "variations-amazon.png", "contentVersionId": null, "id": "2pmSG000005olVVYAY", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "variations-amazon.png", "url": "/cms/delivery/media/MCVCHRIP72OVFIDPYX4R67HCC66U?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" }, "error": {}, "fields": { "LastModifiedDate": "2025-01-24T18:49:21Z", "DisplayUrl": null, "IsDeleted": "false", "Description": null, "ProductCode": null, "IsActive": "true", "ExternalId": null, "LastViewedDate": null, "UserRecordAccessId": null, "LastReferencedDate": null, "StockKeepingUnit": null, "CurrencyIsoCode": "USD", "Name": "color_size variation", "SystemModstamp": "2025-01-24T18:49:22Z", "IsArchived": "false", "Type": "Base", "CreatedById": "005SG00000CCGwX", "CloneSourceId": null, "QuantityUnitOfMeasure": null, "CreatedDate": "2025-01-24T18:49:21Z", "Family": null, "ProductClass": "VariationParent", "LastModifiedById": "005SG00000CCGwX" }, "id": "01tSG000003xbeXYAQ", "mediaGroups": [ { "developerName": "productListImage", "id": "2mgSG000000oceoYAA", "mediaItems": [ { "alternateText": "variations-amazon.png", "contentVersionId": null, "id": "2pmSG000005olVVYAY", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "variations-amazon.png", "url": "/cms/delivery/media/MCVCHRIP72OVFIDPYX4R67HCC66U?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" } ], "name": "Product List Image", "usageType": "Listing" } ], "name": "color_size variation", "productClass": "VariationParent", "isConfigurationAllowed": true, "success": true, "variationAttributeSet": { "apiName": "Color_Size", "attributes": [], "label": "Color_Size" }, "variationInfo": { "attributesToProductMappings": [ { "canonicalKey": "Blue_Large", "image": { "alternateText": "blue.png", "contentVersionId": null, "id": "2pmSG000005olX7YAI", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "blue.png", "url": "/cms/delivery/media/MCEOJ5CVZPPVEH5GZ7TJ2NUUUML4?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" }, "mediaItems": [ { "alternateText": "blue.png", "contentVersionId": null, "id": "2pmSG000005olX7YAI", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "blue.png", "url": "/cms/delivery/media/MCEOJ5CVZPPVEH5GZ7TJ2NUUUML4?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" }, { "alternateText": "Green.png", "contentVersionId": null, "id": "2pmSG000005olX7YAI", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "blue.png", "url": "/cms/delivery/media/MCEOJ5CVZPPVEH5GZ7TJ2NUUUML4?oid=00DSG00000EB40D&version=1.1&channelId=0apSG0000010zCk" } ], "productId": "01tSG000003xbg9YAA", "selectedAttributes": [ { "apiName": "Color__c", "label": "Color", "sequence": 0, "value": "Blue" }, { "apiName": "Size__c", "label": "Size", "sequence": 1, "value": "Large" } ], "urlName": null } ], "variationAttributeInfo": { "Color__c": { "allowableValues": [ "Blue", "Green", "Red" ], "apiName": "Color__c", "availableValues": [ "Blue", "Green", "Red" ], "fieldEnumOrId": "00NSG00000cFRYf", "groupedBy": false, "label": "Color", "objectName": "ProductAttribute", "options": [ { "apiName": "Blue", "colorHexCode": "#292FD3", "label": "Blue", "variantAvailable": true }, { "apiName": "Green", "colorHexCode": "#28E72C", "label": "Green", "variantAvailable": true }, { "apiName": "Red", "colorHexCode": "#ED1111", "label": "Red", "variantAvailable": true } ], "sequence": 0, "viewType": "ColorSwatch" }, "Size__c": { "allowableValues": [ "Large", "Medium", "Small" ], "apiName": "Size__c", "availableValues": [ "Large" ], "fieldEnumOrId": "00NSG00000cFRYg", "groupedBy": false, "label": "Size", "objectName": "ProductAttribute", "options": [ { "apiName": "Large", "colorHexCode": null, "label": "Large", "variantAvailable": true }, { "apiName": "Medium", "colorHexCode": null, "label": "Medium", "variantAvailable": false }, { "apiName": "Small", "colorHexCode": null, "label": "Small", "variantAvailable": false } ], "sequence": 1, "viewType": "Dropdown" } }, "variationCount": 3 } } ], "total": 1 } ``` _Example: example\_2_ Payload 2 ``` { "products": [ { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000010yAAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "Description": "One box of Alpine Energy Post Workout single serve, compostable Eco Pods. Chai Flavor.", "ProductCode": "r7832487624876423867", "Name": "Alpine Energy Post Eco Pod, Chai", "ProductClass": "VariationParent" }, "id": "01txx0000006mCXAAY", "name": "Alpine Energy Post Eco Pod, Chai", "productClass": "Simple", "isConfigurationAllowed": true, "productSellingModels": [ { "displayName": "PSM2", "id": "0jPxx000000001dEAA", "name": "PSM1", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined", "subscriptionTermRule": { "increment": 2, "maximum": 10, "minimum": 2 } } ], "purchaseQuantityRule": { "increment": "1.0", "maximum": "1.0E+8", "minimum": "1.0" }, "sku": "6010019", "success": true }, { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000010wAAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "Description": "A signature Alpine health and fitness beverage. This post-workout beverage with Chai flavor is designed to help athletes maximize recovery and gains. 0.5L PET", "Name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "Family": "Alpine Energy", "ProductClass": "VariationParent" }, "id": "01txx0000006mCWAAY", "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack", "productClass": "VariationParent", "productSellingModels": [ { "id": "0jPxx000000003FEAQ", "name": "PSM2", "pricingTerm": null, "pricingTermUnit": null, "sellingModelType": "OneTime" }, { "description": "<p>377834kajhsbfkhjdabf</p>", "displayName": "PSM", "id": "0jPxx000000001dEAA", "name": "PSM1", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined", "subscriptionTermRule": { "increment": 2, "maximum": 4, "minimum": 2 } } ], "purchaseQuantityRule": { "increment": "1.0", "maximum": "1.0E+8", "minimum": "1.0" }, "sku": "6010009", "Success": true, "variationAttributeSet": { "attributes": { "Size__c": null, "Color__c": null }, "developerName": "Apparel", "id": null }, "variationInfo": { "attributesToProductMappings": [ { "canonicalKey": "Blue_Large", "productId": "01txx0000006mNpAAI", "selectedAttributes": [ { "apiName": "Color__c", "label": "Color", "sequence": 0, "value": "Blue" }, { "apiName": "Size__c", "label": "Size", "sequence": 1, "value": "Large" } ], "urlName": null, "image": { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000012jAAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } }, { "canonicalKey": "Green_Medium", "productId": "01txx0000006mNqAAI", "selectedAttributes": [ { "apiName": "Color__c", "label": "Color", "sequence": 0, "value": "Green" }, { "apiName": "Size__c", "label": "Size", "sequence": 1, "value": "Medium" } ], "urlName": null, "image": { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000012jAAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } }, { "canonicalKey": "Red_Small", "productId": "01txx0000006mNrAAI", "selectedAttributes": [ { "apiName": "Color__c", "label": "Color", "sequence": 0, "value": "Red" }, { "apiName": "Size__c", "label": "Size", "sequence": 1, "value": "Small" } ], "urlName": null, "image": { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000012jAAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } } ], "variationAttributeInfo": { "Color__c": { "allowableValues": [ "Blue", "Green", "Red" ], "apiName": "Color__c", "availableValues": [ "Blue", "Green", "Red" ], "options": [ { "label": "Red", "api": "red__c", "color": "#FF0000", "isAvailable": true }, { "label": "Blue", "api": "blue__c", "color": "#0000FF", "isAvailable": true }, { "label": "Green", "api": "green__c", "color": "#0000FF", "isAvailable": false } ], "viewType": "ColorSwatch", "fieldEnumOrId": "00Nxx000001G3XI", "label": "Color", "objectName": "ProductAttribute", "sequence": 0 }, "Size__c": { "allowableValues": [ "Large", "Medium", "Small" ], "apiName": "Size__c", "availableValues": [ "Large", "Medium", "Small" ], "viewType": "DropDown", "options": [ { "label": "Large", "api": "Large__c", "isAvailable": true }, { "label": "Medium", "api": "Medium__c", "isAvailable": true }, { "label": "Small", "api": "Small__C", "isAvailable": true } ] }, "fieldEnumOrId": "00Nxx000001G3XJ", "label": "Size", "objectName": "ProductAttribute", "sequence": 1 }, "variationCount": 3 } }, { "error": { "errorCode": "PRODUCT_NOT_FOUND", "message": "You can't view 234423." }, "success": false } ], "total": 3 } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000004rGAA/products ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000004rGAA/products?effectiveAccountId=${accountId}&excludePrices=${true}&excludeMedia=${true}&ids=${01txx0000006i44AII, 01txx0000006i44ACC, 01txx0000006i44ACC,…., 20th}&fields=${sku,name,productCode} ``` ### GET Commerce Webstore Product `GET /commerce/webstores/{webstoreId}/products/{productId}` Operation ID: `getProductView`. Tags: Commerce B2B Resources. Used to fetch standard field data, custom field data, and enrichment data for a single Product Get a product. Getting products respects buyer View Product entitlements and only users entitled to view product data can access it. _Available in: v49.0_ #### Parameters * `productId` (path, string (Id), required) ID of the product. Pattern: ^(01t)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v49.0_ * `excludeAttributeSetInfo` (query, boolean) Specifies whether the attribute set information for the product is returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v50.0_ * `excludeDynamicAttributeInfo` (query, boolean) Specifies whether the dynamic attribute information for the product is returned (`false`) or not (`true`). If unspecified, defaults to `true`. _Available in: v66.0_ * `excludeFields` (query, boolean) Specifies whether the fields are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v49.0_ * `excludeMedia` (query, boolean) Specifies whether the media groups and default images of the product are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v49.0_ * `excludePrimaryProductCategory` (query, boolean) Specifies whether the primary category path of the product is returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v49.0_ * `excludeProductSellingModels` (query, boolean) Specifies whether product selling models are returned or not. The behavior of this parameter depends on whether you turn on the CommerceSubscription permission. If the permission is on, and if you set the parameter to `false` (or if you omit the parameter), product selling models are returned. If the permission is on, and if you set the parameter to `true`, product selling models are not returned. If the permission is off, product selling models are not returned, regardless of whether you omit the parameter or provide a value. _Available in: v56.0_ * `excludeQuantityRule` (query, boolean) Specifies whether the quantity rule information for the product is returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v52.0_ * `excludeVariationInfo` (query, boolean) Specifies whether the variation information for the product is returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v50.0_ * `fields` (query, array of string) Comma-separated list of field names. If this list is unspecified, all fields are returned. There is no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If `excludeFields` and `fields` are specified, the `excludeFields` parameter takes precedence. _Available in: v49.0_ * `mediaGroups` (query, array of string) Comma-separated list of developer names of media group records. If this list is empty or unspecified, all media groups are returned. If `excludeMedia` and `mediaGroups` are specified, the `excludeMedia` parameter takes precedence. _Available in: v49.0_ * `noCache` (query, string) Specifies whether to ignore cached data and return the latest response ( `true` ) or not ( `false` ). _Available in: v66.0_ * `excludeEntitlementDetails` (query, boolean) Specifies whether the entitlement details of the product are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v49.0–56.0_ #### Responses * **200** _Product Detail_ Details of a product. Media type: `application/json`. Schema: `ProductDetail`. _Example: example\_1_ Payload 1 ``` { "products": [ { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "ConfigureDuringSale": "NotAllowed", "StockKeepingUnit": null, "Name": "KeyBoard" }, "id": "01tSG00000BpCgKYAV", "isConfigurationAllowed": false, "mediaGroups": [ { "developerName": "productListImage", "id": "2mgSG000001u6JwYAI", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product List Image", "usageType": "Listing" } ], "name": "KeyBoard", "productClass": "Simple", "productSellingModels": [ { "id": "0jPSG000000B2he2AC", "name": "One Time", "pricingTerm": null, "pricingTermUnit": null, "sellingModelType": "OneTime" }, { "id": "0jPSG000000B2hd2AC", "name": "Term Based - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined", "subscriptionTermRule": { "increment": 1, "maximum": null, "minimum": 1 } }, { "id": "0jPSG000000B2hi2AC", "name": "Evergreen - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "Evergreen" } ], "success": true }, { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "ConfigureDuringSale": "NotAllowed", "StockKeepingUnit": "M-0002", "Name": "Mac Bundle" }, "id": "01tSG00000BpCgJYAV", "isConfigurationAllowed": false, "mediaGroups": [ { "developerName": "productListImage", "id": "2mgSG000001u6JwYAI", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product List Image", "usageType": "Listing" } ], "name": "Mac Bundle", "productClass": "Bundle", "productSellingModels": [ { "id": "0jPSG000000B2he2AC", "name": "One Time", "pricingTerm": null, "pricingTermUnit": null, "sellingModelType": "OneTime" }, { "id": "0jPSG000000B2hd2AC", "name": "Term Based - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined" }, { "id": "0jPSG000000B2hi2AC", "name": "Evergreen - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "Evergreen" } ], "sku": "M-0002", "success": true }, { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "ConfigureDuringSale": null, "StockKeepingUnit": null, "Name": "subproduct" }, "id": "01tSG00000BpCgFYAV", "isConfigurationAllowed": false, "mediaGroups": [ { "developerName": "productListImage", "id": "2mgSG000001u6JwYAI", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product List Image", "usageType": "Listing" } ], "name": "subproduct", "productClass": "Simple", "productSellingModels": [ { "id": "0jPSG000000B2hd2AC", "name": "Term Based - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined" }, { "id": "0jPSG000000B2hh2AC", "name": "Evergreen - Yearly", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "Evergreen" } ], "success": true }, { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "ConfigureDuringSale": null, "StockKeepingUnit": null, "Name": "testproduct1" }, "id": "01tSG00000BpCgDYAV", "isConfigurationAllowed": false, "mediaGroups": [ { "developerName": "productListImage", "id": "2mgSG000001u6JwYAI", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product List Image", "usageType": "Listing" } ], "name": "testproduct1", "productClass": "Simple", "productSellingModels": [ { "id": "0jPSG000000B2hd2AC", "name": "Term Based - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined" }, { "id": "0jPSG000000B2hf2AC", "name": "Term Based - Yearly", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "TermDefined" } ], "success": true }, { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "error": {}, "fields": { "ConfigureDuringSale": null, "StockKeepingUnit": null, "Name": "testproduct" }, "id": "01tSG00000BpCgCYAV", "isConfigurationAllowed": false, "mediaGroups": [ { "developerName": "productListImage", "id": "2mgSG000001u6JwYAI", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product List Image", "usageType": "Listing" } ], "name": "testproduct", "productClass": "Simple", "success": true } ], "total": 5 } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZEOK00000008vJ4AQ/products/01tOK000000EUozYAG ``` ### GET Commerce Webstore Product Children `GET /commerce/webstores/{webstoreId}/products/{productId}/children` Operation ID: `getProductChildCollection`. Tags: Commerce B2B Resources. A Collection of child product assigned to Parent Product ie (SET, BUNDLE) with default quantity. Get a collection of child products related to a parent product. This resource respects buyer View Product entitlements, allowing access only to users authorized to view product data. It supports bundle and set products but is not available for simple, variation, or variation-parent products. **Note**: Dynamic bundles are supported only in Commerce B2B stores. _Available in: v57.0_ #### Parameters * `productId` (path, string (Id), required) ID of the product. Pattern: ^(01t)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v57.0_ * `excludeAttributeSetInfo` (query, boolean) Specifies whether the attribute set information for the product is returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v57.0_ * `excludeDynamicAttributeInfo` (query, boolean) * `excludeFields` (query, boolean) Specifies whether the fields are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v57.0_ * `excludeMedia` (query, boolean) Specifies whether the media groups and default images of the product are returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v57.0_ * `excludeQuantityRule` (query, boolean) Specifies whether the quantity rule information for the product is returned (`false`) or not (`true`). If unspecified, defaults to `false`. _Available in: v57.0_ * `fields` (query, array of string) Comma-separated list of field names. If this list is empty or unspecified, all fields are returned. There’s no limit to the number of fields you can specify. The number of fields and number of characters in the field name may affect the URL size limit. If `excludeFields` and `fields` are specified, the `excludeFields` parameter takes precedence. _Available in: v57.0_ * `includeProductSellingModels` (query, boolean) Indicates whether product selling model options are returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v63.0_ * `includeRequiredChildrenOnly` (query, boolean) * `mediaGroups` (query, array of string) Comma-separated list of developer names of media group records. Possible values: * `Attachment` * `productDetailImage` * `productListImage` If this list is empty or unspecified, all media groups are returned. If `excludeMedia` and `mediaGroups` are specified, the `excludeMedia` parameter takes precedence. For product bundles, only the `producListImage` is returned. _Available in: v57.0_ * `noCache` (query, string) * `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 20. _Available in: v57.0_ * `pageToken` (query, string) Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned. _Available in: v57.0_ #### Responses * **200** _Product Child Collection_ Collection of child products related to a parent product. Media type: `application/json`. Schema: `ProductChildCollection`. _Example: example\_1_ Payload 1 Example response for a product set: ``` { "count": 2, "currentPageToken": "eyJwIjoyMCwibyI6MH0=", "currentPageUrl": "/services/data/v67.0/commerce/webstores/0ZExx000000004tGAA/products/01txx0000006iGyAAI/​children?mediaGroups=productListImage&pageToken=eyJwIjoyMCwibyI6MH0%3D", "items": [ { "defaultQuantity": "1.0", "isEntitled": true, "productInfo": { "defaultImage": null, "fields": { "LastModifiedDate": "2024-10-31T18:14:13Z", "DisplayUrl": null, "IsDeleted": "false", "Description": "A signature Alpine health and fitness beverage. This post-workout beverage with Tart Cherry flavor is designed to help athletes maximize recovery and gains. 0.5L PET", "ProductCode": null, "IsActive": "true", "ExternalId": null, "LastViewedDate": "2024-11-07T00:06:06Z", "UserRecordAccessId": null, "LastReferencedDate": "2024-11-07T00:06:06Z", "StockKeepingUnit": "6010015", "CurrencyIsoCode": "USD", "Name": "Alpine Energy Drink Tart Cherry Post 0.5L PET - 6 pack", "SystemModstamp": "2024-11-04T18:40:55Z", "IsArchived": "false", "Type": null, "CreatedById": "005xx000001X7zp", "CloneSourceId": null, "QuantityUnitOfMeasure": null, "CreatedDate": "2024-10-31T18:14:13Z", "Family": "Alpine Energy", "ProductClass": "Simple", "LastModifiedById": "005xx000001X7zp" }, "id": "01txx0000006iCGAAY", "mediaGroups": [ { "developerName": "productListImage", "id": "2mgxx000000004sAAA", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000005AAAQ", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/​default/images/large/6Pack-Tart-Cherry-Post-Large.jpg" } ], "name": "Product List Image", "usageType": "Listing" } ], "productClass": "Simple", "productSellingModels": [ { "id": "0jPxx000000003FEAQ", "name": "PSM Evergreen", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "Evergreen" } ], "purchaseQuantityRule": null, "urlName": null } }, { "defaultQuantity": "1.0", "isEntitled": true, "productInfo": { "defaultImage": null, "fields": { "LastModifiedDate": "2024-10-31T18:14:13Z", "DisplayUrl": null, "IsDeleted": "false", "Description": "One box of Alpine Energy During Workout single serve, compostable Eco Pods. Chai Flavor.", "ProductCode": null, "IsActive": "true", "ExternalId": null, "LastViewedDate": "2024-11-12T19:38:36Z", "UserRecordAccessId": null, "LastReferencedDate": "2024-11-12T19:38:36Z", "StockKeepingUnit": "6010018", "CurrencyIsoCode": "USD", "Name": "Alpine Energy During Eco Pod, Chai", "SystemModstamp": "2024-10-31T18:14:13Z", "IsArchived": "false", "Type": null, "CreatedById": "005xx000001X7zp", "CloneSourceId": null, "QuantityUnitOfMeasure": null, "CreatedDate": "2024-10-31T18:14:13Z", "Family": "Alpine Energy", "ProductClass": "Simple", "LastModifiedById": "005xx000001X7zp" }, "id": "01txx0000006iCBAAY", "mediaGroups": [ { "developerName": "productListImage", "id": "2mgxx000000004sAAA", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000004zAAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/​default/images/large/alpine_energy_product_ecopod-chai.jpg" } ], "name": "Product List Image", "usageType": "Listing" } ], "productClass": "Simple", "productSellingModels": [ { "id": "0jPxx000000001dEAA", "name": "PSM Term", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined", "subscriptionTermRule": { "increment": 1, "maximum": null, "minimum": 1 } }, { "id": "0jPxx000000003FEAQ", "name": "PSM Evergreen", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "Evergreen" } ], "purchaseQuantityRule": null, "urlName": null } } ], "nextPageToken": null, "nextPageUrl": null, "previousPageToken": null, "previousPageUrl": null, "productClass": "Set", "total": 2 } ``` _Example: example\_2_ Payload 2 Example response for a product bundle: ``` { "count": 1, "currentPageToken": "eyJwIjoyMCwibyI6MH0=", "currentPageUrl": "/services/data/v67.0/commerce/webstores/0ZExx000000009hGAA/products/01txx0000006j8CAAQ/​children?pageToken=eyJwIjoyMCwibyI6MH0%3D", "items": [ { "defaultQuantity": "2.0", "isEntitled": true, "isPriceIncludedInParent": false, "isRequired": false, "isDefault": true, "componentGroup": { "id": "0y7xx000000006T", "name": "pcg1" }, "productInfo": { "defaultImage": { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" }, "fields": { "LastModifiedDate": "2025-06-10T09:31:43Z", "FulfillmentQtyCalcMethod": null, "Description": "testBundleChild1", "StockCheckMethod": null, "SpecificationType": "Commercial", "IsActive": "true", "LastReferencedDate": null, "StockKeepingUnit": "testBundleChild1", "ExternalDataSourceId": null, "Name": "testBundleChild1", "ShippingWeightUnitOfMeasure": null, "CreatedById": "005xx000001X8Er", "RecordTypeId": "012xx0000005pnQ", "DiscontinuedDate": null, "ProductClass": "Simple", "CanRamp": "false", "DisplayUrl": null, "IsDeleted": "false", "ConfigureDuringSale": null, "IsAssetizable": "false", "ProductCode": "testBundleChild1", "UsageModelType": null, "ExternalId": null, "ProductPurpose": "Sell", "LastViewedDate": null, "UserRecordAccessId": null, "HelpText": null, "CurrencyIsoCode": "USD", "AvailabilityDate": null, "BasedOnId": null, "SystemModstamp": "2025-06-10T09:35:22Z", "IsArchived": "false", "DecompositionScope": null, "BillingPolicyId": null, "Type": null, "EndOfLifeDate": null, "IsShippingChargeNotApplicable": "false", "QuantityUnitOfMeasure": null, "CreatedDate": "2025-06-10T09:31:43Z", "Family": null, "UnitOfMeasureId": null, "ShippingWeight": null, "LastModifiedById": "005xx000001X8Er", "TaxPolicyId": null, "IsSoldOnlyWithOtherProds": "false" }, "id": "01txx0000006j9oAAA", "mediaGroups": [ { "developerName": "productListImage", "id": "2mgxx000000009kAAA", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product List Image", "usageType": "Listing" }, { "developerName": "productDetailImage", "id": "2mgxx000000009jAAA", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": null, "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "image", "url": "/img/b2b/default-product-image.svg" } ], "name": "Product Detail Images", "usageType": "Standard" } ], "productClass": "Simple", "purchaseQuantityRule": null, "urlName": null } } ], "nextPageToken": "eyJwIjoyMCwibyI6MjB9", "nextPageUrl": "/services/data/v67.0/commerce/webstores/0ZExx000000009hGAA/products/01txx0000006j8CAAQ/​children?pageToken=eyJwIjoyMCwibyI6MjB9", "previousPageToken": null, "previousPageUrl": null, "productClass": "Bundle", "total": 1 } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000004tGAA/products/01txx0000006iGyAAI/children ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000004tGAA/products/01txx0000006iGyAAI/children?mediaGroups=productListImage&pageToken=eyJwIjoyMCwibyI6MH0%3D&includeProductSellingModels=true ``` ### GET Commerce Webstore Product Featured Products `GET /commerce/webstores/{webstoreId}/products/{productId}/featured-products` Operation ID: `getFeaturedProductCollection`. Tags: Commerce B2B Resources. Retrieve products featured by another product in the context of a particular webstore. Retrieve a collection of feature products for a specific product. Featured products include complementary items, promotional products, best-sellers, new arrivals, or limited-time offers. For example, if a customer buys a shirt, the featured products list suggests shoes, pants, and accessories to complete the outfit. _Available in: v64.0_ #### Parameters * `productId` (path, string (Id), required) ID of the product. Pattern: ^(01t)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v64.0_ * `excludeFields` (query, boolean) Indicates whether the product fields are returned ( `false` ) or not ( `true` ). If unspecified, defaults to `false` . _Available in: v64.0_ * `fields` (query, array of string) Comma-separated list of product field names. If this list is empty or unspecified, all fields are returned. There is no limit to the number of fields you can specify. _Available in: v64.0_ * `includeAttributeSetInfo` (query, boolean) Indicates whether to include attribute set information for a variation parent product ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v64.0_ * `includeMediaGroups` (query, boolean) Indicates whether media groups are returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v64.0_ * `includeProductSellingModel` (query, boolean) Indicates whether product selling model options are returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v64.0_ * `includePurchaseQuantityRules` (query, boolean) Indicates whether purchase quantity rules are returned ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v64.0_ * `mediaGroups` (query, array of string) Comma-separated list of developer names of media group records. Possible media groups are: * `Attachment` * `ProductDetailImage` * `ProductListImage` If this list is empty or unspecified, all media groups are returned. If `excludeMedia` and `mediaGroups` are specified, the `excludeMedia` parameter takes precedence. _Available in: v64.0_ * `relationshipTypes` (query, array of string) Comma-separated list of developer names of relationship type records. This defines how the featured product is related to a product. The field is a dynamic enum. If no `relationshipTypes` are specified, the API response returns all available relationship types. _Available in: v64.0_ #### Responses * **200** _Featured Products Output_ Details of featured products for a specified product. Media type: `application/json`. Schema: `FeaturedProductsOutput`. _Example: example\_1_ Payload 1 ``` { "featuredProductsByRelationshipType": { "similarProducts": [ { "defaultImage": null, "fields": { "LastModifiedDate": "2024-10-31T18:14:13Z", "DisplayUrl": null, "IsDeleted": "false", "Description": "A signature Alpine health and fitness beverage. This post-workout beverage with Tart Cherry flavor is designed to help athletes maximize recovery and gains. 0.5L PET", "ProductCode": null, "IsActive": "true", "ExternalId": null, "LastViewedDate": "2024-11-07T00:06:06Z", "UserRecordAccessId": null, "LastReferencedDate": "2024-11-07T00:06:06Z", "StockKeepingUnit": "6010015", "CurrencyIsoCode": "USD", "Name": "Alpine Energy Drink Tart Cherry Post 0.5L PET - 6 pack", "SystemModstamp": "2024-11-04T18:40:55Z", "IsArchived": "false", "Type": null, "CreatedById": "005xx000001X7zp", "CloneSourceId": null, "QuantityUnitOfMeasure": null, "CreatedDate": "2024-10-31T18:14:13Z", "Family": "Alpine Energy", "ProductClass": "Simple", "LastModifiedById": "005xx000001X7zp" }, "id": "01txx0000006iCGAAY", "mediaGroups": [ { "developerName": "productListImage", "id": "2mgxx000000004sAAA", "mediaItems": [ { "alternateText": "", "contentVersionId": null, "id": "2pmxx000000005AAAQ", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Tart-Cherry-Post-Large.jpg" } ], "name": "Product List Image", "usageType": "Listing" } ], "productClass": "Simple", "productSellingModels": [ { "id": "0jPxx000000003FEAQ", "name": "PSM Evergreen", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "Evergreen" } ], "purchaseQuantityRule": null, "urlName": null } ] } } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx000000004tGAA/products/01txx0000006iGyAAI/featured-products ``` ### POST Commerce Import Category Job, Create `POST /commerce/management/import/category/jobs` Operation ID: `postCommerceCategoryImportCollection`. Tags: Commerce B2B Resources. Commerce Management Import Connect POST API for importing categories asynchronously Create a job to asynchronously import category data using a .csv file. _Available in: v59.0_ #### Request body Configuration for an asynchronous category import job. Media type: `application/json`. Schema: `CategoryImportInput`. _Example: example\_1_ Payload 1 ``` { "importConfiguration": { "importSource": { "contentVersionId": "069xx0000004CH6AAM" }, "importSettings": { "productCatalogId": "0ZSxx000000004rGAA" } } } ``` #### Responses * **200** _Category Import_ Information about a category import job. Media type: `application/json`. Schema: `CategoryImport`. ### GET Commerce Import Category Job, Manage `GET /commerce/management/import/category/jobs/{jobId}` Operation ID: `getCommerceCategoryImport`. Tags: Commerce B2B Resources. Commerce Management Import Connect GET and PATCH API for importing categories asynchronously Get the status of a job to asynchronously import category data using a .csv file. _Available in: v59.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(750)\\w\*. #### Responses * **200** _Category Import_ Information about a category import job. Media type: `application/json`. Schema: `CategoryImport`. ### PATCH Commerce Import Category Job, Manage `PATCH /commerce/management/import/category/jobs/{jobId}` Operation ID: `patchCommerceCategoryImport`. Tags: Commerce B2B Resources. Commerce Management Import Connect GET and PATCH API for importing categories asynchronously Cancel or get the status of a job to asynchronously import category data using a .csv file. _Available in: v59.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(750)\\w\*. #### Request body Cancel asynchronous category import job input. Media type: `application/json`. Schema: `CategoryImportAbortInput`. _Example: example\_1_ Payload 1 ``` { "status": "Aborted" } ``` #### Responses * **200** _Category Import_ Information about a category import job. Media type: `application/json`. Schema: `CategoryImport`. ### POST Commerce Import Product Job, Create `POST /commerce/management/import/product/jobs` Operation ID: `postCommerceAsyncProductImportCollection`. Tags: Commerce B2B Resources. Commerce Management Import Connect API for importing products asynchronously Create a job to asynchronously import product data using a .csv file. _Available in: v57.0_ #### Request body Configuration for an asynchronous global product import job. Media type: `application/json`. Schema: `GlobalProductImportInput`. _Example: example\_1_ Payload 1 ``` { "importConfiguration": { "importSource": { "contentVersionId": "069RM0000008F4FYAU" }, "importSettings": { "category": { "productCatalogId": "0ZSRM00000004Fk4AI" }, "media": { "cmsWorkspaceId": "0ZuRM0000000Fcz0AE" }, "price": { "pricebookAliasToIdMapping": { "original": "01sRM000004aArJYAU", "sales": "01sRM000004aArIYAU", "wintersales": "01sRM000004aArKYAU" } }, "entitlement": { "defaultEntitlementPolicyId": "1CeRM00000003o40AA" } } } } ``` #### Responses * **200** _Global Product Import_ Information about a global product import job. Media type: `application/json`. Schema: `GlobalProductImport`. ### GET Commerce Import Product Job, Manage `GET /commerce/management/import/product/jobs/{jobId}` Operation ID: `getCommerceAsyncProductImport`. Tags: Commerce B2B Resources. Commerce Management Import Connect API for importing products asynchronously Get the status of a job to asynchronously import global product data using a .csv file. _Available in: v57.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(750)\\w\*. #### Responses * **200** _Global Product Import_ Information about a global product import job. Media type: `application/json`. Schema: `GlobalProductImport`. ### PATCH Commerce Import Product Job, Manage `PATCH /commerce/management/import/product/jobs/{jobId}` Operation ID: `patchCommerceAsyncProductImport`. Tags: Commerce B2B Resources. Commerce Management Import Connect API for importing products asynchronously Cancel or get the status of a job to asynchronously import global product data using a .csv file. _Available in: v57.0_ #### Parameters * `jobId` (path, string (Id), required) ID of the job. Pattern: ^(750)\\w\*. #### Request body Cancel asynchronous product import job input. Media type: `application/json`. Schema: `ProductImportCancelInput`. _Example: example\_1_ Payload 1 ``` { "status": "Aborted" } ``` #### Responses * **200** _Global Product Import_ Information about a global product import job. Media type: `application/json`. Schema: `GlobalProductImport`. ### GET Commerce Extensions `GET /commerce/extension/extensions` Operation ID: `getExtensionCollection`. Tags: Commerce B2B Resources. Get a collection of available extensions Get a collection of Commerce extensions available for your org. _Available in: v58.0_ #### Responses * **200** _Commerce Extension Collection_ Collection of Commerce extensions. Media type: `application/json`. Schema: `ExtensionOutputCollection`. ### GET Commerce Extension Mappings `GET /commerce/extension/mappings` Operation ID: `getMappingCollection`. Tags: Commerce B2B Resources. Supports creating and retrieving extension provider mappings. Get extension provider mappings, which associate an extension provider with a webstore. _Available in: v58.0_ #### Parameters * `epn` (query, string) Extension point name. For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. If you omit the extension point name, the system gets all extension mappings for the webstore. If you specify an extension point name, the system gets mappings only for that extension point. _Available in: v58.0_ * `webstoreId` (query, string) ID of the webstore. _Available in: v58.0_ #### Responses * **200** _Commerce Extension Mappings Collection_ Collection of Commerce extension mappings. Media type: `application/json`. Schema: `MappingOutputCollection`. ### POST Commerce Extension Mappings `POST /commerce/extension/mappings` Operation ID: `postMappingCollection`. Tags: Commerce B2B Resources. Supports creating and retrieving extension provider mappings. Set extension provider mappings, which associate an extension provider with a webstore. _Available in: v58.0_ #### Request body (required) Describes information used to map an extension provider to a webstore. _Available in: v58.0_ Media type: `application/json`. Schema: `MappingInput`. _Example: example\_1_ Payload 1 ``` { "webstoreId": "0ZExx000000003FGAQ", "providerName": "UltimateInventory" } ``` #### Responses * **200** _Commerce Extension Mapping_ Mapping of a Commerce extension provider to a webstore. Media type: `application/json`. Schema: `MappingOutput`. ### GET Commerce Extension Mapping `GET /commerce/extension/mappings/{mappingId}` Operation ID: `getMapping`. Tags: Commerce B2B Resources. Manage individual extension mappings. Get a Commerce extension mapping. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v58.0_ #### Parameters * `mappingId` (path, string, required) ID of the mapping. #### Responses * **200** _Commerce Extension Mapping_ Mapping of a Commerce extension provider to a webstore. Media type: `application/json`. Schema: `MappingOutput`. ### PUT Commerce Extension Mapping `PUT /commerce/extension/mappings/{mappingId}` Operation ID: `putMapping`. Tags: Commerce B2B Resources. Manage individual extension mappings. Delete, get, or modify a Commerce extension mapping. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v58.0_ #### Parameters * `mappingId` (path, string, required) ID of the mapping. #### Request body Describes information used to map an extension provider to a webstore. _Available in: v58.0_ Media type: `application/json`. Schema: `object`. * `mappingInputRepresentation` (_object_) MappingInput An Commerce Extension Provider Mapping Input object, which describes information used to map an extension provider to a webstore. You can provide this information in the request body or as a URL parameter. Includes all fields of `MappingInput`. * `providerName` (_string_) Unique name of the extension provider. * `webstoreId` (_string_) ID of the webstore. _Example: example\_1_ Payload 1 ``` { "webstoreId": "0ZExx000000003FGAQ", "providerName": "UltimateInventory" } ``` #### Responses * **200** _Commerce Extension Mapping_ Mapping of a Commerce extension provider to a webstore. Media type: `application/json`. Schema: `MappingOutput`. ### DELETE Commerce Extension Mapping `DELETE /commerce/extension/mappings/{mappingId}` Operation ID: `deleteMapping`. Tags: Commerce B2B Resources. Manage individual extension mappings. Delete a Commerce extension mapping. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v58.0_ #### Parameters * `mappingId` (path, string, required) ID of the mapping. #### Responses * **200** Success ### GET Commerce Extension Providers `GET /commerce/extension/providers` Operation ID: `getExtensionProvidersCollection`. Tags: Commerce B2B Resources. Supports registering and retrieving extension providers. Get Commerce extension providers or register a Commerce extension provider. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v58.0_ #### Parameters * `epn` (query, string) Extension point name (unique identifier for an extension). For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. _Available in: v58.0_ * `webstoreId` (query, string, required) ID of a webstore. _Available in: v58.0_ #### Responses * **200** _Commerce Extension Provider Collection_ Collection of Commerce extension providers. Media type: `application/json`. Schema: `ProviderOutputCollection`. ### POST Commerce Extension Providers `POST /commerce/extension/providers` Operation ID: `postExtensionProvidersCollection`. Tags: Commerce B2B Resources. Supports registering and retrieving extension providers. Get Commerce extension providers or register a Commerce extension provider. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v58.0_ #### Request body An extension provider for an Commerce extension point. Media type: `application/json`. Schema: `ProviderInput`. _Example: example\_1_ Payload 1 ``` { "name": "UltimateInventory", "epn": "Commerce_Domain_Inventory_Service", "type": "apexClass", "description": "Extension provider for ultimate inventory.", "isApplication": true, "apexClass": { "classId": "0ZExx000000003FGAQ", "className": "UltimateSoftwareSalesforceInventoryServiceExtension" } } ``` #### Responses * **200** _Commerce Extension Provider_ A Commerce extension provider. Media type: `application/json`. Schema: `ProviderOutput`. ### GET Commerce Extension Provider `GET /commerce/extension/providers/{providerId}` Operation ID: `getExtensionProvider`. Tags: Commerce B2B Resources. Manage individual extension providers. Get a Commerce extension provider. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v59.0_ #### Parameters * `providerId` (path, string, required) ID of the provider. #### Responses * **200** _Commerce Extension Provider_ A Commerce extension provider. Media type: `application/json`. Schema: `ProviderOutput`. ### DELETE Commerce Extension Provider `DELETE /commerce/extension/providers/{providerId}` Operation ID: `deleteExtensionProvider`. Tags: Commerce B2B Resources. Manage individual extension providers. Delete a Commerce extension provider. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v59.0_ #### Parameters * `providerId` (path, string, required) ID of the provider. #### Responses * **200** Success ### PATCH Commerce Extension Provider `PATCH /commerce/extension/providers/{providerId}` Operation ID: `patchExtensionProvider`. Tags: Commerce B2B Resources. Manage individual extension providers. Modify a Commerce extension provider. An extension provider is an Apex Class that implements a Commerce extension. _Available in: v59.0_ #### Parameters * `providerId` (path, string, required) ID of the provider. #### Request body An extension provider for an Commerce extension point. Media type: `application/json`. Schema: `ProviderInput`. _Example example\_1: same as POST /commerce/extension/providers request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Commerce Extension Provider_ A Commerce extension provider. Media type: `application/json`. Schema: `ProviderOutput`. ### GET Commerce Webstore Pricing Products `GET /commerce/webstores/{webstoreId}/pricing/products` Operation ID: `getMultiProductPrice`. Tags: Commerce B2B Resources. Resource endpoint for calculating the price for multiple products Get the prices for multiple products. Getting prices for products respects buyer entitlements and only users entitled to view product and price data can access it. To get price information, the context store and account must have 25 or fewer price books associated with them. To reduce the number of active price books for the account within the store, you can change the active status, modify valid dates, or remove assignments of price books. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ **Note:** POST methods typically create an item, but for this resource POST is used to retrieve information. GET calls can be cached. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `currencyIsoCode` (query, string) Three-letter ISO 4217 currency code associated with the product pricing record. Products are priced using the currency for the buyer account or guest buyer profile. If your store doesn’t support the currency for the buyer account or guest buyer profile, products are priced using the default currency for your store. _Available in: v54.0_ * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v54.0_ * `productIds` (query, array of string, required) List of product IDs for which you want to get prices. _Available in: v54.0_ #### Responses * **200** _Pricing Result_ Product pricing result. Media type: `application/json`. Schema: `PricingResult`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZExx0000000002GAA/pricing/products ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/webstores/0ZEOK00000008vK4AQ/pricing/products?currencyIsoCode=USD&effectiveAccountId=001OK000001o5FtYAI&productIds=01txx000000000A,01txx000000000V ``` ### POST Commerce Webstore Pricing Products `POST /commerce/webstores/{webstoreId}/pricing/products` Operation ID: `postMultiProductPrice`. Tags: Commerce B2B Resources. Resource endpoint for calculating the price for multiple products Getting prices for products respects buyer entitlements and only users entitled to view product and price data can access it. To get price information, the context store and account must have 25 or fewer price books associated with them. To reduce the number of active price books for the account within the store, you can change the active status, modify valid dates, or remove assignments of price books. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ **Note:** POST methods typically create an item, but for this resource POST is used to retrieve information. GET calls can be cached. #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `currencyIsoCode` (query, string) Three-letter ISO 4217 currency code associated with the product pricing record. Products are priced using the currency for the buyer account or guest buyer profile. If your store doesn’t support the currency for the buyer account or guest buyer profile, products are priced using the default currency for your store. _Available in: v49.0_ * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v49.0_ #### Request body Pricing for multiple products. _Available in: v49.0_ Media type: `application/json`. Schema: `PricingInput`. _Example: example\_1_ Payload 1 ``` { "pricingLineItems": [ { "productId": "01txx000000000V" }, { "productId": "01txx000000000W" }, { "productId": "01txx000000000A" } ] } ``` #### Responses * **200** _Pricing Result_ Product pricing result. Media type: `application/json`. Schema: `PricingResult`. ### GET Commerce Webstore Pricing Product `GET /commerce/webstores/{webstoreId}/pricing/products/{productId}` Operation ID: `getProductPrice`. Tags: Commerce B2B Resources. Used to get the list price and buyer price for a product in the context of a Web Store Get the list and buyer price for a product. Getting prices for products respects buyer entitlements and only users entitled to view product and price data can access it. To get price information, the context store and account must have 25 or fewer price books associated with them. To reduce the number of active price books for the account within the store, you can change the active status, modify valid dates, or remove assignments of price books. If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values. _Available in: v49.0_ #### Parameters * `productId` (path, string (Id), required) ID of the product. Pattern: ^(01t)\\w\*. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `allProductSellingModelPrices` (query, array of string) List of product selling model prices for the product. _Available in: v60.0_ * `currencyIsoCode` (query, string) Three-letter ISO 4217 currency code associated with the cart. _Available in: v57.0_ * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. _Available in: v49.0_ * `includeChildProductPrices` (query, boolean) Indicates whether to include child product prices in the response ( `true` ) or not ( `false` ). Default value is `false` . _Available in: v65.0_ * `productSellingModelIds` (query, array of string) List of product selling model IDs for the product. _Available in: v56.0_ #### Responses * **200** _Product Price_ Pricing information for a product. Media type: `application/json`. Schema: `ProductPrice`. _Example: example\_1_ Payload 1 ``` { "childEntries": [ { "childEntries": [], "currencyIsoCode": "USD", "listPrice": "59.99", "lowestUnitPrice": null, "priceAdjustment": null, "pricebookEntryId": "01uxx00000090SSAAY", "productId": "01txx0000006kYyAAI", "productPriceEntries": [ { "error": {}, "listPrice": "59.99", "lowestUnitPrice": null, "priceAdjustment": null, "pricebookEntryId": "01uxx00000090SSAAY", "productSellingModelId": null, "success": true, "unitPrice": "55.5" } ], "productSellingModelId": null, "unitPrice": "55.5" } ], "currencyIsoCode": "USD", "listPrice": "150.0", "lowestUnitPrice": null, "priceAdjustment": null, "pricebookEntryId": "01uxx000000910EAAQ", "productId": "01txx0000006knQAAQ", "productPriceEntries": [ { "error": {}, "listPrice": "150.0", "lowestUnitPrice": null, "priceAdjustment": null, "pricebookEntryId": "01uxx000000910EAAQ", "productSellingModelId": null, "success": true, "unitPrice": "100.0" } ], "productSellingModelId": null, "unitPrice": "100.0" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/pricing/products/01txx0000006knQAAQ ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/pricing/products/01txx0000006knQAAQ?effectiveAccountId=001xx000003DMe9 ``` ### GET Commerce Subscriptions `GET /commerce/webstores/{webstoreId}/subscriptions` Operation ID: `getCommerceSubscriptionCollection`. Tags: Commerce B2B Resources. Fetch collection of subscriptions. Retrieve a collection of Commerce subscriptions. This API is available only to registered shoppers. This API retrieves Commerce subscriptions based on the account ID specified in the `effectiveAccountId` parameter. If no account ID is provided as a query parameter, the API defaults to the user’s context and returns subscriptions relevant to them. To access this API, users must have the B2B Commerce license. _Available in: v63.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. This field is required for the account switcher to view subscriptions associated with other registered shoppers. _Available in: v63.0_ * `pageSize` (query, integer) Number of items per page. Valid values are from 1 through 100. If unspecified, defaults to 25. _Available in: v63.0_ * `pageToken` (query, string) 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. _Available in: v63.0_ * `sortOrder` (query, string) Sort order for subscriptions. Possible values are: * `CreatedDateAsc` —Sort results in ascending order of created date. * `CreatedDateDesc` —Sort results in descending order of created date. If unspecified, defaults to `CreatedDateDesc`. _Available in: v63.0_ * `state` (query, string) State of the subscription. Possible values are: * `Active` * `Past` If unspecified, defaults to `Active`. _Available in: v63.0_ #### Responses * **200** _Commerce Subscription Collection_ Representation for the Commerce subscriptions collection. Media type: `application/json`. Schema: `CommerceSubscriptionCollection`. _Example: example\_1_ Payload 1 ``` { "count": 2, "currentPageToken": null, "currentPageUrl": "/services/data/v67.0/commerce/webstores/0ZExx0000000001/subscriptions?effectiveAccountId=001xx000003GZ4l&pageSize=25&sortOrder=CreatedDateDesc", "nextPageToken": null, "nextPageUrl": null, "previousPageToken": null, "previousPageUrl": null, "sortOrder": "CreatedDateDesc", "subscriptions": [ { "amendmentStatus": null, "billing": { "billingMethod": "OrderAmount", "billingPeriodAmount": "38.0", "billingTerm": 1, "billingTermUnit": "Month", "billingType": "Advance", "cancellationDate": null, "currencyIsoCode": "USD", "nextBillingDate": null, "savedPaymentMethod": null }, "cancelStatus": null, "endDate": "2025-10-25T23:59:59.000+0000", "id": "02ixx0000004HxeAAE", "lastAction": { "details": { "changes": [ { "field": "quantity", "previousValue": 2, "newValue": 1 } ], "errors": null, "status": "Success" }, "effectiveDateTime": "2025-12-20", "performedDateTime": "2025-11-20T09:39:59.000Z", "type": "Amend" }, "processExceptions": [], "product": { "canViewProduct": true, "error": null, "fields": { "Description": { "dataName": "Description", "dataType": "STANDARD", "label": "Description", "text": "A signature Alpine health and fitness beverage. This post-workout beverage with Chai flavor is designed to help athletes maximize recovery and gains. 0.5L PET", "type": "TEXTAREA" }, "StockKeepingUnit": { "dataName": "StockKeepingUnit", "dataType": "STANDARD", "label": "StockKeepingUnit", "text": "6010009", "type": "STRING" }, "Name": { "dataName": "Name", "dataType": "STANDARD", "label": "Name", "text": "Netflix subscription", "type": "STRING" } }, "id": "01txx0000006i2SAAQ", "image": { "alternateText": "", "contentVersionId": null, "id": "2pmxx0000000003AAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg" }, "name": "Netflix subscription", "purchaseQuantityRule": { "increment": "1.0", "maximum": "8", "minimum": "1.0" }, "sku": "6010009", "success": true, "variationAttributes": [] }, "quantity": 2, "renewalStatus": null, "sellingModel": { "id": "0jPxx0000000002EAA", "name": "Term - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined" }, "startDate": "2025-09-26T00:00:00.000+0000", "subscriptionTerm": 1 }, { "amendmentStatus": null, "billing": null, "cancelStatus": null, "endDate": "2026-01-24T23:59:59.000+0000", "id": "02ixx0000004HKwAAM", "lastAction": null, "processExceptions": [], "product": { "canViewProduct": true, "error": null, "fields": { "Description": { "dataName": "Description", "dataType": "STANDARD", "label": "Description", "text": "A signature Alpine health and fitness beverage. This post-workout beverage with Chai flavor is designed to help athletes maximize recovery and gains. 0.5L PET", "type": "TEXTAREA" }, "StockKeepingUnit": { "dataName": "StockKeepingUnit", "dataType": "STANDARD", "label": "StockKeepingUnit", "text": "6010009", "type": "STRING" }, "Name": { "dataName": "Name", "dataType": "STANDARD", "label": "Name", "text": "Netflix subscription", "type": "STRING" } }, "id": "01txx0000006i2SAAQ", "image": { "alternateText": "", "contentVersionId": null, "id": "2pmxx0000000003AAA", "mediaType": "Image", "sortOrder": 0, "thumbnailUrl": null, "title": "jpg", "url": "https://s3.amazonaws.com/northerntrailoutfitters.com/nto-alpine-nutrition/default/images/large/6Pack-Chai-Post-Large.jpg" }, "name": "Netflix subscription", "purchaseQuantityRule": { "increment": "1.0", "maximum": "8", "minimum": "1.0" }, "sku": "6010009", "success": true, "variationAttributes": [] }, "quantity": 2, "renewalStatus": null, "sellingModel": { "id": "0jPxx0000000002EAA", "name": "Term - Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined" }, "startDate": "2025-09-25T00:00:00.000+0000", "subscriptionTerm": 4 } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions?effectiveAccountId=001xx000003DMe9&state=active&sortOrder=CreatedDateDesc ``` ### POST Commerce Subscription Amendment Initiation `POST /commerce/webstores/{webstoreId}/subscriptions/actions/initiate-amendment` Operation ID: `postCommerceSubscriptionAmend`. Tags: Commerce B2B Resources. Commerce Subscription Amend Resource Amend an active Commerce subscription. This API is available only to registered shoppers. Amendments allow you to modify the digital product quantity of an active subscription. When a customer needs quantity changes to their subscription, you can apply them through an amendment. When using this resource, keep the following considerations in mind: * For positive amendments, changes can be done anytime before the next billing date. By default, pricing is based on the current list price of the digital product subscription. * For negative amendments, changes are allowed only on the next billing date. By default, pricing is based on the last transaction price of the digital product subscription. * A renewed subscription can’t be amended before its renewal start date. To access this API, users must have the following licenses and permissions: * B2B Commerce * Revenue Lifecycle Management _Available in: v65.0_ #### Parameters * `webstoreId` (path, string (Id), required) ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If not specified, it defaults to the account ID for the context user. This field is required if the buyer wants to cancel a subscription associated with a managed account other than their default account. _Available in: v65.0_ #### Request body Input representation for the Commerce subscription amend request. _Available in: v65.0_ Media type: `application/json`. Schema: `CommerceSubscriptionAmendInput`. _Example: example\_1_ Payload 1 ``` { "amendStartDate": "2025-08-01T00:00:00.000Z", "quantityChange": 50, "subscriptionIds": [ "02ixx0000004Hb4AAE" ] } ``` #### Responses * **200** _Commerce Subscription Amend_ Representation for the Commerce subscription amend request. Media type: `application/json`. Schema: `CommerceSubscriptionAmendOutput`. _Example: example\_1_ Payload 1 ``` { "orderId": "8015i000000obwHAAQ" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions/actions/initiate-amendment Content-Type: application/json { "amendStartDate": "2025-08-01T00:00:00.000Z", "quantityChange": 50, "subscriptionIds": [ "02ixx0000004Hb4AAE" ] } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions/actions/initiate-amendment?effectiveAccountId=001xx000003DMe9 Content-Type: application/json { "amendStartDate": "2025-08-01T00:00:00.000Z", "quantityChange": 50, "subscriptionIds": [ "02ixx0000004Hb4AAE" ] } ``` ### POST Commerce Subscription Cancellation `POST /commerce/webstores/{webstoreId}/subscriptions/actions/initiate-cancellation` Operation ID: `postCommerceSubscriptionCancel`. Tags: Commerce B2B Resources. Commerce Subscription Cancel Resource Cancel an active Commerce subscription. This API is available only to registered shoppers. This API cancels a Commerce subscription for a registered shopper using the account ID specified in the `effectiveAccountId` parameter. If no account ID is provided as a query parameter, the API defaults to the user’s context to cancel the specified subscription. When using this resource, keep the following considerations in mind: * A subscription cancellation takes effect only on the subscription’s next billing date. * A subscription that has been amended or renewed cannot be canceled before the amendment or renewal start date. To cancel such a subscription, you must first revert the amendment or renewal using the [Initiate Rollback on Last Action](https://developer.salesforce.com/docs/atlas.en-us.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/actions_obj_initiate_rollback_last_action.htm). Once the rollback is complete, you can cancel the subscription using the Commerce Webstore Subscription Cancellation API. For example, if you amend your current subscription by increasing its quantity from 5 to 10 and later decide to cancel the subscription, you can't cancel it directly. Instead, first initiate a rollback to revert the amendment, and then proceed with the cancellation using the API. To access this API, users must have the following licenses and permissions: * B2B Commerce * Revenue Lifecycle Management _Available in: v63.0_ #### Parameters * `webstoreId` (path, string (Id), required) ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If not specified, it defaults to the account ID for the context user. This field is required if the buyer wants to cancel a subscription associated with a managed account other than their default account. _Available in: v63.0_ #### Request body Input representation for the Commerce subscription cancel request. _Available in: v63.0_ Media type: `application/json`. Schema: `CommerceSubscriptionCancelInput`. _Example: example\_1_ Payload 1 ``` { "subscriptionIds": [ "02ixx0000004Hb4AAE" ] } ``` #### Responses * **200** _Commerce Subscription Cancel Output_ Representation for the Commerce subscription cancellation request. Media type: `application/json`. Schema: `CommerceSubscriptionCancelOutput`. _Example: example\_1_ Payload 1 ``` { "orderId": "8015i000000obwHAAQ" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions/actions/initiate-cancellation Content-Type: application/json { "subscriptionIds": [ "02ixx0000004Hb4AAE" ] } ``` ### POST Commerce Subscription Renewal Initiation `POST /commerce/webstores/{webstoreId}/subscriptions/actions/initiate-renewal` Operation ID: `postCommerceSubscriptionRenew`. Tags: Commerce B2B Resources. Commerce Subscription Renewal Resource Renew an active Commerce subscription. This API is available only to registered shoppers. When using this resource, keep the following considerations in mind: * Subscription renewal takes effect after the end date of subscription. You can renew only once before the subscription term ends. After the term ends, you can renew again. * Default pricing for renewals is based on the current list price of the digital product subscription. * An amended subscription can’t be renewed before its amendment start date. To access this API, users must have the following licenses and permissions: * B2B Commerce * Revenue Lifecycle Management _Available in: v65.0_ #### Parameters * `webstoreId` (path, string (Id), required) ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If not specified, it defaults to the account ID for the context user. This field is required if the buyer wants to cancel a subscription associated with a managed account other than their default account. _Available in: v65.0_ #### Request body Input representation for the Commerce subscription renew request. _Available in: v65.0_ Media type: `application/json`. Schema: `CommerceSubscriptionRenewInput`. _Example: example\_1_ Payload 1 ``` { "renewalEndDate": "2025-12-31T23:59:59.000Z", "renewalStartDate": "2025-06-01T00:00:00.000Z", "renewalTermLength": 1, "renewalTermUnit": "Year", "subscriptionIds": [ "02ixx0000004Hb4AAE", "02ixx0000004Hc5AAE" ] } ``` #### Responses * **200** _Commerce Subscription Renew_ Representation for the Commerce subscription renew request. Media type: `application/json`. Schema: `CommerceSubscriptionRenewOutput`. _Example: example\_1_ Payload 1 ``` { "orderId": "8015i000000obwHAAQ" } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions/actions/initiate-renewal Content-Type: application/json { "renewalEndDate": "2025-12-31T23:59:59.000Z", "renewalStartDate": "2025-06-01T00:00:00.000Z", "renewalTermLength": 1, "renewalTermUnit": "Year", "subscriptionIds": [ "02ixx0000004Hb4AAE", "02ixx0000004Hc5AAE" ] } ``` _Example: Example 2 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx000000005rGAA/subscriptions/actions/initiate-renewal?effectiveAccountId=001xx000003DMe9 Content-Type: application/json { "renewalEndDate": "2025-12-31T23:59:59.000Z", "renewalStartDate": "2025-06-01T00:00:00.000Z", "renewalTermLength": 1, "renewalTermUnit": "Year", "subscriptionIds": [ "02ixx0000004Hb4AAE", "02ixx0000004Hc5AAE" ] } ``` ### POST Commerce Subscription Renewal Price Forecast `POST /commerce/webstores/{webstoreId}/subscriptions/renewal-price-forecast` Operation ID: `postCommerceSubscriptionRenewalPriceForecast`. Tags: Commerce B2B Resources. Commerce Subscription Renewal Price Forecast Resource Retrieve renewal pricing forecasts for specified Commerce subscriptions. This API is available only to authenticated registered shoppers. To access this API, users must have the following licenses and permissions: * B2B Commerce * Revenue Lifecycle Management _Available in: v67.0_ #### Parameters * `webstoreId` (path, string (Id), required) ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If not specified, it defaults to the account ID for the context user. _Available in: v67.0_ #### Request body Input representation for renewal price forecasting of the specified Commerce subscriptions. _Available in: v67.0_ Media type: `application/json`. Schema: `CommerceSubscriptionRenewalPriceForecastInput`. _Example: example\_1_ Payload 1 Sample request using a list of subscription IDs. ``` { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ] } ``` _Example: example\_2_ Payload 2 Sample request using start and end dates along with subscription IDs. ``` { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ], "startDate": "2026-03-06T00:00:00", "endDate": "2027-04-05T00:00:00" } ``` _Example: example\_3_ Payload 3 Sample request using start date and term length along with subscription IDs. ``` { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ], "startDate": "2026-03-06T00:00:00", "termLength": 1, "termUnit": "Month" } ``` #### Responses * **200** _Commerce Subscription Renewal Price Forecast_ Output representation of the Commerce subscription renewal price forecast. Media type: `application/json`. Schema: `CommerceSubscriptionRenewalPriceForecastOutput`. _Example: example\_1_ Payload 1 ``` { "errors": [], "renewalPriceForecasts": [ { "endDate": "2027-02-10T00:00:00.000Z", "renewalPriceDetails": [ { "netUnitPrice": "35.00", "quantity": "10.00" } ], "startDate": "2026-06-01T00:00:00.000Z", "subscriptionId": "02iSG000001hHg9YAE", "totalLineAmount": "100.90" } ] } ``` #### Code samples _Example: Example 1 · HTTP_ ``` http://yourInstance.salesforce.com/services/data/67.0/commerce/webstores/0ZESG000002TTAL/subscriptions/renewal-price-forecast Content-Type: application/json { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ] } ``` _Example: Example 2 · HTTP_ ``` http://yourInstance.salesforce.com/services/data/67.0/commerce/webstores/0ZESG000002TTAL/subscriptions/renewal-price-forecast Content-Type: application/json { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ], "startDate": "2026-03-06T00:00:00", "endDate": "2027-04-05T00:00:00" } ``` _Example: Example 3 · HTTP_ ``` http://yourInstance.salesforce.com/services/data/67.0/commerce/webstores/0ZESG000002TTAL/subscriptions/renewal-price-forecast Content-Type: application/json { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ], "startDate": "2026-03-06T00:00:00", "termLength": 1, "termUnit": "Month" } ``` _Example: Example 4 · HTTP_ ``` http://yourInstance.salesforce.com//services/data/v67.0/commerce/webstores/0ZESG000002TTAL/subscriptions/renewal-price-forecast?effectiveAccountId=001SG00001MZvXh Content-Type: application/json { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ] } ``` _Example: Example 5 · HTTP_ ``` http://yourInstance.salesforce.com//services/data/v67.0/commerce/webstores/0ZESG000002TTAL/subscriptions/renewal-price-forecast?effectiveAccountId=001SG00001MZvXh Content-Type: application/json { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ], "startDate": "2026-03-06T00:00:00", "endDate": "2027-04-05T00:00:00" } ``` _Example: Example 6 · HTTP_ ``` http://yourInstance.salesforce.com//services/data/v67.0/commerce/webstores/0ZESG000002TTAL/subscriptions/renewal-price-forecast?effectiveAccountId=001SG00001MZvXh Content-Type: application/json { "subscriptionIds": [ "02iSG000001n4ujYAA", "02iSG000001gomDYAQ" ], "startDate": "2026-03-06T00:00:00", "termLength": 1, "termUnit": "Month" } ``` ### GET Commerce Subscription Action History `GET /commerce/webstores/{webstoreId}/subscriptions/{subscriptionId}/action-history` Operation ID: `getCommerceSubscriptionActionsHistory`. Tags: Commerce B2B Resources. This API allows Internal and Buyer Users to fetch subscription actions history for a specific subscription. Retrieve the complete subscription action history for the specified subscription. This API is available only for authenticated buyers. _Available in: v66.0_ #### Parameters * `subscriptionId` (path, string (Id), required) ID of the subscription to fetch actions history for. Pattern: ^(02i)\\w\*. * `webstoreId` (path, string (Id), required) ID of the web store. Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string, required) ID of the account for which the request is made. _Available in: v66.0_ #### Responses * **200** _Commerce Subscription Actions History_ Representation for subscription actions history. Media type: `application/json`. Schema: `CommerceSubscriptionActionsHistory`. _Example: example\_1_ Payload 1 ``` { "actions": [ { "details": { "changes": [ { "field": "quantity", "previousValue": 1, "newValue": 0 }, { "field": "subscriptionTerm", "previousValue": 2, "newValue": 0 } ], "errors": null, "status": "Success" }, "effectiveDateTime": "2026-01-21T23:59:59.000+0000", "performedDateTime": "2025-12-21T08:33:58.000Z", "type": "Cancel" }, { "details": { "changes": [ { "field": "quantity", "previousValue": 2, "newValue": 1 }, { "field": "subscriptionTerm", "previousValue": 4, "newValue": 4 } ], "errors": null, "status": "Success" }, "effectiveDateTime": "2025-12-20T00:00:00.000Z", "performedDateTime": "2025-11-20T09:39:59.000Z", "type": "Amend" } ] } ``` ### PATCH Commerce Subscriptions, Saved Payment Method `PATCH /commerce/webstores/{webstoreId}/subscriptions/{subscriptionId}/saved-payment-methods` Operation ID: `patchCommerceSubscriptionSavedPaymentMethod`. Tags: Commerce B2B Resources. Commerce Saved Payment Method Update the saved payment method associated with a specific Commerce subscription. This API is available only to registered buyers. In the out-of-the-box Commerce solution, this API is implemented on the My Subscriptions page, enabling buyers to update saved payment methods for their subscriptions through My Subscription experience. To access this API, users must have the following licenses and permissions: * B2B Commerce, or D2C Commerce * Revenue Lifecycle Management _Available in: v63.0_ Here’s a sample response for the Commerce Subscription Detail in the Saved Payment Method PATCH request: #### Parameters * `subscriptionId` (path, string (Id), required) ID of the subscription record for which the request is made Pattern: ^(02i)\\w\*. * `webstoreId` (path, string (Id), required) ID of the web store for which the request is made Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. For the account switcher, if the user provides a valid effectiveAccountId, the API updates the saved payment method associated with a Commerce subscription for that account ID. The account switcher feature is only applicable to B2B Commerce. _Available in: v63.0_ #### Request body Input representation for updating a saved payment method associated with a subscription. _Available in: v63.0_ Media type: `application/json`. Schema: `CommerceSubscriptionSavedPaymentMethodInput`. _Example: example\_1_ Payload 1 ``` { "merchantAccountId": "8zbxx00000000ODAAY", "savedPaymentMethodId": "12qxx000002pmjEAAQ" } ``` #### Responses * **200** _billing_ Here’s a sample response for the Commerce Subscription Detail in the Saved Payment Method PATCH request: The PATCH API populates only the `billing`, `endDate`, `id`, and `startDate` field values in the response. Other fields are ignored by the PATCH API. ``` { "billing": { "billingMethod": "OrderAmount", "billingPeriodAmount": null, "billingTerm": 1, "billingTermUnit": "Month", "billingType": "Arrears", "cancellationDate": null, "currencyIsoCode": "USD", "nextBillingDate": "2024-10-10", "savedPaymentMethod": { "gatewayResponse": {}, "id": "12qxx000002pmmSAAQ", "merchantAccountId": "8zbxx00000000ODAAY", "name": "Ra*****" } }, "cancelStatus": null, "endDate": "2025-09-10T23:59:59.000Z", "id": "02ixx0000004HJKAA2", "product": null, "quantity": null, "sellingModel": null, "startDate": "2024-09-10T00:00:00.000Z", "subscriptionTerm": null } ``` Commerce Subscription Detail Media type: `application/json`. Schema: `CommerceSubscriptionDetail`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/commerce/webstores/0ZExx00000003NhGAI/subscriptions/02ixx0000004HJKAA2/saved-payment-methods Content-Type: application/json { "merchantAccountId": "8zbxx00000000ODAAY", "savedPaymentMethodId": "12qxx000002pmjEAAQ" } ``` ### GET Business Objectives `GET /connect/business-objectives` Operation ID: `getBusinessObjectives`. Tags: Commerce B2B Resources. Get business objective information Get business objective (goal) information _Available in: v59.0_ #### Parameters * `channelId` (query, string) Associated channel ID. _Available in: v59.0_ * `includeInsightSummary` (query, boolean) Specifies whether to include an insight summary in the response. Default value is `false` . _Available in: v59.0_ * `includeRecSummary` (query, boolean) Specifies whether to include a summary of recommended actions in the response. Default value is `false` . _Available in: v59.0_ * `kpiName` (query, string) Name of the key performance indicator. _Available in: v59.0_ * `webstoreId` (query, string, required) ID of the webstore to retrieve business objectives from. _Available in: v59.0_ #### Responses * **200** _Business Objectives Summary_ List of summaries for business objectives, or goals. Media type: `application/json`. Schema: `BusinessObjectivesSummaryOutput`. ### PATCH Business Objectives `PATCH /connect/business-objectives` Operation ID: `patchBusinessObjectives`. Tags: Commerce B2B Resources. Get business objective information Get business objective (goal) information _Available in: v59.0_ #### Request body A business objective, or goal, and insights associated with it. Media type: `application/json`. Schema: `BusinessObjectiveInput`. _Example: example\_1_ Payload 1 ``` { "businessObjectiveId": "0GO000000000001", "insightSummary": { "targetCompletionDate": "2024-12-31", "targetValue": 1000000 } } ``` #### Responses * **200** _Business Objective Summary_ Summary of a business objective, or goal. Media type: `application/json`. Schema: `BusObjSummaryOutput`. ### GET Business Objectives, Recommendations `GET /connect/business-objectives/recommendations` Operation ID: `getRecommendations`. Tags: Commerce B2B Resources. Retrieve recommendations information Get recommended actions for business objectives (goals). _Available in: v59.0_ #### Parameters * `businessObjectiveId` (query, string, required) ID of the business objective. _Available in: v59.0_ * `channelId` (query, string) Associated channel ID for the recommended action. _Available in: v59.0_ * `domain` (query, string) Domain of the recommended action to filter by. _Available in: v59.0_ * `externalName` (query, string) External name used for recommended action filtering. _Available in: v59.0_ * `grouping` (query, string) Free-form categorization field to filter the recommended action by additional groupings. _Available in: v59.0_ * `secondaryState` (query, string) Optional state field for additional filtering of recommendation states. _Available in: v59.0_ * `state` (query, string) Primary state of the recommended action to filter by (e.g., "ACTIVE", "INACTIVE", "ACCEPTED", "NOT\_EXPIRING"). _Available in: v59.0_ * `tertiaryState` (query, string) Optional state field for additional filtering of recommendation states. _Available in: v59.0_ #### Responses * **200** _Recommended Actions_ List of recommended actions. Media type: `application/json`. Schema: `RecommendationsOutput`. ### PUT Business Objectives, Recommendations `PUT /connect/business-objectives/recommendations` Operation ID: `putRecommendations`. Tags: Commerce B2B Resources. Retrieve recommendations information Create and update recommended actions for business objectives (goals). _Available in: v59.0_ #### Request body Recommended action for a business objective, or goal. Media type: `application/json`. Schema: `BusObjRecommendationInput`. _Example: example\_1_ Payload 1 ``` { "acceptanceLabel": "Accept Recommendation", "actionInfo": { "name": "recommendedAction", "parameters": "{\"actionType\": \"product_recommendation\"}" }, "businessObjectiveId": "0GO000000000001", "channelId": "0CH000000000001", "description": "Increase revenue by promoting this product", "domain": "Product", "externalName": "PROD_REC_001", "externalState": "{\"productId\": \"01t000000000001\"}", "goalId": "0GG000000000001", "grouping": "revenue_growth", "iconName": "standard:product", "imageId": 69000000000001, "name": "Product Recommendation", "output": { "name": "lastExecutedAction", "parameters": "{\"executionTime\": \"2024-03-21T10:30:00Z\"}" }, "recommendationId": "0RG000000000001", "rejectionLabel": "Dismiss", "score": "85", "state": "ACTIVE", "secondaryState": "HIGH_PRIORITY", "tertiaryState": "REVENUE_FOCUSED" } ``` #### Responses * **200** _Recommended Action_ Recommended action. Media type: `application/json`. Schema: `Rec`. ### POST Business Objectives, Recommendations `POST /connect/business-objectives/recommendations` Operation ID: `postRecommendations`. Tags: Commerce B2B Resources. Retrieve recommendations information Create recommended actions for business objectives (goals). _Available in: v59.0_ #### Request body Recommended action for a business objective, or goal. Media type: `application/json`. Schema: `BusObjRecommendationInput`. _Example example\_1: same as PUT /connect/business-objectives/recommendations request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Recommended Action_ Recommended action. Media type: `application/json`. Schema: `Rec`. ### PATCH Business Objectives, Recommendations `PATCH /connect/business-objectives/recommendations` Operation ID: `patchRecommendations`. Tags: Commerce B2B Resources. Retrieve recommendations information Update recommended actions for business objectives (goals). _Available in: v59.0_ #### Request body Recommended action for a business objective, or goal. Media type: `application/json`. Schema: `BusObjRecommendationInput`. _Example example\_1: same as PUT /connect/business-objectives/recommendations request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Recommended Action_ Recommended action. Media type: `application/json`. Schema: `Rec`. ### GET Commerce Webstore Externally Managed Accounts `GET /commerce/webstores/{webstoreId}/external-managed-accounts` Operation ID: `getExternalManagedAccount`. Tags: Commerce B2B Resources. A collection of External Managed Accounts. Get a collection of externally managed accounts. _Available in: v49.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `includeMyAccount` (query, boolean) Specifies whether to return the context user’s account (`true`) or not (`false`). The default value is `false`. _Available in: v53.0_ #### Responses * **200** _External Managed Account Collection Output_ Collection of externally managed accounts. Media type: `application/json`. Schema: `ExternalManagedAccountCollectionOutput`. ### POST Commerce Einstein Webstore Activities, Export `POST /commerce/webstores/{webstoreId}/ai/activities/export-jobs` Operation ID: `postCommerceEinsteinActivityExportJobCollection`. Tags: Commerce Einstein Webstore Resources. Connect resource for posting activity export jobs to the queue. Enqueue a job to export Commerce Einstein activity for a store. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Commerce Einstein activity job. Media type: `application/json`. Schema: `CommerceEinsteinActivityJobInput`. _Example: example\_1_ Payload 1 ``` { "userId": "005B0000000Ge16" } ``` #### Responses * **200** _Commerce Einstein Activity Export Job_ Commerce Einstein activity export job. Media type: `application/json`. Schema: `CommerceEinsteinActivityExportJob`. ### GET Commerce Einstein Webstore Activities, Export Status `GET /commerce/webstores/{webstoreId}/ai/activities/export-jobs/{jobId}` Operation ID: `getCommerceEinsteinActivityExportJob`. Tags: Commerce Einstein Webstore Resources. Connect API endpoint for getting the status of an activity export job. Get the status of a Commerce Einstein activity export job for a store. _Available in: v55.0_ #### Parameters * `jobId` (path, string, required) ID of the job. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Commerce Einstein Activity Export Job_ Commerce Einstein activity export job. Media type: `application/json`. Schema: `CommerceEinsteinActivityExportJob`. ### GET Commerce Einstein Webstore Activities, Download Export File `GET /commerce/webstores/{webstoreId}/ai/activities/export-jobs/{jobId}/file-content` Operation ID: `getCommerceEinsteinActivityExportFile`. Tags: Commerce Einstein Webstore Resources. Implementation of a Connect API endpoint for downloading exported Commerce Einstein activity files. Download an exported Commerce Einstein activity file for a store. _Available in: v55.0_ #### Parameters * `jobId` (path, string, required) ID of the job. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** Binary stream of the file content Media type: `application/octet-stream`. Schema: `string (binary)`. Binary stream of the file content Type: `string (binary)`. ### POST Commerce Einstein Webstore Activities, Purge `POST /commerce/webstores/{webstoreId}/ai/activities/purge-jobs` Operation ID: `postCommerceEinsteinActivityPurgeJobCollection`. Tags: Commerce Einstein Webstore Resources. Connect resource for posting activity purge jobs to the queue. Enqueue a job to purge Commerce Einstein activity for a store. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Request body Commerce Einstein activity job. Media type: `application/json`. Schema: `CommerceEinsteinActivityJobInput`. _Example: example\_1_ Payload 1 ``` { "userId": "005B0000000Ge16" } ``` #### Responses * **200** _Commerce Einstein Activity Purge Job_ Commerce Einstein activity purge job. Media type: `application/json`. Schema: `CommerceEinsteinActivityPurgeJob`. ### GET Commerce Einstein Webstore Activities, Purge Status `GET /commerce/webstores/{webstoreId}/ai/activities/purge-jobs/{jobId}` Operation ID: `getCommerceEinsteinActivityPurgeJob`. Tags: Commerce Einstein Webstore Resources. Connect API endpoint for getting the status of an activity purge job. Get the status of a Commerce Einstein activity purge job for a store. _Available in: v55.0_ #### Parameters * `jobId` (path, string, required) ID of the job. * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Commerce Einstein Activity Purge Job_ Commerce Einstein activity purge job. Media type: `application/json`. Schema: `CommerceEinsteinActivityPurgeJob`. ### GET Commerce Einstein Webstore Configuration `GET /commerce/webstores/{webstoreId}/ai/configuration` Operation ID: `getCommerceEinsteinConfiguration`. Tags: Commerce Einstein Webstore Resources. Provides access to Commerce Einstein configuration Get the Commerce Einstein configuration for a store. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Commerce Einstein Configuration_ Commerce Einstein configuration. Media type: `application/json`. Schema: `CommerceEinsteinConfiguration`. ### GET Commerce Einstein Webstore Recommendations `GET /commerce/webstores/{webstoreId}/ai/recommendations` Operation ID: `getCommerceEinsteinRecommendations`. Tags: Commerce Einstein Webstore Resources. Get recommendations in a webstore. Get Commerce Einstein product recommendations. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. * `anchorFromCurrentCart` (query, boolean) Indicates whether to use products in the cart as anchor values for generating product recommendations ( `true` ) or not ( `false` ). If unspecified, the default value is false . Use this field when using a product recommender as `CustomersWhoBoughtAlsoBought` . _Available in: v63.0_ * `anchorValues` (query, array of string (Id)) List of product or category IDs to use as context for the recommendations. When using a product recommender, such as `SimilarProducts` or `ComplementaryProducts` , specify product IDs. When using a category recommender, such as `MostViewedByCategory` or `TopSellingByCategory` , specify category IDs. The anchor list can't contain both product IDs and category IDs. This field is required for product or category recommenders. _Available in: v55.0_ * `currencyIsoCode` (query, string) Three-letter ISO 4217 currency code associated with the recommendation. _Available in: v56.0_ * `dataSpace` (query, string) Reserved for future use. _Available in: v60.0_ * `effectiveAccountId` (query, string) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. To view prices from the API, administrators must specify an effective account. _Available in: v55.0_ * `includePricingAndProductInformation` (query, boolean) Indicates whether to include product and pricing information for the request product in the response ( `true` ) or not ( `false` ). If unspecified, the default value is false . _Available in: v63.0_ * `includeRequestProduct` (query, boolean) Specifies whether to include product information for the requested product in the response ( `true` ) or not ( `false` ). If unspecified, the default value is false . _Available in: v60.0_ * `individualId` (query, string) Reserved for future use. _Available in: v60.0_ * `personalizationPoint` (query, string) Reserved for future use. _Available in: v60.0_ * `recommender` (query, CommerceEinsteinRecommenderConnectEnum, required) Specifies the recommender to use to generate recommendations. * `RecentlyViewed` — Generates recommendations based on items that the customer recently viewed. * `SimilarProducts` — Generates recommendations based on the viewing behavior of customers who viewed the same product and the product’s similarity to other products. These recommendations match the category of the product viewed. * `ComplementaryProducts` — Generates recommendations of products that complement other products. These recommendations don’t match the category of the product being viewed. * `CustomersWhoBoughtAlsoBought` — Generates recommendations of products that were bought by other customers who also bought this product. * `MostViewedByCategory` — Generates recommendations of products that were most viewed in a specific category. * `Personalization` —Reserved for future use. * `TopSellingByCategory` — Generates recommendations by analyzing which products were recently purchased by other customers in the category being viewed. * `Upsell` — Generates recommendations by analyzing the purchasing behavior of other shoppers who either bought or viewed the same product. * `TopSelling` — Generates recommendations by analyzing which products were recently purchased by other customers. * `PersonalizedForShopper` —Reserved for future use. When you specify a recommender, always include the `cqcid` cookie value in the "Cookie" header of your request. The value of the `cqcid` cookie must be the same as that used in the shopper's Einstein activity tracking events. If you omit the `cqcid` cookie, an empty set of results is returned. For more information about each recommender, see the Usage Notes section for the [Einstein Recommendations Component for D2C Stores](https://help.salesforce.com/s/articleView?id=commerce.comm_einstein_component.htm&type=5). _Available in: v55.0_ #### Responses * **200** _Commerce Einstein Recommendation Results_ Commerce Einstein recommendations. Media type: `application/json`. Schema: `CommerceEinsteinRecommendationResults`. #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0//commerce/webstores/0ZExx0000000002GAA/ai/recommendations ``` ### GET Commerce Einstein Webstore Deployment Status `GET /commerce/webstores/{webstoreId}/ai/status` Operation ID: `getCommerceEinsteinStatus`. Tags: Commerce Einstein Webstore Resources. Provides access to Commerce Einstein deployment status Get the status of a Commerce Einstein deployment for a store. _Available in: v55.0_ #### Parameters * `webstoreId` (path, string (Id), required) The ID of the web store. Pattern: ^(0ZE)\\w\*. #### Responses * **200** _Commerce Einstein Status_ Commerce Einstein deployment status. Media type: `application/json`. Schema: `CommerceEinsteinStatus`. ### POST Fulfillment Orders, Create Multiple `POST /commerce/fulfillment/actions/create-multiple` Operation ID: `postMultipleFulfillmentOrderCreate`. Tags: Salesforce Order Management Resources. Creates Multiple FulfillmentOrders in a Single Request Create FulfillmentOrders for multiple OrderDeliveryGroups in a single request. When the HTTP status code indicates success, the response body is a Multiple Fulfillment Order Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Multiple Fulfillment Order Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v50.0_ #### Request body List of inputs for creating fulfillment orders. Media type: `application/json`. Schema: `MultipleFulfillmentOrderInput`. #### Responses * **200** _Multiple Fulfillment Order Output_ A list of responses for the individual FulfillmentOrder creation attempts from a request to create multiple fulfillment orders. Media type: `application/json`. Schema: `MultipleFulfillmentOrderOutput`. ### POST Fulfillment Orders `POST /commerce/fulfillment/fulfillment-orders` Operation ID: `postFulfillmentOrderCreate`. Tags: Salesforce Order Management Resources. Creates Fulfillment Orders Create one or more FulfillmentOrders and FulfillmentOrderLineItems for an OrderDeliveryGroupSummary, which defines a delivery method and recipient for an OrderSummary. You specify the OrderItemSummaries to allocate, which can be fulfilled from different locations. Specifying multiple fulfillment groups creates one FulfillmentOrder for each location. For each OrderItemSummary, a FulfillmentOrderLineItem is created and assigned to the corresponding FulfillmentOrder. When the HTTP status code indicates success, the response body is a Fulfillment Order Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Fulfillment Order Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Request body An OrderDeliveryGroupSummary that defines a delivery method and recipient, and a list of fulfillment groups to assign to FulfillmentOrders. Each fulfillment group is a set of OrderItemSummaries that match the OrderDeliveryGroupSummary and share the same fulfillment location. The method creates a FulfillmentOrder for each fulfillment group and a FulfillmentOrderLineItem for each OrderItemSummary. Media type: `application/json`. Schema: `FulfillmentOrderInput`. _Example: example\_1_ Payload 1 ``` { "defaultActivationStatus": "Allocated", "orderSummaryId": "1Osxx0000000000001", "orderDeliveryGroupSummaryId": "0ag7Q000000xPYgQAM", "fulfillmentGroups": [ { "fulfilledFromLocationId": "131xx00000000W0001", "fulfillmentType": "warehouse", "orderItemSummaries": [ { "orderItemSummaryId": "10uxx00000000W0001", "quantity": 3 }, { "orderItemSummaryId": "10uxx00000000W0002", "quantity": 1 } ] } ] } ``` #### Responses * **200** _Fulfillment Order Output_ A list of IDs of the created FulfillmentOrders. Media type: `application/json`. Schema: `FulfillmentOrderOutput`. ### POST Fulfillment Orders, Create Multiple Invoices `POST /commerce/fulfillment/fulfillment-orders/actions/create-multiple-invoices` Operation ID: `postFulfillmentOrderCreateMultipleInvoices`. Tags: Salesforce Order Management Resources. Creates multiple Invoices for the Fulfillment Orders Create Invoices for multiple FulfillmentOrders. When the HTTP status code indicates success, the response body is a Multiple Fulfillment Order Invoices Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Multiple Fulfillment Order Invoices Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v52.0_ #### Request body The FulfillmentOrders to create Invoices for. Media type: `application/json`. Schema: `MultipleFulfillmentOrderInvoicesInput`. _Example: example\_1_ Payload 1 ``` { "fulfillmentOrderIds": [ "0a3xx00000000W1", "0a3xx00000000W2", "0a3xx00000000W3" ] } ``` #### Responses * **200** _Multiple Fulfillment Order Invoices Output_ IDs of the created Invoices. Media type: `application/json`. Schema: `MultipleFulfillmentOrderInvoicesOutput`. ### POST Fulfillment Orders, Cancel Item `POST /commerce/fulfillment/fulfillment-orders/{fulfillmentOrderId}/actions/cancel-item` Operation ID: `postFulfillmentOrderCancelOrderItems`. Tags: Salesforce Order Management Resources. Cancels items from the Fulfillment Order Cancel FulfillmentOrderLineItems from a FulfillmentOrder. This action doesn’t cancel the associated OrderItemSummaries, so reallocate the canceled quantities to a new FulfillmentOrder. When the HTTP status code indicates success, the response body is a Fulfillment Order Cancel Line Items Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Fulfillment Order Cancel Line Items Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Parameters * `fulfillmentOrderId` (path, string (Id), required) Fulfillment Order ID Pattern: ^(0a3)\\w\*. #### Request body A list of FulfillmentOrderLineItems and quantities to cancel. Media type: `application/json`. Schema: `FulfillmentOrderLineItemsToCancelInput`. _Example: example\_1_ Payload 1 ``` { "fulfillmentOrderLineItemsToCancel": [ { "fulfillmentOrderLineItemId": "0a4xx00000000W0001", "quantity": 1 }, { "fulfillmentOrderLineItemId": "0a4xx00000000W0002", "quantity": 2 } ] } ``` #### Responses * **200** _Fulfillment Order Cancel Line Items Output_ Wraps the base output. Media type: `application/json`. Schema: `FulfillmentOrderCancelLineItemsOutput`. ### POST Fulfillment Orders, Create Invoice `POST /commerce/fulfillment/fulfillment-orders/{fulfillmentOrderId}/actions/create-invoice` Operation ID: `postFulfillmentOrderCreateInvoice`. Tags: Salesforce Order Management Resources. Creates an Invoice for the Fulfillment Order Create an invoice for a FulfillmentOrder that doesn’t have one. When the HTTP status code indicates success, the response body is a Fulfillment Order Invoice Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Fulfillment Order Invoice Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Parameters * `fulfillmentOrderId` (path, string (Id), required) Fulfillment Order ID Pattern: ^(0a3)\\w\*. #### Request body Use an empty request body for this input. Media type: `application/json`. Schema: `FulfillmentOrderInvoiceInput`. _Example: example\_1_ Payload 1 ``` {} ``` #### Responses * **200** _Fulfillment Order Invoice Output_ ID of the created invoice. Media type: `application/json`. Schema: `FulfillmentOrderInvoiceOutput`. ### POST Fulfillment Orders, Distribute Quantities `POST /commerce/fulfillment/pick-tickets/actions/distribute-quantities` Operation ID: `postDistributePickedQuantities`. Tags: Salesforce Order Management Resources. Distributes batch-picked quantities to orders that require the items picked. Distributes batch-picked quantities to orders that require the items picked. _Available in: v58.0_ #### Request body (required) Input representation to Distribute Picked Quantities. _Available in: v58.0_ Media type: `application/json`. Schema: `object`. * `distributePickedQuantitiesInput` (_object_, required) DistributePickedQuantitiesInput Input to Distribute Picked Quantities. Includes all fields of `DistributePickedQuantitiesInput`. #### Responses * **200** _Distribute Picked Quantities Output_ Output representation of where the quantities were distributed in orders and any remaining quantity Media type: `application/json`. Schema: `DistributePickedQuantitiesOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` POST /services/data/vXX.0/commerce/fulfillment/pick-tickets/actions/distribute-quantities Content-Type: application/json; charset=UTF-8 Accept: application/json { "quantitiesPickedList": [{ "externalItemId": "sku1", "quantity": 16 }], "optimizationCriteria": "FulfillInSequencePartial", "distributeToOrders": [{ "externalOrderId:": "FO-1", "itemQuantities": [{ "externalItemId": "sku1", "quantity": 4 }] }] } ``` ### GET Analytics, Text Classifications `GET /commerce/order-management/analytics/ai/text-classifications` Operation ID: `getTextClassifications`. Tags: Salesforce Order Management Resources. Get text classified into different classifications using text analysis. Get text classified into different classifications using text analysis. _Available in: v59.0_ #### Parameters * `ids` (query, array of string, required) List of request IDs. _Available in: v59.0_ #### Responses * **200** _Text Classifications Bulk Results_ Text classification bulk results. Media type: `application/json`. Schema: `TextClassificationsBulkResultsOutput`. ### POST Analytics, Text Classifications `POST /commerce/order-management/analytics/ai/text-classifications` Operation ID: `postTextClassifications`. Tags: Salesforce Order Management Resources. Get text classified into different classifications using text analysis. Get text classified into different classifications using text analysis. _Available in: v59.0_ #### Parameters * `llmType` (query, string, required) The large language model that’s used for analysis. Supports open-ai only. _Available in: v59.0_ #### Request body (required) Input representation for text classifications request submission. _Available in: v59.0_ Media type: `application/json`. Schema: `TextClassificationsInput`. _Example: example\_1_ Payload 1 ``` { "textList": [ "description not matching one aaa", "Runs big", "color is different", "color is different", "Didn't fit", "bad quality", "Wrong color", "Didn't like", "Didn't like" ], "classifiers": [ "Runs big", "Runs small", "Defective", "Inaccurate Description", "Color does", "Item arrived late", "Other" ] } ``` #### Responses * **200** _Text Classifications_ HTTP headers containing URLs associating text strings and classifications. Media type: `application/json`. Schema: `TextClassificationsOutput`. ### GET Analytics, Products Return Rate `GET /commerce/order-management/analytics/insights/products-return-rate` Operation ID: `getProductsReturnRate`. Tags: Salesforce Order Management Resources. Get products with return rates Get a page of products with return rates. _Available in: v59.0_ #### Parameters * `dataSpacePrefixes` (query, array of string) The data space prefixes that fetch the related products of a data space. _Available in: v65.0_ * `page` (query, integer, required) Number of the page (for example, 2). _Available in: v59.0_ * `pageSize` (query, integer, required) Number of items per page. Valid values are 0 to 50. _Available in: v59.0_ * `products` (query, array of string) List of product IDs for which you want to get return rates. _Available in: v59.0_ #### Responses * **200** Product Return Rate List Media type: `application/json`. Schema: `ProductReturnRateListOutput`. ### POST Preview Cart to Exchange Order `POST /commerce/order-management/exchanges/actions/preview-cart-to-exchange-order` Operation ID: `postPreviewCartToExchangeOrder`. Tags: Salesforce Order Management Resources. Returns the expected change order financial values for a preview exchange order action on the Main Order Summary without executing the action. Retrieves a preview of an exchange order. This action considers the order summary balance and the difference between the return order and the cart that represents the exchange order. _Available in: v60.0_ #### Request body Information required to preview a cart to exchange order. Media type: `application/json`. Schema: `PreviewCartToExchangeOrderInput`. _Example: example\_1_ Payload 1 ``` { "orderSummaryId": "1Osxx0000000000", "exchangeCartId": "0a6xx0000000000", "referenceId": "2oNxx0000000000" } ``` #### Responses * **200** _Preview Cart To Exchange Order_ Expected change order financial values for the preview cart to exchange order action. Media type: `application/json`. Schema: `PreviewCartToExchangeOrderOutput`. ### POST Submit Cart to Exchange Order `POST /commerce/order-management/exchanges/actions/submit-cart-to-exchange-order` Operation ID: `postSubmitCartToExchangeOrder`. Tags: Salesforce Order Management Resources. Submits and creates the Exchange Order Summary Creates an exchange order summary, based on the return order and the cart used for exchanges. The new exchange order summary is attached to the original order summary (created before any exchanges occurred). You can also provide optional payment information and optional information about order summary sequences, which affect the newly created exchange order summary. _Available in: v60.0_ #### Request body Information required to submit an exchange order. Media type: `application/json`. Schema: `SubmitCartToExchangeOrderInput`. _Example: example\_1_ Payload 1 ``` { "orderSummaryId": "1Osxx0000000000", "exchangeCartId": "0a6xx0000000000", "referenceId": "2oNxx0000000000", "orderNumber": "My exchange order", "paymentInfoList": { "paymentInfoItems": [ { "paymentIds": [ "0aQxx0000000000", "0aQxx0000000001" ], "name": "VISA-1234", "paymentMethodId": "0aaxx0000000001", "lastPaymentGatewayLogId": "0Xtxx0000000001" }, { "paymentAuthorizationId": "0Xcxx0000000002", "name": "VISA-4567", "paymentMethodId": "0aaxx0000000002", "lastPaymentGatewayLogId": "0Xtxx0000000002" }, { "paymentIds": [ "0aQxx0000000003", "0aQxx0000000004" ], "paymentAuthorizationId": "0Xcxx0000000003", "name": "VISA-9123", "paymentMethodId": "0aaxx0000000003", "lastPaymentGatewayLogId": "0Xtxx0000000003" } ] }, "sequences": { "sequences": [ { "orderPaymentSummaryId": "0bMxx0000000000", "amount": 10 }, { "orderPaymentSummaryId": "0bMxx0000000001", "amount": 20 }, { "orderPaymentSummaryId": "0bMxx0000000002" } ] } } ``` #### Responses * **200** _Submit Cart to Exchange Order_ Exchange order summary resulting from a submit cart to exchange order action. Media type: `application/json`. Schema: `SubmitCartToExchangeOrderOutput`. ### POST Order Payment Summaries `POST /commerce/order-management/order-payment-summaries` Operation ID: `postCreateOrderPaymentSummary`. Tags: Salesforce Order Management Resources. Create an Order Payment Summary for a given Order Summary, Payment and/or Payment Authorization as well as an optional Payment Method. Create an OrderPaymentSummary for an OrderSummary. Specify a payment authorization or payments that share the same payment method. In an org with the multicurrency feature enabled, the OrderPaymentSummary inherits the CurrencyIsoCode value from the OrderSummary. When the HTTP status code indicates success, the response body is a Create Order Payment Summary Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Create Order Payment Summary Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Request body An OrderSummary for which to create an OrderPaymentSummary, with the payment authorization or payments to include in it. Media type: `application/json`. Schema: `CreateOrderPaymentSummaryInput`. #### Responses * **200** _Create Order Payment Summary Output_ ID of the created Order Payment Summary. Media type: `application/json`. Schema: `CreateOrderPaymentSummaryOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "orderSummaryId":"1Osxx0000000000001", "paymentAuthorizationId":"2Dgxx00000000W0001", “name”: “CASH” } ``` _Example: Example 2 · HTTP_ ``` { "orderSummaryId":"1Osxx0000000000001", "paymentIds":[ "0a3xx0000000085AAA", "0a3xx0000000085BBB", ], “name”: “CASH” } ``` ### POST Order Summaries `POST /commerce/order-management/order-summaries` Operation ID: `postOrderSummaryCreate`. Tags: Salesforce Order Management Resources. Create an Order Summary for a given Order. Create an OrderSummary based on an order. That order is considered the original order for the OrderSummary. Subsequent change orders that apply to the OrderSummary are also represented as orders. You can specify whether the order is managed in Salesforce Order Management or by an external system. Most Salesforce Order Management APIs can run only on orders that it manages. When the HTTP status code indicates success, the response body is an Order Summary Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is an Order Summary Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Request body An order from which to create an OrderSummary. Optionally, you can specify OrderSummary-specific information such as its Status and whether it is managed in Salesforce Order Management. Media type: `application/json`. Schema: `OrderSummaryInput`. _Example: example\_1_ Payload 1 ``` { "orderId": "801xx000003GbTgAAK" } ``` #### Responses * **200** _Order Summary Output_ ID of the created Order Summary. Media type: `application/json`. Schema: `OrderSummaryOutput`. ### POST Order Summaries, Create Multiple Invoices from Change Orders `POST /commerce/order-management/order-summaries/actions/create-multiple-change-invoices` Operation ID: `postCreateMultipleInvoicesFromChangeOrders`. Tags: Salesforce Order Management Resources. Creates multiple Invoices for the Change Orders Create Invoices to represent the charges for one or more change orders. Create Invoices for change orders that increase order amounts, such as for return fees. When you ensure the refund for a return, include the invoices for any associated return fees in the request. When the HTTP status code indicates success, the response body is a Create Multiple Invoices From Change Orders Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Create Multiple Invoices From Change Orders Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v56.0_ #### Request body Data about the change orders to create Invoices for. Media type: `application/json`. Schema: `CreateMultipleInvoicesFromChangeOrdersInput`. #### Responses * **200** _Create Multiple Invoices From Change Orders Output_ List of lists of invoices created from change orders for fees. Media type: `application/json`. Schema: `CreateMultipleInvoicesFromChangeOrdersOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` [ { "changeOrderIds" ["0a3xx00000000W1", "0a3xx00000000W2", "0a3xx00000000W3"], "orderSummaryId": "1Osxx0000004EAqCAM" } ] ``` ### POST Order Summaries, Multiple Ensure Funds Async `POST /commerce/order-management/order-summaries/async-actions/multiple-ensure-funds-async` Operation ID: `postOrderSummaryMultipleEnsureFundsAsync`. Tags: Salesforce Order Management Resources. This action triggers asynchronous background processes that send requests to the payment provider and await a response. It returns multiple IDs of the processes. Ensure and apply funds for one or more Invoices. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status. _Available in: v56.0_ #### Usage For each Invoice in the request, this method checks the OrderPaymentSummaries associated with the specified OrderSummary for funds to apply to the Invoice balance following this logic. 1. Verify that the Invoice balance doesn’t exceed the total BalanceAmount of all the OrderPaymentSummaries associated with the OrderSummary. 2. If an OrderPaymentSummary has a BalanceAmount equal to the invoice balance, apply the funds from that OrderPaymentSummary. 3. If no exact match was found, apply funds from the OrderPaymentSummary with the largest BalanceAmount. 4. If the Invoice still has a balance to ensure, repeat steps 2 and 3 until the full balance is ensured or no captured funds remain. 5. If the Invoice still has a balance, look for an OrderPaymentSummary with an authorized amount equal to the remaining Invoice balance. If one exists, capture and apply the funds from that OrderPaymentSummary. 6. If no exact match was found, capture and apply funds from the OrderPaymentSummary with the largest authorized amount. 7. If the Invoice still has a balance to ensure, repeat steps 5 and 6 until the full balance is ensured. If multiple OrderPaymentSummaries have equal BalanceAmount values, their order of selection is random. If the method creates a payment, the payment record’s ClientContext value isn’t predictable. Don't use it in custom logic. When the HTTP status code indicates success, the response body is a Multiple Async Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Multiple Async Output, and the value of the `enhancedErrorType` property can be ignored. #### Request body List of Invoices and the associated OrderSummaries. Media type: `application/json`. Schema: `MultipleEnsureFundsAsyncInput`. _Example: example\_1_ Payload 1 ``` { "asyncInputs": [ { "orderSummaryId": "1Osxx0000000001", "invoiceId": "3ttxx0000000001" }, { "orderSummaryId": "1Osxx0000000002", "invoiceId": "3ttxx0000000002" } ] } ``` #### Responses * **200** _Multiple Async Output_ IDs of the asynchronous background operations. This output only includes the operation IDs, regardless of whether calls are made to an external payment gateway. It doesn’t include any errors from the operations. Media type: `application/json`. Schema: `MultipleAsyncOutput`. ### POST Order Summaries, Preview Adjust `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/adjust-item-preview` Operation ID: `postAdjustOrderItemSummaryPreview`. Tags: Salesforce Order Management Resources. Adjusts items from the Order Summary Retrieve the expected results of adjusting the price of one or more OrderItemSummaries from an OrderSummary, without actually executing the adjustment. The response data contains the financial changes that would result from submitting the proposed adjustment. When the HTTP status code indicates success, the response body is an Adjust Order Summary Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is an Adjust Order Summary Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v49.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body Price adjustments to order item summaries that together make up a price adjustment to an order, with options for adjusting items in the process of being fulfilled. Media type: `application/json`. Schema: `AdjustOrderItemSummaryInput`. _Example: example\_1_ Payload 1 ``` { "adjustItems": [ { "reason": "Unknown", "amount": -45, "adjustmentType": "AmountWithoutTax", "orderItemSummaryId": "10uxx0000004EXLAA2", "description": "foobar" } ], "allocatedItemsChangeOrderType": "Disallowed" } ``` #### Responses * **200** _Adjust Order Summary Output_ Output representation of the financial changes for an adjust items action. For a preview action, these values are the expected output. For a submit action, these values are the actual output. Media type: `application/json`. Schema: `AdjustOrderSummaryOutput`. ### POST Order Summaries, Submit Adjust `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/adjust-item-submit` Operation ID: `postAdjustOrderItemSummarySubmit`. Tags: Salesforce Order Management Resources. Adjusts items from the Order Summary Adjust the price of one or more OrderItemSummaries from an OrderSummary, and create corresponding change orders. _Available in: v49.0_ #### Usage When a price adjustment is applied to an OrderItemSummary, its quantities are considered in three groups: * **Pre-fulfillment**: QuantityAvailableToFulfill, which is equal to QuantityOrdered - QuantityCanceled - QuantityAllocated * **In-fulfillment**: QuantityAllocated - QuantityFulfilled * **Post-fulfillment**: QuantityAvailableToReturn, which is equal to QuantityFulfilled - QuantityReturnInitiated You can apply adjustments to these groups in three different ways, controlled by the `{allocatedItemsChangeOrderType}` input property: * Distribute the adjustment evenly between pre-fulfillment and post-fulfillment quantities. Ignore in-fulfillment quantities. Create one change order for the adjustments to pre-fulfillment quantities and one change order for the adjustments to post-fulfillment quantities. * Distribute the adjustment evenly between pre-fulfillment, in-fulfillment, and post-fulfillment quantities. Create one change order for the adjustments to both pre-fulfillment and in-fulfillment quantities, and one change order for the adjustments to post-fulfillment quantities. * Distribute the adjustment evenly between pre-fulfillment, in-fulfillment, and post-fulfillment quantities. Create one change order for the adjustments to pre-fulfillment quantities, one change order for the adjustments to in-fulfillment quantities, and one change order for the adjustments to post-fulfillment quantities. After submitting a price adjustment, process refunds as appropriate: * If the discount only applied to OrderItemSummaries for which payment has not been captured, it does not require a refund. This situation normally applies to OrderItemSummaries in the US that have not been fulfilled. * If the discount applied to OrderItemSummaries that have not been fulfilled and for which payment has been captured, process a refund. In this case, pass the `{totalExcessFundsAmount}` from the response body to the [Order Summaries, Ensure Refunds Async](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postOrderSummaryEnsureRefundsAsync) resource. * If the discount applied to OrderItemSummaries that have been fulfilled, process a refund. Pass the `{postFulfillmentChangeOrderId}` from the response body to the [Order Summaries, Create Credit Memo](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postCreateCreditMemo) resource, then pass the CreditMemo to the [Order Summaries, Ensure Refunds Async](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postOrderSummaryEnsureRefundsAsync) resource. * If the discount applied to both fulfilled and unfulfilled OrderItemSummaries for which payment has been captured, process both refunds. Pass the `{postFulfillmentChangeOrderId}` from the response body to the [Order Summaries, Create Credit Memo](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postCreateCreditMemo) resource, then pass the credit memo and the `{totalExcessFundsAmount}` from the response body to the [Order Summaries, Ensure Refunds Async](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postOrderSummaryEnsureRefundsAsync) resource. When the HTTP status code indicates success, the response body is an Adjust Order Summary Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is an Adjust Order Summary Output, and the value of the `enhancedErrorType` property can be ignored. #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body Price adjustments to order item summaries that together make up a price adjustment to an order, with options for adjusting items in the process of being fulfilled. Media type: `application/json`. Schema: `AdjustOrderItemSummaryInput`. _Example example\_1: same as POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/adjust-item-preview request._ Payload 1 _Example: example\_1_ Payload 1 #### Responses * **200** _Adjust Order Summary Output_ Output representation of the financial changes for an adjust items action. For a preview action, these values are the expected output. For a submit action, these values are the actual output. Media type: `application/json`. Schema: `AdjustOrderSummaryOutput`. ### POST Order Summaries, Create Credit Memo `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/create-credit-memo` Operation ID: `postCreateCreditMemo`. Tags: Salesforce Order Management Resources. Creates a Credit Memo associated with the Order Summary Create a credit memo to represent the refund for one or more change orders associated with an OrderSummary. When the HTTP status code indicates success, the response body is a Create Credit Memo Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Create Credit Memo Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body A list of change orders used to create a credit memo. Media type: `application/json`. Schema: `CreateCreditMemoInput`. _Example: example\_1_ Payload 1 ``` { "changeOrderIds": [ "801R0000000EAAkIAO" ] } ``` #### Responses * **200** _Create Credit Memo Output_ ID of a created Credit Memo. Media type: `application/json`. Schema: `CreateCreditMemoOutput`. ### POST Order Summaries, Preview Cancel `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/preview-cancel` Operation ID: `postOrderSummaryPreviewCancel`. Tags: Salesforce Order Management Resources. Returns the expected change order financial values for a cancel items action on the Order Summary without executing the action Retrieve the expected change order values for canceling one or more OrderItemSummaries from an OrderSummary, without actually executing the cancel. When the HTTP status code indicates success, the response body is a Preview Cancel Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Preview Cancel Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body A list of changes to order item summaries that make up an order change, such as a cancel or return. Media type: `application/json`. Schema: `ChangeInput`. _Example: example\_1_ Payload 1 ``` { "changeItems": [ { "orderItemSummaryId": "10uxx0000004FYDAA2", "quantity": 1, "reason": "Wrong Item", "shippingReductionFlag": true } ] } ``` #### Responses * **200** _Preview Cancel Output_ Expected financial values for a proposed cancel action. Media type: `application/json`. Schema: `PreviewCancelOutput`. ### POST Order Summaries, Preview Change `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/preview-change` Operation ID: `postPreviewChangeOrderSummary`. Tags: Salesforce Order Management Resources. Returns the expected change order financial values for changing order summary fields and related entities without executing the action Return the expected change order financial values for changing order summary fields and related entities without executing the action. _Available in: v66.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body (required) application/json _Available in: v66.0_ Media type: `application/json`. Schema: `object`. * `changeOrderSummaryInput` (_object_, required) ChangeOrderSummaryInput The order summary change that you’re previewing. Includes all fields of `ChangeOrderSummaryInput`. #### Responses * **200** _Preview Change Order Summary_ The output representation for the change order summary preview. Media type: `application/json`. Schema: `PreviewChangeOrderSummaryOutput`. ### POST Order Summaries, Preview Return `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/preview-return` Operation ID: `postOrderSummaryPreviewReturn`. Tags: Salesforce Order Management Resources. Returns the expected change order financial values for a return items action on the Order Summary without executing the action Retrieve the expected change order values for a simple return of one or more OrderItemSummaries from an OrderSummary, without actually executing the return. When the HTTP status code indicates success, the response body is a Preview Return Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Preview Return Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body A list of changes to order item summaries that make up an order change, such as a cancel or return. Media type: `application/json`. Schema: `ChangeInput`. _Example: example\_1_ Payload 1 ``` { "changeItems": [ { "orderItemSummaryId": "10uxx0000004FYDAA2", "quantity": 1, "reason": "Wrong Item", "shippingReductionFlag": true } ] } ``` #### Responses * **200** _Preview Return Output_ Expected financial values for a proposed return action. Media type: `application/json`. Schema: `PreviewReturnOutput`. ### POST Order Summaries, Submit Cancel `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/submit-cancel` Operation ID: `postOrderSummarySubmitCancel`. Tags: Salesforce Order Management Resources. Cancels items from the Order Summary Cancel one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order. When the HTTP status code indicates success, the response body is a Submit Cancel Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Submit Cancel Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v48.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body A list of changes to order item summaries that make up an order change, such as a cancel or return. Media type: `application/json`. Schema: `ChangeInput`. _Example: example\_1_ Payload 1 ``` { "changeItems": [ { "orderItemSummaryId": "10uxx0000004FYDAA2", "quantity": 1, "reason": "Wrong Item", "shippingReductionFlag": true } ] } ``` #### Responses * **200** _Submit Cancel Output_ ID of the change order created for a cancel action, and a set of its financial values. Media type: `application/json`. Schema: `SubmitCancelOutput`. ### POST Order Summaries, Submit Change `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/submit-change` Operation ID: `postSubmitChangeOrderSummary`. Tags: Salesforce Order Management Resources. Submits the change order values for changing order summary fields and related entities. Submit changes to an existing order summary's non-financial fields, pre-fulfillment order item summaries, and related adjustments and taxes, including custom fields. This resource supports adding or modifying order delivery groups and order level adjustments. _Available in: v66.0_ #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body (required) application/json _Available in: v66.0_ Media type: `application/json`. Schema: `object`. * `changeOrderSummaryInput` (_object_, required) ChangeOrderSummaryInput The order summary that you’re changing. Includes all fields of `ChangeOrderSummaryInput`. #### Responses * **200** _Submit Change Order Summary_ The output representation for the submitted change order summary. Media type: `application/json`. Schema: `SubmitChangeOrderSummaryOutput`. ### POST Order Summaries, Submit Return `POST /commerce/order-management/order-summaries/{orderSummaryId}/actions/submit-return` Operation ID: `postOrderSummarySubmitReturn`. Tags: Salesforce Order Management Resources. Returns items from the Order Summary Return one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order. This return is a simple return that creates a change order but not a ReturnOrder. _Available in: v48.0_ #### Usage After submitting a return, process a refund. Pass the `{changeOrderId}` from the response body to the [Order Summaries, Create Credit Memo](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postCreateCreditMemo) resource, then pass the CreditMemo to the [Order Summaries, Ensure Refunds Async](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Salesforce-Order-Management-Resources/operation/postOrderSummaryEnsureRefundsAsync) resource. When the HTTP status code indicates success, the response body is a Submit Return Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Submit Return Output, and the value of the `enhancedErrorType` property can be ignored. #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body A list of changes to order item summaries that make up an order change, such as a cancel or return. Media type: `application/json`. Schema: `ChangeInput`. _Example: example\_1_ Payload 1 ``` { "changeItems": [ { "orderItemSummaryId": "10uxx0000004FYDAA2", "quantity": 1, "reason": "Wrong Item", "shippingReductionFlag": true } ] } ``` #### Responses * **200** _Submit Return Output_ ID of the change order created for a return action, and a set of its financial values. Media type: `application/json`. Schema: `SubmitReturnOutput`. ### POST Order Summaries, Ensure Funds Async `POST /commerce/order-management/order-summaries/{orderSummaryId}/async-actions/ensure-funds-async` Operation ID: `postOrderSummaryEnsureFundsAsync`. Tags: Salesforce Order Management Resources. This action triggers an asynchronous background process that sends a request to the payment provider and awaits a response. It returns the ID of that process. Ensure funds for an Invoice and apply them to it and optional define a sequence to capture payments in. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status. _Available in: v48.0_ #### Usage This method checks the OrderPaymentSummaries associated with the specified OrderSummary for funds to apply to the Invoice balance following this logic: 1. Verify that the Invoice balance doesn’t exceed the total BalanceAmount of all the OrderPaymentSummaries associated with the OrderSummary. 2. If an OrderPaymentSummary has a BalanceAmount equal to the Invoice balance, apply the funds from that OrderPaymentSummary. 3. If no exact match was found, apply funds from the OrderPaymentSummary with the largest BalanceAmount. 4. If the Invoice still has a balance to ensure, repeat steps 2 and 3 until the full balance is ensured or no captured funds remain. 5. If the Invoice still has a balance, look for an OrderPaymentSummary with an authorized amount equal to the remaining Invoice balance. If one exists, capture and apply the funds from that OrderPaymentSummary. 6. If no exact match was found, capture and apply funds from the OrderPaymentSummary with the largest authorized amount. 7. If the Invoice still has a balance to ensure, repeat steps 5 and 6 until the full balance is ensured. If multiple OrderPaymentSummaries have equal BalanceAmount values, their order of selection is random. If the method creates a payment, the payment record’s ClientContext value isn’t predictable. Don't use it in custom logic. When the HTTP status code indicates success, the response body is an Ensure Funds Async Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is an Ensure Funds Async Output, and the value of the `enhancedErrorType` property can be ignored. #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body ID of an Invoice to ensure funds for and apply them to. Media type: `application/json`. Schema: `EnsureFundsAsyncInput`. _Example: example\_1_ Payload 1 ``` { "invoiceId": "3ttR000000000JNIAY" } ``` #### Responses * **200** _Ensure Funds Async Output_ ID of the asynchronous background operation. This output only includes the operation ID, regardless of whether a call is made to an external payment gateway. It doesn’t include any errors from the operation. Media type: `application/json`. Schema: `EnsureFundsAsyncOutput`. ### POST Order Summaries, Ensure Refunds Async `POST /commerce/order-management/order-summaries/{orderSummaryId}/async-actions/ensure-refunds-async` Operation ID: `postOrderSummaryEnsureRefundsAsync`. Tags: Salesforce Order Management Resources. This action triggers an asynchronous background process that sends a request to the payment provider and awaits a response. It returns the ID of that process. Ensure refunds for a CreditMemo or excess funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and don’t affect the background operation status. _Available in: v48.0_ #### Usage This method applies the refund to the OrderPaymentSummaries associated with the specified OrderSummary following this logic. 1. Verify that the CreditMemo balance and excess funds amount don't exceed the total AvailableToRefund amount of all the OrderPaymentSummaries associated with the OrderSummary. 2. If sequences is specified, follow these steps. 1. Traverse the sequences list in order and apply the specified refund amounts to the specified OrderPaymentSummaries. 2. If the specified CreditMemo and excess funds are fully refunded, or if isAllowPartial is true, then the action stops here. 3. If a CreditMemo is specified, follow these steps. 1. If an OrderPaymentSummary has an AvailableToRefund amount matching the CreditMemo’s remaining balance, apply the refund to that payment. 2. If no exact match was found but one or more OrderPaymentSummary has a large enough AvailableToRefund amount to cover the balance, use the OrderPaymentSummary with the smallest AvailableToRefund amount. 3. If no single OrderPaymentSummary has a large enough AvailableToRefund amount, use multiple OrderPaymentSummaries in descending order of AvailableToRefund amount. This ensures the fewest OrderPaymentSummaries are used. 4. If only one OrderPaymentSummary is specified but has multiple payments, follow these steps. 1. If a payment has an amount matching the CreditMemo’s remaining balance, apply the refund to that payment. 2. If no exact match was found but one or more payment has a large enough amount to cover the balance, use the payment with the smallest amount. 3. If no single payment has a large enough amount, use multiple payments in descending order of amount. This ensures the fewest payments are used. 5. If an excess funds amount is specified, follow these steps. 1. Examine those OrderPaymentSummaries. If one has an AvailableToRefund amount matching the excess funds amount, apply the refund to that OrderPaymentSummary. 2. If no exact match was found but one or more OrderPaymentSummary has a large enough AvailableToRefund amount to cover the balance, use the OrderPaymentSummary with the smallest AvailableToRefund amount. 3. If no single OrderPaymentSummary has a large enough AvailableToRefund amount, use multiple OrderPaymentSummaries in descending order of AvailableToRefund amount. This ensures the fewest OrderPaymentSummaries are used. If multiple OrderPaymentSummaries have equal AvailableToRefund amounts, their order of selection is random. If the method creates a refund, the refund record’s ClientContext value isn’t predictable. Don't use it in custom logic. When the HTTP status code indicates success, the response body is an Ensure Refunds Async Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is an Ensure Refunds Async Output, and the value of the `enhancedErrorType` property can be ignored. #### Parameters * `orderSummaryId` (path, string (Id), required) Order Summary ID Pattern: ^(1Os)\\w\*. #### Request body ID of a credit memo to ensure refunds for, an amount of excess funds to refund, or both. At least one is required. Also includes any invoices for fees that reduce the refund amount, such as return fees. If multiple payment methods are available, you can specify how to distribute the refund. Media type: `application/json`. Schema: `EnsureRefundsAsyncInput`. #### Responses * **200** _Ensure Refunds Async Output_ ID of the asynchronous background operation. This output only includes the operation ID, regardless of whether a call is made to an external payment gateway. It doesn’t include any errors from the operation. Media type: `application/json`. Schema: `EnsureRefundsAsyncOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` { "creditMemoId": "50gR000000000JB00G", "invoicesToPay": [ { .."invoiceId": "3ttR000000000JNIAY" } ] } ``` ### GET Products `GET /commerce/order-management/products` Operation ID: `getProductsExpand`. Tags: Salesforce Order Management Resources. Capture the return reasons from external sources based on the product ids. Capture the return reasons from external sources based on the product IDs. _Available in: v59.0_ #### Parameters * `expand` (query, array of ConnectProductExpandType, required) Product expand type. Valid value is `ReturnReasons` . _Available in: v59.0_ * `products` (query, array of string, required) A list of IDs to fetch details for. _Available in: v59.0_ * `scope` (query, string, required) The scope for the extensibility framework. Requires a webstore ID. _Available in: v59.0_ #### Responses * **200** _Product List_ Products with product data and with expand details. Media type: `application/json`. Schema: `ProductsListOutput`. ### POST Routing, Find Routes with Fewest Splits `POST /commerce/order-management/routing/actions/find-routes-with-fewest-splits` Operation ID: `postFindRoutesWithFewestSplits`. Tags: Salesforce Order Management Resources. Find Routes With Fewest Splits Returns combinations of inventory locations that can fulfill an order within a specified limit of shipment splits. By default, checks up to 1,000,000 potential routes, returning a maximum of 10,000 results. When the HTTP status code indicates success, the response body is a Find Routes With Fewest Splits Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Find Routes With Fewest Splits Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v51.0_ #### Request body Data used to calculate order fulfillment routes involving the fewest number of shipment splits. Media type: `application/json`. Schema: `FindRoutesWithFewestSplitsInput`. #### Responses * **200** _Find Routes With Fewest Splits Output_ A list of inventory location combinations that can fulfill an order without exceeding the maximum number of shipments. Media type: `application/json`. Schema: `FindRoutesWithFewestSplitsOutput`. ### POST Routing, Find Routes with Fewest Splits Using OCI `POST /commerce/order-management/routing/actions/find-routes-with-fewest-splits-using-oci` Operation ID: `postFindRoutesWithFewestSplitsUsingOCI`. Tags: Salesforce Order Management Resources. Find Routes With Fewest Splits Using Omnichannel Inventory Service For one or more order summaries, find inventory availability using Omnichannel Inventory and identify the fulfillment routes with fewest splits. This method combines the functionality of the Get Inventory Availability and Find Routes With Fewest Splits resources. When the HTTP status code indicates success, the response body is a Find Routes With Fewest Splits Using OCI Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Find Routes With Fewest Splits Using OCI Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v54.0_ #### Request body Data used to calculate order fulfillment routes involving the fewest number of shipment splits, taking into account inventory availability. Media type: `application/json`. Schema: `FindRoutesWithFewestSplitsUsingOCIInput`. #### Responses * **200** _Find Routes With Fewest Splits Using OCI Output_ A list of order fulfillment routes with inventory availability information. Media type: `application/json`. Schema: `FindRoutesWithFewestSplitsUsingOCIOutput`. ### POST Routing, Rank By Average Distance `POST /commerce/order-management/routing/actions/rank-byaverage-distance` Operation ID: `postRankAverageDistance`. Tags: Salesforce Order Management Resources. Rank Average Distance Calculates the average distance from sets of inventory locations to an order recipient, and ranks them. Use this method to compare the average shipping distances for different sets of locations that can fulfill an order. While this method is executing, you can’t invoke another Apex callout. When the HTTP status code indicates success, the response body is a Rank Average Distance Output. The response body can still indicate processing errors. When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The `output` property is a Rank Average Distance Output, and the value of the `enhancedErrorType` property can be ignored. _Available in: v51.0_ #### Request body An order recipient’s geographic location and information about sets of inventory locations that can fulfill the order. Media type: `application/json`. Schema: `RankAverageDistanceInput`. #### Responses * **200** _Rank Average Distance Output_ The results of calculating the average distances from sets of inventory locations to an order recipient. Media type: `application/json`. Schema: `RankAverageDistanceOutput`. ### POST Routing, Confirm Held Capacity `POST /commerce/order-management/routing/fulfillment-order-capacity/actions/confirm-held-capacity` Operation ID: `postConfirmHeldFOCapacity`. Tags: Salesforce Order Management Resources. Confirm Held Fulfillment Order Capacity Confirm held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity and increases its assigned fulfillment order count. Confirm held capacity when you assign a fulfillment order to a location. Confirm Held FO Capacity Output _Available in: v55.0_ #### Request body Request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call. Media type: `application/json`. Schema: `ConfirmHeldFOCapacityInput`. _Example: example\_1_ Payload 1 ``` { "confirmHeldFOCapacityRequests": [ { "capacityRequests": [ { "actionRequestId": "FOCapacityInteractionId1", "locationId": "LOC-1" } ], "allOrNothing": false }, { "capacityRequests": [ { "actionRequestId": "FOCapacityInteractionId2", "locationId": "LOC-1" }, { "actionRequestId": "FOCapacityInteractionId3", "locationId": "LOC-2" } ], "allOrNothing": false } ] } ``` #### Responses * **200** _Confirm Held FO Capacity Output_ Response to a request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call. Media type: `application/json`. Schema: `ConfirmHeldFOCapacityOutput`. ### POST Routing, Get Capacity Values `POST /commerce/order-management/routing/fulfillment-order-capacity/actions/get-capacity-values` Operation ID: `postGetFOCapacityValues`. Tags: Salesforce Order Management Resources. Get Capacity Fulfillment Order Reservations Get information about the current fulfillment order capacity of one or more locations. _Available in: v55.0_ #### Request body Locations to get fulfillment order capacity information for. Media type: `application/json`. Schema: `GetFOCapacityValuesRequestInput`. _Example: example\_1_ Payload 1 ``` { "locationIds": [ "LOC-1", "LOC-2", "LOC-3", "LOC-5" ] } ``` #### Responses * **200** _Get FO Capacity Values Output_ Response to a request for fulfillment order capacity values for one or more locations. Media type: `application/json`. Schema: `GetFOCapacityValuesOutput`. ### POST Routing, Hold Capacity `POST /commerce/order-management/routing/fulfillment-order-capacity/actions/hold-capacity` Operation ID: `postHoldFOCapacity`. Tags: Salesforce Order Management Resources. Hold fulfillment order capacity. Hold fulfillment order capacity at a location. Holding capacity at a location reserves a space for a fulfillment order that you’ll assign to it. _Available in: v55.0_ #### Request body Request to hold fulfillment order capacity at one or more locations. Can correspond to one action call. Media type: `application/json`. Schema: `HoldFOCapacityInput`. _Example: example\_1_ Payload 1 ``` { "holdFOCapacityRequests": [ { "capacityRequests": [ { "actionRequestId": "FOCapacityInteractionId1", "locationId": "LOC-1" }, { "actionRequestId": "FOCapacityInteractionId2", "locationId": "LOC-1" }, { "actionRequestId": "FOCapacityInteractionId3", "locationId": "LOC-2" } ], "allOrNothing": false }, { "capacityRequests": [ { "actionRequestId": "FOCapacityInteractionId4", "locationId": "LOC-1" }, { "actionRequestId": "FOCapacityInteractionId5", "locationId": "LOC-1" } ], "allOrNothing": true } ] } ``` #### Responses * **200** _Hold FO Capacity Output_ Response to a request to hold fulfillment order capacity at one or more locations. Can correspond to one action call. Media type: `application/json`. Schema: `HoldFOCapacityOutput`. ### POST Routing, Release Held Capacity `POST /commerce/order-management/routing/fulfillment-order-capacity/actions/release-held-capacity` Operation ID: `postReleaseHeldFOCapacity`. Tags: Salesforce Order Management Resources. Release Fulfillment Order Reservations Release held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity without changing its assigned fulfillment order count. Release held capacity when you cancel the assignment of a fulfillment order to a location. _Available in: v55.0_ #### Request body Request to release held fulfillment order capacity at one or more locations. Can correspond to one action call. Media type: `application/json`. Schema: `ReleaseHeldFOCapacityInput`. _Example: example\_1_ Payload 1 ``` { "releaseHeldFOCapacityRequests": [ { "capacityRequests": [ { "actionRequestId": "FOCapacityInteractionId1", "locationId": "LOC-1" }, { "actionRequestId": "FOCapacityInteractionId4", "locationId": "LOC-1" } ], "allOrNothing": false }, { "capacityRequests": [ { "actionRequestId": "FOCapacityInteractionId2", "locationId": "LOC-2" }, { "actionRequestId": "FOCapacityInteractionId3", "locationId": "LOC-2" } ], "allOrNothing": false } ] } ``` #### Responses * **200** _Release Held FO Capacity Output_ Response to a request to release held fulfillment order capacity at one or more locations. Can correspond to one action call. Media type: `application/json`. Schema: `ReleaseHeldFOCapacityOutput`. ### GET Repricing, Product Search `GET /commerce/order-management/webstores/{webstoreId}/products` Operation ID: `ProductSearch`. Tags: Salesforce Order Management Resources. Search for products by keyword. Search a webstore for products by search term. _Available in: v59.0_ #### Parameters * `webstoreId` (path, string (Id), required) Web Store ID Pattern: ^(0ZE)\\w\*. * `effectiveAccountId` (query, string) ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. Required for B2B and D2C webstores _Available in: v59.0_ * `facets` (query, string) A list of facet names to filter the search. For example, `["size_medium", "color_red"]` is encoded to `WyJzaXplX21lZGl1bSIsICJjb2xvcl9yZWQiXQ==` _Available in: v59.0_ * `page` (query, integer) Maximum number of search results pages to return. If you don't specify a value, the default is 1. _Available in: v59.0_ * `pageSize` (query, integer) Number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 20. _Available in: v59.0_ * `searchTerm` (query, string, required) Term used for the search. _Available in: v59.0_ #### Responses * **200** _Product Search_ Product search response. Media type: `application/json`. Schema: `ProductSearchOutput`. ### GET Repricing, Product Details `GET /commerce/order-management/webstores/{webstoreId}/products/{skuOrProductId}` Operation ID: `ProductDetails`. Tags: Salesforce Order Management Resources. Product Details Resource Get details of a product in a web store. _Available in: v55.0_ #### Parameters * `skuOrProductId` (path, string, required) SKU or Product ID * `webstoreId` (path, string (Id), required) Web Store ID Pattern: ^(0ZE)\\w\*. * `currencyCode` (query, string) ISO currency code. If you pass null, the default store value is used. _Available in: v55.0_ * `effectiveAccountId` (query, string) Effective Account ID. Required for B2B stores. For other stores, pass null. Required for B2B stores _Available in: v55.0_ * `excludeAttributeSetInfo` (query, boolean) Specifies whether the attribute set information for the product is returned. * `excludeBundleChildrenInfo` (query, boolean) Specifies whether the child product information for the product bundle is returned. _Available in: v64.0_ * `excludeMedia` (query, boolean) Specifies whether the media groups and default images of the product are returned. * `excludePrices` (query, boolean) Specifies whether the prices for the product is returned. * `excludeQuantityRule` (query, boolean) Specifies whether the quantity rule information for the product is returned. * `excludeVariationInfo` (query, boolean) Specifies whether the variation information for the product is returned. * `locale` (query, string) Locale. If you pass null, the default store value is used. _Available in: v55.0_ #### Responses * **200** Success Media type: `application/json`. Schema: `ProductDetailsOutput`. ### POST Return Orders `POST /commerce/returns/return-orders` Operation ID: `postReturnOrderCreate`. Tags: Salesforce Order Management Resources. Creates Return Order Create a ReturnOrder and ReturnOrderLineItems for items belonging to an OrderSummary. _Available in: v50.0_ #### Request body Data for creating a ReturnOrder and ReturnOrderLineItems. Media type: `application/json`. Schema: `ReturnOrderInput`. _Example: example\_1_ Payload 1 ``` { "orderSummaryId": "1Osxx0000004EAqCAM", "status": "Submitted", "returnOrderLifeCycleType": "Unmanaged", "returnOrderLineItems": [ { "quantityExpected": "1", "reasonForReturn": "Not Satisfied", "canReduceShipping": false, "orderItemSummaryId": "10uxx0000004GKbAAM", "quantityReceived": "0" } ] } ``` #### Responses * **200** _Return Order Output_ Output representation of the created Return Order. Media type: `application/json`. Schema: `ReturnOrderOutput`. ### POST Return Orders, Return Items `POST /commerce/returns/return-orders/{returnOrderId}/actions/return-items` Operation ID: `postReturnItems`. Tags: Salesforce Order Management Resources. Return Items Process ReturnOrderLineItems belonging to a ReturnOrder. Processing a ReturnOrderLineItem generates a change Order and makes that ReturnOrderLineItem read-only. The change order for a returned item or delivery charge has a positive amount and should be used to create a credit memo. The change order for a return fee has a negative amount and should be used to create an invoice. If a processed ReturnOrderLineItem has any remaining expected quantity, then the API creates a separate ReturnOrderLineItem representing that quantity. _Available in: v52.0_ #### Parameters * `returnOrderId` (path, string (Id), required) Return Order ID Pattern: ^(2oN)\\w\*. #### Request body Data about products and delivery charges to return, as well as associated return fees. Media type: `application/json`. Schema: `ReturnItemsInput`. _Example: example\_1_ Payload 1 ``` { "returnOrderItems": [ { "returnOrderLineItemId": "10uxx0000004GKbAAM", "quantityReturned": "1", "quantityToCancel": "0", "quantityReceived": "1", "quantityRejected": "0", "reasonForRejection": "N/A" } ], "returnOrderItemDeliveryCharges": [ { "returnOrderLineItemId": "10uxx0000004GKbAAP" } ], "returnOrderItemFees": [ { "returnOrderLineItemId": "10uxx0000004GKbA23", "quantityReturned": "1", "quantityToCancel": "0" } ] } ``` #### Responses * **200** _Return Items Output_ Output of Return Items. Includes the ID of the generated change order for items and delivery charges being returned, as well as the ID of the generated change order for any charged return fees. Also includes information about any ReturnOrderLineItems that were created to represent remaining return quantities. Media type: `application/json`. Schema: `ReturnItemsOutput`. ### POST Register Guest Buyer `POST /commerce/webstores/{webstoreId}/accounts/{accountId}/actions/register-guest-buyer` Operation ID: `postRegisterGuestBuyer`. Tags: Salesforce Order Management Resources. Register the given account id as buyer for given webstore Register a guest buyer for a webstore using an account ID. This action enables a guest buyer to order on behalf of another buyer. _Available in: v60.0_ #### Parameters * `accountId` (path, string, required) Account ID * `webstoreId` (path, string (Id), required) Web Store ID Pattern: ^(0ZE)\\w\*. #### Request body Media type: `application/json`. Schema: `RegisterGuestBuyerInput`. #### Responses * **200** _Register Guest Buyer_ Indicates success or failure of a register guest buyer action. Media type: `application/json`. Schema: `RegisterGuestBuyerOutput`. ### POST Pending Order Summaries `POST /commerce/order-summaries` Operation ID: `postSubmitOrderSummaryGraphs`. Tags: Salesforce Order Management Resources. Receives Order Summary graphs to be enqueued Create pending order summaries from order summary graphs. The High Scale Orders feature must be active, but a B2C Commerce connection isn’t required. Created pending order summaries are queued for automatic processing into order summaries, the same as pending order summaries ingested from B2C Commerce. The provided JSON example references person accounts, but business accounts are also supported. _Available in: v57.0_ #### Request body List of graphs containing order summary data. Media type: `application/json`. Schema: `OrderSummaryGraphsInput`. _Example: example\_1_ Payload 1 ``` { "orderSummaryGraphs": [ { "orderSummaryGraphId": "${ID}", "purchaseSupportDetails": [ { "attributes": { "attributes": { "type": "Account" }, "Name": "FTest Suite", "FirstName": "FTest", "LastName": "Suite", "Phone": "(111)-111-1111", "isPersonAccount": true }, "referenceId": "refAccount" }, { "referenceId": "refProduct2_1", "attributes": { "attributes": { "type": "Product2" }, "Description": "WOMEN'S TORPEDO JACKET 1", "Name": "WOMEN'S TORPEDO JACKET 1", "StockKeepingUnit": "${ProductCode1}", "ProductCode": "${ProductCode1}", "IsActive": true } }, { "referenceId": "refProduct2_2", "attributes": { "attributes": { "type": "Product2" }, "Description": "Apple Watch", "Name": "Apple Watch", "StockKeepingUnit": "${ProductCode2}", "ProductCode": "${ProductCode2}", "IsActive": true } }, { "referenceId": "refPricebookEntry_1", "attributes": { "attributes": { "type": "PricebookEntry" }, "Pricebook2Id": "${StandardPricebookId}", "UnitPrice": 200, "IsActive": true, "Product2Id": "@{refProduct2_1.id}", "CurrencyIsoCode": "USD" } }, { "referenceId": "refPricebookEntry_2", "attributes": { "attributes": { "type": "PricebookEntry" }, "Pricebook2Id": "${StandardPricebookId}", "UnitPrice": 800, "IsActive": true, "Product2Id": "@{refProduct2_2.id}", "CurrencyIsoCode": "USD" } }, { "referenceId": "refSalesChannel", "attributes": { "attributes": { "type": "SalesChannel" }, "Description": "NTO", "SalesChannelName": "${SalesChannelName}" } }, { "referenceId": "refPromotion_1", "attributes": { "attributes": { "type": "Promotion" }, "Name": "${PromotionName1}", "DisplayName": "${PromotionName1}", "Description": "${PromotionName1}", "StartDate": "2022-05-24", "StartDateTime": "2021-09-06T23:58:59Z", "EndDateTime": "2025-09-06T23:58:59Z", "IsAutomatic": true, "IsCommercePromotion": true, "IsActive": true } }, { "referenceId": "refPromotion_2", "attributes": { "attributes": { "type": "Promotion" }, "Name": "${PromotionName2}", "DisplayName": "${PromotionName2}", "Description": "${PromotionName2}", "StartDate": "2022-05-24", "StartDateTime": "2021-09-06T23:58:59Z", "EndDateTime": "2025-09-06T23:58:59Z", "IsCommercePromotion": true, "IsActive": true } }, { "referenceId": "refWebStore", "attributes": { "attributes": { "type": "WebStore" }, "Name": "NTO USD", "Type": "B2CE", "ExternalReference": "${WebStoreExternalReference}", "DefaultTaxLocaleType": "Net" } }, { "referenceId": "refOrderDeliveryMethod", "attributes": { "attributes": { "type": "OrderDeliveryMethod" }, "Name": "Overnight", "Description": "FedEx", "ReferenceNumber": "${OrderDeliveryMethodReferenceNumber}", "ProductId": "@{refProduct2_2.id}", "IsActive": true } } ], "purchaseDetails": [ { "attributes": { "attributes": { "type": "OrderSummary" }, "OrderNumber": "${NUMBER}", "OrderLifeCycleType": "MANAGED", "BillingEmailAddress": "${EMAIL}", "BillingPhoneNumber": "${PHONE}", "OrderedDate": "${DATE}", "Description": "${TEXT}", "SalesChannelId": "@{refSalesChannel.id}", "SalesStoreId": "@{refWebStore.id}", "AccountId": "@{refAccount.id}", "ExternalReferenceIdentifier": "${ExternalReferenceIdentifier}", "Pricebook2Id": "${StandardPricebookId}", "${CustomAttribute.for[OrderSummary]}": "${TEXT}", "CurrencyIsoCode": "USD" }, "referenceId": "refOrderSummary" }, { "attributes": { "attributes": { "type": "CardPaymentMethod" }, "${CustomAttribute.for[CardPaymentMethod]}": "${TEXT}", "GatewayToken": "dcdn23wj3vkb8sf1kho", "PaymentGatewayId": "${PaymentGatewayId}", "Status": "Active", "PaymentMethodStreet": "11122 HARBOUR SPRINGS CIR", "PaymentMethodCity": "BOCA RATON", "PaymentMethodPostalCode": "33428", "PaymentMethodState": "FL", "PaymentMethodCountry": "us", "InputCardNumber": "************1234", "CardType": "Visa", "CardHolderName": "Me and Me", "ExpiryYear": "2021", "ExpiryMonth": "1", "CardCategory": "CreditCard", "AccountId": "@{refAccount.id}", "ProcessingMode": "External" }, "referenceId": "refCardPaymentMethod" }, { "attributes": { "attributes": { "type": "OrderPaymentSummary" }, "${CustomAttribute.for[OrderPaymentSummary]}": "${TEXT}", "OrderSummaryId": "@{refOrderSummary.id}", "OwnerId": "${OwnerId}" }, "referenceId": "refOrderPaymentSummary" }, { "attributes": { "attributes": { "type": "PaymentAuthorization" }, "${CustomAttribute.for[PaymentAuthorization]}": "${TEXT}", "PaymentGatewayId": "${PaymentGatewayId}", "Amount": 326.79, "ProcessingMode": "External", "Status": "Processed", "GatewayRefNumber": "0000010112", "AccountId": "@{refAccount.id}", "PaymentMethodId": "@{refCardPaymentMethod.id}", "OrderPaymentSummaryId": "@{refOrderPaymentSummary.id}" }, "referenceId": "refPayment" }, { "attributes": { "attributes": { "type": "PaymentGatewayLog" }, "PaymentGatewayId": "${PaymentGatewayId}", "InteractionStatus": "Success", "InteractionType": "Authorization", "ReferencedEntityId": "@{refPayment.id}" }, "referenceId": "refPaymentGatewayLog" }, { "attributes": { "attributes": { "type": "OrderDeliveryGroupSummary" }, "${CustomAttribute.for[OrderDeliveryGroupSummary]}": "${TEXT}", "EmailAddress": "me@salesforce.com", "DeliverToCity": "BOCA RATON", "DeliverToCountry": "us", "DeliverToName": "Me and Me", "DeliverToPostalCode": "33428", "DeliverToState": "FL", "DeliverToStreet": "11122 HARBOUR SPRINGS CIR", "PhoneNumber": "3333333333", "OrderDeliveryMethodId": "@{refOrderDeliveryMethod.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refOrderDeliveryGroup" }, { "attributes": { "attributes": { "type": "OrderItemSummary" }, "${CustomAttribute.for[OrderItemSummary,Order]}": "${TEXT}", "Description": "WOMEN'S TORPEDO JACKET 1", "Type": "Order Product", "Quantity": 1, "TotalLineAmount": 200, "LineNumber": 1, "UnitPrice": 200, "ListPrice": 200, "OrderSummaryId": "@{refOrderSummary.id}", "OrderDeliveryGroupSummaryId": "@{refOrderDeliveryGroup.id}", "Product2Id": "@{refProduct2_1.id}", "PricebookEntryId": "@{refPricebookEntry_1.id}" }, "referenceId": "refOrderItem_1" }, { "attributes": { "attributes": { "type": "OrderItemSummary" }, "${CustomAttribute.for[OrderItemSummary,Order]}": "${TEXT}", "Description": "WOMEN'S TORPEDO JACKET 2", "Type": "Order Product", "Quantity": 1, "TotalLineAmount": 800, "LineNumber": 1, "UnitPrice": 800, "ListPrice": 800, "OrderSummaryId": "@{refOrderSummary.id}", "OrderDeliveryGroupSummaryId": "@{refOrderDeliveryGroup.id}", "Product2Id": "@{refProduct2_2.id}", "PricebookEntryId": "@{refPricebookEntry_2.id}" }, "referenceId": "refOrderItem_2" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "2072100 - Tax", "Type": "Estimated", "Amount": 10, "Rate": 0.05, "TaxEffectiveDate": "2018-09-18T17:15:58.000Z", "OrderItemSummaryId": "@{refOrderItem_1.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refrefOrderItem_1_OrderItemTaxLineItem_1" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "2072100 - Tax", "Type": "Estimated", "Amount": 40, "Rate": 0.05, "TaxEffectiveDate": "2018-09-18T17:15:58.000Z", "OrderItemSummaryId": "@{refOrderItem_2.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refrefOrderItem_2_OrderItemTaxLineItem_2" }, { "attributes": { "attributes": { "type": "OrderAdjustmentGroupSummary" }, "Name": "20%offOrderAmountOver100", "Description": "20%offOrderAmountOver100", "Type": "Header", "OrderSummaryId": "@{refOrderSummary.id}", "AdjustmentCauseId": "@{refPromotion_1.id}" }, "referenceId": "refOrderAdjustmentGroupSummary_1" }, { "attributes": { "attributes": { "type": "OrderAdjustmentGroupSummary" }, "Name": "50offOrderAmountOver100", "Description": "50offOrderAmountOver100", "Type": "Header", "OrderSummaryId": "@{refOrderSummary.id}", "AdjustmentCauseId": "@{refPromotion_2.id}" }, "referenceId": "refOrderAdjustmentGroupSummary_2" }, { "attributes": { "attributes": { "type": "OrderItemAdjustmentLineSummary" }, "${CustomAttribute.for[OrderItemAdjustmentLineSummary]}": "${TEXT}", "Name": "2072100 - 20%offOrderAmountOver100", "Amount": -15.84, "OrderItemSummaryId": "@{refOrderItem_1.id}", "OrderSummaryId": "@{refOrderSummary.id}", "OrderAdjustmentGroupSummaryId": "@{refOrderAdjustmentGroupSummary_1.id}" }, "referenceId": "refrefOrderItem_1_OrderItemAdjustmentLineItem_1" }, { "attributes": { "attributes": { "type": "OrderItemAdjustmentLineSummary" }, "${CustomAttribute.for[OrderItemAdjustmentLineSummary]}": "${TEXT}", "Name": "2072100 - 20%offOrderAmountOver100", "Amount": -15.84, "OrderItemSummaryId": "@{refOrderItem_1.id}", "OrderSummaryId": "@{refOrderSummary.id}", "OrderAdjustmentGroupSummaryId": "@{refOrderAdjustmentGroupSummary_2.id}" }, "referenceId": "refrefOrderItem_1_OrderItemAdjustmentLineItem_2" }, { "attributes": { "attributes": { "type": "OrderItemAdjustmentLineSummary" }, "${CustomAttribute.for[OrderItemAdjustmentLineSummary]}": "${TEXT}", "Name": "2072100 - 20%offOrderAmountOver100", "Amount": -15.84, "OrderItemSummaryId": "@{refOrderItem_2.id}", "OrderSummaryId": "@{refOrderSummary.id}", "OrderAdjustmentGroupSummaryId": "@{refOrderAdjustmentGroupSummary_1.id}" }, "referenceId": "refrefOrderItem_2_OrderItemAdjustmentLineItem_1" }, { "attributes": { "attributes": { "type": "OrderItemAdjustmentLineSummary" }, "${CustomAttribute.for[OrderItemAdjustmentLineSummary]}": "${TEXT}", "Name": "2072100 - 20%offOrderAmountOver100", "Amount": -15.84, "OrderItemSummaryId": "@{refOrderItem_2.id}", "OrderSummaryId": "@{refOrderSummary.id}", "OrderAdjustmentGroupSummaryId": "@{refOrderAdjustmentGroupSummary_2.id}" }, "referenceId": "refrefOrderItem_2_OrderItemAdjustmentLineItem_2" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "2072100 - Adjustment Tax", "Type": "Estimated", "Amount": -0.79, "Rate": 0.05, "TaxEffectiveDate": "2021-02-12T23:53:01.471Z", "OrderItemSummaryId": "@{refOrderItem_1.id}", "OrderItemAdjustmentLineSummaryId": "@{refrefOrderItem_1_OrderItemAdjustmentLineItem_1.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refrefOrderItem_1_OrderItemAdjustmentLineItem_1_OrderItemTaxLineItem_1" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "2072100 - Adjustment Tax", "Type": "Estimated", "Amount": -0.79, "Rate": 0.05, "TaxEffectiveDate": "2021-02-12T23:53:01.471Z", "OrderItemSummaryId": "@{refOrderItem_1.id}", "OrderItemAdjustmentLineSummaryId": "@{refrefOrderItem_1_OrderItemAdjustmentLineItem_2.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refrefOrderItem_1_OrderItemAdjustmentLineItem_2_OrderItemTaxLineItem_2" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "2072100 - Adjustment Tax", "Type": "Estimated", "Amount": -0.79, "Rate": 0.05, "TaxEffectiveDate": "2021-02-12T23:53:01.471Z", "OrderItemSummaryId": "@{refOrderItem_2.id}", "OrderItemAdjustmentLineSummaryId": "@{refrefOrderItem_2_OrderItemAdjustmentLineItem_1.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refrefOrderItem_2_OrderItemAdjustmentLineItem_1_OrderItemTaxLineItem_1" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "2072100 - Adjustment Tax", "Type": "Estimated", "Amount": -0.79, "Rate": 0.05, "TaxEffectiveDate": "2021-02-12T23:53:01.471Z", "OrderItemSummaryId": "@{refOrderItem_2.id}", "OrderItemAdjustmentLineSummaryId": "@{refrefOrderItem_2_OrderItemAdjustmentLineItem_2.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refrefOrderItem_2_OrderItemAdjustmentLineItem_2_OrderItemTaxLineItem_2" }, { "attributes": { "attributes": { "type": "OrderItemSummary" }, "${CustomAttribute.for[OrderItemSummary,Order]}": "${TEXT}", "Description": "Shipping", "Type": "Delivery Charge", "Quantity": 1, "TotalLineAmount": 200, "LineNumber": 1, "UnitPrice": 200, "ListPrice": 200, "OrderSummaryId": "@{refOrderSummary.id}", "OrderDeliveryGroupSummaryId": "@{refOrderDeliveryGroup.id}", "Product2Id": "@{refProduct2_1.id}", "PricebookEntryId": "@{refPricebookEntry_1.id}" }, "referenceId": "refShipping" }, { "attributes": { "attributes": { "type": "OrderItemTaxLineItemSummary" }, "${CustomAttribute.for[OrderItemTaxLineItemSummary]}": "${TEXT}", "Name": "DeliveryCharge - Tax", "Type": "Estimated", "Amount": 10, "Rate": 0.05, "TaxEffectiveDate": "2018-09-18T17:15:58.000Z", "OrderItemSummaryId": "@{refShipping.id}", "OrderSummaryId": "@{refOrderSummary.id}" }, "referenceId": "refShipping_OrderItemTaxLineItem" } ] } ] } ``` #### Responses * **200** _Order Summary Graphs Output_ Response from creating pending order summaries. Media type: `application/json`. Schema: `OrderSummaryGraphsOutputRepresentationList`. ### POST Estimate Delivery Date `POST /commerce/delivery/estimation-setup/{externalReference}/estimate/estimate-date` Operation ID: `EstimateDeliveryDate`. Tags: Salesforce Order Management Resources. Get the estimated delivery date based on the given details. Forecast an expected delivery date and time based on delivery estimation settings and the selected shipping carrier method. Provide information on when a package is expected to be shipped and delivered. _Available in: v63.0_ #### Parameters * `externalReference` (path, string, required) External Reference #### Request body Delivery date estimation information. Media type: `application/json`. Schema: `EstimateDeliveryDateInput`. _Example: example\_1_ Payload 1 ``` { "shippingCarrier": { "externalReference": "UPS001", "shippingCarrierMethods": [ { "externalReference": "UPSGround001" }, { "externalReference": "UPSAIR001" } ] }, "locations": [ "California" ], "products": [ { "stockKeepingUnit": "SKU01", "quantity": 5 } ], "deliveryAddress": { "country": "USA", "state": "CA", "city": "San Francisco", "postalCode": "00000", "latitude": 30.123, "longitude": 100.123 } } ``` #### Responses * **200** _Estimate Delivery Date_ Estimated delivery dates. Media type: `application/json`. Schema: `EstimateDeliveryDateOutput`. ### POST Delivery Routing Engine `POST /commerce/delivery/route/routing-rules` Operation ID: `DeliveryRoutingEngine`. Tags: Commerce B2B Resources. Calculate optimal delivery routes based on fulfillment criteria and location constraints Retrieve routing rules that determine which fulfillment locations should fulfill products for a given delivery address, returning ranked routes and the best location per SKU based on configured fulfillment routing criteria. _Available in: v67.0_ #### Request body Input for the Delivery Routing Engine, which retrieves routing rules to determine which fulfillment locations should fulfill products for a given delivery address. Media type: `application/json`. Schema: `DeliveryRoutingEngineInput`. _Example: example\_1_ Payload 1 ``` { "fulfillmentCriteriaGroupName": "Standard_Routing", "locationGroupName": "US_West_Warehouses", "products": { "products": [ { "stockKeepingUnit": "SKU-001", "quantity": 2 }, { "stockKeepingUnit": "SKU-002", "quantity": 1 } ] }, "deliveryAddress": { "countryCode": "US", "postalCode": "94105" }, "excludeLocations": { "locations": [ "LOC-CLOSED-01" ] } } ``` #### Responses * **200** _Delivery Routing Engine Output_ Delivery routing engine output, including ranked routes and the best fulfillment locations for each SKU. Media type: `application/json`. Schema: `DeliveryRoutingEngineOutput`. ### POST Availability Records, Batch Update `POST /commerce/oci/availability-records/actions/batch-update` Operation ID: `postBatchUpdate`. Tags: Salesforce Omnichannel Inventory Resources. Batch update inventory records, specify the records Update a batch of inventory records to Omnichannel Inventory. Add a new inventory record or update on hand, future quantity, future date, safety stock count, and shipping eligibility to an existing inventory record. Supports partial success. For example, when 10 items are sent and two fail, the failed items show in the error section. _Available in: v62.0_ #### Request body Details of one or more inventory records to update in a batch. Media type: `application/json`. Schema: `OCIBatchUpdateInput`. _Example: example\_1_ Payload 1 ``` { "records": [ { "externalRefId": "7282822-9823-aaa", "futureStock": [ { "expectedDate": "2019-08-24T21:13:00Z", "quantity": 10.25 } ], "attributeSet": { "groupEligibilityExclusion": [ "GroupA", "GroupB" ] }, "locationIdentifier": "warehouse5", "onHand": 1200.35, "safetyStockCount": 12.45, "stockKeepingUnit": "sku123", "actionRequestId": "82251928-8863-488e-840b-2aebd10b57ba", "effectiveDate": "2019-07-24T21:13:00Z" } ] } ``` #### Responses * **200** _OCI Batch Update_ Details of the updated inventory records. Media type: `application/json`. Schema: `OCIBatchUpdateOutput`. ### POST Availability Records, Upload `POST /commerce/oci/availability-records/uploads` Operation ID: `postUploadInventoryAvailability`. Tags: Salesforce Omnichannel Inventory Resources. Upload inventory availability records to the Inventory Availability Service, and check for status. Upload an inventory availability data file to Omnichannel Inventory. _Available in: v51.0_ #### Request body (required) JSON or CSV file containing inventory availability data. To create an inventory data file, format the data as a series of NDJSON or CSV entries that represent locations and individual inventory records. Inventory Import Data Considerations: * Separate the top-level entries with line feeds, not commas. Each entry must be on a single line. * When the system reads a location entry, it assigns the subsequent inventory entries to that location until it reads another location entry. * Legacy NDJSON requires that you specify a header record for each location entry (`{"location":"wickenburg","mode":"UPDATE"}`). The header isn't required for a high-performance NDJSON layout or CSV file. * Each inventory record entry requires a unique recordId. Best practice is to use a UUID. The recordId protects against importing duplicate data. The recordId is provided in NDJSON and automatically generated for CSV. * Each inventory record entry requires an effectiveDate. * If provided, each futures entry requires a nonzero quantity and a future expectedDate. **Note:** The file must be in NDJSON or CSV format. For larger collections, use the Commerce API or split the data into multiple files. The Commerce API accepts GZIP, NDJSON, or CSV files up to 100 MB. _Available in: v51.0 (JSON), v63.0 (CSV)_ Media type: `application/octet-stream`. Schema: `string (binary)`. Type: `string (binary)`. #### Responses * **200** _OCI Upload Inventory Availability Output_ Response to an upload inventory availability job. Media type: `application/json`. Schema: `OCIUploadInventoryAvailabilityOutput`. #### Code samples _Example: Example 1 · HTTP_ ``` # This example illustrates the data format. For readability, this example shows # the first few entries on multiple lines. In the import file, each location and # inventory record entry must be on a single line. { "location":"Warehouse-A", // location identifier "mode":"UPDATE" // must be UPDATE (other operations might be available in future releases) } { "recordId":"0a87539d-f3dd-47bc-91c7-9c752e39dbe0", // unique identifier for the inventory record "onHand":10, "sku":"12389156", "effectiveDate":"2020-12-08T14:05:22.790896-07:00", "futures":[ // list of future restocks { "quantity":1, "expectedDate":"2021-04-18T14:05:22.781-07:00" }, { "quantity":5, "expectedDate":"2021-05-18T14:05:22.781-07:00" } ], "safetyStockCount":0 } { "recordId":"0a87539d-f3dd-47bc-91c7-9c752e312345", "onHand":10, "sku":"9485728", "effectiveDate":"2020-12-08T14:05:22.790896-07:00", "futures":[ { "quantity":10, "expectedDate":"2021-04-18T14:05:22.781-07:00" } ], "safetyStockCount":0 } {"location":"Warehouse-B","mode":"UPDATE"} {"recordId":"0a87539d-f3dd-47bc-91c7-9c75abc123de","onHand":10,"sku":"12389156","effectiveDate":"2020-12-08T14:05:22.790896-07:00","futures":[{"quantity":1,"expectedDate":"2021-04-18T14:05:22.781-07:00"}],"safetyStockCount":0} {"recordId":"0a87539d-f3dd-47bc-91c7-9c75abc98765","onHand":10,"sku":"93867201","effectiveDate":"2020-12-08T14:05:22.790896-07:00","futures":[{"quantity":5,"expectedDate":"2021-04-18T14:05:22.781-07:00"}],"safetyStockCount":0} ``` ### GET Availability Records, Upload `GET /commerce/oci/availability-records/uploads/{uploadId}` Operation ID: `getUploadInventoryAvailability_22579949`. Tags: Salesforce Omnichannel Inventory Resources. Upload inventory availability records to the Inventory Availability Service, and check for status. Retrieve the status of an inventory availability upload job. _Available in: v51.0_ #### Parameters * `uploadId` (path, string, required) ID of the upload. #### Responses * **200** _OCI Upload Inventory Availability Status Output_ Detailed status of an upload inventory availability job. Media type: `application/json`. Schema: `OCIUploadInventoryAvailabilityStatusOutput`. ### POST Availability Records, Get Availability `POST /commerce/oci/availability/availability-records/actions/get-availability` Operation ID: `postGetAvailabilityService`. Tags: Salesforce Omnichannel Inventory Resources. Get inventory levels; optionally, specify SKU and location or location group Retrieve inventory availability data for one or more products at one or more inventory locations or location groups. _Available in: v51.0_ #### Request body Details of a request to retrieve inventory availability. Specify exactly one location criterion (`locationGroupIdentifier`, `locationGroupIdentifiers`, or `locationIdentifiers`) and exactly one product SKU value (`stockKeepingUnit` or `stockKeepingUnits`). Media type: `application/json`. Schema: `OCIGetInventoryAvailabilityInput`. #### Responses * **200** _OCI Get Inventory Availability Output_ Response to a request for inventory availability data. Media type: `application/json`. Schema: `OCIGetInventoryAvailabilityOutput`. ### POST Location Graph, Upload `POST /commerce/oci/location-graph/uploads` Operation ID: `postPublishLocationStructure`. Tags: Salesforce Omnichannel Inventory Resources. Publish inventory locations structure (including locations, location groups and their assignments) to Omnichannel Inventory Service, and check publish status Asynchronously publish information about your inventory locations and location groups to Omnichannel Inventory. The publish includes records whose IsEnabled and ShouldSyncWithOci fields are both true. This method returns an ID that you can use to retrieve the status of the publish job. _Available in: v51.0_ #### Responses * **200** _OCI Publish Location Structure Output_ Response to a publish location structure request. Media type: `application/json`. Schema: `OCIPublishLocationStructureOutput`. ### GET Location Graph, Upload `GET /commerce/oci/location-graph/uploads/{uploadId}` Operation ID: `getPublishLocationStructure_-477180781`. Tags: Salesforce Omnichannel Inventory Resources. Publish inventory locations structure (including locations, location groups and their assignments) to Omnichannel Inventory Service, and check publish status Retrieve the status of a publish location structure job. _Available in: v51.0_ #### Parameters * `uploadId` (path, string, required) ID of the upload. #### Responses * **200** _OCI Publish Location Structure Status Output_ Detailed status of a publish location structure job. Media type: `application/json`. Schema: `OCIPublishLocationStructureStatusOutput`. ### POST Reservations, Fulfill `POST /commerce/oci/reservation/actions/fulfillments` Operation ID: `postFulfillReservation`. Tags: Salesforce Omnichannel Inventory Resources. Fulfill products for inventory reservation Fulfill one or more inventory reservations. _Available in: v51.0_ #### Request body A list of inventory reservations to fulfill. Media type: `application/json`. Schema: `OCIFulfillReservationInput`. #### Responses * **200** _OCI Fulfill Reservation Output_ Response to a request to fulfill one or more inventory reservations. Media type: `application/json`. Schema: `OCIFulfillReservationOutput`. ### POST Reservations, Release `POST /commerce/oci/reservation/actions/releases` Operation ID: `postReleaseReservation`. Tags: Salesforce Omnichannel Inventory Resources. Remove reservations from inventory items Release one or more existing inventory reservations to free up that inventory. _Available in: v51.0_ #### Request body Details of one or more inventory reservations to release. Media type: `application/json`. Schema: `OCIReleaseReservationInput`. #### Responses * **200** _OCI Release Reservation Output_ Response to a request to release one or more inventory reservations. Media type: `application/json`. Schema: `OCIReleaseReservationOutput`. ### POST Reservations, Create `POST /commerce/oci/reservation/actions/reservations` Operation ID: `postCreateReservation`. Tags: Salesforce Omnichannel Inventory Resources. Create reservation for products Create an inventory reservation in Omnichannel Inventory. _Available in: v51.0_ #### Request body Data to reserve inventory at one or more Omnichannel Inventory locations or location groups. Media type: `application/json`. Schema: `OCICreateReservationInput`. #### Responses * **200** _OCI Create Reservation Output_ Result of an Omnichannel Inventory reservation creation request. Media type: `application/json`. Schema: `OCICreateReservationOutput`. ### POST Reservations, Transfer `POST /commerce/oci/reservation/actions/transfers` Operation ID: `postTransferReservation`. Tags: Salesforce Omnichannel Inventory Resources. Transfer inventory reservations to a location Transfer one or more inventory reservations between locations or location groups. This API doesn’t change physical quantities, but reduces the reserved quantity at the source and increases it at the destination. _Available in: v51.0_ #### Request body A list of inventory reservation transfers and specifies whether a single failure cancels the entire list. Media type: `application/json`. Schema: `OCITransferReservationInput`. #### Responses * **200** _OCI Transfer Reservation Output_ Response to a request to transfer one or more inventory reservations. Media type: `application/json`. Schema: `OCITransferReservationOutput`. ### POST Reservations, Update `POST /commerce/oci/reservation/actions/update` Operation ID: `postUpdateReservation`. Tags: Salesforce Omnichannel Inventory Resources. Update reservation for products Updates an existing reservation in Omnichannel Inventory. Add, remove, and update quantities for existing SKUs in the reservation. _Available in: v61.0_ #### Request body Data to update one or more Omnichannel Inventory item reservations. Media type: `application/json`. Schema: `OCIUpdateReservationInput`. #### Responses * **200** _OCI Update Reservation Output_ Result of an Omnichannel Inventory update request for reserved inventory. Media type: `application/json`. Schema: `OCIUpdateReservationOutput`. ### POST Inventory Check Availability `POST /commerce/inventory/check-availability` Operation ID: `postInventoryCheckAvailability`. Tags: Salesforce Omnichannel Inventory Resources. Used to get access to Inventory Check Availability Get information about inventory availability for products in locations or location groups in your commerce inventory system. Provides available to fulfill, available to order, and on hand quantity information. _Available in: v60.0_ #### Parameters * `scope` (query, string, required) Expression specifying the webstore ID. Example: `/commerce/inventory/check-availability?scope=webStoreId%20Eq%20%270ZExx000000123FGAQ%27` _Available in: v60.0_ #### Request body (required) Check inventory availability in either an individual location or group location. Check for available to fulfill, available to order, and on hand quantity information. _Available in: v60.0_ Media type: `application/json`. Schema: `InventoryCheckAvailabilityInput`. _Example: example\_1_ Payload 1 * Locations ``` { "locations": [ { "locationId": "131xx0000004FwPAAU", "includeInventoryLevel": false, "products": [ { "product2Id": "01txx0000006i65AAA", "quantity": 10 }, { "product2Id": "01txx0000006i66AAA", "quantity": 11 } ] }, { "locationId": "131xx1234567FwSAAU", "includeInventoryLevel": false, "products": [ { "product2Id": "01txx0000006i67AAA", "quantity": 100 }, { "product2Id": "01txx0000006i68AAA", "quantity": 400 } ] } ], "inventoryDimension": "AvailableToOrder" } ``` _Example: example\_2_ Payload 2 * Location Groups ``` { "locationGroups": [ { "locationGroupId": "0ghxx000000001eAAA", "includeInventoryLevel": false, "products": [ { "product2Id": "01txx0000006i65AAA", "quantity": 10 }, { "product2Id": "01txx0000006i66AAA", "quantity": 11 } ] }, { "locationGroupId": "0ghxx000000001dAAA", "includeInventoryLevel": false, "products": [ { "product2Id": "01txx0000006i67AAA", "quantity": 100 }, { "product2Id": "01txx0000006i68AAA", "quantity": 400 } ] } ], "inventoryDimension": "AvailableToOrder" } ``` #### Responses * **200** _OCI Inventory Check Availability Output_ Inventory product availability for an individual location or location group. Media type: `application/json`. Schema: `InventoryCheckAvailabilityOutput`. ### GET Inventory Levels `GET /commerce/inventory/levels` Operation ID: `getInventoryLevels`. Tags: Salesforce Omnichannel Inventory Resources. Used to get access to Inventory Levels Get information about inventory levels for products in locations and location groups in your commerce inventory system. There are limits to how many product IDs, SKUs, and locations requests can be made at a time. Refer to the parameter descriptions for limits. Previously retrieved product inventory values are cached. Cached products aren't included in subsequent requests to external inventory systems, like Omnichannel Inventory. Consequently, the number of products counted towards request limits may be lower, depending on how many products have been cached when the request is made. _Available in: v60.0_ #### Parameters * `includeRelatedProducts` (query, boolean) * `locationgroups` (query, array of string) List of location groups where the inventory is requested. Required if `locations` isn't used. _Available in: v60.0_ * `locations` (query, array of string) List of locations that contain inventory. A maximum of 100 product and location combinations are allowed per request. Required if `locationgroups` isn't used. _Available in: v60.0_ * `products` (query, array of string, required) List of products (ID or SKU). * A maximum of 100 product ID and location combinations are allowed per request. * A maximum of 20 SKU and location combinations are allowed per request. _Available in: v60.0_ * `scope` (query, string, required) Webstore ID. Example: `/commerce/inventory/levels?scope=webStoreId Eq '0ZExx000000123FGAQ'` _Available in: v60.0_ #### Responses * **200** _OCI Inventory Levels Output_ Inventory levels data. Media type: `application/json`. Schema: `InventoryLevelsOutput`. ### POST Invoice Creation `POST /commerce/invoicing/invoices/collection/actions/generate` Operation ID: `postInvoice`. Tags: Commerce B2B Resources. Invoice service REST resource Create an invoice for an account, order, or a list of billing schedules. This API request creates billing period items for the matching billing schedules. The billing period items are created for the period between the next charge date of the billing schedule and the specified target date. Invoice lines are created by processing these billing period items. These invoice lines are then grouped into invoices based on the defined grouping criteria on the billing schedule. _Available in: v62.0_ #### Special Access Rules You need the Generate Invoices From Billing Schedule API, Billing Operations User, or Billing Customer Service permission set to use this API. Commerce B2B and D2C customers can call this API if Commerce Subscriptions is enabled. #### Request body Input representation of the details of the billing schedule. Media type: `application/json`. Schema: `InvoiceInput`. _Example: example\_1_ Payload 1 ``` { "accountId": "001SG00000mYtRWYA0", "action": "Posted", "billingScheduleIds": [ "44bSG000000CVeMYAW" ], "billingTransactionId": "801SG00000mYtaXYAS", "correlationId": null, "invoiceDate": "2024-01-12", "targetDate": "2024-01-12" } ``` #### Responses * **200** _Revenue Async Response_ Output representation of the result of the API request with the request identifier. Media type: `application/json`. Schema: `RevenueAsync`. _Example: example\_1_ Payload 1 ``` { "errors": null, "requestIdentifier": "ae6f23bc-f056-44b7-aa4d-c7f6fc5e0cf4", "success": true } ``` #### Code samples _Example: Example 1 · HTTP_ ``` https://yourInstance.salesforce.com/services/data/v67.0/commerce/invoicing/invoices/collection/actions/generate Content-Type: application/json { "accountId": "001SG00000mYtRWYA0", "action": "Posted", "billingScheduleIds": [ "44bSG000000CVeMYAW" ], "billingTransactionId": "801SG00000mYtaXYAS", "correlationId": null, "invoiceDate": "2024-01-12", "targetDate": "2024-01-12" } ``` ## Schemas ### CheckoutStartInput Input to start a Commerce store checkout for a cart. * `cartId` (_string_, required) ID of a cart, or the value `active` , which indicates that the checkout operation should use the active cart. _Available in: v55.0_ * `customFields` (_array of object_) Array of sObjects with their respective custom fields. Currently, custom fields are supported on the [WebCart](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webcart.htm) and [CartDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroup.htm) entities. You can specify up to 21 sObjects in the array: one WebCart and multiple CartDeliveryGroups. Field-level security rules from the [shopper profile](https://help.salesforce.com/s/articleView?id=commerce.comm_create_shopper_profile.htm&type=5) 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. We currently don’t support updating the `country` and `state` fields through `customFields` as part of the address update using request. Instead, specify the `countryCode` and `stateCode`. Use the `{yyyy-MM-dd}` format to specify `date` fields. Use the `{yyyy-MM-ddTHH:mm:ss.SSS+/-HH:mm}` or `{yyyy-MM-ddTHH:mm:ss.SSSZ}` formats to specify `dateTime` fields. When a timezone is added to a UTC `dateTime`, the result is the date and time in that timezone. Use the `{HH:mm.ss.SSS}` or `{HH:mm.ss.SSSZ}` formats to specify `time` fields. When a timezone is added to a UTC time, the result is the time in that timezone. The `customFields` property isn't supported in stores built on an Aura template. _Available in: v62.0_ Additional properties: `any`. * `deliveryAddress` (_string_) Delivery address * `deliveryAddressInput` (_object_) CheckoutStartAddressInputRequest Address data used for the delivery address. _Available in: v61.0_ Includes all fields of `CheckoutStartAddressInputRequest`. ### CheckoutSessionV2 Checkout for a Commerce store. * `cartSummary` (_object_) CartSummaryInformation Summary details of a cart. _Available in: v61.0_ _Filter group: Small_ Includes all fields of `CartSummaryInformation`. * `checkoutId` (_string (Id)_) ID for the checkout. _Available in: v55.0_ _Filter group: Small_ * `contactInfo` (_object_) ContactInfoV2 Information for a guest contact. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `ContactInfoV2`. * `customFields` (_array of object_) Array of sObjects and viewable custom fields for the sObjects. Currently, only the WebCart and CartDeliveryGroup sObjects are supported. The custom fields can be of type Checkbox, Currency, Date, Email, LongTextArea, Number, Percent, Phone, Text, TextArea, or Url. The supported format for `dateTime` fields is `{yyyy-MM-ddTHH:mm:ss.SSSZ}`. The supported format for `time` fields is `{HH:mm.ss.SSSZ}`. The `customFields` property isn't supported in stores built on an Aura template. _Available in: v62.0_ _Filter group: Small_ Additional properties: `any`. * `deliveryGroups` (_object_) DeliveryGroupCollectionV2 Available delivery group for checkout. _Available in: v55.0_ _Filter group: Big_ Includes all fields of `DeliveryGroupCollectionV2`. * `errors` (_array of CheckoutError_) List of errors, if any, for the checkout. _Available in: v55.0_ _Filter group: Small_ * `orderReferenceNumber` (_string_) Globally unique identifier (GUID) of the payment order generated after successful completion of a payment request. _Available in: v61.0_ _Filter group: Small_ ### CheckoutSessionV2Input Checkout Session Input Representation * `contactInfo` (_CheckoutContactInfoV2Input_) * `customFields` (_array of object_) Custom Fields Additional properties: `any`. * `deliveryAddress` (_CheckoutAddressInputV2CommerceCheckout_) * `deliveryMethodId` (_string_) Checkout Delivery Method ID * `desiredDeliveryDate` (_string (date-time)_) Checkout Desired Delivery Date * `shippingInstructions` (_string_) Checkout Shipping Instructions ### CheckoutOrderV2 Checkout Order Representation * `errors` (_array of CheckoutError_) List of errors, if any. _Available in: v55.0_ _Filter group: Small_ * `orderReferenceNumber` (_string_) Reference number for the order. _Available in: v55.0_ _Filter group: Small_ ### CheckoutOrderActionListInput Input representation of the Commerce store checkout.request. * `actions` (_array of CheckoutOrderActionInput_, required) Details of the action to be performed on the place order request. _Available in: v64.0_ ### CheckoutOrderActionCollection Checkout Order Action Collection Representation * `actions` (_array of CheckoutOrderAction_) Details of the action and the associated order reference number. _Available in: v64.0_ _Filter group: Small_ * `errors` (_array of CheckoutError_) List of errors, if any. _Available in: v64.0_ _Filter group: Small_ ### CheckoutPaymentInput Payment input for a Commerce store checkout. * `billingAddress` (_object_) CheckoutAddressInput Billing address for the checkout. Don't include a value for `shipToPhoneNumber` on the Checkout Address Input. This field is ingored in the payment request. _Available in: v55.0_ Includes all fields of `CheckoutAddressInput`. * `paymentAmount` (_number (double)_) Payment Amount * `paymentToken` (_string_) Payment token value has a different meaning depending on the request type. If the request type is `Auth`, the value is a card payment method ID. If the request type is `SimplePurchaseOrder`, the value is a purchase order number. If the request type is `PostAuth`, the value is a string that identifies the payment transaction so it can be validated by the payment gateway adapter’s PostAuth handler. Required if `requestType` is `Auth` , `PostAuth` , or `SimplePurchaseOrder` _Available in: v55.0_ * `paymentsData` (_string_) Additional data from a payment request for custom checkout implementations. Supports up to four key-value pairs. `paymentsData` is only applicable to requests with a `requestType` of `Auth` or `PostAuth` . Simple purchase orders don’t support `paymentsData` . _Available in: v55.0_ * `requestType` (_object_, required) PaymentRequestType Type of payment request. Valid values are: * `Auth` —Payment authorization request. * `PostAuth` — Record a payment transaction that happened outside of the Salesforce platform * `SimplePurchaseOrder` — Use a purchase order as a form of payment _Available in: v55.0_ Includes all fields of `PaymentRequestType`. ### CheckoutPaymentOutput Checkout Payment Representation * `errors` (_array of CheckoutError_) A list of errors, if any. _Available in: v55.0_ _Filter group: Small_ * `paymentData` (_object_, nullable) Additional data from a payment request for custom checkout implementations. Supports up to four key-value pairs. `paymentData` is only applicable to requests with a `requestType` of `Auth` or `PostAuth` . Simple purchase orders don’t support `paymentData` . _Available in: v55.0_ _Filter group: Small_ Additional properties: `object`. * `salesforceResultCode` (_string_) PaymentResultCode Salesforce payment result code. Valid values are: * `Decline` —Payment was declined * `Success` —Payment succeeded. * `SystemError` —System error. * `ValidationError` —Validation error. _Available in: v55.0_ _Filter group: Small_ Allowed values: `Decline`, `Success`, `SystemError`, `ValidationError`. ### PaymentTokenInput Input to tokenize a credit card payment method for a Commerce store checkout. * `billingAddress` (_object_) CheckoutAddressInput Billing address for the checkout. Don't include a value for `shipToPhoneNumber` on the Checkout Address Input. This field is ingored in the payment request. _Available in: v55.0_ Includes all fields of `CheckoutAddressInput`. * `cardPaymentMethod` (_object_, required) CardPaymentMethodTokenizationInputRequest Credit card payment method to tokenize. _Available in: v55.0_ Includes all fields of `CardPaymentMethodTokenizationInputRequest`. * `hasSubscriptionProduct` (_boolean_) Indicates whether the cart has subscription products ( `true` ) or not ( `false` ). This field is used for third-party payment gateway integrations with Commerce subscriptions. When set to true, it triggers the [`AuthorizationRequest`](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_commercepayments_AuthorizationRequest.htm) Apex class to include the `SavedPaymentMethod` for payment authorization. To use this field, you must have the required permission. Contact Salesforce Customer Support for more help. _Available in: v67.0_ ### PaymentToken Payment Token Representation * `errors` (_array of CheckoutError_) List of errors, if any. _Available in: v55.0_ _Filter group: Small_ * `token` (_string_) Token for the payment. _Available in: v55.0_ _Filter group: Small_ ### ConnectWishlistItemSortOrderEnum Sort order for wishlist items. One of these values: * `CreatedDateAsc`: Sorts by oldest creation date. * `CreatedDateDesc`: Sorts by most recent creation date. Type: `string`. Allowed values: `CreatedDateAsc`, `CreatedDateDesc`. ### WishlistSummaries List of wishlist summaries and the displayed list for the context user. * `displayedList` (_object_) Wishlist Oldest wishlist displayed for the context user. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `Wishlist`. * `summaries` (_array of WishlistSummary_) Summary of wishlists belonging to the context user. _Available in: v49.0_ _Filter group: Small_ * `wishlistCount` (_integer_) Total number of wishlists belonging to the context user. _Available in: v49.0_ _Filter group: Small_ ### WishlistInput Wishlist to create. * `name` (_string_, required) Name of the wishlist. _Available in: v49.0_ * `products` (_array of WishlistItemInput_) List of products to add to the wishlist. _Available in: v49.0_ ### Wishlist Wishlist, including summary and items. * `page` (_object_) WishlistItemCollection Page of wishlist items. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `WishlistItemCollection`. * `summary` (_object_) WishlistSummary Summary of the wishlist. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `WishlistSummary`. ### WishlistUpdateInput Wishlist name to update. * `name` (_string_, required) Update a wishlist name. _Available in: v50.0_ ### WishlistSummary Summary of a wishlist. * `createdDate` (_string (date-time)_) Created date for the wishlist in ISO 8601 format, for example, 2011-02-25T18:24:31.000Z. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the wishlist. _Available in: v49.0_ _Filter group: Small_ * `modifiedDate` (_string (date-time)_) Last modified date of the wishlist in ISO 8601 format, for example, 2011-02-25T18:24:31.000Z. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the wishlist. _Available in: v49.0_ _Filter group: Small_ * `wishlistProductCount` (_integer_) Unique product count in the wishlist. _Available in: v49.0_ _Filter group: Small_ ### WishlistToCartResult Result of adding a wishlist to a cart. * `cartId` (_string (Id)_) ID of the cart to which the products were added. _Available in: v49.0_ _Filter group: Small_ * `failedWishlistToCartItems` (_array of CartItemResultCommerceWishlist_) Wishlist items that weren’t successfully added to the cart. _Available in: v49.0_ _Filter group: Medium_ * `productsFailedCount` (_integer_) Total number of products that weren’t added to the cart. _Available in: v49.0_ _Filter group: Small_ * `productsRequestedCount` (_integer_) Total number of products requested to add to the cart. _Available in: v49.0_ _Filter group: Small_ * `productsSucceededCount` (_integer_) Total number of products that were successfully added to the cart. _Available in: v49.0_ _Filter group: Small_ * `succeededWishlistToCartItems` (_array of CartItemResultCommerceWishlist_) Wishlist items that were successfully added to the cart. _Available in: v49.0_ _Filter group: Medium_ ### WishlistItemCollection Collection of wishlist items. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. _Available in: v49.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v49.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v49.0_ _Filter group: Small_ * `hasErrors` (_boolean_) Specifies whether at least one of the results contains an error (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `items` (_array of WishlistItem_) Collection of wishlist items. _Available in: v49.0_ _Filter group: Big_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v49.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v49.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v49.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v49.0_ _Filter group: Small_ ### WishlistItemInput Item to update or add to a wishlist. * `productId` (_string_, required) ID of the product to update or add to the wishlist. _Available in: v49.0_ ### WishlistItem Item in a wishlist to create. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. _Available in: v49.0_ _Filter group: Small_ * `error` (_object_) ErrorResponse Error information. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ErrorResponseBilling`. * `listPrice` (_number (double)_) List price of the wishlist item. _Available in: v49.0_ _Filter group: Small_ * `productSummary` (_object_) CartProductSummary Product summary for the wishlist item. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `CartProductSummary`. * `salesPrice` (_number (double)_) Sales price of the wishlist item. _Available in: v49.0_ _Filter group: Small_ * `wishlistItemId` (_string (Id)_) ID of the wishlist item. _Available in: v49.0_ _Filter group: Small_ ### ConnectCommerceAddressSortOrderEnum Sort order for Commerce addresses. Values are: * `CreatedDateAsc` —Sort in ascending order of created date. * `CreatedDateDesc` —Sort in descending order of created date. * `NameAsc` —Sort in ascending order of name. * `NameDesc` —Sort in descending order of name. _Available in: v54.0_ _Filter group: Small_ Type: `string`. Allowed values: `CreatedDateAsc`, `CreatedDateDesc`, `NameAsc`, `NameDesc`. ### CommerceAddressCollection A collection of commerce addresses. * `count` (_integer_) Count of addresses. _Available in: v54.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token to the current page of addresses. _Available in: v54.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of addresses. _Available in: v54.0_ _Filter group: Small_ * `items` (_array of CommerceAddressOutput_) List of addresses. _Available in: v54.0_ _Filter group: Medium_ * `nextPageToken` (_string_) Token to the next page of addresses. _Available in: v54.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of addresses. _Available in: v54.0_ _Filter group: Small_ * `pageSize` (_integer_) Page size for addresses. _Available in: v54.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token to previous page of addresses. _Available in: v54.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of addresses. _Available in: v54.0_ _Filter group: Small_ * `sortOrder` (_object_) ConnectCommerceAddressSortOrderEnum Sort order for Commerce addresses. Values are: * `CreatedDateAsc` —Sort in ascending order of created date. * `CreatedDateDesc` —Sort in descending order of created date. * `NameAsc` —Sort in ascending order of name. * `NameDesc` —Sort in descending order of name. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceAddressSortOrderEnum`. ### CommerceAddressInput Commerce address input. * `addressType` (_string_) Type of address, for example, `Shipping` or `Billing`. _Available in: v54.0_ * `city` (_string_) The address city. _Available in: v54.0_ * `commerceAddressFieldInputList` (_array of CommerceAddressFieldInput_) A list of custom address fields, if any. _Available in: v54.0_ * `companyName` (_string_) The address company name. _Available in: v57.0_ * `country` (_string_) The address country, specified using the ISO country code. For example, `US` for United States. _Available in: v54.0_ * `firstName` (_string_) The address first name. _Available in: v57.0_ * `isDefault` (_boolean_) Indicates whether a contact’s address is the preferred method of communication (`true`) or not (`false`). The default value is `false`. _Available in: v54.0_ * `lastName` (_string_) The address last name. _Available in: v57.0_ * `middleName` (_string_) The address middle name. _Available in: v57.0_ * `name` (_string_, required) Name of the contact. _Available in: v54.0_ * `phoneNumber` (_string_) The phone number associated with the address, including a valid country code. For example, `+1xxxxxxxxxx` (for a US number). _Available in: v57.0_ * `postalCode` (_string_) Zip code or postal code for the address. _Available in: v54.0_ * `region` (_string_) The address state, specified using the ISO state code. For example, CA for California state. _Available in: v54.0_ * `street` (_string_) The address street. _Available in: v54.0_ * `countryCode` (_string_) Two-character country code. For example, US for United States. _Available in: v54.0–58.0_ * `regionCode` (_string_) The address state code. For example, `CA` for California state. _Available in: v54.0–58.0_ ### CommerceAddressOutput Address for a Commerce account. * `addressId` (_string_) ID of the address. _Available in: v54.0_ _Filter group: Small_ * `addressType` (_string_) Type of address (for example, “Shipping” or “Billing”). _Available in: v54.0_ _Filter group: Small_ * `city` (_string_) The address city. _Available in: v54.0_ _Filter group: Small_ * `companyName` (_string_) The address company name. _Available in: v57.0_ _Filter group: Small_ * `country` (_string_) The address country. _Available in: v54.0_ _Filter group: Small_ * `fields` (_object_) Custom fields for the address. _Available in: v54.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `firstName` (_string_) The address first name. _Available in: v57.0_ _Filter group: Small_ * `isDefault` (_boolean_) Indicates whether a contact’s address is the preferred method of communication (`true`) or not (`false`). The default value is `false`. _Available in: v54.0_ _Filter group: Small_ * `lastName` (_string_) The address last name. _Available in: v57.0_ _Filter group: Small_ * `middleName` (_string_) The address middle name. _Available in: v57.0_ _Filter group: Small_ * `name` (_string_) Name of the contact. _Available in: v54.0_ _Filter group: Small_ * `phoneNumber` (_string_) The address phone number. _Available in: v57.0_ _Filter group: Small_ * `postalCode` (_string_) Zip code or postal code for the address. _Available in: v54.0_ _Filter group: Small_ * `region` (_string_) The address state. _Available in: v54.0_ _Filter group: Small_ * `street` (_string_) The address street. _Available in: v54.0_ _Filter group: Small_ * `countryCode` (_string_) Two-character country code. _Available in: v54.0–58.0_ _Filter group: Small_ * `regionCode` (_string_) The address state code. _Available in: v54.0–58.0_ _Filter group: Small_ ### BuyerRegistrationInput Provides a customer’s account registration information for your store. * `addressList` (_array of CheckoutAddressInputV2CommerceCheckout_, required) Saves the customer’s physical address entered during checkout. _Available in: v61.0_ * `captchaToken` (_string_, required) Generated token used to verify user identity. _Available in: v61.0_ * `email` (_string_, required) Customer’s email address. _Available in: v61.0_ * `firstName` (_string_, required) Customer’s first name. _Available in: v61.0_ * `lastName` (_string_, required) Customer’s last name. _Available in: v61.0_ * `phoneNumber` (_string_, required) Customer’s phone number _Available in: v61.0_ ### BuyerRegistration The ID of the registered buyer that is returned in the response. * `accountId` (_string_) The account ID created for the guest user during the registration process. _Available in: v61.0_ _Filter group: Small_ ### BuyerProfile Details for a buyer profile fetch request. * `email` (_string_) The email address of the buyer. _Available in: v52.0_ _Filter group: Medium_ * `firstName` (_string_) The first name of the buyer. _Available in: v52.0_ _Filter group: Small_ * `isEmailVerified` (_boolean_) Indicates whether the email address of the buyer is verified ( `true` ) or not ( `false` ). _Available in: v64.0_ _Filter group: Small_ * `isPhoneVerified` (_boolean_) Indicates whether the phone number of the buyer is verified ( `true` ) or not ( `false` ). _Available in: v64.0_ _Filter group: Small_ * `lastName` (_string_) The last name of the buyer. _Available in: v52.0_ _Filter group: Small_ * `phoneNumber` (_string_) The phone number of the buyer. _Available in: v59.0_ _Filter group: Small_ * `userName` (_string_) The user name of the buyer in the Salesforce org, such as `user@mycompany.com` . _Available in: v59.0_ _Filter group: Small_ ### BuyerProfileInput Input details for the buyer profile update request. * `email` (_string_) The email address of the buyer. _Available in: v59.0_ * `firstName` (_string_) The first name of the buyer. _Available in: v59.0_ * `lastName` (_string_) The last name of the buyer. _Available in: v59.0_ * `phoneNumber` (_string_) The phone number of the buyer. _Available in: v59.0_ * `verificationInput` (_object_, required) BuyerProfileVerificationInput The verification details required to update either the buyer's email or phone number. This update process applies only when two-factor authentication is enabled in your Salesforce org. When two-factor authentication is disabled in your org, you can update both the buyer's email and phone number within a single API request. _Available in: v64.0_ Includes all fields of `BuyerProfileVerificationInput`. ### BuyerProfilePatch Output details for a buyer profile update request. * `email` (_string_) The email of the buyer. _Available in: v59.0_ _Filter group: Medium_ * `firstName` (_string_) The first name of the buyer. _Available in: v59.0_ _Filter group: Small_ * `isEmailVerified` (_boolean_) Indicates whether the email of the buyer is verified ( `true` ) or not ( `false` ). _Available in: v64.0_ _Filter group: Small_ * `isPhoneVerified` (_boolean_) Indicates whether the phone number of the buyer is verified ( `true` ) or not ( `false` ). _Available in: v64.0_ _Filter group: Small_ * `lastName` (_string_) The last name of the buyer. _Available in: v59.0_ _Filter group: Small_ * `phoneNumber` (_string_) The phone number of the buyer. _Available in: v59.0_ _Filter group: Small_ * `userName` (_string_) The user name of the buyer in the Salesforce org, such as `user@mycompany.com` . _Available in: v59.0_ _Filter group: Small_ * `verificationResponse` (_object_) BuyerProfileVerificationResponse The response details for an email address or phone number update request. This field is populated only if two-factored authentication is enabled in your Salesforce org. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `BuyerProfileVerificationResponse`. ### BuyerProfileInitInput Input details for a buyer profile OTP initiate request. * `method` (_object_, required) BuyerProfileInitMethodEnum The mode used to send one-time-password (OTP) for verification. Possible _Available in: v64.0_ Includes all fields of `BuyerProfileInitMethodEnum`. * `reCaptchaToken` (_string_, required) An encrypted response generated by Google reCAPTCHA. This token is used as a unique identifier to verify the user's identity. _Available in: v64.0_ * `type` (_object_, required) BuyerProfileInitTypeEnum The type for which one-time-password (OTP) is required to be sent. Possible _Available in: v64.0_ Includes all fields of `BuyerProfileInitTypeEnum`. ### BuyerProfileInitOutput Output details for the buyer profile OTP initiate request. * `identifier` (_string_) An unique identifier associated with the OTP request. The identifier is used to verify the OTP through the `Commerce Webstore My Profile Verify OTP` API. _Available in: v64.0_ _Filter group: Small_ * `message` (_string_) The response message for a successful or failed initiate OTP request. _Available in: v64.0_ _Filter group: Small_ * `recipient` (_string_) The recipient of the OTP can be either the buyer's email or phone number, which is masked. _Available in: v64.0_ _Filter group: Small_ * `status` (_string_) Indicates whether the initiate OTP request succeeded or failed. _Available in: v64.0_ _Filter group: Small_ ### BuyerProfileVerifyInput Input details for the buyer profile verify request. * `code` (_string_, required) The one-time-password (OTP) to be verified. This is generated through the `Commerce Webstore My Profile Initiate OTP` API. _Available in: v64.0_ * `identifier` (_string_, required) An identifier associated with the OTP. This is generated through the `Commerce Webstore My Profile Initiate OTP` API. _Available in: v64.0_ ### BuyerProfileVerifyOutput Output details for the buyer profile verify request. * `identifier` (_string_) An unique identifier for the one-time-password (OTP). _Available in: v64.0_ _Filter group: Small_ * `message` (_string_) The response message for a successful or failed verification request. _Available in: v64.0_ _Filter group: Small_ * `status` (_string_) The status of the verification request. _Available in: v64.0_ _Filter group: Small_ ### ConnectOrderSummarySortEnum Sort order for order summaries. Values are: * `CreatedDateAsc` —Sorts by the oldest created date. * `CreatedDateDesc` —Sorts by the most recent created date. * `OrderedDateAsc` —Sorts by the oldest ordered date. * `OrderedDateDesc` —Sorts by the most recent ordered date. _Available in: v51.0_ _Filter group: Small_ Type: `string`. Allowed values: `CreatedDateAsc`, `CreatedDateDesc`, `OrderedDateAsc`, `OrderedDateDesc`. ### OrderSummaryCollection Collection of order summaries. * `count` (_integer_) Total count of order summaries returned on the current page. _Available in: v51.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v51.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) Connect REST API URL identifying the current page. _Available in: v51.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v51.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v51.0_ _Filter group: Small_ * `orderSummaries` (_array of OrderSummary_) Collection of order summaries. _Available in: v51.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v51.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v51.0_ _Filter group: Small_ * `sortOrder` (_object_) ConnectOrderSummarySortEnum Sort order for order summaries. Values are: * `CreatedDateAsc` —Sorts by the oldest created date. * `CreatedDateDesc` —Sorts by the most recent created date. * `OrderedDateAsc` —Sorts by the oldest ordered date. * `OrderedDateDesc` —Sorts by the most recent ordered date. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ConnectOrderSummarySortEnum`. ### AddOrderToCartInput Input for adding an order to a cart. * `accessToken` (_string_) Encrypted access token, retrieved from the Commerce Webstore Order Summary Authorization API after successful verification for guest users. The access token is valid for 60 minutes. This is required for guest users if the request doesn't include the session cookie and `verification` field. _Available in: v64.0_ * `cartStateOrId` (_string_, required) Cart state (`active` or `current`) or the ID of the cart to which the products from an order are to be copied. _Available in: v59.0_ * `orderSummaryIdOrRefNumber` (_string_, required) Either the order summary ID or reference number value. For guest shoppers, use the order reference number. _Available in: v59.0_ * `verification` (_object_) OrderSummaryVerificationInput Verification attributes for guest shoppers. This is required for guest users if the request doesn't include the session cookie and `accessToken` field. _Available in: v59.0_ Includes all fields of `OrderSummaryVerificationInput`. ### OrderToCartResult Result of action adding an order to a cart. * `cartId` (_string (Id)_) ID of the cart. _Available in: v57.0_ _Filter group: Small_ * `totalFailedProductCount` (_integer_) Number of products that couldn't be successfully added to the cart from the order. _Available in: v57.0_ _Filter group: Small_ * `totalSucceededProductCount` (_integer_) Number of products successfully added to the cart from the order. _Available in: v57.0_ _Filter group: Small_ * `unaddedProducts` (_array of OrderToCartFailedProduct_) Collection of products not successfully added to the cart. _Available in: v57.0_ _Filter group: Small_ ### OrderSummaryAuthorizationInput Input representation to authorize guest access for the requested order summary record. * `email` (_string_, required) An email address of the guest user. _Available in: v64.0_ * `lastName` (_string_) The last name of the guest user. _Available in: v64.0_ * `orderSummaryRefNumber` (_string_, required) The order summary reference number of the order summary record. _Available in: v64.0_ * `phoneNumber` (_string_, required) The phone number of the guest user. _Available in: v64.0_ ### OrderSummaryAuthorizationOutput Result of the authorize guest user request. * `accessToken` (_string_) An encrypted token used in the Commerce Webstore Order Summary Lookup GET API to validate guest access for the requested order summary record. The access token is valid for 60 minutes. _Available in: v64.0_ _Filter group: Small_ ### OrderSummaryLookupOutput Order summary lookup output. * `adjustmentAggregates` (_object_) OrderSummaryAdjustmentAggregates Adjustment aggregates associated with the order summary. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `OrderSummaryAdjustmentAggregates`. * `adjustments` (_array of OrderSummaryAdjustment_) Collection of adjustments for an order summary. _Available in: v63.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the order summary. _Available in: v58.0_ _Filter group: Small_ * `deliveryGroups` (_array of OrderDeliveryGroupSummaryLookupOutput_) Delivery groups associated with the order summary. _Available in: v58.0_ _Filter group: Small_ * `fields` (_object_) Map of requested order summary fields. _Available in: v58.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) ID of the order summary. _Available in: v58.0_ _Filter group: Small_ * `orderNumber` (_string_) Reference number of the order summary. _Available in: v58.0_ _Filter group: Small_ * `owner` (_object_) BuyerProfile Buyer profile details for an order summary. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `BuyerProfile`. * `payments` (_array of OrderPaymentSummary_) Payment details for an order summary. _Available in: v63.0_ _Filter group: Small_ * `status` (_string_) Status associated with the order summary. _Available in: v58.0_ _Filter group: Small_ ### OrderSummaryLookupInput Order summary lookup input. * `orderSummaryIdOrRefNumber` (_string_, required) Either the order summary ID or reference number value. For guest shoppers, use the order reference number. _Available in: v58.0_ * `verification` (_object_) OrderSummaryVerificationInput Verification attributes for guest shoppers. This is required for guest users if the request doesn't include a valid session cookie. _Available in: v58.0_ Includes all fields of `OrderSummaryVerificationInput`. ### OrderSummaryAdjustmentAggregatesAsyncInput Order summary IDs for calculating adjustment aggregates. * `orderSummaryIds` (_array of string_, required) List of order summary IDs. _Available in: v55.0_ ### OrderSummaryAdjustmentAggregatesAsyncOutput Async adjustment aggregates output. * `statusURL` (_string_) Status URL. _Available in: v55.0_ _Filter group: Small_ ### OrderSummary Order summary information. * `adjustmentAggregates` (_object_) OrderSummaryAdjustmentAggregates Adjustment aggregates associated with the order summary. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `OrderSummaryAdjustmentAggregates`. * `createdDate` (_string (date-time)_) Created date of the order summary. _Available in: v51.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the order summary record. _Available in: v57.0_ _Filter group: Small_ * `fields` (_object_) Map of requested order summary fields. _Available in: v51.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `orderNumber` (_string_) Order number of the order summary. _Available in: v51.0_ _Filter group: Small_ * `orderProductTopLevelLineCount` (_integer_) Count of top level order product line summaries. _Available in: v62.0_ _Filter group: Small_ * `orderSummaryId` (_string (Id)_) ID of the order summary. _Available in: v51.0_ _Filter group: Small_ * `orderedDate` (_string (date-time)_) Ordered date of the order summary. _Available in: v51.0_ _Filter group: Small_ * `ownerId` (_string (Id)_) ID of the owner of the order summary. _Available in: v51.0_ _Filter group: Small_ * `products` (_array of OrderSummaryProductLookupOutput_) Order summary product lookup details. _Available in: v61.0_ _Filter group: Small_ * `status` (_string_) Status of the order summary. _Available in: v51.0_ _Filter group: Small_ * `totalAmount` (_string_) Total amount of the order summary. _Available in: v51.0_ _Filter group: Small_ ### OrderToCartInput Input for action adding an order to a cart. * `cartStateOrId` (_string_, required) Cart state (`active` or `current`) or the ID of the cart to which the products from an order are to be copied. _Available in: v57.0_ ### OrderSummaryAdjustmentCollection Collection of adjustments for an order summary. * `adjustments` (_array of OrderSummaryAdjustment_) Collection of adjustments for an order summary. _Available in: v53.0_ _Filter group: Small_ ### ConnectOrderDeliveryGroupSummarySortEnum Sort order for order delivery group summaries. One of these values: * `IdAsc`: Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc`: Sorts by ID in descending alphanumeric order (Z–A, 9–0). Type: `string`. Allowed values: `IdAsc`, `IdDesc`. ### OrderDeliveryGroupSummaryCollection Collection of order delivery group summaries. * `currentPageToken` (_string_) Token identifying the current page of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ * `orderDeliveryGroups` (_array of OrderDeliveryGroupSummary_) Collection of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying previous page of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of order delivery group summaries. _Available in: v51.0_ _Filter group: Small_ ### ConnectOrderItemSummarySortEnum Sort order for order item summaries. One of these values: * `IdAsc`: Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc`: Sorts by ID in descending alphanumeric order (Z–A, 9–0). Type: `string`. Allowed values: `IdAsc`, `IdDesc`. ### OrderItemSummaryCollection Collection of order item summaries. * `currentPageToken` (_string_) Token identifying the current page of items. _Available in: v51.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of items. _Available in: v51.0_ _Filter group: Small_ * `items` (_array of OrderItemSummary_) Collection of order item summaries. _Available in: v51.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page of items. _Available in: v51.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of items. _Available in: v51.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page of items. _Available in: v51.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of items. _Available in: v51.0_ _Filter group: Small_ ### OrderItemSummaryAdjustmentCollectionInput Collection of order item summaries. * `orderItemSummaries` (_array of OrderItemSummaryAdjustmentInput_, required) List of order item summaries. _Available in: v53.0_ ### OrderItemSummaryAdjustmentCollection Collection of adjustments for order item summaries. * `orderItemSummaries` (_object_) Order item summaries and their associated adjustments. _Available in: v53.0_ _Filter group: Small_ Additional properties: `OrderItemSummaryAdjustmentList`. ### ConnectOrderShipmentSortEnum Sort order for order shipments. Values are: * `ExpectedDeliveryDateAsc` —Sorts by the oldest expected delivery date. * `ExpectedDeliveryDateDesc` —Sorts by the most recent expected delivery date. * `ShipmentNumberAsc` —Sorts by shipment number in ascending order (0–9). * `ShipmentNumberDesc` —Sorts by shipment number in descending order (9–0). _Available in: v52.0_ _Filter group: Small_ Type: `string`. Allowed values: `ExpectedDeliveryDateAsc`, `ExpectedDeliveryDateDesc`, `ShipmentNumberAsc`, `ShipmentNumberDesc`. ### OrderShipmentCollection Collection of order shipments. * `count` (_integer_) Total number of records returned in the collection. _Available in: v52.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page of order shipments. _Available in: v52.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of order shipments. _Available in: v52.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page of order shipments. _Available in: v52.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of order shipments. _Available in: v52.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page of order shipments. _Available in: v52.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of order shipments. _Available in: v52.0_ _Filter group: Small_ * `shipments` (_array of OrderShipment_) Collection of order shipments. _Available in: v52.0_ _Filter group: Small_ * `sortOrder` (_object_) ConnectOrderShipmentSortEnum Sort order for order shipments. Values are: * `ExpectedDeliveryDateAsc` —Sorts by the oldest expected delivery date. * `ExpectedDeliveryDateDesc` —Sorts by the most recent expected delivery date. * `ShipmentNumberAsc` —Sorts by shipment number in ascending order (0–9). * `ShipmentNumberDesc` —Sorts by shipment number in descending order (9–0). _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectOrderShipmentSortEnum`. ### ConnectOrderShipmentItemSortEnum Sort order for order shipment items. Values are: * `IdAsc` —Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc` —Sorts by ID in descending alphanumeric order (Z–A, 9–0). _Available in: v52.0_ _Filter group: Small_ Type: `string`. Allowed values: `IdAsc`, `IdDesc`. ### OrderShipmentItemCollection Collection of order shipment items. * `count` (_integer_) Total number of records returned in a page. _Available in: v52.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `items` (_array of OrderShipmentItem_) Collection of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of order shipment items. _Available in: v52.0_ _Filter group: Small_ * `sortOrder` (_object_) ConnectOrderShipmentItemSortEnum Sort order for order shipment items. Values are: * `IdAsc` —Sorts by ID in ascending alphanumeric order (A–Z, 0–9). * `IdDesc` —Sorts by ID in descending alphanumeric order (Z–A, 9–0). _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectOrderShipmentItemSortEnum`. ### FacetableAttributesCollectionOutput Collection of facetable attributes. * `facetableAttributeSettings` (_array of FacetableAttributeOutput_) Collection of facetable attributes. _Available in: v49.0_ _Filter group: Small_ ### FacetableAttributesCollectionInput Collection of facetable settings for search attributes. * `facetableAttributeSettings` (_array of FacetableAttributeInput_, required) Collection of up to 50 facetable settings. _Available in: v49.0_ ### SearchableAttributesCollectionOutput Collection of searchable attributes. * `searchableAttributeSettings` (_array of SearchableAttributeOutput_) Collection of searchable attributes. _Available in: v49.0_ _Filter group: Small_ ### SearchableAttributesCollectionInput Collection of searchable attributes. * `searchableAttributeSettings` (_array of SearchableAttributeInput_, required) Collection of up to 25 searchable attributes. _Available in: v49.0_ ### SearchBoostBuryRulesCollectionOutput Collection of boost and bury rules. * `boostBuryRules` (_array of SearchBoostBuryRuleOutput_) Collection of boost and bury rules. A webstore can have up to 25 rules. _Available in: v59.0_ _Filter group: Medium_ ### SearchBoostBuryRuleInput Boost and bury rule input. * `action` (_object_, required) ConnectSearchBoostBuryRuleActionEnum Action of the boost and bury rule. Values are: * `Boost` —Boost rule. Increases search result rankings for targeted products. * `Bury` —Bury rule. Decreases search result rankings for targeted products. _Available in: v59.0_ Includes all fields of `ConnectSearchBoostBuryRuleActionEnum`. * `endDate` (_string (date-time)_, required) End date and time of the boost and bury rule. _Available in: v59.0_ * `level` (_integer_, required) Level of the boost and bury rule. Values are from 1-100. The level determines the degree to which a boost and bury rule influences search result rankings for the targeted products. _Available in: v59.0_ * `name` (_string_, required) Name of the boost and bury rule. _Available in: v59.0_ * `queryContext` (_BoostBuryQueryContextInput_) * `startDate` (_string (date-time)_, required) Start date and time of the boost and bury rule. _Available in: v59.0_ * `targetExpression` (_object_, required) BoostBuryTargetExpressionInput Target expression for a boost and bury rule. The target expression specifies which products a boost and bury rule applies to. _Available in: v59.0_ Includes all fields of `BoostBuryTargetExpressionInput`. ### SearchBoostBuryRuleOutput Boost and bury rule information. * `action` (_object_) ConnectSearchBoostBuryRuleActionEnum Action of the boost and bury rule. Values are: * `Boost` —Boost rule. Increases search result rankings for targeted products. * `Bury` —Bury rule. Decreases search result rankings for targeted products. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `ConnectSearchBoostBuryRuleActionEnum`. * `endDate` (_string (date-time)_) End date and time of the boost and bury rule. _Available in: v59.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the boost and bury rule. _Available in: v59.0_ _Filter group: Small_ * `level` (_integer_) Level of the boost and bury rule. Values are from 1-100. The level determines the degree to which a boost and bury rule influences search result rankings for the targeted products. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the boost and bury rule. _Available in: v59.0_ _Filter group: Small_ * `queryContext` (_BoostBuryQueryContextOutput_) * `startDate` (_string (date-time)_) Start date and time of the boost and bury rule. _Available in: v59.0_ _Filter group: Small_ * `targetExpression` (_object_) BoostBuryTargetExpressionOutput Target expression for a boost and bury rule. The target expression specifies which products a boost and bury rule applies to. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `BoostBuryTargetExpressionOutput`. ### CommerceSearchIndexLogCollection Collection of search index logs for a webstore. * `indexLogs` (_array of CommerceSearchIndexLog_) List of up to 100 index logs sorted by most recent catalog snapshot time of the index. _Available in: v57.0_ _Filter group: Small_ ### CommerceSearchIndexCollectionOutput Collection of indexes. * `indexes` (_array of CommerceSearchIndexOutput_) List of up to two indexes. Returns the completed, live index and either the in-progress, out-of-use index or the most-recently-failed, out-of-use index. _Available in: v49.0_ _Filter group: Small_ ### ConnectCommerceSearchIndexBuildTypeEnum Build type of the index. _Available in: v57.0_ _Filter group: Small_ Type: `string`. Allowed values: `Full`, `Incremental`. ### CommerceSearchIndexOutput Index information. * `completionDate` (_string (date-time)_) Completion date and time of the index. _Available in: v49.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Creation date of the index. _Available in: v49.0_ _Filter group: Small_ * `creationType` (_object_) ConnectCommerceSearchIndexCreationTypeEnum Creation type of the index. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchIndexCreationTypeEnum`. * `id` (_string_) ID of the index. _Available in: v49.0_ _Filter group: Small_ * `indexBuildType` (_object_) ConnectCommerceSearchIndexBuildTypeEnum Build type of the index. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchIndexBuildTypeEnum`. * `indexStatus` (_object_) ConnectCommerceSearchIndexStatusEnum Status of the index. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchIndexStatusEnum`. * `indexUsage` (_object_) ConnectCommerceSearchIndexUsageEnum Usage of the index. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchIndexUsageEnum`. * `isIncrementable` (_boolean_) Specifies whether the index allows incremental indexing (`true`) or not (`false`). _Available in: v57.0_ _Filter group: Small_ * `lastCatalogSnapshotTime` (_string (date-time)_) Catalog snapshot time of the index. _Available in: v57.0_ _Filter group: Small_ * `message` (_string_) Detailed message for the index status. _Available in: v49.0_ _Filter group: Small_ ### SearchProductSettingCollectionOutput Collection of product search settings. * `searchProductSettings` (_array of SearchProductSettingOutput_) Collection of product search settings. _Available in: v49.0_ _Filter group: Small_ ### SearchProductSettingCollectionInput Collection of product search settings. * `searchProductSettings` (_array of SearchProductSettingInput_, required) Up to 200 product search settings to update. Products of class `VariationParent` can’t be updated. _Available in: v49.0_ ### SortDirectionEnum Sort direction for search result rules Type: `string`. Allowed values: `Ascending`, `Descending`. ### SearchResultsRulesCollectionOutput Collection of include search rules. * `offset` (_integer_) Offset for pagination * `pageSize` (_integer_) Page size for pagination * `searchRules` (_array of SearchResultsRuleOutput_) A collection of include search rules. _Available in: v58.0_ _Filter group: Medium_ * `totalCount` (_integer_) Total count of all search result rules ### SearchResultsRulesCollectionInput Search results rules input collection information of a webstore. * `searchResultsRules` (_array of SearchResultsRuleInput_, required) An input collection of search results rules _Available in: v58.0_ ### SearchResultsRuleInput Input representation of a search result rule. * `isActive` (_boolean_) Whether the search result rule is active. * `locales` (_array of string_, required) Comma-separated list of locales that the include search rule applies to. _Available in: v58.0_ * `ruleDefinition` (_array of string_, required) Comma-separated list of terms that the include search rule applies to. Valid number of unique strings is from 2 through 5. _Available in: v58.0_ * `type` (_object_, required) ConnectCommerceSearchResultRuleTypeEnum Type of search rule. Value is: * `BidirectionalSynonym` —Use when terms are interchangeable and must return the same results both ways. For example, jacket ⇄ winter coat. Available from API version 66.0 and later. * `Include` —Use when a term in a query matches any term in a `ruleDefinition`, Commerce Search returns results for all terms in the list. Supported in API versions 58.0 to 66.0. We suggest using `BidirectionalSynonym`, which returns equivalent results for interchangeable terms in both directions, unlike `Include`. * `UnidirectionalSynonym` —Use when one term must expand results, but not necessarily the reverse. For example, jacket → hoodie. Available from API version 66.0 and later. _Available in: v58.0_ Includes all fields of `ConnectCommerceSearchResultRuleTypeEnum`. ### SearchResultsRuleOutput Include search rule. * `isActive` (_boolean_) Whether the search result rule is active. * `lastModifiedDate` (_string (date-time)_) Last modified date of the search result rule. _Available in: v66.0_ _Filter group: Medium_ * `locales` (_array of string_) Comma-separated list of up to 10 locales that the include search rule applies to. _Available in: v58.0_ _Filter group: Medium_ * `ruleDefinition` (_array of string_) Comma-separated list of terms that the include search rule applies to. Valid number of unique strings is from 2 through 5. _Available in: v58.0_ _Filter group: Medium_ * `searchResultsRuleId` (_string (Id)_) Entity ID of the search result rule. * `type` (_object_) ConnectCommerceSearchResultRuleTypeEnum Type of search rule. Value is: * `BidirectionalSynonym` —Use when terms are interchangeable and should return the same results both ways. For example, jacket ⇄ winter coat. Available from API version 66.0 and later. * `Include` —When a term in a query matches any term in a `ruleDefinition`, Commerce Search returns results for all terms in the list. Supported in API versions 58.0 to 66.0. We suggest using `BidirectionalSynonym`, which returns equivalent results for interchangeable terms in both directions, unlike `Include`. * `UnidirectionalSynonym` —Use when one term should expand results, but not necessarily the reverse. For example, jacket → hoodie. Available from API version 66.0 and later. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchResultRuleTypeEnum`. * `searchResultRuleId` (_string_) ID of the include search rule. _Available in: v58.0_ _Filter group: Small_ ### SortRulesCollection Collection of sort rules. * `sortRules` (_array of SortRule_) Collection of sort rules. _Available in: v52.0_ _Filter group: Small_ ### SortRulesCollectionInput Sort rules input collection information an admin can use to create sort rules for a webstore. * `sortRules` (_array of SortRuleInput_, required) A collection of sort rules inputs. _Available in: v54.0_ ### ProductSearchInput Product search. * `categoryId` (_string_) Category ID returns results for products in this category or its subcategories. If you omit `categoryId` from the request, all categories are searched. If you specify `categoryId` and `searchTerm`, only products in the specified category are searched. Required if `searchTerm` isn’t specified _Available in: v49.0_ * `fields` (_array of string_) Product fields to return in search results. Search results include fields you have access to. If unspecified, returns the `Name`, `Description`, `StockKeepingUnit`, `ProductCode`, and `Family` fields. _Available in: v49.0_ * `grouping` (_object_) ProductSearchGroupingInput Specifies whether to group products in search results and how to group them. If unspecified, the default is the value specified in **Search** **Results Display Settings** **Results Grouping**. _Available in: v51.0_ Includes all fields of `ProductSearchGroupingInput`. * `includePrices` (_boolean_) Specifies whether to include prices for products in search results (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v49.0_ * `includeQuantityRule` (_boolean_) Specifies whether to include purchase quantity rule information for products in search results (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v52.0_ * `page` (_integer_) Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. When multiplying the `page` and `pageSize` property values together, they can’t exceed 5000. For example, for a `pageSize` of 20, you can specify a `page` value up to 250. _Available in: v49.0_ * `pageSize` (_integer_) Specifies the number of items per page. Valid values are from 1 through 200. If unspecified, the default is the value specified in Results per Page in **Search** **Results Display Settings**. When multiplying the `page` and `pageSize` property values together, they can’t exceed 5000. For example, for a `pageSize` of 20, you can specify a `page` value up to 250. _Available in: v49.0_ * `refinements` (_array of RefinementInput_) List up to nine refinements (facets) for search results. Buyers or shoppers can select up to 20 values for each refinement. _Available in: v49.0_ * `searchTerm` (_string_) List of up to 32 space-separated search terms. Required if `categoryId` isn’t specified _Available in: v49.0_ * `sortRuleId` (_string_) ID of the sort rule that specifies the order of products in the search results. _Available in: v52.0_ ### ProductSearchResults Product search results. * `categories` (_object_) SearchCategory Categories from the search results. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `SearchCategory`. * `correlationId` (_string_) Reserved for future use. _Available in: v55.0_ _Filter group: Small_ * `facets` (_array of SearchFacet_) Facets from the search results. _Available in: v49.0_ _Filter group: Medium_ * `locale` (_string_) Locale of the search results. _Available in: v49.0_ _Filter group: Small_ * `productsPage` (_object_) ProductSummaryCollection Page of products from the search results. _Available in: v49.0_ _Filter group: Medium_ Includes all fields of `ProductSummaryCollectionCommerceSearch`. ### CommerceProductSearchResults Product search results. * `categories` (_object_) SearchCategory Categories from the search results. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `SearchCategory`. * `correlationId` (_string_) Reserved for future use. _Available in: v55.0_ _Filter group: Small_ * `facets` (_array of DistinctValueSearchFacet_) Facets from the search results. _Available in: v55.0_ _Filter group: Medium_ * `locale` (_string_) Locale of the search results. _Available in: v55.0_ _Filter group: Small_ * `productsPage` (_object_) CommerceProductSummaryCollection Page of products from the search results. _Available in: v55.0_ _Filter group: Medium_ Includes all fields of `CommerceProductSummaryCollection`. ### ProductSearchSuggestionsResults Product search suggestions results. * `recentSearchSuggestions` (_array of AbstractSearchSuggestion_) Suggestions based on the user’s recent searches. _Available in: v52.0_ _Filter group: Small_ ### CouponCodeRedemptionInput Input representation for coupon code redemption. * `buyer` (_string_, required) ID of the buyer account or email address for a guest user. _Available in: v60.0_ * `couponCodes` (_array of string_, required) List of coupon codes. _Available in: v58.0_ * `transactionId` (_string_, required) ID of the transaction, which must be a valid cart ID. _Available in: v58.0_ * `effectiveAccountId` (_string_, required) ID of the account. _Available in: v58.0–59.0_ ### CouponCodeRedemptionCollection Collection of coupon code redemption results. * `couponCodeRedemptionResults` (_array of CouponCodeRedemptionResult_) List of coupon code redemption results. _Available in: v58.0_ _Filter group: Small_ ### PromotionEvaluationHSInput Evaluate Promotions High Scale Input Representation * `cart` (_object_, required) CartInput Cart and its items. _Available in: v56.0_ Includes all fields of `CartInput`. * `couponCodes` (_array of string_) Collection of coupon codes to enable promotions. A customer can apply a maximum of two coupons per cart. _Available in: v56.0_ * `effectiveAccountId` (_string (Id)_) ID of the account for which the request is made. _Available in: v56.0_ * `isItemizeHeaderAdjustments` (_boolean_) Specifies whether order-level adjustments are itemized (`true`) or not (`false`). If unspecified, the default value is `false`. _Available in: v56.0_ * `parentProducts` (_array of ParentProductInputRepresentationPair_) Collection of parent product IDs mapped to their variation product IDs. _Available in: v56.0_ * `productCategories` (_array of ProductCategoryInputRepresentationPair_) Collection of product IDs mapped to their associated category IDs. _Available in: v56.0_ * `scope` (_object_) ConnectPromotionScopeEnum Promotion evaluation scope. If no value is provided, default is Cart. If you want any shipping promotions to be evaluated, set to Delivery. _Available in: v60.0_ Includes all fields of `ConnectPromotionScopeEnum`. * `segments` (_array of string_) All promotions associated with promotion segments specified in this collection are active and can be evaluated against the cart. Additionally, any segments associated with a store or buyer group are also still evaluated against the cart. If this field is not present, only the promotions associated with a store or buyer group are evaluated. _Available in: v56.0_ * `webStoreId` (_string (Id)_) ID of the store for which the request is made. If unspecified, defined segments must be used instead. _Available in: v56.0_ * `cartDeliveryGroups` (_array of PromotionCartDeliveryGroupInputRequest_) List of cart delivery groups associated with the items in the cart. Available if shipping promotions are enabled. Required when evaluating shipping promotions _Available in: v57.0_ ### PromotionEvaluationHS Evaluate Promotions High Scale Output Representation * `cart` (_CartOutput_) * `coupons` (_array of Coupon_) Represents the list of coupons ### PromotionProductEvaluationInput Finds promotions that products are eligible for and computes the discounts. Supports domain dependent requests based on `webstoreId` and `effectiveAccountId`, or domain independent requests using an external dataset based on SKUs or product categories. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the payment group record. Required when multi-currency is enabled _Available in: v58.0_ * `effectiveAccountId` (_string (Id)_) For domain dependent evaluation, this is the ID of the account for which the request is made. For domain independent evaluation, this is a buyer ID from another system. No validation will be performed on this value. _Available in: v58.0_ * `productCategories` (_object_) For domain independent evaluation, this is the map of product IDs to their associated category IDs. _Available in: v58.0_ Additional properties: `string`. * `products` (_array of PromotionProductInput_, required) List of product objects. _Available in: v58.0_ * `segments` (_array of string_) All promotions associated with promotion segments specified in this list are active and can be evaluated against the products. Additionally, any segments associated with a store or buyer group are also still evaluated against the products. If this field is not present, only the promotions associated with a store or buyer group are evaluated. Required for domain independent evaluation _Available in: v58.0_ * `webStoreId` (_string (Id)_) ID of the store for which the request is made. If unspecified, defined segments must be used instead. _Available in: v58.0_ ### PromotionProductEvaluationResults Promotion Product Evaluation Results Output Representation * `promotionProductEvaluationResults` (_array of PromotionProductEvaluationResult_) Represents the list of product evaluation result representation used in results ### CompositePromotion Output representation of the composite promotion information. * `active` (_boolean_) Indicates whether the promotion is active ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ * `areQualItemsExclFromDiscounts` (_boolean_) Indicates whether qualifying items are excluded from discounts for the promotion ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ * `coupons` (_array of PromotionCoupon_) List of coupons associated with the promotion. _Available in: v63.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the promotion. _Available in: v62.0_ _Filter group: Small_ * `description` (_string_) Description of the promotion. _Available in: v62.0_ _Filter group: Small_ * `discountOrder` (_object_) ConnectDiscountOrderTypeEnum Discount order for the promotion. Possible _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectDiscountOrderTypeEnum`. * `discountRestriction` (_object_) ConnectDiscountRestrictionTypeEnum Discount restriction for the promotion. Possible _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectDiscountRestrictionTypeEnum`. * `displayName` (_object_) PromotionTranslation Promotion display name and translated values. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `PromotionTranslation`. * `endDateTime` (_string_) The date time the promotion ends. _Available in: v62.0_ _Filter group: Small_ * `exclusivityType` (_object_) ConnectPromotionExclusivityTypeEnum Type of exclusivity to be considered when applying the promotion. Possible values are: * `Class` —Class exclusion. * `Global` —Global exclusion. * `No` —No exclusion. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectPromotionExclusivityTypeEnum`. * `generationId` (_string_) ID of the generated promotion. This field is used to display the feedback component and collect promotion feedback when Smart Promotion is enabled. _Available in: v62.0_ _Filter group: Small_ * `isApproachingDiscountApplicable` (_boolean_) Indicates whether the promotion is an approaching discount ( `true` ) or not ( `false` ). If true, the promotion shows an approaching discount alert. _Available in: v64.0_ _Filter group: Small_ * `maximumUsageCount` (_integer_) Number of times the promotion can apply to a cart. _Available in: v62.0_ _Filter group: Small_ * `name` (_string_) Name of the promotion. _Available in: v62.0_ _Filter group: Small_ * `objective` (_string_) Objective of the promotion. _Available in: v62.0_ _Filter group: Small_ * `priorityNumber` (_integer_) Priority number for the promotion. _Available in: v62.0_ _Filter group: Small_ * `qualifierCriteria` (_object_) ConnectPromotionCriteriaTypeEnum Qualifier criteria for the promotion. Possible values are: * `All` —All the criteria are met. * `Any` —Any of the criteria can be met. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectPromotionCriteriaTypeEnum`. * `qualifiers` (_array of PromotionQualifier_) List of promotion qualifiers. _Available in: v62.0_ _Filter group: Small_ * `segments` (_array of PromotionSegment_) List of promotion segments associated with the web store or buyer group. _Available in: v62.0_ _Filter group: Small_ * `startDateTime` (_string_) The date time the promotion starts. _Available in: v62.0_ _Filter group: Small_ * `targetCriteria` (_object_) ConnectPromotionCriteriaTypeEnum Promotion criteria type. Possible values are: * `All` —All the criteria are met. * `Any` —Any of the criteria can be met. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectPromotionCriteriaTypeEnum`. * `targets` (_array of PromotionTarget_) List of promotion targets. _Available in: v62.0_ _Filter group: Small_ * `termsAndCondition` (_object_) PromotionTranslation Promotion terms and conditions and translated values. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `PromotionTranslation`. * `tiered` (_boolean_) Indicates whether promotion is tiered ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ ### CompositePromotionInput Input representation of the create promotion request. * `active` (_boolean_) Indicates whether the promotion is active ( `true` ) or not ( `false` ). _Available in: v62.0_ * `areQualItemsExclFromDiscounts` (_boolean_) Indicates whether qualifying items are excluded from discounts for the promotion ( `true` ) or not ( `false` ). _Available in: v62.0_ * `coupons` (_array of PromotionCouponInput_) List of coupons associated with the promotion. _Available in: v63.0_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the promotion. _Available in: v62.0_ * `description` (_string_) Localized display name of the promotion. _Available in: v62.0_ * `discountOrder` (_object_) ConnectDiscountOrderTypeEnum Discount order for the promotion. Possible _Available in: v62.0_ Includes all fields of `ConnectDiscountOrderTypeEnum`. * `discountRestriction` (_object_) ConnectDiscountRestrictionTypeEnum Discount restriction for the promotion. Possible _Available in: v62.0_ Includes all fields of `ConnectDiscountRestrictionTypeEnum`. * `displayName` (_object_) PromotionTranslationInput Promotion display name and translated values. _Available in: v62.0_ Includes all fields of `PromotionTranslationInput`. * `endDateTime` (_string_) The date time the promotion ends. _Available in: v62.0_ * `exclusivityType` (_object_) ConnectPromotionExclusivityTypeEnum Type of exclusivity to be considered when applying the promotion. Possible values are: * `Class` —Class exclusion. * `Global` —Global exclusion. * `No` —No exclusion. _Available in: v62.0_ Includes all fields of `ConnectPromotionExclusivityTypeEnum`. * `generationId` (_string_) ID of the generated promotion. This field is used to display the feedback component and collect promotion feedback when Smart Promotion is enabled. _Available in: v62.0_ * `isApproachingDiscountApplicable` (_boolean_) Indicates whether the promotion is an approaching discount ( `true` ) or not ( `false` ). If true, the promotion shows an approaching discount alert. _Available in: v64.0_ * `maximumUsageCount` (_integer_) Number of times a promotion can apply to a cart. _Available in: v62.0_ * `name` (_string_, required) Name of the promotion. _Available in: v62.0_ * `objective` (_string_) Objective for promotion. _Available in: v62.0_ * `priorityNumber` (_integer_) Priority number for the promotion. _Available in: v62.0_ * `qualifierCriteria` (_object_) ConnectPromotionCriteriaTypeEnum Qualifier criteria for the promotion. Possible values are: * `All` —All the criteria are met. * `Any` —Any of the criteria can be met. _Available in: v62.0_ Includes all fields of `ConnectPromotionCriteriaTypeEnum`. * `qualifiers` (_array of PromotionQualifierInput_) List of promotion qualifiers. _Available in: v62.0_ * `segments` (_array of PromotionSegmentInput_, required) List of promotion segments associated with the web store or buyer group. _Available in: v62.0_ * `startDateTime` (_string_) The date time the promotion starts. _Available in: v62.0_ * `targetCriteria` (_object_) ConnectPromotionCriteriaTypeEnum Promotion criteria type. Possible values are: * `All` —All the criteria are met. * `Any` —Any of the criteria can be met. _Available in: v62.0_ Includes all fields of `ConnectPromotionCriteriaTypeEnum`. * `targets` (_array of PromotionTargetInput_, required) List of promotion targets. _Available in: v62.0_ * `termsAndCondition` (_object_) PromotionTranslationInput Promotion terms and conditions and translated values. _Available in: v62.0_ Includes all fields of `PromotionTranslationInput`. * `tiered` (_boolean_) Indicates whether promotion is tiered ( `true` ) or not ( `false` ). If it is a tiered promotion, each tier can have its own set of targets and qualifiers. For example, buy 1 "t-shirt" and get 10% off or buy 2 "t-shirts” and get 20% off. _Available in: v62.0_ ### CompositePromotionResult Output representation of composite promotion create request. * `errors` (_array of string_) Any error messages that were returned by the API. _Available in: v62.0_ _Filter group: Small_ * `promotionId` (_string_) ID of the promotion record created after the API request is successful. _Available in: v62.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the API request was successful ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ ### ApplicationContext Application context for a Commerce store. * `cartCalculateEnabled` (_boolean_) Indicates whether the cart is enabled ( `true` ) or not ( `false` ). _Available in: v60.0_ _Filter group: Small_ * `catalogSnapshotVersionId` (_string (Id)_) ID of the catalog snapshot's version. _Available in: v54.0_ _Filter group: Small_ * `checkoutSettings` (_object_) CheckoutSettings Settings for Salesforce Checkout. _Available in: v61.0_ _Filter group: Small_ Includes all fields of `CheckoutSettings`. * `clientSidePaymentConfiguration` (_object_) ClientSidePaymentConfiguration Client-side payment configuration. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ClientSidePaymentConfiguration`. * `commerceMultiCartEnabled` (_boolean_) true if multi cart is enabled for the org * `country` (_string_) Two-digit ISO code of the store's country. _Available in: v55.0_ _Filter group: Small_ * `defaultCurrency` (_string_) Default currency for the store. _Available in: v54.0_ _Filter group: Small_ * `giftingConfig` (_object_) GiftingConfig Gifting configuration settings for the org. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `GiftingConfig`. * `guestBrowsingEnabled` (_boolean_) Indicates if guest browsing is enabled (`true`) or not (`false`). _Available in: v57.0_ _Filter group: Small_ * `guestCartCheckoutEnabled` (_boolean_) Indicates whether the guest cart checkout feature is enabled ( `true` ) or not ( `false` ). In API version 58.0 and later, use `guestCartEnabled` and `guestCheckoutEnabled` instead. _Available in: v54.0–57.0_ _Filter group: Small_ * `guestCartEnabled` (_boolean_) Indicates whether the guest cart access is enabled ( `true` ) or not ( `false` ). _Available in: v58.0_ _Filter group: Small_ * `guestCheckoutEnabled` (_boolean_) Indicates whether the guest checkout access is enabled ( `true` ) or not ( `false` ). _Available in: v58.0_ _Filter group: Small_ * `hideShippingAddress` (_boolean_) true if shipping address should be hidden * `inventoryConfiguration` (_object_) InventoryConfiguration Inventory configuration settings for the store. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `InventoryConfiguration`. * `managedCheckoutVersion` (_string_) Managed checkout version number for the store. _Available in: v62.0_ _Filter group: Small_ * `markets` (_array of Market_) Market configuration for the store. _Available in: v58.0_ _Filter group: Small_ * `orderStatuses` (_array of OrderStatus_) Order statuses available in the Status picklist of the [Order Summary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm) object. _Available in: v62.0_ _Filter group: Small_ * `placeOrderV2Enabled` (_boolean_) Indicates whether place order orchestration V2 is enabled ( `true` ) or not ( `false` ) for your web store. _Available in: v64.0_ _Filter group: Small_ * `productConfig` (_object_) ProductConfig Product configuration settings for the org. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `ProductConfig`. * `propertiesEx` (_object_) Map of extra properties. Properties contained here should not be relied on and may be removed at any time. _Available in: v54.0_ _Filter group: Small_ Additional properties: `object`. * `quoteStatuses` (_array of QuoteStatus_) List of Quote Statuses linked to the Status picklist of the Quote Entity * `sessionDrivenCurrency` (_boolean_) Indicates whether to base the currency on the session context value (`true`) or not (`false`). For D2C stores without markets, this property is set to `false`. For D2C stores with markets and for all B2B stores (with or without markets), the property is set to `true`. _Available in: v57.0_ _Filter group: Small_ * `shippingCountries` (_array of string_) Array of two-digit ISO codes of the countries to which purchases in the store can be shipped. If the store’s Supported Ship To Countries field is set, this value matches it. If not, then this value matches the `country` value. _Available in: v55.0_ _Filter group: Small_ * `shopperConsentEnabled` (_boolean_) Indicates whether shopper consent is enabled ( `true` ) or not ( `false` ) for your web store. _Available in: v64.0_ _Filter group: Small_ * `skipPhoneNumberValidationEnabled` (_boolean_) Indicates whether skip phone number validation is enabled ( `true` ) or not ( `false` ) for your web store. _Available in: v64.0_ _Filter group: Small_ * `splitShipmentEnabled` (_boolean_) Indicates whether split shipment is enabled ( `true` ) or not ( `false` ) for your web store. _Available in: v60.0_ _Filter group: Small_ * `subscriptionConfig` (_object_) SubscriptionConfig Commerce subscription configuration settings for the org. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `SubscriptionConfig`. * `supportedCurrencies` (_array of string_) List of currencies supported for the store. _Available in: v54.0_ _Filter group: Small_ * `taxType` (_string_) Tax type of the store. `Gross` if prices include tax. `Net` if prices don't include tax. _Available in: v55.0_ _Filter group: Small_ * `usesSingleEntitlementPolicy` (_boolean_) Indicates if the store uses a single entitlement policy ( `true` ) or not ( `false` ). _Available in: v54.0_ _Filter group: Small_ * `usesUniversalPricebooks` (_boolean_) Indicates if the store uses a single price book for both guest and authenticated users ( `true` ) or not ( `false` ). _Available in: v62.0_ _Filter group: Small_ ### SessionContext Session context for a shopper using a Commerce store. * `accountId` (_string_) Context user's account ID. This field is included in the response only for authenticated users and doesn't apply to guest users. _Available in: v57.0_ _Filter group: Small_ * `accountName` (_string_) Context user's account name. _Available in: v57.0_ _Filter group: Small_ * `buyerGroups` (_array of BuyerGroup_) List of buyer groups associated with the context. _Available in: v58.0_ _Filter group: Small_ * `guestUser` (_boolean_) Indicates if the session context is for a guest user ( `true` ) or not ( `false` ). _Available in: v54.0_ _Filter group: Small_ * `profile` (_object_) CommerceUserProfile User's profile data. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `CommerceUserProfile`. * `userId` (_string_) ID of the user. _Available in: v54.0_ _Filter group: Small_ * `userName` (_string_) Full name of the user. _Available in: v54.0_ —61.0 _Filter group: Small_ ### ShippingProfileCollection Output representation of the shipping profile collection. * `count` (_integer_) Number of shipping profiles returned on the current page. _Available in: v59.0_ _Filter group: Small_ * `items` (_array of ShippingProfile_) List of shipping profiles. _Available in: v59.0_ _Filter group: Small_ * `total` (_integer_) Total number of shipping profiles available for a webstore. _Available in: v59.0_ _Filter group: Small_ ### CalculateTaxesInput Calculate tax input. * `calculatebyTaxClass` (_boolean_) Flag representing if taxes are calculated based on tax class. _Available in: v58.0_ * `currencyIsoCode` (_string_) ISO code of the country. Must match one of the valid ISO codes defined within the org’s State-Country picklist. If unspecified, the default value is the default country for the webstore. Required when multi-currency is enabled _Available in: v58.0_ * `lineItemGroups` (_array of array of CalculateTaxesLineItemInput_, required) List of line items grouped by shipping address. _Available in: v58.0_ * `effectiveAccountId` (_string_, required) The ID of the account for which the request is made. _Available in: v58.0_ ### CalculateTaxes List tax classes. * `classTax` (_array of ClassTaxes_) A tax class. _Available in: v58.0_ _Filter group: Small_ * `error` (_object_) ErrorResponse Error code and message. _Available in: v58.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `lineItems` (_array of CalculateTaxesLineItem_) List of calculate taxes line item. _Available in: v58.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the execution was successful `(true)` or not `(false)` . _Available in: v58.0_ _Filter group: Small_ * `taxLocaleType` (_object_) TaxLocaleTypeEnum Tax types of the store. Values are: * Gross – Prices include tax. * Net – Prices don’t include tax. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `TaxLocaleTypeEnum`. * `totalTaxAmount` (_string_) Total tax amount. _Available in: v58.0_ _Filter group: Small_ ### GetStoreTaxesInfo Output representation of the tax type along with a collection of tax details about a product. * `taxLocaleType` (_object_) TaxLocaleTypeEnum Tax type of the store. Possible values are: * `Gross` —Prices include tax. * `Net` —Prices don’t include tax. . _Available in: v56.0_ _Filter group: Small_ Includes all fields of `TaxLocaleTypeEnum`. * `taxesInfo` (_object_) Tax rate and tax treatment information for the store. _Available in: v56.0_ _Filter group: Small_ Additional properties: `object`. TaxesInfoContainer Includes all fields of `TaxesInfoContainer`. ### CompositeCommerceProductInput Input representation of the composite product create request. * `attributeSetInfo` (_object_) ProductAttributeSetInput Attribute set information for a variation parent product. _Available in: v62.0_ Includes all fields of `ProductAttributeSetInput`. * `categoryIds` (_array of string_) A list of category IDs to be associated with the product. _Available in: v61.0_ * `productFields` (_object_, required) A map of product field names and their values. _Available in: v61.0_ Additional properties: `string`. * `productMedia` (_array of ProductMediaInput_) A list of media records to be associated with the product. _Available in: v61.0_ * `productPricing` (_object_) ProductPricingInput Details of the product pricing. _Available in: v61.0_ Includes all fields of `ProductPricingInput`. ### CompositeCommerceProductOutput Representation of the composite product create or upsert request. * `errorDetails` (_array of CompositeProductErrorDetailsResponse_) List of ErrorDetailsResponseRepresentation * `errors` (_array of ErrorResponse_) The list of errors that were returned, including the error code and error message. _Available in: v61.0_ _Filter group: Small_ * `productId` (_string_) The Salesforce ID of the product record created after the request was successful. _Available in: v61.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the product was successfully created ( `true` ) or not ( `false` ). _Available in: v61.0_ _Filter group: Small_ ### CompositeCommerceVariationInput Input representation of product variation details. * `parentProductId` (_string_, required) ID of the variation parent product. _Available in: v62.0_ * `variations` (_array of ProductVariationInput_, required) List of variation products and their attributes. _Available in: v62.0_ ### CompositeCommerceVariationOutput Composite product variation create request response. * `errorDetails` (_object_) List of error details per variation Additional properties: `array of CompositeProductErrorDetailsResponse`. * `errors` (_array of ErrorResponse_) List of any errors that were returned, including the error code and error message. _Available in: v62.0_ _Filter group: Small_ * `productIds` (_array of string_) IDs of the created product variations. _Available in: v62.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the product variations were successfully created (`true`) or not (`false`). _Available in: v62.0_ _Filter group: Small_ ### NavigationMenuItemCollection Navigation Menu Item Collection * `menuItems` (_array of NavigationMenuItem_) List of navigation menu items. _Available in: v47.0_ _Filter group: Small_ ### ProductCategoryDetailCollection Collection of product category details. * `productCategories` (_array of ProductCategoryDetail_) List of product category details. _Available in: v52.0_ _Filter group: Small_ ### ProductCategoryDetail Details of a product category. * `bannerImage` (_object_) ProductCategoryMedia Banner image of the product category. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductCategoryMedia`. * `fields` (_object_) List of fields for the product category. _Available in: v49.0_ _Filter group: Small_ Additional properties: `string`. * `id` (_string (Id)_) ID of the product category. _Available in: v49.0_ _Filter group: Small_ * `mediaGroups` (_array of ProductCategoryMediaGroup_) List of media groups of the product category. _Available in: v49.0_ _Filter group: Small_ * `tileImage` (_object_) ProductCategoryMedia Tile image of the product category. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductCategoryMedia`. * `urlName` (_string_) SEO-friendly URL name of the product category. _Available in: v59.0_ _Filter group: Small_ ### ProductCategoryPath List of product categories in a path. * `path` (_array of ProductCategory_) List of product categories in a path. _Available in: v49.0_ _Filter group: Small_ ### ProductOverviewCollection A collection of product overviews. * `products` (_array of ProductOverview_) Collection of product overview. _Available in: v54.0_ _Filter group: Medium_ * `total` (_integer_) Total number of products returned. _Available in: v54.0_ _Filter group: Small_ ### ProductDetail Details of a product. * `attributeSetInfo` (_object_) Map of the attribute set developer name to its metadata. _Available in: v50.0_ _Filter group: Small_ Additional properties: `ProductAttributeSetInfo`. * `defaultImage` (_object_) ProductMedia Default image of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductMedia`. * `dynamicAttributeCount` (_integer_) Count of dynamic attributes associated with the product. This field is supported for both simple products and dynamic product bundles. _Available in: v66.0_ _Filter group: Small_ * `fields` (_object_) List of fields for the product. _Available in: v49.0_ _Filter group: Small_ Additional properties: `string`. * `id` (_string (Id)_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `isConfigurationAllowed` (_boolean_) isConfigurationAllowed value for Product * `mediaGroups` (_array of ProductMediaGroup_) List of media groups of the product. _Available in: v49.0_ _Filter group: Small_ * `primaryProductCategoryPath` (_object_) ProductCategoryPath Primary category path of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductCategoryPath`. * `productClass` (_object_) ConnectProductClassEnum Class of product. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnum`. * `productSellingModels` (_array of ProductSellingModel_) List of product selling models for the product. _Available in: v56.0_ _Filter group: Small_ * `purchaseQuantityRule` (_object_) PurchaseQuantityRule If one exists, purchase quantity rule for the product. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRule`. * `urlName` (_string_) SEO-friendly URL name for the product. _Available in: v59.0_ _Filter group: Small_ * `variationAttributeSet` (_object_) ProductAttributeSet Variation attribute set for the product. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ProductAttributeSet`. * `variationInfo` (_object_) ProductVariationInfo Available and allowable values for variation attributes and a map to resolve variation product IDs from attribute value combinations. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ProductVariationInfo`. * `variationParentId` (_string (Id)_) ID of the variation parent. _Available in: v50.0_ _Filter group: Small_ * `entitlement` (_object_) ProductEntitlement Entitlement details for the product. To get pricing information for products in version 57 and later, use [Commerce Webstore Pricing Products](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getMultiProductPrice). _Available in: v49.0–56.0_ _Filter group: Small_ Includes all fields of `ProductEntitlement`. ### ProductChildCollection Collection of child products related to a parent product. * `count` (_integer_) Number of child products returned on this page. _Available in: v57.0_ _Filter group: Small_ * `currentPageToken` (_string_) Current page token, if any. _Available in: v57.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL of the current page in the response. _Available in: v57.0_ _Filter group: Small_ * `items` (_array of ProductChild_) Collection of child products related to the parent product. The child products are sorted by their configured sequence values, in ascending order, with null values sorted last. If there are no configured sequence values, the child products are sorted by `createdDate` , in ascending order. _Available in: v57.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token for the next page, if any. A value is included in the response only if a value is returned for `nextPageUrl`. _Available in: v57.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL of the next page, if any. _Available in: v57.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token for the previous page, if any. A value is included in the response only if a value is returned for `previousPageUrl`. _Available in: v57.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL of the previous page, if any. _Available in: v57.0_ _Filter group: Small_ * `productClass` (_object_) ConnectProductClassEnum Class of product. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnum`. * `total` (_integer_) Total number of child products in the collection. _Available in: v57.0_ _Filter group: Small_ ### FeaturedProductsOutput Details of featured products for a specified product. * `featuredProductsByRelationshipType` (_object_) A map of each relationship type to an ordered list of featured products associated with that type. The lists are sorted based on the `Sequence` field on the junction object. _Available in: v64.0_ _Filter group: Small_ Additional properties: `array of ProductDetail`. ### CategoryImportInput Configuration for an asynchronous category import job. * `importConfiguration` (_object_, required) ImportConfiguration Configuration for a category import operation. _Available in: v59.0_ Includes all fields of `ImportConfiguration`. ### CategoryImport Information about a category import job. * `categoriesCreated` (_integer_) Number of product categories created by the import. _Available in: v59.0_ _Filter group: Small_ * `categoriesSlugsCreated` (_integer_) Number of category URL slugs created by the import. _Available in: v59.0_ _Filter group: Medium_ * `categoriesSlugsUpdated` (_integer_) Number of category URL slugs updated by the import. _Available in: v59.0_ _Filter group: Medium_ * `categoriesUpdated` (_integer_) Number of product categories updated by the import. _Available in: v59.0_ _Filter group: Small_ * `contentVersionId` (_string (Id)_) ID of the .csv file that was imported. _Available in: v59.0_ _Filter group: Small_ * `endTime` (_integer (int64)_) Unix epoch timestamp when the import finished. _Available in: v59.0_ _Filter group: Small_ * `errorMessages` (_object_) Map of .csv file record number to error message. _Available in: v59.0_ _Filter group: Small_ Additional properties: `string`. * `jobId` (_string (Id)_) ID of the import job. _Available in: v59.0_ _Filter group: Medium_ * `numberError` (_integer_) Number of .csv records that failed to process. _Available in: v59.0_ _Filter group: Small_ * `numberSuccess` (_integer_) Number of .csv records that processed successfully. _Available in: v59.0_ _Filter group: Small_ * `numberToProcess` (_integer_) Number of .csv records in the data source. _Available in: v59.0_ _Filter group: Small_ * `numberWarning` (_integer_) Number of warnings while processing csv records * `processTime` (_integer (int64)_) Unix epoch timestamp of how long the import process took. _Available in: v59.0_ _Filter group: Small_ * `productCatalogId` (_string (Id)_) ID of the product catalog imported to. _Available in: v59.0_ _Filter group: Small_ * `startTime` (_integer (int64)_) Unix epoch timestamp when the import started. _Available in: v59.0_ _Filter group: Small_ * `startedBy` (_string (Id)_) ID of the user who started the import. _Available in: v59.0_ _Filter group: Small_ * `status` (_string_) Status of the import. _Available in: v59.0_ _Filter group: Small_ * `warningMessages` (_object_) Map of record number to associated list of warning messages. _Available in: v59.0_ _Filter group: Small_ Additional properties: `array of string`. ### CategoryImportAbortInput Cancel asynchronous category import job input. * `status` (_string_, required) The value must be `Aborted` . _Available in: v59.0_ ### GlobalProductImportInput Configuration for an asynchronous global product import job. * `importConfiguration` (_object_, required) ImportConfiguration Configuration for a product import operation. _Available in: v57.0_ Includes all fields of `ImportConfiguration`. ### GlobalProductImport Information about a global product import job. * `cmsWorkspaceId` (_string (Id)_) ID of the CMS workspace. _Available in: v57.0_ _Filter group: Medium_ * `commerceEntitlementPolicyId` (_string (Id)_) ID of the entitlement policy imported to. _Available in: v53.0_ _Filter group: Small_ * `commerceEntitlementProductsCreated` (_integer_) Number of entitlement products created by the import. _Available in: v53.0_ _Filter group: Small_ * `contentVersionId` (_string (Id)_) ID of the .csv file that was imported. _Available in: v53.0_ _Filter group: Small_ * `endTime` (_integer (int64)_) Unix epoch timestamp when the import finished. _Available in: v53.0_ _Filter group: Small_ * `errorMessages` (_object_) Map of .csv file record number to error message. _Available in: v53.0_ _Filter group: Small_ Additional properties: `string`. * `jobId` (_string (Id)_) ID of the import job. _Available in: v57.0_ _Filter group: Medium_ * `numberError` (_integer_) Number of .csv records that failed to process. _Available in: v53.0_ _Filter group: Small_ * `numberSuccess` (_integer_) Number of .csv records that processed successfully. _Available in: v53.0_ _Filter group: Small_ * `numberToProcess` (_integer_) Number of .csv records in the data source. _Available in: v53.0_ _Filter group: Small_ * `numberWarning` (_integer_) Number of warning messages. _Available in: v56.0_ _Filter group: Small_ * `pricebookAliasToIdMapping` (_object_) Map of pricebook aliases to pricebook IDs. _Available in: v57.0_ _Filter group: Medium_ Additional properties: `string (Id)`. * `pricebookEntriesCreated` (_integer_) Number of pricebook entries created by the import. _Available in: v53.0_ _Filter group: Small_ * `pricebookEntriesUpdated` (_integer_) Number of pricebook entries updated by the import. _Available in: v53.0_ _Filter group: Small_ * `processTime` (_integer (int64)_) Unix epoch timestamp of how long the import process took. _Available in: v53.0_ _Filter group: Small_ * `productAttributeSetProductsCreated` (_integer_) Number of product attribute set products created by the import. _Available in: v53.0_ _Filter group: Small_ * `productAttributesCreated` (_integer_) Number of product attributes created by the import. _Available in: v53.0_ _Filter group: Small_ * `productAttributesUpdated` (_integer_) Number of product attributes updated by the import. _Available in: v53.0_ _Filter group: Small_ * `productCatalogId` (_string (Id)_) ID of the product catalog imported to. _Available in: v53.0_ _Filter group: Small_ * `productCategoriesCreated` (_integer_) Number of product categories created by the import. _Available in: v53.0_ _Filter group: Small_ * `productCategoryProductsCreated` (_integer_) Number of product category products created by the import. _Available in: v53.0_ _Filter group: Small_ * `productMediaCreated` (_integer_) Reserved for future use. _Available in: v53.0_ _Filter group: Medium_ * `productMediaUpdated` (_integer_) Reserved for future use. _Available in: v53.0_ _Filter group: Medium_ * `productSellingModelCreated` (_integer_) Number of product selling models created by the import. _Available in: v54.0_ _Filter group: Medium_ * `productSellingModelOptionCreated` (_integer_) Number of product selling model options created by the import. _Available in: v54.0_ _Filter group: Medium_ * `productsCreated` (_integer_) Number of products created by the import. _Available in: v53.0_ _Filter group: Small_ * `productsUpdated` (_integer_) Number of products updated by the import. _Available in: v53.0_ _Filter group: Small_ * `sampleData` (_object_) ConnectSampleDataEnum Sample .csv file that was imported. Values are: * `B2BSampleData` —B2B sample data set. * `Camera` —Camera store sample data set. * `Coffee` —Coffee store sample data set. * `Hardware` —Hardware store sample data set. * `NorthernTrail` —Outdoor goods store sample data set. * `NorthernTrailLarge` —Larger outdoor goods store sample data set. * `Simple` —Two-product sample data set. _Available in: v53.0_ _Filter group: Small_ Includes all fields of `ConnectSampleDataEnum`. * `slugsCreated` (_integer_) Number of URL slugs created by the import. _Available in: v58.0_ _Filter group: Medium_ * `slugsUpdated` (_integer_) Number of URL slugs updated by the import. _Available in: v58.0_ _Filter group: Medium_ * `startTime` (_integer (int64)_) Unix epoch timestamp when the import started. _Available in: v53.0_ _Filter group: Small_ * `startedBy` (_string (Id)_) ID of the user of who started the import. _Available in: v53.0_ _Filter group: Small_ * `status` (_string_) Status of the import. _Available in: v53.0_ _Filter group: Small_ * `warningMessages` (_object_) Map of record number to associated list of warning messages. _Available in: v56.0_ _Filter group: Small_ Additional properties: `array of string`. * `webstoreId` (_string (Id)_) ID of the store imported to (if used). _Available in: v57.0_ _Filter group: Medium_ ### ProductImportCancelInput Cancel asynchronous product import job input. * `status` (_string_, required) The value must be `Aborted`. _Available in: v57.0_ ### ExtensionOutputCollection Collection of Commerce extensions. * `count` (_integer_) Total number of extensions. _Available in: v58.0_ _Filter group: Big_ * `items` (_array of ExtensionOutput_) Collection of extensions. _Available in: v58.0_ _Filter group: Big_ ### MappingOutputCollection Collection of Commerce extension mappings. * `count` (_integer_) Total number of extensions. _Available in: v58.0_ _Filter group: Big_ * `items` (_array of MappingOutput_) Collection of extension mappings. _Available in: v58.0_ _Filter group: Big_ ### MappingInput Input representation for mapping. * `epn` (_string_) Extension point name (unique identifier for an extension). For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. _Available in: v59.0_ * `id` (_string_) Mapping ID. _Available in: v59.0_ * `providerName` (_string_, required) Unique name of the extension provider. _Available in: v59.0_ * `webstoreId` (_string_, required) ID of the webstore. _Available in: v59.0_ ### MappingOutput Mapping of a Commerce extension provider to a webstore. * `epn` (_string_) Extension point name (unique identifier for an extension). For valid values, see the ExtensionPointName field of [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) . _Available in: v58.0_ _Filter group: Big_ * `id` (_string_) Mapping ID. _Available in: v58.0_ _Filter group: Big_ * `providerName` (_string_) Unique name of the extension provider. _Available in: v58.0_ _Filter group: Big_ * `webstoreId` (_string_) ID of the webstore. _Available in: v58.0_ _Filter group: Big_ ### ProviderOutputCollection Collection of Commerce extension providers. * `count` (_integer_) Total number of extensions. _Available in: v58.0_ _Filter group: Big_ * `items` (_array of ProviderOutput_) List of extension providers. _Available in: v58.0_ _Filter group: Big_ ### ProviderInput Input representation of a Provider * `apexClass` (_object_, required) ApexClassInput Apex class for the extension provider. _Available in: v59.0_ Includes all fields of `ApexClassInput`. * `configUrl` (_string_) Reserved for future use. _Available in: v59.0_ * `description` (_string_, required) Description of the provider. _Available in: v59.0_ * `epn` (_string_, required) Extension point name (unique identifier for an extension). For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. _Available in: v59.0_ * `iconUri` (_string_) Reserved for future use. _Available in: v59.0_ * `isApplication` (_boolean_, required) Indicates if the extension provider is contained within a managed package. ( `true` ) or not ( `false` ). _Available in: v59.0_ * `name` (_string_, required) Unique name of the extension provider. _Available in: v59.0_ * `type` (_string_, required) Type of extension (for example, apexClass). _Available in: v59.0_ ### ProviderOutput A Commerce extension provider. * `apexClass` (_object_) ApexClassOutput Commerce extension provider Apex class. This class extends an Apex base class and provides a custom implementation for an extension point. _Available in: v58.0_ _Filter group: Big_ Includes all fields of `ApexClassOutput`. * `configUrl` (_string_) Reserved for future use. _Available in: v59.0_ _Filter group: Big_ * `description` (_string_) Description of the extension provider. _Available in: v59.0_ _Filter group: Big_ * `effectiveMappings` (_array of EffectiveMapping_) Collection of mappings associated with the extension provider. _Available in: v58.0_ _Filter group: Big_ * `epn` (_string_) Extension point name (unique identifier for an extension). For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. _Available in: v58.0_ _Filter group: Big_ * `iconUri` (_string_) Reserved for future use. _Available in: v59.0_ _Filter group: Big_ * `id` (_string_) ID of the extension provider. _Available in: v59.0_ _Filter group: Big_ * `isApplication` (_boolean_) Indicates if the extension provider is contained within a managed package. ( `true` ) or not ( `false` ). _Available in: v59.0_ _Filter group: Big_ * `name` (_string_) Unique name of the extension provider. _Available in: v58.0_ _Filter group: Big_ * `type` (_string_) Type of extension (for example, apexClass). _Available in: v58.0_ _Filter group: Big_ ### PricingResult Product pricing result. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. _Available in: v49.0_ _Filter group: Small_ * `error` (_object_) ErrorResponse Error code and message. _Available in: v49.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `pricingLineItemResults` (_array of PricingResultLineItemCommerceStorePricing_) Pricing result line Items. _Available in: v49.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the execution was successful (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ ### PricingInput Pricing for multiple products. * `pricingLineItems` (_array of PricingLineItemInput_, required) Up to 500 line items for pricing. _Available in: v49.0_ ### ProductPrice Pricing information for a product. * `childEntries` (_array of ProductPrice_) List of line item prices for the child products. _This property is recursive: each item has the same structure as `ProductPrice`._ _Available in: v65.0_ _Filter group: Small_ * `contractId` (_string_) Represents the ID of the contract * `contractItemPriceId` (_string_) Represents the ID of the contract item price * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. Products are priced using the currency for the buyer account or guest buyer profile. If your store doesn’t support the currency for the buyer account or guest buyer profile, products are priced using the default currency for your store. _Available in: v49.0_ _Filter group: Small_ * `listPrice` (_string_) List price for the product. _Available in: v49.0_ _Filter group: Small_ * `lowestUnitPrice` (_string_) Lowest unit price for the product. _Available in: v59.0_ _Filter group: Small_ * `priceAdjustment` (_object_) PriceAdjustmentSchedule Price adjustment schedule for the product. If a product selling model ID is specified in a request parameter, this property is empty. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `PriceAdjustmentSchedule`. * `pricebookEntryId` (_string (Id)_) ID of the price book entry. If a product selling model ID is specified in a request parameter, this property is empty. _Available in: v49.0_ _Filter group: Small_ * `productId` (_string_) ID of the product. _Available in: v65.0_ _Filter group: Small_ * `productPriceEntries` (_array of ProductPriceEntry_) List of line item prices for the product. _Available in: v56.0_ _Filter group: Small_ * `productSellingModelId` (_string (Id)_) Represents the ID of the product selling model * `unitPrice` (_string_) Unit price for the product. If a product selling model ID is specified in a request parameter, this property is empty. _Available in: v49.0_ _Filter group: Small_ ### CommerceSubscriptionCollection Representation for the Commerce subscriptions collection. * `count` (_integer_) Total number of subscriptions returned only on the current page. _Available in: v63.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token for the current page of subscriptions. _Available in: v63.0_ _Filter group: Small_ * `currentPageUrl` (_string (url)_) URL to the current page of subscriptions. _Available in: v63.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token for the next page of subscriptions. _Available in: v63.0_ _Filter group: Small_ * `nextPageUrl` (_string (url)_) URL to the next page of subscriptions. _Available in: v63.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token for the previous page of subscriptions. _Available in: v63.0_ _Filter group: Small_ * `previousPageUrl` (_string (url)_) URL to the previous page of subscriptions. _Available in: v63.0_ _Filter group: Small_ * `sortOrder` (_object_) ConnectCommerceSubscriptionSortEnum Sort order of the subscription results returned in the page. Possible values are: * `CreatedDateAsc` —Sort in ascending order of created date. * `CreatedDateDesc` —Sort in descending order of created date. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSubscriptionSortEnum`. * `subscriptions` (_array of CommerceSubscriptionDetail_) Details of Commerce subscriptions. _Available in: v63.0_ _Filter group: Small_ ### CommerceSubscriptionAmendInput Input representation for the Commerce subscription amend request. * `amendStartDate` (_string (date)_, required) The date when the subscription amendment takes effect. The specified date must not be in the past and cannot be later than the subscription end date. _Available in: v65.0_ * `outputType` (_OutputTypeEnum_) * `quantityChange` (_number (double)_, required) The change in digital product quantity for the existing subscription. _Available in: v65.0_ * `recordId` (_string_) ID of the record. * `subscriptionIds` (_array of string_, required) List of digital product subscription IDs to amend. Currently supports amending only one digital product subscription per request. _Available in: v65.0_ ### CommerceSubscriptionAmendOutput Representation for the Commerce subscription amend request. * `orderId` (_string (Id)_) Order ID created for the Commerce subscription amend request. _Available in: v65.0_ _Filter group: Small_ * `recordId` (_string (Id)_) Id of the generated record. * `requestIdentifier` (_string_) Unique identifier for tracking this request. ### CommerceSubscriptionCancelInput Input representation for the Commerce subscription cancel request. * `cancelStartDate` (_string (date-time)_) Date when the cancellation should take effect. * `subscriptionIds` (_array of string_) Set Subscription Ids * `subscriptions` (_array of string_, required) List of digital product subscription IDs to cancel. Currently supports canceling only one digital product subscription per request. _Available in: v63.0_ ### CommerceSubscriptionCancelOutput Representation for the Commerce subscription cancellation request. * `orderId` (_string (Id)_) Order ID created for the Commerce subscription cancellation request. _Available in: v63.0_ _Filter group: Small_ * `recordId` (_string (Id)_) Id of the generated record. * `requestIdentifier` (_string_) Unique identifier for tracking this request. ### CommerceSubscriptionRenewInput Input representation for the Commerce subscription renew request. * `renewalEndDate` (_string (date-time)_) The date when the subscription renewal period ends. If `renewalStartDate` is present, you must specify either `renewalEndDate` or both `renewalTermLength` and `renewalTermUnit` . _Available in: v65.0_ * `renewalStartDate` (_string (date-time)_, required) The date when the subscription renewal period begins. Defaults to one day after the current subscription end date. _Available in: v65.0_ * `renewalTermLength` (_integer_) The duration of the renewal term. If `renewalStartDate` is provided, you must specify either `renewalEndDate` or both `renewalTermLength` and `renewalTermUnit` . _Available in: v65.0_ * `renewalTermUnit` (_string_) The unit of time for the renewal term. For example, days, months, or years. If `renewalStartDate` is present, you must specify either `renewalEndDate` or both `renewalTermLength` and `renewalTermUnit` . _Available in: v65.0_ * `subscriptionIds` (_array of string_, required) List of digital product subscription IDs to renew. The default is 5. The maximum value is 25. The API supports renewal of one digital product subscription per request. From API version 66.0 and later, you can renew multiple subscriptions in a single request. _Available in: v65.0_ ### CommerceSubscriptionRenewOutput Representation for the Commerce subscription renew request. * `orderId` (_string (Id)_) Order ID created for the Commerce subscription renew request. _Available in: v65.0_ _Filter group: Small_ * `recordId` (_string (Id)_) Id of the generated record. * `requestIdentifier` (_string_) Unique identifier for tracking this request. ### CommerceSubscriptionRenewalPriceForecastInput Input representation for renewal price forecasting of the specified Commerce subscriptions. * `endDate` (_string (date-time)_) End date for the renewal. If `startDate` is present, then either `endDate` , or ( `termLength` and `termUnit` ), must be present. _Available in: v67.0_ * `startDate` (_string (date-time)_) Start date for the renewal. Defaults to one day after the current subscription end date. _Available in: v67.0_ * `subscriptionIds` (_array of string_, required) List of subscription IDs for renewal price forecasting. _Available in: v67.0_ * `termLength` (_integer_) Term length for the renewal. If `startDate` is present, then either `endDate` , or ( `termLength` and `termUnit` ), must be present. _Available in: v67.0_ * `termUnit` (_string_) Term unit for the renewal. If `startDate` is present, then either `endDate` , or ( `termLength` and `termUnit` ), must be present. _Available in: v67.0_ ### CommerceSubscriptionRenewalPriceForecastOutput Output representation of the Commerce subscription renewal price forecast. * `errors` (_array of ErrorResponse_) Error response representation for renewal price forecast. _Available in: v67.0_ _Filter group: Small_ * `renewalPriceForecasts` (_array of SubscriptionRenewalPriceForecastDetail_) List of commerce subscription renewal price forecast details. _Available in: v67.0_ _Filter group: Small_ ### CommerceSubscriptionActionsHistory Representation for subscription actions history. * `actions` (_array of SubscriptionActionOutput_) List of actions associated with a subscription. _Available in: v66.0_ _Filter group: Small_ ### CommerceSubscriptionSavedPaymentMethodInput Input representation for updating a saved payment method associated with a subscription. * `merchantAccountId` (_string_, required) Salesforce Payments merchant account ID associated with the saved payment method. _Available in: v63.0_ * `savedPaymentMethodId` (_string_, required) ID of the saved payment method record associated with the Commerce subscription. _Available in: v63.0_ ### CommerceSubscriptionDetail Representation for the Commerce subscription details. * `amendmentStatus` (_object_) OperationStatus Amendment status of the subscription. Possible values are: * `Failed` —The operation status is failed. * `InProgress` —The operation status is in progress. * `Success` —The operation status is successful. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `OperationStatus`. * `billing` (_object_) CommerceSubscriptionBillingSummary Billing info associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `CommerceSubscriptionBillingSummary`. * `cancelStatus` (_object_) OperationStatus Cancel status of the subscription. Possible values are: * `Failed` —The operation status is failed. * `InProgress` —The operation status is in progress. * `Success` —The operation status is successful. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `OperationStatus`. * `endDate` (_string (date-time)_) End date associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the Commerce subscription record. _Available in: v63.0_ _Filter group: Small_ * `lastAction` (_object_) SubscriptionActionOutput Details about the most recent action performed on the subscription. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `SubscriptionActionOutput`. * `processExceptions` (_array of ProcessExceptionOutput_) Reserved for future use. _Available in: v64.0_ _Filter group: Small_ * `product` (_object_) BuyerProductSummary Product associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `BuyerProductSummary`. * `quantity` (_number (double)_) Quantity associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ * `renewalStatus` (_object_) OperationStatus Renewal status of the subscription. Possible values are: * `Failed` —The operation status is failed. * `InProgress` —The operation status is in progress. * `Success` —The operation status is successful. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `OperationStatus`. * `sellingModel` (_object_) ProductSellingModel Selling model associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ProductSellingModelCommerceBuyerexperience`. * `startDate` (_string (date-time)_) Start date associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ * `subscriptionTerm` (_integer_) Subscription term associated with the Commerce subscription. _Available in: v63.0_ _Filter group: Small_ ### BusinessObjectivesSummaryOutput List of summaries for business objectives, or goals. * `businessObjectivesSummary` (_array of BusObjSummaryOutput_) List of business objective summaries. _Available in: v59.0_ _Filter group: Small_ ### BusinessObjectiveInput A business objective, or goal, and insights associated with it. * `businessObjectiveId` (_string_, required) ID of the business objective. _Available in: v62.0_ * `insightSummary` (_object_) BusObjInsightsInput A summary of insights about the business objective. _Available in: v62.0_ Includes all fields of `BusObjInsightsInput`. * `associations` (_array of BusinessObjectiveAssociationInputRequest_) List of business objective associations. _Available in: v59.0_ * `description` (_string_) Description of the business objective. _Available in: v59.0_ * `labelName` (_string_, required) Label name of the business objective. _Available in: v59.0_ ### BusObjSummaryOutput Summary of a business objective, or goal. * `description` (_string_) Description of the business objective. _Available in: v59.0_ _Filter group: Small_ * `id` (_string_) ID of the business objective. _Available in: v59.0_ _Filter group: Small_ * `insightSummary` (_object_) BusObjInsightsOutput Summary of insights related to the business objective. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `BusObjInsightsOutput`. * `kpi` (_string_) Key performance indicator associated with the business objective. _Available in: v61.0_ _Filter group: Small_ * `labelName` (_string_) Display name of the business objective. _Available in: v59.0_ _Filter group: Small_ * `recommendationSummary` (_object_) BusObjRecommendationsOutput Summary of recommended actions for the business objective. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `BusObjRecommendationsOutput`. ### RecommendationsOutput List of recommended actions. * `recommendations` (_array of Rec_) List of recommended actions. _Available in: v59.0_ _Filter group: Small_ ### BusObjRecommendationInput Recommended action for a business objective, or goal. * `acceptanceLabel` (_string_) Text indicating user acceptance of the recommended action. _Available in: v60.0_ * `actionInfo` (_object_) ActionInfoInput Name and parameters required for processing and displaying the recommended action. _Available in: v60.0_ Includes all fields of `ActionInfoInput`. * `businessObjectiveId` (_string_, required) 18-character business objective ID associated with the recommended action. _Available in: v60.0_ * `channelId` (_string_, required) Associated channel ID for the recommended action. _Available in: v61.0_ * `description` (_string_) Detailed description of the recommended action. _Available in: v60.0_ * `domain` (_string_) Domain category of the recommended action (e.g., "Product"). _Available in: v60.0_ * `externalName` (_string_) External identifier used for recommended action tracking. _Available in: v61.0_ * `externalState` (_string_) JSON string containing data required for executing the recommended action. _Available in: v60.0_ * `goalId` (_string_) 18-character GoalAssignment ID linked to the recommended action. _Available in: v61.0_ * `grouping` (_string_) Free-form categorization field to keep track of additional groupings of the recommended actions. _Available in: v62.0_ * `iconName` (_string_) SLDS icon name representing the recommended action domain. _Available in: v60.0_ * `imageId` (_string_) Content asset file ID for the recommended action display image. _Available in: v60.0_ * `name` (_string_, required) Display name of the recommended action. _Available in: v60.0_ * `output` (_object_) ActionInfoInput Stores the last executed snapshot of the recommended action. _Available in: v61.0_ Includes all fields of `ActionInfoInput`. * `recommendationId` (_string_, required) 18-character unique identifier for the recommended action. _Available in: v60.0_ * `rejectionLabel` (_string_) Text indicating user rejection of the recommended action. _Available in: v60.0_ * `score` (_string_) Impact score of the recommended action (value between 0-100). _Available in: v60.0_ * `secondaryState` (_string_) Optional state field for additional filtering of recommended action states. _Available in: v62.0_ * `state` (_string_) Primary state of the recommended action (e.g., "ACTIVE", "INACTIVE", "ACCEPTED", "NOT\_EXPIRING"). _Available in: v60.0_ * `tertiaryState` (_string_) Optional state field for additional filtering of recommended action states. _Available in: v62.0_ ### Rec Recommended action. * `acceptanceLabel` (_string_) Text indicating user acceptance of the recommended action. _Available in: v59.0_ _Filter group: Small_ * `actionInfo` (_object_) ActionInfoOutput Name and parameters required for processing and displaying the recommended action. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `ActionInfoOutput`. * `businessObjectiveId` (_string_) 18-character business objective ID associated with the recommended action. _Available in: v59.0_ _Filter group: Small_ * `channelId` (_string_) Associated channel ID for the recommended action. _Available in: v61.0_ _Filter group: Small_ * `createdDate` (_string (date-time)_) Creation date of the recommended action. _Available in: v61.0_ _Filter group: Small_ * `description` (_string_) Description of the recommended action. _Available in: v59.0_ _Filter group: Small_ * `domain` (_string_) Domain category of the recommended action (e.g., "Product"). _Available in: v59.0_ _Filter group: Small_ * `externalName` (_string_) External identifier used for recommended action tracking. _Available in: v60.0_ _Filter group: Small_ * `externalState` (_string_) JSON string containing data required for executing the recommended action. _Available in: v60.0_ _Filter group: Small_ * `grouping` (_string_) Free-form categorization field to keep track of additional groupings of the recommended actions. _Available in: v62.0_ _Filter group: Small_ * `iconName` (_string_) SLDS icon name representing the recommended action domain. _Available in: v60.0_ _Filter group: Small_ * `id` (_string_) ID of the recommended action. _Available in: v59.0_ _Filter group: Small_ * `imageId` (_string_) Content asset file ID for the recommended action display image. _Available in: v60.0_ _Filter group: Small_ * `lastModifiedDate` (_string (date-time)_) Date that the recommended action was last modified. _Available in: v61.0_ _Filter group: Small_ * `name` (_string_) Display name of the recommended action. _Available in: v59.0_ _Filter group: Small_ * `output` (_object_) ActionInfoOutput Stores the last executed snapshot of the recommended action. _Available in: v61.0_ _Filter group: Small_ Includes all fields of `ActionInfoOutput`. * `rejectionLabel` (_string_) Text indicating user rejection of the recommended action. _Available in: v59.0_ _Filter group: Small_ * `score` (_integer_) Impact score of the recommended action (value between 0-100). _Available in: v60.0_ _Filter group: Small_ * `secondaryState` (_string_) Optional state field for additional filtering of recommended action states. _Available in: v62.0_ _Filter group: Small_ * `state` (_string_) Primary state of the recommended action (e.g., "ACTIVE", "INACTIVE", "ACCEPTED", "NOT\_EXPIRING"). _Available in: v59.0_ _Filter group: Small_ * `tertiaryState` (_string_) Optional state field for additional filtering of recommended action states. _Available in: v62.0_ _Filter group: Small_ ### ExternalManagedAccountCollectionOutput Collection of externally managed accounts. * `externalManagedAccounts` (_array of ExternalManagedAccountOutput_) Collection of externally managed accounts. _Available in: v49.0_ _Filter group: Small_ * `totalExternalManagedAccounts` (_integer_) Total number of externally managed accounts. _Available in: v49.0_ _Filter group: Small_ ### CommerceEinsteinActivityJobInput Commerce Einstein activity job. * `cookieId` (_string_) ID of the cookie. Specify `cookieId` or `userId`, not both. Required if `userId` isn’t specified _Available in: v52.0_ * `userId` (_string_) ID of the user. Specify `cookieId` or `userId`, not both. Required if `cookieId` isn’t specified _Available in: v52.0_ ### CommerceEinsteinActivityExportJob Commerce Einstein activity export job. * `fileUrl` (_string (url)_) URL to download the export file after the job completes. _Available in: v52.0_ _Filter group: Small_ * `fileUrlExpiration` (_string (date-time)_) Expiration date of the file download URL, which is 30 days after the job completes. _Available in: v52.0_ _Filter group: Small_ * `jobId` (_string_) ID of the job. _Available in: v52.0_ _Filter group: Small_ * `statusCode` (_object_) ConnectCommerceEinsteinActivityJobStatusEnum Status code for the job. Values are: * `Completed` —Job completed. * `NoData` —Export job completed with no data. * `Pending` —Job is in progress. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceEinsteinActivityJobStatusEnum`. * `url` (_string (url)_) URL to the job resource. _Available in: v52.0_ _Filter group: Small_ ### CommerceEinsteinActivityPurgeJob Commerce Einstein activity purge job. * `jobId` (_string_) ID of the job. _Available in: v52.0_ _Filter group: Small_ * `statusCode` (_object_) ConnectCommerceEinsteinActivityJobStatusEnum Status code for the job. Values are: * `Completed` —Job completed. * `NoData` —Export job completed with no data. * `Pending` —Job is in progress. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceEinsteinActivityJobStatusEnum`. * `url` (_string (url)_) URL to the job resource. _Available in: v52.0_ _Filter group: Small_ ### CommerceEinsteinConfiguration Commerce Einstein configuration. * `activityTrackingEnabled` (_boolean_) Specifies whether activity tracking is enabled for the site (`true`) or not (`false`). _Available in: v52.0_ _Filter group: Small_ * `catalogExists` (_boolean_) Specifies if the storefront catalog is deployed and finished uploading successfully (`true`) or not (`false`). _Available in: v54.0_ _Filter group: Small_ * `deploymentEnabled` (_boolean_) Specifies if the Deploy Commerce Einstein toggle is enabled on the Commerce Einstein tab in the Administration Workspace (`true`) or not (`false`). _Available in: v55.0_ _Filter group: Small_ * `host` (_string_) Host name for Commerce Einstein APIs. _Available in: v52.0_ _Filter group: Small_ * `isDeployed` (_boolean_) Specifies if Commerce Einstein is deployed successfully (`true`) or not (`false`). _Available in: v54.0_ _Filter group: Small_ * `siteId` (_string_) Site ID for Commerce Einstein. _Available in: v52.0_ _Filter group: Small_ * `tenant` (_string_) Tenant identifier for Commerce Einstein. _Available in: v52.0_ _Filter group: Small_ ### CommerceEinsteinRecommenderConnectEnum Enumerating the different recommendations available in commerce einstein Type: `string`. Allowed values: `ComplementaryProducts`, `CustomersWhoBoughtAlsoBought`, `MostViewedByCategory`, `Personalization`, `PersonalizedForShopper`, `RecentlyViewed`, `SimilarProducts`, `TopSelling`, `TopSellingByCategory`, `Upsell`. ### CommerceEinsteinRecommendationResults Commerce Einstein recommendations. * `productPage` (_object_) ProductSummaryCollection Products being recommended. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `ProductSummaryCollection`. * `uuid` (_string_) Recommendations identifier. This value is passed back to the viewReco activity. _Available in: v55.0_ _Filter group: Small_ ### CommerceEinsteinStatus Commerce Einstein deployment status. * `statusCode` (_object_) ConnectCommerceEinsteinStatusEnum Status code for the deployment. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceEinsteinStatusEnum`. * `url` (_string (url)_) URL to the status resource. _Available in: v52.0_ _Filter group: Small_ ### MultipleFulfillmentOrderInput List of inputs for creating fulfillment orders. * `allOrNothing` (_boolean_) Controls whether a single failed request cancels all other requests in the list. * `fulfillmentOrders` (_array of FulfillmentOrderInput_, required) Each element contains the data to create one fulfillment order. _Available in: v50.0_ ### MultipleFulfillmentOrderOutput A list of responses for the individual FulfillmentOrder creation attempts from a request to create multiple fulfillment orders. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `fulfillmentOrders` (_array of FulfillmentGroupOutput_) _Available in: v50.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### FulfillmentOrderInput An OrderDeliveryGroupSummary that defines a delivery method and recipient, and a list of fulfillment groups to assign to FulfillmentOrders. Each fulfillment group is a set of OrderItemSummaries that match the OrderDeliveryGroupSummary and share the same fulfillment location. The method creates a FulfillmentOrder for each fulfillment group and a FulfillmentOrderLineItem for each OrderItemSummary. * `defaultActivationStatus` (_string_) Default activation status for a new fulfillment order. If you don't specify a value, the default value is `Allocated`, which belongs to the `Activated` status category. This default can be changed, but the replacement status must also have a status category of `Activated`. _Available in: v58.0_ * `fulfillmentGroups` (_array of FulfillmentGroupInput_, required) List of fulfillment groups that specify the OrderItemSummaries and fulfillment locations. _Available in: v48.0_ * `orderDeliveryGroupSummaryId` (_string (Id)_, required) ID of the OrderDeliveryGroupSummary. _Available in: v48.0_ * `orderSummaryId` (_string (Id)_, required) ID of the OrderSummary. _Available in: v48.0_ ### FulfillmentOrderOutput A list of IDs of the created FulfillmentOrders. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `fulfillmentOrderIds` (_array of string_) A list of IDs of created Fulfillment Orders. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### MultipleFulfillmentOrderInvoicesInput The FulfillmentOrders to create Invoices for. * `fulfillmentOrderIds` (_array of string_, required) List of IDs of FulfillmentOrders to create Invoices for. _Available in: v52.0_ ### MultipleFulfillmentOrderInvoicesOutput IDs of the created Invoices. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `invoiceIds` (_array of string_) List of IDs of the created Invoices. _Available in: v52.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### FulfillmentOrderLineItemsToCancelInput A list of FulfillmentOrderLineItems and quantities to cancel. * `fulfillmentOrderLineItemsToCancel` (_array of FulfillmentOrderLineItemInput_, required) List of FulfillmentOrderLineItems and quantities. _Available in: v48.0_ ### FulfillmentOrderCancelLineItemsOutput Wraps the base output. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### FulfillmentOrderInvoiceInput Input representation of an invoice to create ### FulfillmentOrderInvoiceOutput ID of the created invoice. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `invoiceId` (_string_) ID of the created invoice. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### DistributePickedQuantitiesInput Input representation to Distribute Picked Quantities. * `distributeToOrders` (_array of DistributeToOrdersInput_, required) List of orders that need quantities distributed. _Available in: v58.0_ * `optimizationCriteria` (_string_, required) Criteria used for distributing picked quantities to orders. _Available in: v58.0_ * `quantitiesPickedList` (_array of ItemQuantityInput_, required) Quantities for each item picked. _Available in: v58.0_ ### DistributePickedQuantitiesOutput Output representation of where the quantities were distributed in orders and any remaining quantity * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `fullyDistributedOrdersList` (_array of OrderQuantitiesOutput_) Orders that have all quantities distributed. _Available in: v58.0_ * `notDistributedOrdersList` (_array of OrderQuantitiesOutput_) Orders that have no quantities available after distribution. _Available in: v58.0_ * `partiallyDistributedOrdersList` (_array of OrderQuantitiesOutput_) Orders that have partially distributed quantities after distribution. _Available in: v58.0_ * `quantitiesRemainingList` (_array of ItemQuantityOutput_) The quantities remaining after the distribution. _Available in: v58.0_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### TextClassificationsBulkResultsOutput Text classification bulk results. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `resultsList` (_array of TextClassificationsResultWithIdOutput_) List of results for passed request IDs. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### TextClassificationsInput Input representation for text classifications request submission. * `classifiers` (_array of string_, required) List of classifiers according to which text has to be classified. _Available in: v59.0_ * `textList` (_array of string_, required) List of text to be classified. _Available in: v59.0_ ### TextClassificationsOutput HTTP headers containing URLs associating text strings and classifications. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `httpHeaders` (_array of HttpHeaderOutput_) HTTP headers for text classifications output. Each header provides a URL you can use to get the result of the classification. The URL takes a list of text strings and classifiers that each text string can be classified in. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ProductReturnRateListOutput Output representation of products with return rates * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `productReturnRateList` (_array of ProductReturnRateOutput_) List of product return rates. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### PreviewCartToExchangeOrderInput Information required to preview a cart to exchange order. * `exchangeCartId` (_string (Id)_, required) ID of the cart used for adding items to the exchange order. _Available in: v60.0_ * `orderSummaryId` (_string (Id)_, required) Order summary ID. _Available in: v60.0_ * `referenceId` (_string (Id)_, required) Return order ID. _Available in: v60.0_ ### PreviewCartToExchangeOrderOutput Expected change order financial values for the preview cart to exchange order action. * `balanceStateExchangeWebCart` (_object_) BalanceStatePreviewOutput The balance state preview for the exchange web cart. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `balanceStateOriginalOrderSummary` (_object_) BalanceStatePreviewOutput The balance state preview for the original order summary. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `balanceStateReturnOrder` (_object_) BalanceStatePreviewOutput The balance state preview for the return order. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### SubmitCartToExchangeOrderInput Information required to submit an exchange order. * `exchangeCartId` (_string (Id)_, required) ID of the cart used for adding items to the exchange order. _Available in: v60.0_ * `orderNumber` (_string_) Order number. _Available in: v60.0_ * `orderSummaryId` (_string (Id)_, required) Order summary ID. _Available in: v60.0_ * `paymentInfoList` (_array of PaymentInfoInput_) List of payment information when additional funds are needed for the newly created exchange order. _Available in: v60.0_ * `referenceId` (_string (Id)_) Return order ID. _Available in: v60.0_ * `reservationType` (_string_) The reservation that's created by the submit API. The possible values are Full, which means there’s a reservation against the exchange cart, or None if there’s no reservation. _Available in: v61.0_ * `sequences` (_array of SharedOrderPaymentSummarySequenceInput_) Ordered list of order payment summaries and reserved balance amounts to apply them to. _Available in: v60.0_ ### SubmitCartToExchangeOrderOutput Exchange order summary resulting from a submit cart to exchange order action. * `balanceStateExchangeWebCart` (_object_) BalanceStatePreviewOutput The balance state preview for the exchange web cart. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `balanceStateOriginalOrderSummary` (_object_) BalanceStatePreviewOutput The balance state preview for the original order summary. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `balanceStateReturnOrder` (_object_) BalanceStatePreviewOutput The balance state preview for the return order. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `exchangeOrderSummaryId` (_string_) Exchange order summary ID. _Available in: v60.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### CreateOrderPaymentSummaryInput An OrderSummary for which to create an OrderPaymentSummary, with the payment authorization or payments to include in it. * `name` (_string_) Name of the OrderPaymentSummary. _Available in: v66.0_ * `orderSummaryId` (_string (Id)_, required) ID of the OrderSummary. _Available in: v48.0_ * `paymentAuthorizationId` (_string (Id)_) ID of the payment authorization. Either a payment authorization or at least one payment is required. _Available in: v48.0_ * `paymentIds` (_array of string_) List of IDs of the payments. Either a payment authorization or at least one payment is required. _Available in: v48.0_ ### CreateOrderPaymentSummaryOutput ID of the created Order Payment Summary. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderPaymentSummaryId` (_string_) ID of the Order Payment Summary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### OrderSummaryInput An order from which to create an OrderSummary. Optionally, you can specify OrderSummary-specific information such as its Status and whether it is managed in Salesforce Order Management. * `businessModel` (_string_) The order’s business model. It can have one of these values: * B2B * B2C _Available in: v53.0_ * `externalCustomerIdReference` (_string_) External Customer Reference Identifier * `externalReferenceIdentifier` (_string_) Used internally to prevent duplicate records. This value is case-sensitive. _Available in: v56.0_ * `name` (_string_) Specifies an OrderNumber to assign to the order summary. _Available in: v50.0_ * `orderId` (_string (Id)_, required) ID of the original order. _Available in: v48.0_ * `orderLifeCycleType` (_string_) Specifies whether the order is managed in Salesforce Order Management or by an external system. It can have one of these values: * `MANAGED` —Managed in Salesforce Order Management. * `UNMANAGED` —Managed by an external system. If no value is specified, the default is `MANAGED`. _Available in: v49.0_ Allowed values: `MANAGED`, `UNMANAGED`. * `sourceProcess` (_string_) Describes the order process creating the OrderSummary. It can have one of these values: * `Exchange—An Exchange process.` * `OrderOnBehalf` —An Order on Behalf Of process. * `Standard` —Any process other than Exchange or Order on Behalf Of. If no value is specified, the default is `Standard`. _Available in: v57.0_ Allowed values: `Exchange—An Exchange process.`, `OrderOnBehalf`, `Standard`. * `status` (_string_) Specifies a status to assign to the order summary. The value must match one of the picklist values on the Status field of the OrderSummary object. _Available in: v50.0_ ### OrderSummaryOutput ID of the created Order Summary. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) ID of the Order Summary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### CreateMultipleInvoicesFromChangeOrdersInput Data about the change orders to create Invoices for. * `invoicesFromChangeOrders` (_array of CreateInvoiceFromChangeOrdersInput_, required) List of OrderSummary IDs with the IDs of the associated change orders to create Invoices for. Each entry in the list generates one invoice, which combines the change orders in that entry. _Available in: v56.0_ ### CreateMultipleInvoicesFromChangeOrdersOutput List of lists of invoices created from change orders for fees. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `invoices` (_array of CreateInvoiceFromChangeOrdersOutput_) List of IDs of invoices created from change orders for fees. Include these invoice IDs when calling Ensure Refunds for the return that the fees applied to. _Available in: v56.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### MultipleEnsureFundsAsyncInput List of Invoices and the associated OrderSummaries. * `asyncInputs` (_array of InnerEnsureFundsAsyncInput_, required) List of Invoices to ensure funds for and the associated OrderSummaries. _Available in: v56.0_ ### MultipleAsyncOutput IDs of the asynchronous background operations. This output only includes the operation IDs, regardless of whether calls are made to an external payment gateway. It doesn’t include any errors from the operations. * `asyncOutputs` (_array of AsyncOutput_) List of IDs of background operations. _Available in: v56.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### AdjustOrderItemSummaryInput Price adjustments to order item summaries that together make up a price adjustment to an order, with options for adjusting items in the process of being fulfilled. * `adjustItems` (_array of AdjustItemInput_, required) List of price adjustments to order item summaries. _Available in: v49.0_ * `allocatedItemsChangeOrderType` (_string_) Process to use for order item summary quantities that are currently being fulfilled, defined as `QuantityAllocated` - `QuantityFulfilled`. Values are: * `Disallowed` —When distributing the adjustment, ignore any quantities being fulfilled. If an order item summary’s entire quantity is being fulfilled, return an error. This is the default value. * `InFulfillment` —When distributing the adjustment, include quantities being fulfilled. Create a separate change order for the adjustments made to those quantities. * `PreFulfillment` —When distributing the adjustment, include quantities being fulfilled. Include the adjustments made to those quantities in the change order for pre-fulfillment quantity adjustments. _Available in: v55.0_ Allowed values: `Disallowed`, `InFulfillment`, `PreFulfillment`. * `individualLineItemTaxAdjustments` (_boolean_) Specifies whether to create multiple lines for each tax adjustment or one line with all tax adjustments. The default value is false. _Available in: v59.0_ ### AdjustOrderSummaryOutput Output representation of the financial changes for an adjust items action. For a preview action, these values are the expected output. For a submit action, these values are the actual output. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `inFulfillmentChangeOrderId` (_string_) ID of the change Order that holds the financial changes applicable to OrderItemSummary quantities that are in the process of being fulfilled. This change Order is only created for a request that specified an `allocatedItemsChangeOrderType` of InFulfillment. For an adjustPreview call, this value is always null. _Available in: v55.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `postFulfillmentChangeOrderId` (_string_) ID of the change Order that holds the financial changes applicable to OrderItemSummary quantities that have been fulfilled. For an adjustPreview call, this value is always null. _Available in: v49.0_ _Filter group: Big_ * `preFulfillmentChangeOrderId` (_string_) ID of the change Order that holds the financial changes applicable to OrderItemSummary quantities that have not been fulfilled. If the request specified an `allocatedItemsChangeOrderType` of PreFulfillment, this change Order also includes the changes applicable to OrderItemSummary quantities that are in the process of being fulfilled. For an adjustPreview call, this value is always null. _Available in: v49.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### CreateCreditMemoInput A list of change orders used to create a credit memo. * `changeOrderIds` (_array of string_, required) List of IDs of the change orders. _Available in: v48.0_ ### CreateCreditMemoOutput ID of a created Credit Memo. * `creditMemoId` (_string_) ID of the created Credit Memo. _Available in: v48.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ChangeInput A list of changes to order item summaries that make up an order change, such as a cancel or return. * `changeItems` (_array of ChangeItemInput_, required) List of changes to OrderItemSummaries. _Available in: v48.0_ ### PreviewCancelOutput Expected financial values for a proposed cancel action. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ChangeOrderSummaryInput A change to an order summary. There are some general validations for this input. The maximum number of changes allowed per request is 100. You must include at least one change for an entity, and each change that’s associated with an entity counts as one change. You can modify only order item summaries in Ordered status. * `changeOrdersReferenceNumber` (_string_) The order reference number value for the Change Order associated with the current request. _Available in: v66.0_ * `changeReason` (_string_, required) The reason for the change. It has to be an active Picklist value from the OrderItemSummaryChange entity Reason field. _Available in: v66.0_ * `orderAdjustmentGroupSummaries` (_array of ChangeOrderAdjustmentGroupSummaryInput_) The list of order adjustment group summaries changes. _Available in: v66.0_ * `orderDeliveryGroupSummaries` (_array of ChangeOrderDeliveryGroupSummaryInput_) The list of order delivery group summaries changes. _Available in: v66.0_ * `orderItemAdjustmentLineSummaries` (_array of ChangeOrderItemAdjustmentLineSummaryInput_) The list of order item adjustment line summaries changes. _Available in: v66.0_ * `orderItemSummaries` (_array of ChangeOrderItemSummaryInput_) The list of order item summaries changes. _Available in: v66.0_ * `orderItemTaxLineItemSummaries` (_array of ChangeOrderItemTaxLineItemSummaryInput_) The list of order item tax line item summaries changes. _Available in: v66.0_ * `orderSummary` (_object_) The order summary sObject representation that contains the changes for the Order Summary. _Available in: v66.0_ Additional properties: `any`. ### PreviewChangeOrderSummaryOutput The output representation for the change order summary preview. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### PreviewReturnOutput Expected financial values for a proposed return action. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### SubmitCancelOutput ID of the change order created for a cancel action, and a set of its financial values. * `changeBalances` (_object_) ChangeItemOutput Financial values resulting from the cancel. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `changeOrderId` (_string_) ID of the change order created for the canceled order items and shipping charges. Use this change order to create a credit memo. _Available in: v48.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `feeChangeOrderId` (_string_) ID of the change order created by canceling order items with associated cancel fees. Use this change order to create an invoice. _Available in: v57.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### SubmitChangeOrderSummaryOutput The output representation for the submitted change order summary. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `preFulfillmentChangeOrderId` (_string_) The pre fulfillment change order ID that holds the financial changes applicable to the modified order. When the change is non-financial, this value is always null. Use this change order to create a credit memo. _Available in: v66.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### SubmitReturnOutput ID of the change order created for a return action, and a set of its financial values. * `changeBalances` (_object_) ChangeItemOutput Financial values resulting from the return. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `changeOrderId` (_string_) ID of the change order created for the returned order items and shipping charges. Use this change order to create a credit memo. _Available in: v48.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `feeChangeOrderId` (_string_) ID of the change order created by returning order items with associated return fees. Use this change order to create an invoice. _Available in: v57.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### EnsureFundsAsyncInput ID of an Invoice to ensure funds for and apply them to. * `invoiceId` (_string (Id)_, required) ID of the Invoice. _Available in: v48.0_ * `isAllowPartial` (_boolean_, required) If true, the invoice can be funded through multiple, partial payments. Optionally, define a sequence to capture multiple payments. If false, the invoice must be funded through a single payment. Default value is false. _Available in: v60.0_ * `isReservedBalanceAmountConsidered` (_boolean_) Is Reserved Balance Considered * `sequences` (_array of SequenceOrderPaymentSummaryInput_) The payment sequence in which the funds are captured for the invoice. _Available in: v60.0_ * `isConsiderReservedBalanceAmount` (_boolean_) If true, the reserved balance amount is used for the Order Summary to fund the invoice. If not enough reserved balance amount, any available balance that isn’t reserved by another Order Summary is used. If false, any available balance is used. _Available in: v59.0_ ### EnsureFundsAsyncOutput ID of the asynchronous background operation. This output only includes the operation ID, regardless of whether a call is made to an external payment gateway. It doesn’t include any errors from the operation. * `backgroundOperationId` (_string_) ID of the background operation. _Available in: v56.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### EnsureRefundsAsyncInput ID of a credit memo to ensure refunds for, an amount of excess funds to refund, or both. At least one is required. Also includes any invoices for fees that reduce the refund amount, such as return fees. If multiple payment methods are available, you can specify how to distribute the refund. * `creditMemoId` (_string (Id)_) ID of the credit memo that represents a refund amount. Either `creditMemoId` or `excessFundsAmount` is required _Available in: v48.0_ * `excessFundsAmount` (_number (double)_) Amount of excess funds to refund. Either `excessFundsAmount` or `creditMemoId` is required _Available in: v49.0_ * `invoicesToPay` (_array of InvoiceToPayInput_) List of invoices for any fees that reduce the refund, such as return fees. _Available in: v56.0_ * `isAllowPartial` (_boolean_) This value controls the behavior when the amounts included in the `sequences` list don’t cover the entire refund amount. If this value is false, then the default refund logic is applied to ensure the remaining refund amount. If this value is true, then the unrefunded balance remains on the credit memo. If you don’t specify a `sequences` list, this value is ignored and the default refund logic is applied. The default value is false. _Available in: v56.0_ * `isReservedBalanceAmountConsidered` (_boolean_) If true, the refundable amount is used to open the payment balance for the reservedBalanceAmount in the Order Payment Summaries. The remaining refundable amount considers the sequence of order payment summaries, if provided. If false, any reserved balance amount for exchanges is refunded. _Available in: v59.0_ * `sequences` (_array of SequenceOrderPaymentSummaryInput_) Ordered list of refund amounts and OrderPaymentSummaries to apply them to. An OrderPaymentSummary must either belong to the order summary or be a reference to the order summary in the OrderPaymentSummaryReference entity. The process traverses this list in order and stops when it's refunded the full amount. _Available in: v56.0_ ### EnsureRefundsAsyncOutput ID of the asynchronous background operation. This output only includes the operation ID, regardless of whether a call is made to an external payment gateway. It doesn’t include any errors from the operation. * `backgroundOperationId` (_string_) ID of the background operation. _Available in: v56.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ConnectProductExpandType ProductExpandType enumeration. Type: `string`. Allowed values: `ReturnReasons`. ### ProductsListOutput Products with product data and with expand details. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `products` (_array of ProductOutput_) The product’s identifier. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### FindRoutesWithFewestSplitsInput Data used to calculate order fulfillment routes involving the fewest number of shipment splits. * `locationAvailableInventory` (_array of LocationAvailabilityInput_) Each list element represents the available quantity of a product at an inventory location. At least one element is required _Available in: v51.0_ * `maximumNumberOfSplits` (_integer_) The maximum allowable number of shipment splits. Routing options that involve more than this number of splits are not returned. Each split represents an additional shipment. Specifying a maximum of 0 returns only locations that can fulfill the entire order in a single shipment. A maximum of 1 returns combinations of locations that can fulfill the order in one or two shipments, and so on. _Available in: v51.0_ * `orderedQuantities` (_array of QuantityWithSkuInput_) Each list element represents a quantity of a product to be routed for fulfillment. At least one element is required _Available in: v51.0_ ### FindRoutesWithFewestSplitsOutput A list of inventory location combinations that can fulfill an order without exceeding the maximum number of shipments. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ * `targetLocations` (_array of AvailableLocationOutput_) Each element of the list is a set of inventory locations that together can fulfill the order being routed. _Available in: v51.0_ _Filter group: Big_ ### FindRoutesWithFewestSplitsUsingOCIInput Data used to calculate order fulfillment routes involving the fewest number of shipment splits, taking into account inventory availability. * `findRoutesWithFewestSplitsUsingOCIInputs` (_array of FindRoutesWithFewestSplitsGroupUsingOCIInput_) Each list element represents a routing request for one order. At least one element is required _Available in: v54.0_ * `ociExpandAttributes` (_string_) The string value groupEligibilityExclusion excludes specific locations. ### FindRoutesWithFewestSplitsUsingOCIOutput A list of order fulfillment routes with inventory availability information. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `results` (_array of FindRoutesWithFewestSplitsWithInventoryOutput_) Each element of the list is the response for one element of the input list. _Available in: v54.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### RankAverageDistanceInput An order recipient’s geographic location and information about sets of inventory locations that can fulfill the order. * `deliveryCountryCode` (_string_, required) The country code of the order recipient. _Available in: v51.0_ * `deliveryPostalCode` (_string_, required) The postal code of the order recipient. _Available in: v51.0_ * `distanceUnit` (_string_) Specify mi or km to return average distances in miles or kilometers, respectively. _Available in: v51.0_ * `sortResult` (_string_) Specify ASC or DESC to rank the results by average shipping distance in ascending or descending order, respectively. _Available in: v51.0_ * `targetLocations` (_array of TargetLocationInput_) Each element is a set of inventory locations that can combine to fulfill the order. At least one element is required _Available in: v51.0_ ### RankAverageDistanceOutput The results of calculating the average distances from sets of inventory locations to an order recipient. * `distanceUnit` (_string_) The specified unit of distance (miles or kilometers). _Available in: v51.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `results` (_array of AverageDistanceResultOutput_) The results of the shipping distance calculations. _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ConfirmHeldFOCapacityInput Request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call. * `confirmHeldFOCapacityRequests` (_array of ConfirmHeldFOCapacityRequestInput_, required) List of requests to confirm held fulfillment order capacity at one or more locations. _Available in: v55.0_ ### ConfirmHeldFOCapacityOutput Response to a request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call. * `confirmHeldFOCapacityResponses` (_array of ConfirmHeldFOCapacityResponseOutput_) List of responses to the requests to confirm held fulfillment order capacity at one or more locations. _Available in: v55.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### GetFOCapacityValuesRequestInput Locations to get fulfillment order capacity information for. * `locationIds` (_array of string_, required) List of IDs of the locations to get fulfillment order capacity information for. _Available in: v55.0_ ### GetFOCapacityValuesOutput Response to a request for fulfillment order capacity values for one or more locations. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `locations` (_array of LocationCapacityOutput_) List of fulfillment order capacity values for one or more locations. _Available in: v55.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### HoldFOCapacityInput Request to hold fulfillment order capacity at one or more locations. Can correspond to one action call. * `holdFOCapacityRequests` (_array of HoldFOCapacityRequestInput_, required) List of requests to hold fulfillment order capacity at one or more locations. _Available in: v55.0_ ### HoldFOCapacityOutput Response to a request to hold fulfillment order capacity at one or more locations. Can correspond to one action call. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `holdFOCapacityResponses` (_array of HoldFOCapacityResponseOutput_) List of responses to the requests to hold fulfillment order capacity at one or more locations. _Available in: v55.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ReleaseHeldFOCapacityInput Request to release held fulfillment order capacity at one or more locations. Can correspond to one action call. * `releaseHeldFOCapacityRequests` (_array of ReleaseHeldFOCapacityRequestInput_, required) List of requests to release held fulfillment order capacity at one or more locations. _Available in: v55.0_ ### ReleaseHeldFOCapacityOutput Response to a request to release held fulfillment order capacity at one or more locations. Can correspond to one action call. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `releaseHeldFOCapacityResponses` (_array of ReleaseHeldFOCapacityResponseOutput_) List of responses to the requests to release held fulfillment order capacity at one or more locations. _Available in: v55.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ProductSearchOutput Product search response. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. _Available in: v59.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `facets` (_array of ProductSearchFacetOutput_) A list of facet names to filter the search. For example, `["size_medium", "color_red"]`. _Available in: v59.0_ _Filter group: Big_ * `locale` (_string_) Locale used for the product search. _Available in: v59.0_ _Filter group: Big_ * `pageNumber` (_integer_) Maximum number of search results pages to return. If you don't specify a value, the default is 1. _Available in: v59.0_ _Filter group: Big_ * `pageSize` (_integer_) Number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 20. _Available in: v59.0_ _Filter group: Big_ * `products` (_array of ProductSearchProductOutput_) Array of products found by the search. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ * `totalRecordsFound` (_integer (int64)_) Total products found. _Available in: v59.0_ _Filter group: Big_ ### ProductDetailsOutput Details about a product. * `attributes` (_array of ProductVariationAttributeOutput_) List of variation attributes that define variations of the product. _Available in: v55.0_ _Filter group: Big_ * `childItems` (_array of ProductBundleChildOutput_) For bundle products only: an array of the individual products that are a part of the bundle. Only applicable for B2B or D2C stores. _Available in: v64.0_ _Filter group: Big_ * `currencyIsoCode` (_string_) Currency ISO code. _Available in: v55.0_ _Filter group: Big_ * `description` (_string_) Description of the product. _Available in: v55.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `fields` (_object_) List of the product’s fields. _Available in: v55.0_ _Filter group: Big_ Additional properties: `object`. * `imageGroups` (_array of ProductImageGroupOutput_) List of the product’s image groups. _Available in: v55.0_ _Filter group: Big_ * `listPrice` (_number (double)_) List price. _Available in: v55.0_ _Filter group: Big_ * `name` (_string_) Name. _Available in: v55.0_ _Filter group: Big_ * `productClass` (_string_) List of variation attributes that define variations of the product. _Available in: v64.0_ _Filter group: Big_ * `productId` (_string_) Product ID. _Available in: v55.0_ _Filter group: Big_ * `productQuantityRule` (_ProductQuantityRuleOutput_) * `stockKeepingUnit` (_string_) The product’s class. Possible values are: Bundle, Simple, Variation, Variation Parent, or Set. _Available in: v55.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ * `totalChildrenCount` (_string_) For bundles only: the total number of child products in a bundle. Only applicable for B2B or D2C stores. _Available in: v64.0_ _Filter group: Big_ * `unitPrice` (_number (double)_) Unit price. _Available in: v55.0_ _Filter group: Big_ * `variants` (_array of ProductVariantOutput_) List of variations of the product. _Available in: v55.0_ _Filter group: Big_ ### ReturnOrderInput Data for creating a ReturnOrder and ReturnOrderLineItems. * `orderSummaryId` (_string (Id)_, required) ID of the OrderSummary containing the items to be returned. The OrderSummary’s OrderLifeCycleType must be Managed. _Available in: v50.0_ * `refundInstructionsHint` (_RefundInstructionsHintInput_) * `returnOrderLifeCycleType` (_string_, required) The LifeCycleType of the ReturnOrder. Possible values are: * Managed—Process the ReturnOrder using the APIs and actions. It can generate change orders and affects financial fields and rollup calculations. * Unmanaged—The ReturnOrder is for tracking purposes only. It isn’t involved in any financial calculations and doesn’t generate any change orders. The system doesn’t prevent the creation of duplicate ReturnOrderLineItems in an unmanaged ReturnOrder for the same OrderItem. _Available in: v51.0_ * `returnOrderLineItems` (_array of ReturnOrderLineItemInput_) List of data for creating ReturnOrderLineItems. At least one element is required _Available in: v50.0_ * `status` (_string_, required) Status to assign the ReturnOrder. This value must match an entry in the ReturnOrder object’s Status picklist. _Available in: v50.0_ ### ReturnOrderOutput Output representation of the created Return Order. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `returnOrderId` (_string_) A newly created Return Order ID _Available in: v50.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ReturnItemsInput Data about products and delivery charges to return, as well as associated return fees. * `returnOrderItemDeliveryCharges` (_array of ReturnOrderItemDeliveryChargeInput_) List of ReturnOrderLineItems to return that represent delivery charges. _Available in: v52.0_ * `returnOrderItemFees` (_array of ReturnOrderItemFeeInput_) List of ReturnOrderLineItems to process that represent return fees. _Available in: v56.0_ * `returnOrderItems` (_array of ReturnOrderItemInput_, required) List of ReturnOrderLineItems to process that represent products, along with data about how to process them. _Available in: v52.0_ ### ReturnItemsOutput Output of Return Items. Includes the ID of the generated change order for items and delivery charges being returned, as well as the ID of the generated change order for any charged return fees. Also includes information about any ReturnOrderLineItems that were created to represent remaining return quantities. * `changeOrderId` (_string_) ID of the change order created by processing the ReturnOrderLineItems representing returned items and delivery charges. Use this change order to create a credit memo. _Available in: v52.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `feeChangeOrderId` (_string_) ID of the change order created by processing the ReturnOrderLineItems representing return fees. Use this change order to create an invoice. _Available in: v56.0_ _Filter group: Big_ * `refundInstructionsHint` (_RefundInstructionsHintOutput_) * `returnLineItemSplits` (_array of ReturnOrderItemSplitLineOutput_) List of properties representing any remaining quantities from partial returns processed by this call. It includes order items, delivery charges, and return fees. Each element of the list includes the ID of a split ReturnOrderLineItem and the ID of the partially processed ReturnOrderLineItem whose remaining quantity it holds. _Available in: v52.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### RegisterGuestBuyerInput Input representation to Register Guest Buyer ### RegisterGuestBuyerOutput Indicates success or failure of a register guest buyer action. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### OrderSummaryGraphsInput List of graphs containing order summary data. * `orderSummaryGraphs` (_array of OrderSummaryGraphInput_, required) List of graphs containing order summary data. _Available in: v57.0_ * `processingInstructions` (_ProcessingInstructionsInput_) ### OrderSummaryGraphsOutputRepresentationList Response from creating pending order summaries. * `error` (_object_) ErrorResponse Error details, if applicable. _Available in: v57.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `orderSummaryGraphsResults` (_array of OrderSummaryGraphOutput_) List of processing results for the order summary graphs in the request. _Available in: v57.0_ _Filter group: Big_ * `success` (_boolean_) Whether the order summary graphs were successfully processed. _Available in: v57.0_ _Filter group: Big_ ### EstimateDeliveryDateInput Delivery date estimation information. * `deliveryAddress` (_string_) apex\_connectapi\_input\_delivery\_address Delivery address. _Available in: v63.0_ * `locations` (_array of string_) List of location external references. _Available in: v63.0_ * `products` (_array of DeliveryEstimationProductInput_, required) List of products included in delivery estimation. _Available in: v63.0_ * `shippingCarrier` (_string_, required) apex\_connectapi\_input\_shipping\_carrier Shipping carrier used to deliver the order. _Available in: v63.0_ ### EstimateDeliveryDateOutput Estimated delivery dates. * `deliveryEstimates` (_array of DeliveryEstimateOutput_) List of delivery estimations. _Available in: v63.0_ * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `estimatedDeliveryReference` (_string_) apex\_methods\_system\_string Unique code, reference, or identifier for the estimated delivery used by external systems. _Available in: v63.0_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### DeliveryRoutingEngineInput Input for the Delivery Routing Engine, which retrieves routing rules to determine which fulfillment locations should fulfill products for a given delivery address. * `deliveryAddress` (_object_, required) DeliveryAddressInput The destination address for delivery. Use a valid address format. * Coordinates: latitude and longitude * Postal: country code and postal code * Geographic: country code, state, and city _Available in: v67.0_ Includes all fields of `DeliveryAddressInput`. * `excludeLocations` (_object_) LocationListInput Locations that are excluded from routing consideration. Don't leave any identifier blank. The list can contain up to 100 items. _Available in: v67.0_ Includes all fields of `LocationListInput`. * `fulfillmentCriteriaGroupName` (_string_, required) The name of the fulfillment criteria group used for routing. _Available in: v67.0_ * `locationGroupName` (_string_, required) The name of the location group where routing is happening. _Available in: v67.0_ * `products` (_array of RoutingProductInput_, required) The list of products to route. Enter a value between 1 to 2,000 items. _Available in: v67.0_ ### DeliveryRoutingEngineOutput Delivery routing engine output, including ranked routes and the best fulfillment locations for each SKU. * `bestLocationsPerStockKeepingUnit` (_object_) The best fulfillment locations for each SKU. The map key is the SKU string. _Available in: v67.0_ _Filter group: Big_ Additional properties: `array of BestLocationPerSKUOutput`. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `routes` (_array of RouteOutput_) Delivery routes ranked by score. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### OCIBatchUpdateInput Details of one or more inventory records to update in a batch. * `records` (_array of OCIBatchUpdateSingleInput_, required) Data for one inventory record in a list to update. _Available in: v62.0_ ### OCIBatchUpdateOutput Details of the updated inventory records. * `errors` (_array of OCIBatchUpdateErrorOutput_) Errors returned by the transaction. _Available in: v62.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v62.0_ _Filter group: Big_ ### OCIUploadInventoryAvailabilityOutput Response to an upload inventory availability job. * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `success` (_boolean_) Indicates whether the transaction was successful. * `uploadId` (_string_) Identifier of the upload job. Use this value to retrieve the status of the job. _Available in: v51.0_ _Filter group: Big_ ### OCIUploadInventoryAvailabilityStatusOutput Detailed status of an upload inventory availability job. * `endTimeUTC` (_string_) The UTC time when the job finished. (for example: "2020-07-06T22:54:08.012Z") _Available in: v51.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `recordsProcessedCount` (_integer_) The number of records processed by the job. _Available in: v51.0_ _Filter group: Big_ * `recordsReadCount` (_integer_) The number of records read by the job. _Available in: v51.0_ _Filter group: Big_ * `recordsSkippedCount` (_integer_) The number of records skipped by the job. _Available in: v51.0_ _Filter group: Big_ * `startTimeUTC` (_string_) _Available in: v51.0_ _Filter group: Big_ * `status` (_string_) The overall status of the inventory availability upload (e.g. "PENDING", "COMPLETED"). _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. * `uploadId` (_string_) Identifier of the job. _Available in: v51.0_ _Filter group: Big_ * `validationErrors` (_array of string_) List of any validation errors returned by the job. _Available in: v51.0_ _Filter group: Big_ * `validationStatus` (_string_) The validation status of the job. _Available in: v51.0_ _Filter group: Big_ ### OCIGetInventoryAvailabilityInput Details of a request to retrieve inventory availability. * `expand` (_array of string_) Expand * `locationGroupIdentifier` (_string_) The External Reference of a location group to retrieve inventory availability data for. Specifying this value retrieves inventory data for all locations belonging to this group. _Available in: v51.0_ * `locationGroupIdentifiers` (_array of string_) A list of up to 100 External References of location groups to retrieve inventory availability data for. _Available in: v51.0_ * `locationIdentifiers` (_array of string_) A list of up to 100 External References of locations to retrieve inventory availability data for. _Available in: v51.0_ * `stockKeepingUnit` (_string_) The SKU of a product to retrieve inventory availability data for. Specifying a SKU with no locations or location groups returns availability data for that SKU at all inventory locations that aren’t assigned to location groups. _Available in: v51.0_ * `stockKeepingUnits` (_array of string_) A list of up to 100 SKUs of products to retrieve inventory availability data for. _Available in: v51.0_ * `useCache` (_boolean_) Specifies whether to fetch the inventory data from the cache. The default value is `true` . _Available in: v51.0_ * `includeRelatedProducts` (_boolean_) Specifies whether the returned inventory level includes variant products if the given product has variants. When set to `true` , only one product ID is accepted. There's a limit of 100 variant products. If the total of variants exceeds 100, no variants are included in the inventory level. _Available in: v64.0_ ### OCIGetInventoryAvailabilityOutput Response to a request for inventory availability data. * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `locationGroups` (_array of OCILocationGroupAvailabilityOutput_) A list of inventory availability data for individual location groups. _Available in: v51.0_ _Filter group: Big_ * `locations` (_array of OCILocationAvailabilityOutput_) A list of inventory availability data for individual locations. _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. ### OCIPublishLocationStructureOutput Response to a publish location structure request. * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `success` (_boolean_) Indicates whether the transaction was successful. * `uploadId` (_string_) Identifier of the publish job. Use this value to retrieve the status of the job. _Available in: v51.0_ _Filter group: Big_ ### OCIPublishLocationStructureStatusOutput Detailed status of a publish location structure job. * `endTimeUTC` (_string_) The UTC time when the job finished. (for example: "2020-07-06T22:54:08.012Z") _Available in: v51.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `recordsProcessedCount` (_integer_) The number of records processed by the job. _Available in: v51.0_ _Filter group: Big_ * `recordsReadCount` (_integer_) The number of records read by the job. _Available in: v51.0_ _Filter group: Big_ * `recordsSkippedCount` (_integer_) The number of records skipped by the job. _Available in: v51.0_ _Filter group: Big_ * `startTimeUTC` (_string_) The UTC time when the job started. (for example: "2020-07-06T22:53:06.788Z") _Available in: v51.0_ _Filter group: Big_ * `status` (_string_) The status of the job. (e.g., "PENDING," "COMPLETED," etc.). _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. * `uploadId` (_string_) Identifier of the job. _Available in: v51.0_ _Filter group: Big_ * `validationErrors` (_array of string_) List of any validation errors returned by the job. _Available in: v51.0_ _Filter group: Big_ * `validationStatus` (_string_) The validation status of the job. _Available in: v51.0_ _Filter group: Big_ ### OCIFulfillReservationInput A list of inventory reservations to fulfill. * `fulfillmentRecords` (_array of OCIFulfillReservationSingleInput_) A list of inventory reservations. The list can include up to 100 elements. At least one element is required. _Available in: v51.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v58.0_ ### OCIFulfillReservationOutput Response to a request to fulfill one or more inventory reservations. * `errors` (_array of OCIFulfillReservationErrorOutput_) Responses for the individual reservations in the fulfillment request. _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request was successful. _Available in: v51.0_ _Filter group: Big_ ### OCIReleaseReservationInput Details of one or more inventory reservations to release. * `releaseRecords` (_array of OCIReleaseReservationSingleInput_) List of inventory reservations to release. The list can include up to 100 elements. At least one element is required. _Available in: v51.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v58.0_ ### OCIReleaseReservationOutput Response to a request to release one or more inventory reservations. * `errors` (_array of OCIReleaseReservationErrorOutput_) Responses for the individual reservations in the release request. _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request was successful. _Available in: v51.0_ _Filter group: Big_ ### OCICreateReservationInput Data to reserve inventory at one or more Omnichannel Inventory locations or location groups. * `actionRequestId` (_string_, required) A UUID that identifies the request. Use the action request IDs in response data to identify which requests succeeded or failed. If the `OmnichannelInventoryService` class's `createReservation` method is called, the actionRequestId is used for the reservationId. _Available in: v51.0_ * `allowPartialReservations` (_boolean_) When true, if the system can’t create the entire reservation, then it attempts to create a partial reservation. _Available in: v51.0_ * `createAllOrNothingRecords` (_array of OCICreateReservationSingleInput_) Records to reserve with all or nothing * `createRecords` (_array of OCICreateReservationSingleInput_) A list of product quantities and locations or location groups. The list can include up to 100 elements. At least one element is required _Available in: v51.0_ * `expirationSeconds` (_integer_) A length of time in seconds. If the reservation isn’t fulfilled within this amount of time after the `reservationTime`, then it expires. The maximum value is 14400. _Available in: v51.0_ * `externalRefId` (_string_) External reference ID. _Available in: v51.0_ * `reservationId` (_string_) Reservation Id * `reservationTime` (_string_) The time at which to record the reservation. Example: 2020-07-24T21:13:00Z _Available in: v51.0_ ### OCICreateReservationOutput Result of an Omnichannel Inventory reservation creation request. * `details` (_array of OCICreateReservationSingleOutput_) Details for each product in the reservation. _Available in: v51.0_ _Filter group: Small_ * `errors` (_array of OCICreateReservationErrorOutput_) Any errors returned by the reservation request. _Available in: v51.0_ _Filter group: Big_ * `expirationTime` (_string_) The time at which the reservation would expire. _Available in: v51.0_ _Filter group: Small_ * `reservationTime` (_string_) The time when the reservation was recorded. _Available in: v51.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the reservation was successfully created. _Available in: v51.0_ _Filter group: Big_ ### OCITransferReservationInput A list of inventory reservation transfers and specifies whether a single failure cancels the entire list. * `allOrNothingTransferId` (_string_) Controls whether a single failed transfer cancels all other transfers in the `transferRecords` list. * To allow some transfers in the `transferRecords` list to succeed when others fail, don’t include this property. * To cancel all the transfers in the `transferRecords` list when any of them fail, set this property to a UUID. The ID must be unique, but isn’t otherwise used in this version. _Available in: v51.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v58.0_ * `transferRecords` (_array of OCITransferReservationSingleInput_) A list of inventory reservation transfers. The list can include up to 100 elements. At least one element is required. _Available in: v51.0_ ### OCITransferReservationOutput Response to a request to transfer one or more inventory reservations. * `errors` (_array of OCITransferReservationErrorOutput_) Responses for the individual reservations in the transfer request. _Available in: v51.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request was successful. _Available in: v51.0_ _Filter group: Big_ ### OCIUpdateReservationInput Data to update one or more Omnichannel Inventory item reservations. * `actionRequestId` (_string_, required) Unique and idempotent action request ID. Use in response data to identify which requests succeeded or failed. _Available in: v61.0_ * `allowPartialReservations` (_boolean_) When true, if the system can’t update the entire reservation, then it attempts to update a partial reservation. _Available in: v61.0_ * `externalRefId` (_string_) External reference ID. _Available in: v61.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v61.0_ * `reservationTime` (_string_) The time the reservation was updated. Example: 2020-07-24T21:13:00Z. _Available in: v61.0_ * `updateAllOrNothingRecords` (_array of OCIUpdateReservationSingleInput_) Controls whether a single failed request updates all other requests in the list (true) or whether some requests can succeed if others fail (false). The default value is false. _Available in: v61.0_ * `updateRecords` (_array of OCIUpdateReservationSingleInput_) A list of product quantities and locations or location groups. The list can have up to 100 elements. At least one element is required _Available in: v61.0_ ### OCIUpdateReservationOutput Result of an Omnichannel Inventory update request for reserved inventory. * `details` (_array of OCIUpdateReservationSingleOutput_) Details for each product in the reservation. _Available in: v61.0_ _Filter group: Small_ * `errors` (_array of OCIUpdateReservationErrorOutput_) Any errors returned by the reservation update request. _Available in: v61.0_ _Filter group: Big_ * `reservationTime` (_string_) The time when the reservation was updated. _Available in: v61.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the reservation was successfully updated. _Available in: v61.0_ _Filter group: Big_ ### InventoryCheckAvailabilityInput Check inventory availability in either an individual location or group location. Check for available to fulfill, available to order, and on hand quantity information. * `inventoryDimension` (_string_) Fulfillment option you want to check. * On Hand: Inventory available, not counting Future Inventory or Quantity Reserved. * Available to Fulfill (ATF): Inventory that can be fulfilled now. * Available to Order (ATO): Inventory that can be ordered. Default option if no dimension is selected. _Available in: v60.0_ * `locationGroups` (_array of LocationGroupCheckAvailabilityInput_) A list of inventory availability data for location groups. Required if `locations` isn’t requested. _Available in: v60.0_ * `locations` (_array of LocationCheckAvailabilityInput_) A list of inventory availability data for individual locations. Required if `locationsGroups` isn’t requested. _Available in: v60.0_ ### InventoryCheckAvailabilityOutput Inventory product availability for an individual location or location group. * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `locationGroups` (_array of LocationGroupCheckAvailabilityOutput_) List of inventory availability data for individual location groups. Request `locationGroups` or `location` information, not both. _Available in: v60.0_ _Filter group: Big_ * `locations` (_array of LocationCheckAvailabilityOutput_) List of inventory availability data for individual locations. Request `locationGroups` or `location` information, not both. _Available in: v60.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. ### InventoryLevelsOutput Inventory levels data. * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `locationGroups` (_array of LocationGroupLevelsOutput_) List of inventory availability data for individual location groups. _Available in: v60.0_ _Filter group: Big_ * `locations` (_array of LocationLevelsOutput_) List of inventory availability data for individual locations. _Available in: v60.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. * `totalInventory` (_array of InventoryProductOutput_) All inventory information associated with the product. _Available in: v60.0_ _Filter group: Big_ ### InvoiceInput Connect API representation of an invoice service input request * `accountId` (_string_) ID of the account record to create the invoices for. Required if the `billingScheduleIds` or `billingTransactionId` property isn’t specified. _Available in: v63.0_ * `action` (_object_, required) InvoiceActionEnum Type of invoice to be created. _Available in: v62.0_ Includes all fields of `InvoiceActionEnum`. * `billingScheduleIds` (_array of string_) List of billing schedule IDs that’s used to create the invoices. You can specify a maximum of 200 billing schedules. Required if the `accountId` or `billingTransactionId` property isn’t specified. _Available in: v62.0_ * `billingTransactionId` (_string_) ID of the billing transaction record, which is the order ID, to create the invoices for. Required if the `accountId` or `billingScheduleIds` property isn’t specified. _Available in: v63.0_ * `configurationOverrides` (_object_) InvoiceAPIConfigurationOverrideInput Additional configuration details for generating an invoice. These details specify whether the generation of payment schedules and payment schedule items must be skipped. _Available in: v63.0_ Includes all fields of `InvoiceAPIConfigurationOverrideInput`. * `correlationId` (_string_) Property that’s tagged against the published `InvoiceProcessedEvent` event, if specified. _Available in: v62.0_ * `invoiceDate` (_string_, required) Stamping date of the invoice in ISO 8601 format. _Available in: v62.0_ * `targetDate` (_string_, required) Date in ISO 8601 format used to decide the billing periods that are included to create invoices. _Available in: v62.0_ ### RevenueAsync Connect API representation of an async service result * `errors` (_array of ErrorResponseBilling_) Details of errors, if any. _Available in: v62.0_ _Filter group: Big_ * `requestIdentifier` (_string_) Unique identifier of the request. _Available in: v62.0_ _Filter group: Big_ * `statusURL` (_string_) a StatusURL for tracking this operation * `success` (_boolean_) Indicates whether the API request is successful (`true`) or not (`false`). _Available in: v62.0_ _Filter group: Big_ ### CheckoutStartAddressInputRequest Checkout start address input. * `city` (_string_) The address city. _Available in: v61.0, v0.0_ * `companyName` (_string_, required) The address company name. _Available in: v61.0_ * `country` (_string_, required) ISO code of the address country. Must match one of the valid ISO codes defined within the org’s State-Country picklist. _Available in: v61.0_ * `firstName` (_string_) First name of the contact. _Available in: v61.0_ * `id` (_string_) ID for the checkout _Available in: v61.0_ * `lastName` (_string_) Last name of the contact. _Available in: v61.0_ * `name` (_string_, required) Name of the contact. _Available in: v61.0_ * `postalCode` (_string_) Zip code or postal code for the address. _Available in: v61.0_ * `region` (_string_) ISO code of the address region. Must match one of the valid ISO codes defined within the org’s State-Country picklist. _Available in: v61.0_ * `shouldUseDefaultAddress` (_boolean_) Indicates whether the contact’s default address shoud be used for checkout ( `true` ) or not ( `false` ). _Available in: v61.0_ * `street` (_string_, required) Address street. _Available in: v61.0_ ### CartSummaryInformation Cart Summary Node Representation * `accountId` (_string_) The ID of account for the Cart. * `asyncOperationStatus` (_ConnectCartAsyncOperationStatusEnum_) * `cartId` (_string_) Unique ID of the Cart * `currencyIsoCode` (_string_) Three-letter ISO currency code associated with the cart. * `firstPymtGrandTotalAmount` (_string_) The first payment amount with taxes of the current cart. * `firstPymtTotalAmount` (_string_) The total amount on the first payment of the current cart. * `firstPymtTotalListPrice` (_string_) The total list price on the first payment of the current cart. * `firstPymtTotalTaxAmount` (_string_) The first payment total tax amount of the current cart. * `grandTotalAmount` (_string_) Grand total amount including shipping and tax for items in the cart, in the currency of the cart. * `isSecondary` (_boolean_) True if the cart should be secondary. * `messagesSummary` (_CartMessagesSummary_) * `name` (_string_) The friendly name for the cart. * `orderOwnerId` (_string_) The Order Owner ID of the Cart. * `ownerId` (_string_) The ID of the owner of the Cart. * `purchaseOrderNumber` (_string_) The associated purchase order for this cart. * `quoteLineItemCount` (_integer_, nullable) Tracks the count of items added to the webcart from quotes. * `status` (_ConnectCartStatusEnum_) * `taxType` (_ConnectCartTaxTypeEnum_) * `totalAmountWithItemAdjustment` (_string_) The total amount with item level adjustment on cart. * `totalBalanceAmountAfterCartCredits` (_string_) The total cart balance after applying the cart credits. * `totalCartLevelAdjustmentAmount` (_string_) The total cart level discount amount on cart. * `totalChargeAmount` (_string_) Total amount for shipping and other charges in the currency of the cart. * `totalChargeAmountWithItemAdjustment` (_string_) The total amount with shipping item level adjustment on cart. * `totalListPrice` (_string_) The total list price of the Cart in the currency of the Cart. * `totalProductAmount` (_string_) Total amount including discounts, but excluding shipping and tax, for product items in the cart. * `totalProductAmountAfterAdjustments` (_string_) TotalProductAmount when Promotion is OFF and Sum of TotalProductAmount and TotalPromotionalAdjustmentAmount with Promotions ON * `totalProductCount` (_string_) The total count of all the items in the Cart. * `totalProductLineItemCount` (_integer_) The total count of cart items of type product in the current cart. * `totalProductListAmount` (_string_) The total list amount for products in the Cart. * `totalPromotionalAdjustmentAmount` (_string_) Sum of all Itemized adjustments amounts and distributed adjustments amounts in the Cart. * `totalSubProductCount` (_string_) The total quantity of subscription product (Evergreen or Term-Defined) of the current cart. * `totalTaxAmount` (_string_) Total tax amount for the cart, including tax on shipping, if applicable. * `type` (_ConnectCartTypeEnum_) * `uniqueProductCount` (_integer_) The total count of unique items(SKUs) in the Cart * `webstoreId` (_string_) The ID of webstore of the Cart. ### ContactInfoV2 Guest Contact Info Representation * `email` (_string_) Email * `firstName` (_string_) First Name * `lastName` (_string_) Last Name * `phoneNumber` (_string_) Phone Number * `secondName` (_string_) Second Name ### DeliveryGroupCollectionV2 Delivery Group Collection V2 Representation * `count` (_integer_) Number of delivery group items returned on the current page. * `currentPageToken` (_string_) Current page token. This property should always be provided. * `currentPageUrl` (_string (url)_) An absolute URL which points to current page in the items (array of DeliveryGroupRepresentations). This property should always be provided. * `id` (_string (Id)_) Delivery group Id * `items` (_array of DeliveryGroupV2_) List of delivery groups. * `nextPageToken` (_string_) Next page token. Returned only if next page exists. * `nextPageUrl` (_string (url)_) Absolute URL pointing to the next page in delivery groups list. Will be returned only if next page exists. * `previousPageToken` (_string_) Previous page token. This property should always be provided. * `previousPageUrl` (_string (url)_) Absolute url to the previous page of delivery group items. Maybe returned if previous page exists. * `sortOrder` (_string_) Sorting type for list of delivery groups. Supported sorting orders CreatedDateDesc, CreatedDateAsc. This property should always be provided. * `total` (_integer_) Total amount of delivery groups. ### CheckoutError Checkout Error Representation * `detail` (_string_) Detailed information about the error. _Available in: v55.0_ _Filter group: Small_ * `instance` (_string_) A URI reference that identifies the specific occurrence of the problem. _Available in: v55.0_ _Filter group: Small_ * `invalidParameters` (_array of InvalidParameter_) List of invalid parameters, if any. _Available in: v55.0_ _Filter group: Big_ * `title` (_string_) Brief summary of the error. _Available in: v55.0_ _Filter group: Small_ * `type` (_string_) Type of error. _Available in: v55.0_ _Filter group: Small_ ### CheckoutContactInfoV2Input Checkout Contact Info Representation * `email` (_string_) Email * `firstName` (_string_) First Name * `isoCountryCodeForPhoneNumber` (_string_) Phone number ISO country code * `lastName` (_string_) Last Name * `phoneNumber` (_string_) Phone number * `secondName` (_string_) Second Name ### CheckoutAddressInputV2CommerceCheckout Address input representation * `city` (_string_) City * `companyName` (_string_) CompanyName * `country` (_string_) Country * `firstName` (_string_) FirstName * `id` (_string_) Id * `lastName` (_string_) LastName * `name` (_string_) Name * `postalCode` (_string_) Postal Code * `region` (_string_) Region * `shipToPhoneNumber` (_string_) Shipping Phone Number * `street` (_string_) Street ### CheckoutOrderActionInput Input representation of the Checkout Order action request, including the action and its parameters for a single order. * `action` (_string_, required) Name of the action to be performed on the place order request. Valid values are: * `prepare` —Validates the request, temporarily reserves inventory, and applies coupons on the items in the cart. * `submit` —Validates the request, enqueues order creation, and returns the order reference number. _Available in: v64.0_ Allowed values: `prepare`, `submit`. * `parameters` (_object_) CheckoutOrderActionParametersInput Parameter for the `submit` action in a place order request. _Available in: v64.0_ Includes all fields of `CheckoutOrderActionParametersInput`. ### CheckoutOrderAction Checkout Order Action Representation * `action` (_string_) Name of the action. _Available in: v64.0_ _Filter group: Small_ * `orderReferenceNumber` (_string_) Unique reference number generated after successfully placing an order. _Available in: v64.0_ _Filter group: Small_ ### CheckoutAddressInput Checkout address input. * `city` (_string_) The address city. _Available in: v55.0_ * `country` (_string_, required) ISO code of the address country. Must match one of the valid ISO codes defined within the org’s State-Country picklist. _Available in: v55.0_ * `countryCode` (_string_) Country Code * `name` (_string_, required) Name of the contact. _Available in: v55.0_ * `postalCode` (_string_) Zip code or postal code for the address. _Available in: v55.0_ * `region` (_string_) ISO code of the address region. Must match one of the valid ISO codes defined within the org’s State-Country picklist. _Available in: v55.0_ * `regionCode` (_string_) Region Code * `street` (_string_, required) The address street. _Available in: v55.0_ * `firstName` (_string_) First name of the contact. _Available in: v57.0_ * `isDefault` (_boolean_) Indicates whether a contact’s address is the default address (`true`) or not (`false`). The default value is `false`. _Available in: v55.0_ * `lastName` (_string_) Last name of the contact. _Available in: v57.0_ * `shipToPhoneNumber` (_string_) 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. If you specify a value, it must be a valid phone number with a country code. _Available in: v63.0_ ### PaymentRequestType Type of payment request. Valid values are: * `Auth` —Payment authorization request. * `PostAuth` — Record a payment transaction that happened outside of the Salesforce platform * `SimplePurchaseOrder` — Use a purchase order as a form of payment _Available in: v55.0_ Type: `string`. Allowed values: `Auth`, `ClientRequest`, `PostAuth`, `SimplePurchaseOrder`. ### CardPaymentMethodTokenizationInputRequest Credit card payment method input for tokenization. * `cardHolderName` (_string_, required) Name of the card holder that appears on the card. _Available in: v55.0_ * `cardNumber` (_string_, required) Card number. _Available in: v55.0_ * `cardType` (_string_, required) Card network type. Valid values are: * `AmericanExpress` * `MasterCard` * `Visa` _Available in: v55.0_ * `cvv` (_integer_, required) CVV (security code). _Available in: v55.0_ * `expiryMonth` (_integer_, required) Card expiration month. _Available in: v55.0_ * `expiryYear` (_integer_, required) Card expiration year. _Available in: v55.0_ ### CartItemResultCommerceWishlist A representation to represent result of a Get Cart Item api request. It contains the cart item information, status code for the request, and message if the request is not successful * `cartItem` (_object_) AbstractCartItem Cart item. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `AbstractCartItem`. * `message` (_string_) Message when the request isn’t successful. _Available in: v49.0_ _Filter group: Small_ * `status` (_string_) Status for the request. _Available in: v49.0_ _Filter group: Small_ ### ErrorResponseBilling Error response representation * `errorCode` (_string_) Error Code * `errorEntityId` (_string_) Error Entity Id * `message` (_string_) Message stating the reason for error, if any ### CartProductSummary The product summary for a cart item. * `dynamicAttributes` (_object_) Represents the dynamic attributes associated with this product. Additional properties: `CommerceProductDynamicAttribute`. * `fields` (_object_) Map of Product fields and values requested via input query parameter. Additional properties: `string`. * `isConfigurationAllowed` (_boolean_) Signifies whether product is configurable or not * `name` (_string_) The name of the Product. * `productClass` (_ConnectProductClassEnumCommerceBuyerexperience_) * `productId` (_string (Id)_) The ID of the Product. * `productSubscriptionInformation` (_ProductSellingModelCommerceBuyerexperience_) * `productUrlName` (_string_) Friendly URL name for the product, used for SEO purposes. * `purchaseQuantityRule` (_PurchaseQuantityRuleCommerceEinstein_) * `sku` (_string_) The sku of the Product. * `thumbnailImage` (_ProductMediaCommerceBuyerexperience_) * `variationAttributes` (_object_) Variation attributes associated to this product Additional properties: `CartProductAttributeCommerceWishlist`. ### CommerceAddressFieldInput Commerce address field input. This is used to reference custom fields for the address. * `dataName` (_string_, required) The name of the custom address field. _Available in: v54.0_ * `text` (_string_) The value of the custom address field. _Available in: v54.0_ ### RecordField Record field containing a reference to another object. * `label` (_string_) Localized string describing the record field. _Available in: v29.0_ _Filter group: Small_ * `text` (_string_) Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case. _Available in: v29.0_ _Filter group: Small_ * `type` (_string_) _Available in: v29.0_ _Filter group: Small_ * `reference` (_object_) Reference Object referenced by the record field. _Available in: v29.0_ _Filter group: Medium_ Includes all fields of `Reference`. ### BuyerProfileVerificationInput Input details for the buyer profile verification request. * `reCaptchaToken` (_string_, required) An encrypted response generated by Google reCAPTCHA. This token is used as a unique identifier to verify the user's identity. _Available in: v64.0_ * `stepUpVerificationIdentifier` (_string_, required) An unique identifier for updating the buyer's email and phone number. This identifier is generated by the `Commerce Webstore My Profile Initiate OTP` API. _Available in: v64.0_ ### BuyerProfileVerificationResponse Response details for the buyer profile verification request. * `identifier` (_string_) An identifier for the OTP generated through the `Commerce Webstore My Profile Initiate OTP` API. The `Commerce Webstore My Profile Verify OTP` API uses this identifier to verify the OTP. _Available in: v64.0_ _Filter group: Small_ * `message` (_string_) The response message for a successful or failed update request. _Available in: v64.0_ _Filter group: Small_ * `method` (_object_) BuyerProfileInitMethodEnum The mode used for sending one-time password (OTP). Possible _Available in: v64.0_ _Filter group: Small_ Includes all fields of `BuyerProfileInitMethodEnum`. * `recipient` (_string_) The recipient of the one-time password (OTP) can be either the buyer's email or phone number, which can be masked. _Available in: v64.0_ _Filter group: Small_ * `status` (_string_) Indicates whether the request succeeded or failed. _Available in: v64.0_ _Filter group: Small_ ### BuyerProfileInitMethodEnum The mode used for sending one-time password (OTP). Possible _Available in: v64.0_ _Filter group: Small_ Type: `string`. Allowed values: `Email`, `Sms`. ### BuyerProfileInitTypeEnum The type for which one-time-password (OTP) is required to be sent. Possible _Available in: v64.0_ Type: `string`. Allowed values: `StepUp`, `Verify`. ### OrderSummaryVerificationInput Order summary verification input. * `email` (_string_) Guest shopper or registered buyer’s email address. This is required for guest shoppers. _Available in: v58.0_ * `lastName` (_string_) Guest shopper or registered buyer’s last name. _Available in: v58.0_ * `phoneNumber` (_string_) Guest shopper or registered buyer’s phone number. This is required for guest shoppers. _Available in: v58.0_ ### OrderToCartFailedProduct Product that couldn’t be added to the cart from an order, with error information. * `errorCode` (_string_) Error code. _Available in: v57.0_ _Filter group: Small_ * `errorMessage` (_string_) Error message about the cause of the failure. _Available in: v57.0_ _Filter group: Small_ * `media` (_object_) ProductMedia Media associated with the product. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `productId` (_string_) ID of the product. _Available in: v57.0_ _Filter group: Small_ * `productName` (_string_) Name of the product. _Available in: v57.0_ _Filter group: Small_ * `productSKU` (_string_) SKU of the product. _Available in: v57.0_ _Filter group: Small_ ### OrderSummaryAdjustmentAggregates Output representation of the a djustment aggregates associated with an order summary. * `available` (_boolean_) Indicates if adjustment aggregate values are available (`true`) or not (`false`). _Available in: v55.0_ _Filter group: Small_ * `status` (_object_) OrderSummaryAdjustmentAggregatesStatusEnum Order summary adjustment aggregate job status. Values are: * `Failed` —The adjustment aggregate data job for the order summary failed. * `InProgress` —The adjustment aggregate data job for the order summary is in progress. * `NotInitiated` —The adjustment aggregate data job for the order summary is not initiated. * `Submitted` —The adjustment aggregate data job for the order summary is submitted. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `OrderSummaryAdjustmentAggregatesStatusEnum`. * `totalDeliveryPromotionDistAmount` (_string_) Total distributed delivery promotion amounts associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalDeliveryPromotionLineAmount` (_string_) Total delivery promotion line amounts associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalDeliveryPromotionTotalAmount` (_string_) Total delivery promotion amount associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalProductPromotionDistAmount` (_string_) Total distributed product promotion amounts associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalProductPromotionLineAmount` (_string_) Total product promotion line amount associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalProductPromotionTotalAmount` (_string_) Total product promotion amount associated with an order summary. _Available in: v55.0_ _Filter group: Small_ ### OrderSummaryAdjustment Adjustment associated with an order summary. * `amount` (_string_) Amount associated with the adjustment. _Available in: v53.0_ _Filter group: Small_ * `basisReferenceDisplayName` (_string_) Display name for secondary cause of the adjustment (for example, Null or the CouponCode that’s associated with a Coupon) _Available in: v53.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the adjustment. _Available in: v53.0_ _Filter group: Small_ * `displayName` (_string_) Display name for the primary cause of the adjustment (for example, Display name of the Promotion) _Available in: v53.0_ _Filter group: Small_ * `targetType` (_object_) ConnectOrderSummaryAdjustmentTargetTypeEnum Type of price adjustment in promotions. Values are: * `SplitLine` —Price adjustment on an order item. * `Header` —Price adjustment on the entire order. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectOrderSummaryAdjustmentTargetTypeEnum`. * `type` (_string_) Type of adjustment (for example, Promotion, Other). _Available in: v53.0_ _Filter group: Small_ ### OrderDeliveryGroupSummaryLookupOutput Order delivery group summary lookup output. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the order delivery group summary record. _Filter group: Small_ * `deliveryMethod` (_object_) OrderDeliveryMethodLookupOutput Delivery method associated with order the delivery group summary. _Filter group: Small_ Includes all fields of `OrderDeliveryMethodLookupOutput`. * `fields` (_object_) Map of requested order delivery group summary fields. _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) ID of the order delivery group summary. _Filter group: Small_ * `lineItems` (_array of OrderItemSummaryLookupOutput_) Line items associated with the order delivery group summary. _Filter group: Small_ ### OrderPaymentSummary Details for the order payment summary. * `fields` (_object_) Collection of order payment summary fields. _Available in: v63.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `paymentMethod` (_object_) OrderPaymentMethod List of order payment methods. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `OrderPaymentMethod`. ### OrderSummaryProductLookupOutput Order summary product lookup output. * `canViewProduct` (_boolean_) Specifies whether the context user can view the product (`true`) or not (`false`). _Available in: v58.0_ _Filter group: Small_ * `dynamicAttributes` (_object_) Represents the dynamic attributes associated with this product Additional properties: `CommerceProductDynamicAttribute`. * `errorCode` (_string_) Error code captured during product load. _Available in: v58.0_ _Filter group: Small_ * `errorMessage` (_string_) Error message captured during product load. _Available in: v58.0_ _Filter group: Small_ * `fields` (_object_) Map of requested product fields. _Available in: v58.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) Id of the product _Available in: v58.0_ _Filter group: Small_ * `media` (_object_) ProductMedia Associated product media. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `variationAttributes` (_object_) Variation attributes (color, size, and so on) associated with the product. _Available in: v58.0_ _Filter group: Small_ Additional properties: `OrderSummaryProductAttribute`. ### OrderDeliveryGroupSummary Order delivery group summary. * `fields` (_object_) Map of fields from order delivery group summary and other related objects that were queried. _Available in: v51.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. ### OrderItemSummary Details of an OrderItemSummary from a failed FulfillmentOrder in a create multiple fulfillment orders request. * `adjustmentAggregates` (_object_) OrderItemSummaryAdjustmentAggregates Adjustment aggregates associated with an order item summary. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `OrderItemSummaryAdjustmentAggregates`. * `currencyIsoCode` (_string_) CurrencyIsoCode of the order item summary. * `fields` (_object_) Map of fields from order item summary and other related objects that were queried. _Available in: v51.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `orderItemSummaryId` (_string (Id)_) ID of the OrderItemSummary. _Available in: v50.0_ _Filter group: Big_ * `orderSummaryId` (_string (Id)_) ID of the order summary. _Available in: v51.0_ _Filter group: Small_ * `product` (_object_) OrderItemSummaryProduct Associated product item information. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `OrderItemSummaryProduct`. * `errors` (_array of ErrorResponseOutput_) List of errors specific to the OrderItemSummary, if any. _Available in: v50.0_ _Filter group: Big_ * `quantity` (_number (double)_) Quantity of the OrderItemSummary. _Available in: v50.0_ _Filter group: Big_ ### OrderItemSummaryAdjustmentInput Order item summary. * `orderItemSummaryId` (_string_, required) ID of the order item summary. _Available in: v53.0_ ### OrderItemSummaryAdjustmentList List of adjustments for an order item summary. * `adjustments` (_array of OrderSummaryAdjustment_) Adjustments associated with an order item summary. _Available in: v53.0_ _Filter group: Small_ ### OrderShipment Order shipment. * `expectedDeliveryDate` (_string (date-time)_) Expected delivery date for the shipment. _Available in: v52.0_ _Filter group: Small_ * `fields` (_object_) Map of requested fields. _Available in: v52.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `orderSummaryId` (_string (Id)_) ID of the order summary. _Available in: v52.0_ _Filter group: Small_ * `shipmentId` (_string (Id)_) ID of the shipment. _Available in: v52.0_ _Filter group: Small_ * `shipmentNumber` (_string_) Number of the shipment. _Available in: v52.0_ _Filter group: Small_ * `status` (_string_) Status of the shipment. _Available in: v52.0_ _Filter group: Small_ ### OrderShipmentItem Order shipment item. * `fields` (_object_) Map of requested fields. _Available in: v52.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `orderItemSummaryId` (_string (Id)_) ID of the order item summary. _Available in: v52.0_ _Filter group: Small_ * `product` (_object_) OrderItemSummaryProduct Product mapped to an order item summary. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `OrderItemSummaryProduct`. * `productId` (_string (Id)_) ID of the product. _Available in: v52.0_ _Filter group: Small_ * `quantity` (_number (double)_) Quantity of the product. _Available in: v52.0_ _Filter group: Small_ * `shipmentId` (_string (Id)_) ID of the shipment. _Available in: v52.0_ _Filter group: Small_ * `shipmentItemId` (_string (Id)_) ID of the shipment item. _Available in: v52.0_ _Filter group: Small_ ### FacetableAttributeOutput Facetable attribute. * `displayRank` (_integer_) Display rank of the facet. Valid values are from 1 through 50. Values must be unique and sequential. _Available in: v49.0_ _Filter group: Small_ * `displayType` (_object_) ConnectFacetDisplayTypeEnum Display type of the facet. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectFacetDisplayTypeEnum`. * `facetValueSortType` (_ConnectFacetValueSortTypeEnum_) * `label` (_string_) Localized label of the attribute. _Available in: v49.0_ _Filter group: Small_ * `nameOrId` (_string_) Developer name of the attribute. _Available in: v49.0_ _Filter group: Small_ * `type` (_object_) ConnectSearchAttributeTypeEnum Type of attribute. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectSearchAttributeTypeEnum`. ### FacetableAttributeInput Facetable attribute for search. * `displayRank` (_integer_, required) Display rank of the facet. Valid values are from 1 through 50. Values must be unique and sequential. _Available in: v49.0_ * `displayType` (_object_, required) ConnectFacetDisplayTypeEnum Display type of the facet. _Available in: v49.0_ Includes all fields of `ConnectFacetDisplayTypeEnum`. * `facetValueSortType` (_ConnectFacetValueSortTypeEnum_) * `nameOrId` (_string_, required) Developer name of the attribute. In version 49.0 and later, the ID of the attribute isn’t supported. _Available in: v49.0_ * `type` (_object_, required) ConnectSearchAttributeTypeEnum Type of attribute. When updating facetable attributes, you must include a `ProductCategory` facet with `nameOrId` set to `Id` and `displayType` set to `categoryTree` , as shown in the JSON example. _Available in: v49.0_ Includes all fields of `ConnectSearchAttributeTypeEnum`. ### SearchableAttributeOutput Searchable attribute. * `label` (_string_) Localized label of the attribute. _Available in: v49.0_ _Filter group: Small_ * `nameOrId` (_string_) Developer name of the attribute. _Available in: v49.0_ _Filter group: Small_ * `type` (_object_) ConnectSearchAttributeTypeEnum Type of attribute. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `weight` (_integer_) Specifies the relative contribution of each searchable field to the relevance ranking of search results. Valid values: 1 (lowest)–10 (highest). Default to 1 if not specified or if set to null. _Available in: v67.0_ _Filter group: Small_ ### SearchableAttributeInput Searchable attribute. * `isSearchable` (_boolean_) Specifies whether the attribute is searchable (`true`) or not (`false`). Default value is `true`. _Available in: v49.0_ * `nameOrId` (_string_, required) Developer name of the attribute. In version 49.0 and later, the ID of the attribute isn’t supported. _Available in: v49.0_ * `type` (_object_, required) ConnectSearchAttributeTypeEnum Type of attribute. _Available in: v49.0_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `weight` (_integer_) Specifies the relative contribution of each searchable field to the relevance ranking of search results. Valid values: 1 (lowest)–10 (highest). Default to 1 if not specified or if set to null. Usage: * The `weight` property controls how much each searchable field contributes to search result relevance ranking. * Fields with a higher weight cause matches on those fields to rank higher in search results. For example, setting the `Name` field to weight 8 and `Description` to weight 3 means products matching by name rank above products matching only by description. * A re-index is required after changing weights for the new rankings to take effect in search results. _Available in: v67.0_ ### ConnectSearchBoostBuryRuleActionEnum Action of the boost and bury rule. Values are: * `Boost` —Boost rule. Increases search result rankings for targeted products. * `Bury` —Bury rule. Decreases search result rankings for targeted products. _Available in: v59.0_ _Filter group: Small_ Type: `string`. Allowed values: `Boost`, `Bury`. ### BoostBuryQueryContextInput Search Boost bury query context * `conditions` (_array of BoostBuryQueryContextConditionInput_) List of conditions for the query context ### BoostBuryTargetExpressionInput Target expression for a boost and bury rule. * `conditions` (_array of BoostBuryConditionInput_, required) List of conditions for the boost and bury rule target expression. _Available in: v59.0_ ### BoostBuryQueryContextOutput Search boost bury query context * `conditions` (_array of BoostBuryQueryContextConditionOutput_) List of conditions for the query context ### BoostBuryTargetExpressionOutput Target expression for a boost and bury rule. * `conditions` (_array of BoostBuryConditionOutput_) List of conditions for the boost and bury rule target expression. _Available in: v59.0_ _Filter group: Small_ ### CommerceSearchIndexLog Search index log information. * `catalogSnapshotTime` (_string (date-time)_) Catalog snapshot time of the index build. _Available in: v57.0_ _Filter group: Small_ * `completionDate` (_string (date-time)_) Completion date of the index build. _Available in: v57.0_ _Filter group: Small_ * `createdById` (_string (Id)_) ID of the user who initiated the index build. _Available in: v57.0_ _Filter group: Small_ * `indexBuildStatus` (_object_) ConnectCommerceSearchIndexStatusEnum Status of the index. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchIndexStatusEnum`. * `indexBuildType` (_object_) ConnectCommerceSearchIndexBuildTypeEnum Build type of the index. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchIndexBuildTypeEnum`. * `indexCreationType` (_ConnectCommerceSearchIndexCreationTypeEnum_) * `indexId` (_string (Id)_) ID of the index build. _Available in: v57.0_ _Filter group: Small_ * `message` (_string_) Detailed message for the index build status. _Available in: v57.0_ _Filter group: Small_ * `numberOfProducts` (_integer_) Number of new or changed products in the index build. _Available in: v57.0_ _Filter group: Small_ ### ConnectCommerceSearchIndexCreationTypeEnum Creation type of the index. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `Manual`, `Scheduled`. ### ConnectCommerceSearchIndexStatusEnum Status of the index. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `Completed`, `CompletedWithErrors`, `Failed`, `InProgress`. ### ConnectCommerceSearchIndexUsageEnum Usage of the index. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `Live`, `OutOfUse`. ### SearchProductSettingOutput Product search setting. * `id` (_string (Id)_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `searchable` (_boolean_) Specifies whether the product is searchable (`true`) or not (`false`). Products of class `VariationParent` are `null`. _Available in: v49.0_ _Filter group: Small_ ### SearchProductSettingInput Product search setting. * `id` (_string_, required) ID of the product. Products of class `VariationParent` can’t be updated. _Available in: v49.0_ * `searchable` (_boolean_) Specifies whether the product is searchable (`true`) or not (`false`). _Available in: v49.0_ ### ConnectCommerceSearchResultRuleTypeEnum Type of search rule. Value is: * `BidirectionalSynonym` —Use when terms are interchangeable and should return the same results both ways. For example, jacket ⇄ winter coat. Available from API version 66.0 and later. * `Include` —When a term in a query matches any term in a `ruleDefinition`, Commerce Search returns results for all terms in the list. Supported in API versions 58.0 to 66.0. We suggest using `BidirectionalSynonym`, which returns equivalent results for interchangeable terms in both directions, unlike `Include`. * `UnidirectionalSynonym` —Use when one term should expand results, but not necessarily the reverse. For example, jacket → hoodie. Available from API version 66.0 and later. _Available in: v58.0_ _Filter group: Small_ Type: `string`. Allowed values: `BidirectionalSynonym`, `Include`, `UnidirectionalSynonym`. ### SortRule Sort rule. * `direction` (_object_) ConnectCommerceSearchSortRuleDirectionEnum Direction of the sort rule. Values are: * `Ascending` —Sorts in ascending alphanumeric order (A–Z, 0–9). * `Default` —When no direction is defined, sorts by relevance. * `Descending` —Sorts in descending alphanumeric order (Z–A, 9–0). _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchSortRuleDirectionEnum`. * `label` (_string_) Label of the sort rule. _Available in: v52.0_ _Filter group: Small_ * `labelSuffix` (_object_) ConnectCommerceSearchSortRuleLabelSuffixEnum Label suffix of the sort rule. Values are: * `Ascen` —Label suffix for 'Asc' * `Ascending` —Label suffix for 'Ascending' * `Az` —Label suffix for 'A-Z' * `Descen` —Label suffix for 'Desc' * `Descending` —Label suffix for 'Descending' * `FewMany` —Label suffix for 'Few-Many' * `HeavyLight` —Label suffix for 'Heavy-Light' * `HighLow` —Label suffix for 'High-Low' * `HighestLowest` —Label suffix for 'Highest-Lowest' * `LightHeavy` —Label suffix for 'Light-Heavy' * `LowHigh` —Label suffix for 'Low-High' * `LowestHighest` —Label suffix for 'Lowest-Highest' * `ManyFew` —Label suffix for 'Many-Few' * `NewOld` —Label suffix for 'New-Old' * `Newest` —Label suffix for 'Newest' * `NewestOldest` —Label suffix for 'Newest-Oldest' * `NineZero` —Label suffix for '9-0' * `OldNew` —Label suffix for 'Old-New' * `Oldest` —Label suffix for 'Oldest' * `OldestNewest` —Label suffix for 'Oldest-Newest' * `PriceDecreasing` —Label suffix for '$$-$' * `PriceIncreasing` —Label suffix for '$-$$' * `ThickThin` —Label suffix for 'Thick-Thin' * `ThinThick` —Label suffix for 'Thin-Thick' * `Za` —Label suffix for 'Z-A' * `ZeroNine` —Label suffix for '0-9' _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchSortRuleLabelSuffixEnum`. * `nameOrId` (_string_) Name of the sort rule field or, if the sort rule is based on a custom field, ID. _Available in: v52.0_ _Filter group: Small_ * `sortOrder` (_integer_) Sort order for the rule. A lower number has higher precedence. The first sort option is called when no other option is selected. _Available in: v54.0_ _Filter group: Small_ * `sortRuleId` (_string (Id)_) ID of the sort rule. _Available in: v52.0_ _Filter group: Small_ * `type` (_object_) ConnectCommerceSearchSortRuleTypeEnum Type of sort rule. Values are: * `ProductAttributeBased` —Sorts by product attribute fields. * `ProductBased` —Sorts by product field data. * `Relevancy` —Sorts by product and catalog term frequency. * `SortByPricebook` —Sorts by product prices defined in the specified pricebook (version 55.0 and later). _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceSearchSortRuleTypeEnum`. ### SortRuleInput Sort rule input. * `customFieldId` (_string_, required) A custom field to use for sorting. You must specify a custom field ID or a standard sort field, but not both. _Available in: v54.0_ * `direction` (_object_) ConnectCommerceSearchSortRuleDirectionEnum Direction of the sort rule. Values are: * `Ascending` —Sorts in ascending alphanumeric order (A–Z, 0–9). * `Default` —When no direction is defined, sorts by relevance. * `Descending` —Sorts in descending alphanumeric order (Z–A, 9–0). _Available in: v54.0_ Includes all fields of `ConnectCommerceSearchSortRuleDirectionEnum`. * `labelSuffix` (_object_) ConnectCommerceSearchSortRuleLabelSuffixEnum Label suffix of the sort rule. Valid values: * `Ascen` —Label suffix for 'Asc' * `Ascending` —Label suffix for 'Ascending' * `Az` —Label suffix for 'A-Z' * `Descen` —Label suffix for 'Desc' * `Descending` —Label suffix for 'Descending' * `FewMany` —Label suffix for 'Few-Many' * `HeavyLight` —Label suffix for 'Heavy-Light' * `HighLow` —Label suffix for 'High-Low' * `HighestLowest` —Label suffix for 'Highest-Lowest' * `LightHeavy` —Label suffix for 'Light-Heavy' * `LowHigh` —Label suffix for 'Low-High' * `LowestHighest` —Label suffix for 'Lowest-Highest' * `ManyFew` —Label suffix for 'Many-Few' * `NewOld` —Label suffix for 'New-Old' * `Newest` —Label suffix for 'Newest' * `NewestOldest` —Label suffix for 'Newest-Oldest' * `NineZero` —Label suffix for '9-0' * `OldNew` —Label suffix for 'Old-New' * `Oldest` —Label suffix for 'Oldest' * `OldestNewest` —Label suffix for 'Oldest-Newest' * `PriceDecreasing` —Label suffix for '$$-$' * `PriceIncreasing` —Label suffix for '$-$$' * `ThickThin` —Label suffix for 'Thick-Thin' * `ThinThick` —Label suffix for 'Thin-Thick' * `Za` —Label suffix for 'Z-A' * `ZeroNine` —Label suffix for '0-9' _Available in: v54.0_ Includes all fields of `ConnectCommerceSearchSortRuleLabelSuffixEnum`. * `sortOrder` (_integer_, required) Sort order for the rule. A lower number has higher precedence. The first sort option is called when no other option is selected. _Available in: v54.0_ * `sortStandardField` (_object_) ConnectCommerceSortStandardFieldEnum A standard field typically used for sorting (for example, Name, StockKeepingUnit, CreatedDate, Family, or ProductCode). Required for ProductAttributeBased or ProductBased sort types. _Available in: v54.0_ Includes all fields of `ConnectCommerceSortStandardFieldEnum`. * `type` (_object_, required) ConnectCommerceSearchSortRuleTypeEnum Type of sort rule. Values are: * `ProductAttributeBased` —Sorts by product attribute fields. * `ProductBased` —Sorts by product field data. * `Relevancy` —Sorts by product and catalog term frequency. * `SortByPricebook` —Sorts by product prices defined in the specified pricebook (version 55.0 and later). _Available in: v54.0_ Includes all fields of `ConnectCommerceSearchSortRuleTypeEnum`. ### ProductSearchGroupingInput Grouping information for product search results. * `groupingOption` (_object_, required) ConnectSearchGroupingOptionEnum Grouping option for search results. Values are: * `BestMatch` —Search results are grouped by the best-match product of the variation group. * `NoGrouping` —Search results aren’t grouped. * `VariationParent` —Search results are grouped by the variation parent. _Available in: v51.0_ Includes all fields of `ConnectSearchGroupingOptionEnum`. * `topProductType` (_string_) Type of the top product to return for each product group in search results. Value is: * `VariationParent` If `NoGrouping` is specified for `groupingOption`, `topProductType` is ignored. _Available in: v51.0_ —62.0 ### RefinementInput Abstract superclass of all attribute-based refinement input representations for product search. * `attributeType` (_object_) ConnectSearchAttributeTypeEnum Search attribute type. _Available in: v50.0_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `nameOrId` (_string_) Developer name of the attribute. In version 49.0 and later, the ID of the attribute isn’t supported. _Available in: v49.0_ * `type` (_object_) ConnectSearchFacetTypeEnum Search facet type. Value is: _Available in: v49.0_ Includes all fields of `ConnectSearchFacetTypeEnum`. ### SearchCategory Search category. * `category` (_object_) ProductCategory Information about the category. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductCategoryCommerceSearch`. * `children` (_array of SearchCategory_) First-level child categories of the category searched with non-empty search results. _This property is recursive: each item has the same structure as `SearchCategory`._ _Available in: v49.0_ _Filter group: Small_ * `productCount` (_integer (int64)_) Number of products in the search results that belong to the category. _Available in: v49.0_ _Filter group: Small_ ### SearchFacet Abstract superclass of all Search Facet representations. * `attributeType` (_object_) ConnectSearchAttributeTypeEnum Type of search attribute for the refinement. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `displayName` (_string_) Display name of the facet. _Available in: v49.0_ _Filter group: Small_ * `displayRank` (_integer_) Display rank of the facet. Valid values are from 1 through 50. _Available in: v49.0_ _Filter group: Small_ * `displayType` (_object_) ConnectFacetDisplayTypeEnum Display type of the facet. Value is: _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ConnectFacetDisplayTypeEnum`. * `facetType` (_object_) ConnectSearchFacetTypeEnum Type of the facet. Value is: _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ConnectSearchFacetTypeEnum`. * `nameOrId` (_string_) Developer name of the attribute for the refinement. _Available in: v64.0_ _Filter group: Small_ ### ProductSummaryCollectionCommerceSearch Collection of product summaries. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. _Available in: v49.0_ _Filter group: Small_ * `pageSize` (_integer_) Number of products per page in the search results. _Available in: v49.0_ _Filter group: Small_ * `products` (_array of ProductSummaryCommerceSearch_) Collection of product summaries. _Available in: v49.0_ _Filter group: Medium_ * `total` (_integer (int64)_) Total number of products in the search results. _Available in: v49.0_ _Filter group: Small_ ### DistinctValueSearchFacet Facet with distinct values in product search results. * `attributeType` (_object_) ConnectSearchAttributeTypeEnum Type of search attribute for the refinement. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `displayName` (_string_) Display name of the facet. _Available in: v49.0_ _Filter group: Small_ * `displayRank` (_integer_) Display rank of the facet. Valid values are from 1 through 50. _Available in: v49.0_ _Filter group: Small_ * `displayType` (_object_) ConnectFacetDisplayTypeEnum Display type of the facet. Value is: _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ConnectFacetDisplayTypeEnum`. * `facetType` (_object_) ConnectSearchFacetTypeEnum Type of the facet. Value is: _Available in: v64.0_ _Filter group: Small_ Includes all fields of `ConnectSearchFacetTypeEnum`. * `nameOrId` (_string_) Developer name of the attribute for the refinement. _Available in: v64.0_ _Filter group: Small_ * `values` (_array of DistinctFacetValue_) Values of the facet found in the search result. Sorted by display name in alphabetical order. _Available in: v49.0_ _Filter group: Medium_ ### CommerceProductSummaryCollection Collection of product summary representations in product search results. * `pageSize` (_integer_) Number of products per page in search result _Available in: v55.0_ _Filter group: Small_ * `products` (_array of CommerceProductSummary_) Collection of product summaries. _Available in: v55.0_ _Filter group: Medium_ * `total` (_integer (int64)_) Total number of products in the search result across all pages. _Available in: v55.0_ _Filter group: Small_ ### AbstractSearchSuggestion The abstract representation class for search suggestions * `value` (_string_) Search suggestion. _Available in: v52.0_ _Filter group: Small_ ### CouponCodeRedemptionResult Coupon code redemption result. * `availableRedemptions` (_integer_) Number of coupon code redemptions available. _Available in: v58.0_ _Filter group: Small_ * `availableRedemptionsThisBuyer` (_integer_) Represents the available coupon code redemptions value for the buyer. * `couponCode` (_string_) Coupon code. _Available in: v58.0_ _Filter group: Small_ * `errorMsg` (_string_) Error message when coupon code redemption isn’t successful. _Available in: v58.0_ _Filter group: Small_ * `isSuccess` (_boolean_) Specifies whether increasing or decreasing the coupon code redemption is successful ( `true` ) or not ( `false` ). _Available in: v58.0_ _Filter group: Small_ * `redemptionLimit` (_integer_) Number of coupon code redemptions allowed. _Available in: v58.0_ _Filter group: Small_ * `redemptionLimitPerBuyer` (_integer_) Represents the coupon code redemption limit value per buyer. ### CartInput A cart. * `cartAdjustmentGroups` (_array of CartAdjustmentGroupInput_) Cart Adjustment Groups * `cartDeliveryGroups` (_array of CartDeliveryGroupInput_) Cart Delivery Groups * `cartItems` (_array of CartItemInput_) Cart Items * `currencyIsoCode` (_string_) Currency ISO code of the cart. _Available in: v57.0_ * `id` (_string (Id)_) Id of Cart * `customFields` (_array of SobjectAttributesInputRequest_) 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](https://help.salesforce.com/s/articleView?id=commerce.comm_create_shopper_profile.htm&type=5) are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. _Available in: v61.0_ * `effectiveAccountId` (_string_) ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. _Available in: v49.0_ * `isSecondary` (_boolean_) Specifies whether the cart is secondary (`true`) or not (`false`). If unspecified, defaults to `false`. _Available in: v53.0_ * `name` (_string_) Name of the cart. The name can have up to 250 Unicode characters. If unspecified, defaults to the generated name. _Available in: v49.0_ * `orderOwnerId` (_string_) ID of the owner of the order. _Available in: v58.0_ * `type` (_string_) Type of cart. Values are: * `Cart` —Cart created by a customer. * `PayNowReadOnly` —Clone of a Template cart that the customer can check out with using the Pay Now feature. * `Template` —Cart created by an internal user. If unspecified, defaults to `Cart` . _Available in: v49.0_ Allowed values: `Cart`, `PayNowReadOnly`, `Template`. * `typeAsString` (_string_) Type of the cart provided as a string. _Available in: v59.0_ ### ParentProductInputRepresentationPair Parent Product Input Representation Pair * `childProductId` (_string_) Child Product Id * `parentProductId` (_string_) Parent Product Id ### ProductCategoryInputRepresentationPair Product Category Input Representation Pair * `categoryId` (_string_) Category Id * `productId` (_string_) Product Id ### ConnectPromotionScopeEnum Promotion evaluation scope. If no value is provided, default is Cart. If you want any shipping promotions to be evaluated, set to Delivery. _Available in: v60.0_ Type: `string`. Allowed values: `Cart`, `Delivery`. ### PromotionCartDeliveryGroupInputRequest IDs of the cart delivery group and its delivery method. * `cartDeliveryGroupId` (_string_, required) ID of the cart delivery group. _Available in: v57.0_ * `cartDeliveryGroupMethods` (_array of CartDeliveryGroupMethodInput_) Collection of cart delivery group methods. _Available in: v60.0_ * `deliveryMethodId` (_string_, required) ID of the delivery method. _Available in: v57.0_ ### CartOutput Cart and its contents. * `approachingDiscounts` (_array of ApproachingDiscountOutput_) Qualifier for a promotion with an approaching discount. _Available in: v64.0_ _Filter group: Small_ * `bonusProducts` (_array of BonusProductOutput_) Bonus Products * `cartAdjustmentGroups` (_array of CartAdjustmentGroup_) Cart adjustment groups associated with the cart. _Available in: v56.0_ _Filter group: Small_ * `cartDeliveryGroups` (_array of CartDeliveryGroupOutput_) CartDeliveryGroups * `cartItems` (_array of CartItemOutput_) Cart items associated with the cart. _Available in: v56.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the cart. Only returned for multi-currency orgs. _Available in: v56.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the cart. _Available in: v56.0_ _Filter group: Small_ * `totalAdjustmentBaseAmount` (_string_) Sum of all adjustments on the cart. _Available in: v56.0_ _Filter group: Small_ * `totalNetAmount` (_string_) Total price of the cart items after all adjustments (includes other item types). _Available in: v56.0_ _Filter group: Small_ * `totalProductBaseAmount` (_string_) Total price of all cart products after all adjustments (excludes other item types). _Available in: v56.0_ _Filter group: Small_ * `type` (_string_) Type of cart item. Valid values are: * `Product` * `DeliveryCharge` . _Available in: v56.0_ _Filter group: Small_ ### Coupon A coupon for a promotion. * `couponCode` (_string_) Coupon code for the coupon. _Available in: v54.0_ _Filter group: Small_ * `couponErrorCode` (_string_) Error code if the coupon is invalid. _Available in: v54.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the coupon. _Available in: v54.0_ _Filter group: Small_ * `isValidCoupon` (_boolean_) Indicates whether the coupon is valid ( `true` ) or invalid ( `false` ). _Available in: v54.0_ _Filter group: Small_ ### PromotionProductInput Products for promotion product evaluation. Supports domain dependent requests based on `productId` and domain independent requests based on `sku`. * `productId` (_string (Id)_) ID of the product. Required for domain dependent evaluation _Available in: v58.0_ * `salesPrice` (_string_, required) Sales price of the product. _Available in: v58.0_ * `sku` (_string_) Stock keeping unit (SKU) of the product. Required for domain independent evaluation _Available in: v58.0_ ### PromotionProductEvaluationResult Results of a promotion product evaluation. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the payment group record. _Available in: v58.0_ _Filter group: Small_ * `errorMessage` (_string_) Promotion product evaluation error message. _Available in: v58.0_ _Filter group: Small_ * `isSuccess` (_boolean_) Specifies whether the promotion product evaluation is a success ( `true` ) or not ( `false` ) _Available in: v58.0_ _Filter group: Small_ * `productId` (_string_) ID of the product. _Available in: v58.0_ _Filter group: Small_ * `promotionPriceAdjustmentList` (_array of PromotionPriceAdjustment_) Represents the list of Promotion Discounts _Available in: v58.0_ _Filter group: Small_ * `promotionalPrice` (_string_) Promotional price of the product _Available in: v58.0_ _Filter group: Small_ * `salesPrice` (_string_) Sales price of the product. _Available in: v58.0_ _Filter group: Small_ * `sku` (_string_) Stock keeping unit (SKU) of the product. _Available in: v58.0_ _Filter group: Small_ ### PromotionCoupon A coupon used in a promotion. * `couponCode` (_string_) Coupon code. _Available in: v56.0_ _Filter group: Small_ * `couponId` (_string_) Coupon id * `description` (_string_) Coupon description * `endDateTime` (_string_) Coupon end date time * `isActive` (_boolean_) Whether or not the coupon is active * `redemptionLimitAllBuyers` (_integer_) Redemption limit all buyers * `redemptionLimitPerBuyer` (_integer_) Redemption limit per buyer * `startDateTime` (_string_) Coupon start date time * `couponErrorCode` (_string_) Error code returned if the coupon is invalid. _Available in: v56.0_ _Filter group: Small_ * `id` (_string_) ID of the coupon. _Available in: v56.0_ _Filter group: Small_ * `isValidCoupon` (_boolean_) Indicates whether the coupon is valid (`true`) or invalid (`false`). _Available in: v56.0_ _Filter group: Small_ ### ConnectDiscountOrderTypeEnum Discount order for the promotion. Possible _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `LeastExpensive`, `MostExpensive`. ### ConnectDiscountRestrictionTypeEnum Discount restriction for the promotion. Possible _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `LeastExpensive`, `None`. ### PromotionTranslation Output representation of the promotion translation. * `translations` (_object_) Map of language code to the translated value. _Available in: v62.0_ _Filter group: Small_ Additional properties: `string`. * `value` (_string_) Value to be translated. _Available in: v62.0_ _Filter group: Small_ ### ConnectPromotionExclusivityTypeEnum Type of exclusivity to be considered when applying the promotion. Possible values are: * `Class` —Class exclusion. * `Global` —Global exclusion. * `No` —No exclusion. _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `Class`, `Global`, `No`. ### ConnectPromotionCriteriaTypeEnum Qualifier criteria for the promotion. Possible values are: * `All` —All the criteria are met. * `Any` —Any of the criteria can be met. _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `All`, `Any`. ### PromotionQualifier Output representation of the promotion qualifier. * `approachingDiscountThreshold` (_string_) The cart amount that a customer has to reach before seeing an approaching discount message. For example, if a promotion qualifier minimum is set at $150 and this field is set at $50, then a customer receives a banner notification that they’re approaching the discount when they have at least $50 in their cart. _Available in: v64.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the promotion qualifier. _Available in: v62.0_ _Filter group: Small_ * `qualifierReferenceType` (_ConnectQualifierReferenceTypeEnum_) * `qualifierReferences` (_array of ItemReference_) List of products and categories that qualifies for the promotion. _Available in: v62.0_ _Filter group: Small_ * `qualifierType` (_object_) ConnectCompositePromotionQualifierTypeEnum Type of the promotion qualifier. Possible values are: * `Amount` —Minimum spend amount. * `Quantity` —Minimum quantity. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectCompositePromotionQualifierTypeEnum`. * `qualifierValue` (_number (double)_) Value for the promotion qualifier. For example, if qualifier type is `Quality` , the value can be "3". _Available in: v62.0_ _Filter group: Small_ * `ruleCriteriaType` (_ConnectPromotionCriteriaTypeEnum_) ### PromotionSegment Output representation of the promotion segment. * `id` (_string_) ID of the promotion segment. _Available in: v62.0_ _Filter group: Small_ * `name` (_string_) Name of the promotion segment. _Available in: v62.0_ _Filter group: Small_ * `segmentType` (_object_) ConnectSegmentType Type of the promotion segment. Possible _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectSegmentType`. ### PromotionTarget Target of a promotion (for example, cart items). * `adjustmentType` (_object_) ConnectPromotionAdjustmentTypeEnum Adjustment type (percentage or absolute). _Available in: v53.0_ _Filter group: Small_ Includes all fields of `ConnectPromotionAdjustmentTypeEnum`. * `adjustmentValue` (_string_) Adjustment value * `currencyIsoCode` (_string_) Currency associated to the target * `isMinItemCountRequired` (_boolean_) Apply discount only when a cart reaches the quantity limit * `restrictionQuantity` (_string_) The maximum number of items that can receive the discount. * `ruleCriteriaType` (_ConnectPromotionCriteriaTypeEnum_) * `targetReferenceType` (_ConnectTargetReferenceTypeEnum_) * `targetReferences` (_array of ItemReference_) List of product or category * `adjustmentAmount` (_string_) Absolute adjustment amount. _Available in: v53.0_ _Filter group: Small_ * `adjustmentPercent` (_string_) Percentage adjustment amount. _Available in: v53.0_ _Filter group: Small_ * `id` (_string_) ID for the promotion target. _Available in: v53.0_ _Filter group: Small_ * `priority` (_integer_) Priority of the promotion target. _Available in: v53.0_ _Filter group: Small_ * `promotionTargetAssociationStatus` (_string_) Association status of the promotion target: * VALID (the promotion target is valid and can be applied to the transaction) * BLOCKEDEXCLUSIVE (the promotion target is valid, but is blocked from the transaction by another promotion) * INVALID (the promotion target is not valid for the transaction) _Available in: v53.0_ _Filter group: Small_ * `promotionTargetLineItems` (_array of PromotionTargetLineItem_) Line items which the promotion target maps to. _Available in: v53.0_ _Filter group: Small_ * `targetId` (_string_) ID of the target record. _Available in: v53.0_ _Filter group: Small_ * `targetType` (_string_) Promotion target type. _Available in: v53.0_ _Filter group: Small_ ### PromotionCouponInput Composite promotion coupon. * `active` (_boolean_) Indicates whether the promotion coupon is active ( `true` ) or not ( `false` ). If unspecified, defaults to `false` . _Available in: v63.0_ * `couponCode` (_string_, required) Coupon code. _Available in: v63.0_ * `couponId` (_string_) Reserved for future use. _Available in: v63.0_ * `description` (_string_) Localized display name of the promotion coupon. _Available in: v63.0_ * `endDateTime` (_string_) The date time the promotion coupon ends. _Available in: v63.0_ * `redemptionLimitAllBuyers` (_integer_) Promotion coupon redemption limit for all buyers. _Available in: v63.0_ * `redemptionLimitPerBuyer` (_integer_) Promotion coupon redemption limit per buyer. _Available in: v63.0_ * `startDateTime` (_string_) The date time the promotion coupon starts. _Available in: v63.0_ ### PromotionTranslationInput Input representation of the promotion translation. * `translations` (_object_) Map of language code to the translated value. _Available in: v62.0_ Additional properties: `string`. * `value` (_string_) Value to be translated. _Available in: v62.0_ ### PromotionQualifierInput Input representation of the promotion qualifier. * `approachingDiscountThreshold` (_string_) The cart amount that a customer has to reach before seeing an approaching discount message. For example, if a promotion qualifier minimum is set at $150 and this field is set at $50, then a customer receives a banner notification that they’re approaching the discount when they have at least $50 in their cart. _Available in: v64.0_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the promotion qualifier. _Available in: v62.0_ * `qualifierReferenceType` (_ConnectQualifierReferenceTypeEnum_) * `qualifierReferences` (_array of ItemReferenceInput_) List of product or category for the promotion qualifier. _Available in: v62.0_ * `qualifierType` (_object_) ConnectCompositePromotionQualifierTypeEnum Type of the promotion qualifier. Possible values are: * `Amount` —Minimum spend amount. * `Quantity` —Minimum quantity. _Available in: v62.0_ Includes all fields of `ConnectCompositePromotionQualifierTypeEnum`. * `qualifierValue` (_number (double)_) Value for the promotion qualifier. For example, if qualifier type is `Quality` , the value can be "3". _Available in: v62.0_ * `ruleCriteriaType` (_ConnectPromotionCriteriaTypeEnum_) ### PromotionSegmentInput Input representation of the promotion segment. * `id` (_string_) ID of the promotion segment. _Available in: v62.0_ * `name` (_string_) Name of the promotion segment. _Available in: v62.0_ * `segmentType` (_object_) ConnectSegmentType Type of the promotion segment. Possible _Available in: v62.0_ Includes all fields of `ConnectSegmentType`. ### PromotionTargetInput Input representation of the promotion target. * `adjustmentType` (_object_, required) ConnectPromotionAdjustmentTypeEnum Adjustment type for the promotion target. Possible values are: * `FixedAmountOffLineItemTotal` —Fixed amount off line item total. * `FixedAmountOffTransaction` —Fixed amount off transaction. * `FixedAmountOffUnitPrice` —Fixed amount off unit price. * `FixedPrice` —Fixed price. * `PercentageDiscount` —Percentage discount. * `TotalFixedPrice` —Total fixed price. _Available in: v62.0_ Includes all fields of `ConnectPromotionAdjustmentTypeEnum`. * `adjustmentValue` (_string_, required) Discount value. _Available in: v62.0_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the promotion target. _Available in: v62.0_ * `isMinItemCountRequired` (_boolean_) Indicates whether discount apply only when a cart reaches the quantity limit ( `true` ) or not ( `false` ). _Available in: v62.0_ * `restrictionQuantity` (_string_) The maximum number of items that can receive the discount. _Available in: v62.0_ * `ruleCriteriaType` (_ConnectPromotionCriteriaTypeEnum_) * `targetReferenceType` (_object_, required) ConnectTargetReferenceTypeEnum Reference type of the promotion target. Possible _Available in: v62.0_ Includes all fields of `ConnectTargetReferenceTypeEnum`. * `targetReferences` (_array of ItemReferenceInput_, required) List of products or categories associated with the promotion target. _Available in: v62.0_ ### CheckoutSettings Settings for Salesforce Checkout. * `isManagedCheckoutEnabled` (_boolean_) Indicates whether Salesforce Checkout is enabled ( `true` ) or not ( `false` ). _Available in: v61.0_ _Filter group: Small_ * `isMngCheckoutAutoPublished` (_boolean_) Is Managed Checkout Auto Publish Enabled * `paymentConfiguration` (_object_) PaymentConfiguration Payment configuration for Salesforce Checkout. _Available in: v61.0_ _Filter group: Small_ Includes all fields of `PaymentConfiguration`. * `shippingMethodsEnabled` (_boolean_) Indicates whether the shipping method calculation is enabled ( `true` ) or not ( `false` ) for your web store. _Available in: v62.0_ _Filter group: Small_ ### ClientSidePaymentConfiguration Client-side payment configuration for a Commerce store. * `componentName` (_string_) Name of the client-side payment component. _Available in: v54.0_ _Filter group: Small_ * `config` (_object_) Map of configuration attributes and values. _Available in: v54.0_ _Filter group: Small_ Additional properties: `string`. * `error` (_string_) Error message, if any. _Available in: v54.0_ _Filter group: Small_ ### GiftingConfig Gifting configuration settings for the application context. * `isGiftMessageEnabled` (_boolean_) Indicates whether sending a gift message is enabled ( `true` ) or not ( `false` ) for a web store. _Available in: v64.0_ _Filter group: Small_ * `isGiftWrapEnabled` (_boolean_) Indicates whether gift wrapping the order is enabled ( `true` ) or not ( `false` ) for a web store. _Available in: v64.0_ _Filter group: Small_ * `isGiftingEnabled` (_boolean_) Indicates whether gifting is enabled ( `true` ) or not ( `false` ) for a web store. _Available in: v64.0_ _Filter group: Small_ ### InventoryConfiguration Inventory settings for the application context. * `inventoryDefaultSource` (_object_) InventoryDefaultSourceOutput Inventory default source details. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `InventoryDefaultSourceOutput`. * `isInventoryEnabled` (_boolean_) Indicates whether Inventory is enabled for your org ( `true` ) or not ( `false` ). _Available in: v58.0_ _Filter group: Small_ ### Market Wrapper containing the detail for a market. * `localeCurrencyMap` (_object_) locale enabled on the market Additional properties: `string`. * `marketId` (_string_) The sfid of a market. ### OrderStatus Order status information. * `apiName` (_string_) API or developer name of the order status. _Available in: v62.0_ _Filter group: Small_ * `displayValue` (_string_) Display value of the order status. _Available in: v62.0_ _Filter group: Small_ ### ProductConfig Product configuration settings for the application context. * `configuratorFlowApiName` (_string_) API name of the product config flow. _Available in: v65.0_ _Filter group: Small_ ### QuoteStatus Quote Status representation * `apiName` (_string_) Api Name * `displayValue` (_string_) Display Value ### SubscriptionConfig Commerce subscription configuration settings for the application context. * `commerceSubscriptionARCUIEnabled` (_boolean_) Commerce Subscriptions ARC UI Enabled * `rlmSubscriptionEnabled` (_boolean_) Indicates whether Commerce Revenue Lifecycle Management Subscription is enabled on the org ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `subscriptionPlusEnabled` (_boolean_) Indicates whether Commerce Subscription Plus is enabled on the org ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ ### BuyerGroup Buyer group details. * `id` (_string_) ID of the buyer group. _Available in: v58.0_ _Filter group: Small_ * `name` (_string_) Name associated with the buyer group. _Available in: v58.0_ _Filter group: Small_ ### CommerceUserProfile User profile details. * `email` (_string_) returns the email of the user * `firstName` (_string_) First name of the user. _Available in: v62.0_ _Filter group: Small_ * `lastName` (_string_) Last name of the user. _Available in: v62.0_ _Filter group: Small_ * `userName` (_string_) Email address of the user. _Available in: v62.0_ _Filter group: Small_ ### ShippingProfile Output representation of the shipping profile. * `id` (_string_) ID of the shipping profile. _Available in: v59.0_ _Filter group: Small_ * `isDefault` (_boolean_) Indicates whether the shipping profile is set as default ( `true` ) or not ( `false` ). _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the shipping profile. _Available in: v59.0_ _Filter group: Small_ * `processTime` (_integer_) Time required to process the shipping order. _Available in: v61.0_ _Filter group: Small_ * `processTimeUnit` (_object_) ConnectShippingTimeUnitEnum Unit of time for processing the shipping order. Possible _Available in: v61.0_ _Filter group: Small_ Includes all fields of `ConnectShippingTimeUnitEnum`. * `shippingRateGroups` (_array of ShippingRateGroup_) List of shipping rate groups. _Available in: v59.0_ _Filter group: Small_ ### CalculateTaxesLineItemInput Calculate taxes line item input. * `adjustments` (_array of LineAdjustmentInput_) List of adjustment inputs. _Available in: v58.0_ * `lineId` (_string_, required) Line ID. _Available in: v58.0_ * `productId` (_string_, required) Product ID. _Available in: v58.0_ * `quantity` (_string_, required) Quantity of product. _Available in: v58.0_ * `totalPrice` (_string_, required) Total price for the item. _Available in: v58.0_ * `unitPrice` (_string_, required) Unit price of the product. _Available in: v58.0_ ### ClassTaxes A tax class. * `productsIds` (_array of string_) List of product IDs that belong to this class. _Available in: v58.0_ _Filter group: Small_ * `storeTaxesInfo` (_object_) TaxesInfo Details about the calculated tax output. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `TaxesInfo`. * `totalAmount` (_string_) Total amount for this tax class. _Available in: v58.0_ _Filter group: Small_ * `totalTaxAmount` (_string_) Total tax amount for this tax class. _Available in: v58.0_ _Filter group: Small_ ### CalculateTaxesLineItem Calculate tax line item. * `error` (_object_) ErrorResponse Error code and message. _Available in: v58.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `lineId` (_string_) Line ID for the product. _Available in: v58.0_ _Filter group: Small_ * `netUnitPrice` (_string_) Net unit price for the product. _Available in: v58.0_ _Filter group: Small_ * `productId` (_string_) ID of the product. _Available in: v58.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the execution was successful (true) or not (false). _Available in: v58.0_ _Filter group: Small_ * `taxAdjustments` (_array of TaxAdjustment_) List of tax adjustments. _Available in: v58.0_ _Filter group: Small_ * `taxInfoList` (_array of CalculateTaxesInfo_) List of calculated tax output. _Available in: v58.0_ _Filter group: Small_ * `totalAdjustmentTaxAmount` (_string_) Total adjustment tax amount. _Available in: v58.0_ _Filter group: Small_ * `totalLineTaxAmount` (_string_) Total line item tax excluding adjustment taxes. _Available in: v58.0_ _Filter group: Small_ * `totalPriceTaxAmount` (_string_) Total tax amount including adjustment taxes. _Available in: v58.0_ _Filter group: Small_ * `totalTieredAdjustmentTaxAmount` (_string_) Total tax amount for tiered adjustments. _Available in: v58.0_ _Filter group: Small_ ### TaxLocaleTypeEnum Tax type of the store. Possible values are: * `Gross` —Prices include tax. * `Net` —Prices don’t include tax. . _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Gross`, `Net`. ### TaxesInfoContainer Outut representation of the list of tax details about a product. * `taxesInfoList` (_array of TaxesInfo_) List of details about the tax rate and tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ ### ProductAttributeSetInput Input representation of attribute set details. * `attributes` (_array of string_) List of up to 5 attribute API names. Required if creating a new attribute set. _Available in: v62.0_ * `id` (_string_) If updating an attribute set, the ID of the existing attribute set for the variation parent product. _Available in: v62.0_ * `name` (_string_) Attribute set name for a new attribute set. _Available in: v62.0_ * `isGroupedBy` (_boolean_) Indicates if variation products are grouped by a specific attribute. _Available in: v64.0_ ### ProductMediaInput Input representation of product media details. * `developerName` (_object_) ConnectElectronicMediaGroupDeveloperNameEnum The API name of the product media group. Possible _Available in: v61.0_ Includes all fields of `ConnectElectronicMediaGroupDeveloperNameEnum`. * `mediaId` (_string_) The Salesforce ID of the managed content record associated with the product. _Available in: v61.0_ ### ProductPricingInput Input representation of product pricing details. * `currencyISOCode` (_string_) The three-letter ISO 4217 currency code associated with the product price. Products are priced using the currency for the buyer account or guest buyer profile. If your store doesn’t support the currency for the buyer account or guest buyer profile, products are priced using the default currency for your store. _Available in: v61.0_ * `listPrice` (_string_) The list price of the product. _Available in: v61.0_ * `unitPrice` (_string_) The unit price of the product _Available in: v61.0_ ### CompositeProductErrorDetailsResponse Composite Error Response Representation * `errorCode` (_string_) Error Code * `fieldName` (_string_) Field name of identifier * `id` (_string_) List of unique identifiers with their values. * `message` (_string_) Message stating the reason for error, if any * `type` (_CompositeProductErrorComponents_) ### ErrorResponse Error response representation * `errorCode` (_string_) Error code. _Available in: v48.0_ _Filter group: Small_ * `errorEntityId` (_string_) Error Entity Id * `message` (_string_) Message stating the reason for error, if any. _Available in: v48.0_ _Filter group: Small_ ### ProductVariationInput Input representation of a variation product. * `isGroupedBy` (_boolean_) Indicates if product variations are grouped by a specific attribute. _Available in: v64.0_ * `productFields` (_object_) A map of product field names and their values. _Available in: v61.0_ Additional properties: `string`. * `productMedia` (_array of ProductMediaInput_) A list of media records to be associated with the product. _Available in: v61.0_ * `productPricing` (_object_) ProductPricingInput Details of the product pricing. _Available in: v61.0_ Includes all fields of `ProductPricingInput`. * `variationAttributes` (_object_, required) Mapping of variation attributes (API name and value) associated with the product. _Available in: v62.0_ Additional properties: `string`. * `variationId` (_string_) The variation product id for updating Product and it's related information. ### NavigationMenuItem Navigation Menu Item Representation * `actionType` (_object_) ConnectNavigationMenuItemActionTypeEnum Event, URL type, or modal navigation menu item. Values are: * `Event` —Event-based navigation. `Event` is internal only and can’t be used in custom components. * `ExternalLink` —URL outside of your Experience Cloud site. * `InternalLink` —Relative URL inside your Experience Cloud site. * `Modal` —Modal, such as Account Switcher. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectNavigationMenuItemActionTypeEnum`. * `actionValue` (_string_, nullable) For `Event` action type, the event fully qualified name for the navigation menu item. For `ExternalLink` and `InternalLink` action types, the route URL for the navigation menu item. For `Modal` action type, the component fully qualified name for the navigation menu item. _Available in: v49.0_ _Filter group: Small_ * `imageUrl` (_string (url)_, nullable) URL to the image of the navigation menu item. _Available in: v47.0_ _Filter group: Small_ * `label` (_string_) Label for the navigation menu item. _Available in: v47.0_ _Filter group: Small_ * `pageReference` (_object_) NavigationMenuPageReference Page reference for the navigation menu item. Page reference is returned only for the Storefront Categories data source. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `NavigationMenuPageReference`. * `subMenu` (_array of NavigationMenuItem_) Submenu for the navigation menu item. _This property is recursive: each item has the same structure as `NavigationMenuItem`._ _Available in: v47.0_ _Filter group: Small_ * `target` (_object_) ConnectNavigationMenuItemOpenTargetEnum Target for the navigation menu item. Values are: * `CurrentWindow` —Navigation menu item opens in the current window. * `NewWindow` —Navigation menu item opens in a new window. _Available in: v47.0_ _Filter group: Small_ Includes all fields of `ConnectNavigationMenuItemOpenTargetEnum`. ### ProductCategoryMedia Media associated with a product category. * `alternateText` (_string_) Alternative text for the product category media. _Available in: v49.0_ _Filter group: Small_ * `contentVersionId` (_string_) 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. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product category image. _Available in: v49.0_ _Filter group: Small_ * `mediaType` (_object_) ConnectProductMediaTypeEnum Type of product media. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectProductMediaTypeEnum`. * `sortOrder` (_integer_) Sort order of a media item inside a media group. _Available in: v49.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) 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. _Available in: v49.0_ _Filter group: Small_ * `title` (_string_) Title of the product category media. _Available in: v49.0_ _Filter group: Small_ * `url` (_string (url)_) URL of the product category media. _Available in: v49.0_ _Filter group: Small_ ### ProductCategoryMediaGroup Media group associated with a product category. * `developerName` (_string_) API name of the product category media group. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product category media group. _Available in: v49.0_ _Filter group: Small_ * `mediaItems` (_array of ProductCategoryMedia_) List of media items within a product category media group. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the product category media group. _Available in: v49.0_ _Filter group: Small_ * `usageType` (_object_) ConnectProductMediaUsageTypeEnum Usage type of a product media item within a media group. Values are: * `Attachment` —Product media group with product documents as attachments. * `Banner` —Product category media group with banner images of the product. * `Listing` —Product media group with listing images of the product. * `Standard` —Product media group with standard images and videos of the product. * `Tile` —Product category media group with tile images of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectProductMediaUsageTypeEnum`. ### ProductCategory Product category. * `description` (_string_) Description of the category. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the category. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the category. _Available in: v49.0_ _Filter group: Small_ * `urlName` (_string_) Friendly urlName for product category * `urlSlug` (_string_) SEO-friendly URL slug of the category. _Available in: v59.0_ _Filter group: Small_ ### ProductOverview Overview of a product, with summary information about prices, selected fields, and the product’s default image. * `defaultImage` (_object_) ProductMedia Media representation of the product's default image. _Available in: v54.0_ _Filter group: Small_ Includes all fields of `ProductMedia`. * `error` (_object_) ErrorResponse Error code and error message. _Available in: v54.0_ _Filter group: Big_ Includes all fields of `ErrorResponse`. * `fields` (_object_) Map of fields belonging to the product. _Available in: v54.0_ _Filter group: Medium_ Additional properties: `string`. * `id` (_string (Id)_) ID of the product. _Available in: v54.0_ _Filter group: Small_ * `isConfigurationAllowed` (_boolean_) Indicates whether the product supports configuration (`true`) or not (`false`). For dynamic bundles, this field is always `true`, and for static bundles, it is `false`. When `true`, buyers can configure the bundle by selecting which child components to include or exclude before adding it to the cart. _Available in: v65.0_ _Filter group: Small_ * `mediaGroups` (_array of ProductMediaGroup_) List of media groups of the product * `name` (_string_) Name of the product. _Available in: v63.0_ _Filter group: Small_ * `productClass` (_object_) ConnectProductClassEnum Class of the product. Possible _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnum`. * `productSellingModels` (_array of ProductSellingModel_) Product selling models information for the product. _Available in: v63.0_ _Filter group: Small_ * `purchaseQuantityRule` (_object_) PurchaseQuantityRule Purchase quantity rule information for the product. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRule`. * `sku` (_string_) SKU of the product. _Available in: v54.0_ _Filter group: Small_ * `success` (_boolean_) Represents whether execution was successful and product overview information was retrieved without error. _Available in: v54.0_ _Filter group: Small_ * `urlName` (_string_) URL name of the product. _Available in: v63.0_ _Filter group: Small_ * `variationAttributeSet` (_object_) ProductAttributeSetSummary Variation attribute set information for the product. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ProductAttributeSetSummary`. * `variationInfo` (_object_) ProductVariationInfo Details of product variation attributes, metadata, and mappings of attribute combinations to variation product IDs. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ProductVariationInfo`. * `prices` (_object_) PricingResultLineItem Price of the product. To get pricing information for products in version 58 and later, use [Commerce Webstore Pricing Products](/docs/platform/connect-rest-api/references/connect-rest-api-commerce#tag/Commerce-B2B-Resources/operation/getMultiProductPrice). _Available in: v54.0–57.0_ _Filter group: Medium_ Includes all fields of `PricingResultLineItem`. ### ProductAttributeSetInfo Product attribute set metadata. * `attributeInfo` (_object_) Map of the API name of the attribute field to the attribute metadata. _Available in: v50.0_ _Filter group: Small_ Additional properties: `ProductAttributeInfo`. * `description` (_string_) Description of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `developerName` (_string_) Developer name of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `masterLabel` (_string_) Label of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence of the attribute set for the product. _Available in: v50.0_ _Filter group: Small_ ### ProductMedia Media associated with a product. * `alternateText` (_string_) Alternative text for the product media. _Available in: v49.0_ _Filter group: Small_ * `contentVersionId` (_string (Id)_) 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. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product image. _Available in: v49.0_ _Filter group: Small_ * `mediaType` (_object_) ConnectProductMediaTypeEnum Type of product media. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectProductMediaTypeEnum`. * `sortOrder` (_integer_) Sort order of a media item within a media group. _Available in: v49.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) 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. _Available in: v49.0_ _Filter group: Small_ * `title` (_string_) Title of the product media. _Available in: v49.0_ _Filter group: Small_ * `url` (_string (url)_) URL of the product media. _Available in: v49.0_ _Filter group: Small_ ### ProductMediaGroup Media group associated with a product. * `developerName` (_string_) API name of the product media group. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product media group. _Available in: v49.0_ _Filter group: Small_ * `mediaItems` (_array of ProductMedia_) List of media items within a product media group. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the product media group. _Available in: v49.0_ _Filter group: Small_ * `usageType` (_object_) ConnectProductMediaUsageTypeEnum Usage type of a product media item within a media group. Values are: * `Attachment` —Product media group with product documents as attachments. * `Banner` —Product category media group with banner images of the product. * `Listing` —Product media group with listing images of the product. * `Standard` —Product media group with standard images and videos of the product. * `Tile` —Product category media group with tile images of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectProductMediaUsageTypeEnum`. ### ConnectProductClassEnum Class of the product. Possible _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `Bundle`, `Set`, `Simple`, `Variation`, `VariationParent`. ### ProductSellingModel Product selling model for Commerce subscriptions. * `description` (_string_) Description of the product selling model displayed on the UI. _Available in: v60.0_ _Filter group: Small_ * `displayName` (_string_) Name of the product selling model displayed on the UI. _Available in: v60.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product selling model. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) Name of the product selling model. _Available in: v56.0_ _Filter group: Small_ * `pricingTerm` (_integer_) Number of pricing term units in the pricing term. Used with `pricingTermUnit` to define the length of the pricing term. For example, if `pricingTermUnit` is `Months` and this property is 1, the subscription is priced monthly. However, if the `sellingModelType` property is set to `OneTime`, the `pricingTerm` property is empty, because the product isn’t sold as a subscription. The only allowed value for this property is 1. _Available in: v56.0_ _Filter group: Small_ * `pricingTermUnit` (_object_) ConnectPricingTermUnitEnum Unit of time used to define a pricing term. Values are: * `Months` —Product is priced on a monthly basis. * `Annual` —Product is priced on an annual basis. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectPricingTermUnitEnum`. * `sellingModelType` (_object_) ConnectSellingModelTypeEnum Type of product selling model. Values are: * `Evergreen` —A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it. * `OneTime` —A product that isn’t sold as a subscription. * `TermDefined` —A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectSellingModelTypeEnum`. * `subscriptionTermRule` (_object_) SubscriptionTermRule Rules for a subscription term. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `SubscriptionTermRule`. ### PurchaseQuantityRule Rule that restricts the quantity of a product that can be purchased. * `increment` (_string_) Increment value of the quantity that can be purchased. _Available in: v52.0_ _Filter group: Small_ * `maximum` (_string_) Maximum quantity that can be purchased. _Available in: v52.0_ _Filter group: Small_ * `minimum` (_string_) Minimum quantity that can be purchased. _Available in: v52.0_ _Filter group: Small_ ### ProductAttributeSet Product attribute set data. * `attributes` (_object_) Map of the attributes that are members of the attribute set. _Available in: v50.0_ _Filter group: Small_ Additional properties: `string`. * `developerName` (_string_) Name of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product attribute record that represents the product attribute set. _Available in: v50.0_ _Filter group: Small_ ### ProductVariationInfo Product variation attributes, metadata, and mappings of attribute combinations to variation product IDs. * `attributesToProductMappings` (_array of ProductAttributesToProductEntry_) List ordered by `ProductAttribute.Sequence` values that map the attribute value combinations to the variation product ID. _Available in: v50.0_ _Filter group: Small_ * `variationAttributeInfo` (_object_) Map of field API name to product attribute information. _Available in: v51.0_ _Filter group: Small_ Additional properties: `ProductAttributeInfo`. * `variationCount` (_integer_) Total count of available product variations. _Available in: v66.0_ _Filter group: Small_ ### ProductEntitlement Entitlements for a product. * `canViewPrice` (_boolean_) Specifies whether the product's price can be viewed (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ ### ProductChild Child product related to a parent product. * `componentGroup` (_object_) ProductComponentGroup Specifies the product component group associated with the child product. This field is returned only for dynamic product bundles. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `ProductComponentGroup`. * `defaultQuantity` (_string_) Default quantity of child products to be ordered. _Available in: v57.0_ _Filter group: Small_ * `isDefault` (_boolean_) Indicates whether the child product is a default component (`true`) or not (`false`). This field is returned only for dynamic product bundles. _Available in: v65.0_ _Filter group: Small_ * `isEntitled` (_boolean_) Specifies whether the child product can be viewed on the product detail page (`true`) or not (`false`). _Available in: v62.0_ _Filter group: Small_ * `isPriceIncludedInParent` (_boolean_) Indicates whether the child product's pricing is included in the parent product (`true`) or not (`false`). This field is returned only for dynamic product bundles. _Available in: v65.0_ _Filter group: Small_ * `isRequired` (_boolean_) Indicates whether the child product is a required component (`true`) or not (`false`). This field is returned only for dynamic product bundles. _Available in: v65.0_ _Filter group: Small_ * `productInfo` (_object_) ProductDetail Product details of the child product. _Available in: v57.0_ _Filter group: Small_ Includes all fields of `ProductDetail`. ### ImportConfiguration Configuration input for a product import operation. * `importContext` (_ConnectImportContextEnum_) * `importSettings` (_object_) ImportSettings Settings applicable to all product rows in a product import .csv file. Required if you specify media-related, entitlement-related, price-related, or category-related column headings in your .csv file. _Available in: v54.0_ Includes all fields of `ImportSettings`. * `importSource` (_object_, required) ImportSource Specifies a product import .csv file for a product import operation. _Available in: v54.0_ Includes all fields of `ImportSource`. ### ConnectSampleDataEnum Sample .csv file to import. Values are: * `B2BSampleData` —B2B sample data set. * `Camera` —Camera store sample data set. * `Coffee` —Coffee store sample data set. * `Hardware` —Hardware store sample data set. * `NorthernTrail` —Outdoor goods store sample data set. * `NorthernTrailLarge` —Larger outdoor goods store sample data set. * `Simple` —Two-product sample data set. Required if `contentVersionId` isn’t specified _Available in: v54.0_ Type: `string`. Allowed values: `B2BSampleData`, `Camera`, `Coffee`, `Hardware`, `NorthernTrail`, `NorthernTrailLarge`, `Simple`. ### ExtensionOutput A Commerce extension. * `domain` (_string_) Service domain to which the extension belongs. By convention, this is the third portion of the extension point name (epn). For example, if the epn is `Commerce_Domain_Cart_Calculate` , the service domain is `Cart` ; and if the epn is `Commerce_Endpoint_Account_Address` , the service domain is `Account` . _Available in: v58.0_ _Filter group: Big_ * `epn` (_string_) Extension point name (unique identifier for an extension). For valid values, see the [RegisteredExternalService](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_registeredexternalservice.htm) object's ExtensionPointName field. _Available in: v58.0_ _Filter group: Big_ * `name` (_string_) Name of the extension. By convention, this is the fourth portion of the extension point name (epn). For example, if the epn is `Commerce_Domain_Cart_Calculate` , the name is `Calculate` . _Available in: v58.0_ _Filter group: Big_ * `product` (_string_) Extension family name. By convention, this is the first portion of the extension point name (epn). For example, if the epn is `Commerce_Domain_Cart_Calculate` , the extension family name is `Commerce` . _Available in: v58.0_ _Filter group: Big_ * `type` (_string_) Type of extension. Valid values are: * `Domain` * `Endpoint` _Available in: v58.0_ _Filter group: Big_ * `alternativeRepresentation` (_object_) Alternative Alternative representation of the extension. _Available in: v40.0_ _Filter group: Small_ Includes all fields of `Alternative`. * `attachmentId` (_string_) Attachment ID of the extension. _Available in: v41.0_ _Filter group: Small_ * `extensionId` (_string_) ID of the extension. _Available in: v40.0_ _Filter group: Small_ * `payload` (_string_) Payload associated with the extension. _Available in: v40.0_ _Filter group: Small_ * `payloadVersion` (_string_) Payload version that identifies the structure of the payload associated with the extension. _Available in: v40.0_ _Filter group: Small_ ### ApexClassInput Input representation of a provider's apex class. * `classId` (_string_) Unique identifier for the apex class. * `className` (_string_) Name of the class containing the entry methods. ### ApexClassOutput Apex class for a Commerce extension provider. * `classId` (_string_) ID of an Apex class extending a base class for an extension point. _Available in: v58.0_ _Filter group: Big_ * `className` (_string_) Name of the Apex extension provider class, without the file extension. _Available in: v58.0_ _Filter group: Big_ * `namespace` (_string_) Unique namespace of the company or party providing the extension. _Available in: v58.0_ _Filter group: Big_ * `version` (_string_) Apex class version. _Available in: v58.0_ _Filter group: Big_ ### EffectiveMapping Webstore mapped to a Commerce extension. * `webstoreId` (_string_) Webstore ID. _Available in: v58.0_ _Filter group: Big_ ### PricingResultLineItemCommerceStorePricing Pricing result line item. * `contractId` (_string_) Represents the ID of the contract * `contractItemPriceId` (_string_) Represents the ID of the contract item price * `error` (_object_) ErrorResponse Error code and message. _Available in: v49.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `listPrice` (_string_) List price for the product. _Available in: v49.0_ _Filter group: Small_ * `lowestUnitPrice` (_string_) Lowest unit price for the product. _Available in: v59.0_ _Filter group: Small_ * `pricebookEntryId` (_string (Id)_) ID of the pricebook entry. _Available in: v49.0_ _Filter group: Small_ * `productId` (_string_) ID of the product to price. _Available in: v49.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the execution was successful (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `unitPrice` (_string_) Unit price for the product. _Available in: v49.0_ _Filter group: Small_ ### PricingLineItemInput Pricing line item. * `productId` (_string (Id)_, required) ID of the product to price. _Available in: v49.0_ ### PriceAdjustmentSchedule Price adjustment schedule. * `adjustmentMethod` (_object_) PriceAdjustmentScheduleAdjustmentMethodEnum Reserved for future use. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `PriceAdjustmentScheduleAdjustmentMethodEnum`. * `id` (_string (Id)_) ID of the price adjustment schedule. _Available in: v49.0_ _Filter group: Small_ * `priceAdjustmentTiers` (_array of PriceAdjustmentTier_) List of price adjustment tiers. _Available in: v49.0_ _Filter group: Small_ * `scheduleType` (_object_) PriceAdjustmentScheduleTypeEnum Reserved for future use. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `PriceAdjustmentScheduleTypeEnum`. ### ProductPriceEntry Line item price for the product. * `contractId` (_string_) Represents the ID of the contract * `contractItemPriceId` (_string_) Represents the ID of the contract item price * `error` (_object_) ErrorResponse Error code and error message. _Available in: v56.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `listPrice` (_string_) List price for the product entry. _Available in: v56.0_ _Filter group: Small_ * `lowestUnitPrice` (_string_) Represents the lowest unit price for the product * `priceAdjustment` (_object_) PriceAdjustmentSchedule Price adjustment schedule. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `PriceAdjustmentSchedule`. * `pricebookEntryId` (_string (Id)_) ID of the pricebook entry. _Available in: v56.0_ _Filter group: Small_ * `productSellingModelId` (_string (Id)_) ID of the product selling model. If no product selling model ID is specified in a request parameter, this property is empty. _Available in: v56.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether execution was successful (`true`) or not (`false`). _Available in: v56.0_ _Filter group: Small_ * `unitPrice` (_string_) Unit price for the product entry. _Available in: v56.0_ _Filter group: Small_ ### ConnectCommerceSubscriptionSortEnum Sort order of the subscription results returned in the page. Possible values are: * `CreatedDateAsc` —Sort in ascending order of created date. * `CreatedDateDesc` —Sort in descending order of created date. _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `CreatedDateAsc`, `CreatedDateDesc`. ### OutputTypeEnum Subscription output type. Type: `string`. Allowed values: `Cart`, `Order`. ### SubscriptionRenewalPriceForecastDetail Output representation of the Commerce subscription renewal price forecast details. * `endDate` (_string (date-time)_) End date for the renewal. _Available in: v67.0_ _Filter group: Small_ * `renewalPriceDetails` (_array of RenewalPriceDetail_) List of renewal price details, including net unit price and quantity. _Available in: v67.0_ _Filter group: Small_ * `startDate` (_string (date-time)_) Start date for the renewal. Defaults to one day after the current subscription end date. _Available in: v67.0_ _Filter group: Small_ * `subscriptionId` (_string_) ID of the subscription. _Available in: v67.0_ _Filter group: Small_ * `totalLineAmount` (_string_) Forecasted total line amount of renewal. _Available in: v67.0_ _Filter group: Small_ ### SubscriptionActionOutput Output representation of the most recent action performed on the subscription. * `details` (_object_) ActionDetail Details of the action performed on the subscription. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `ActionDetail`. * `effectiveDateTime` (_string (date-time)_) Date and time when the subscription action takes effect. For example 2025-09-29T11:41:45.040Z. _Available in: v65.0_ _Filter group: Small_ * `performedDateTime` (_string (date-time)_) Date and time when the subscription action was performed. For example 2025-08-29T11:41:45.040Z. _Available in: v65.0_ _Filter group: Small_ * `type` (_string_) Specifies the type of action performed on the subscription. For example, Amend, Cancel, or Renew. _Available in: v65.0_ _Filter group: Small_ ### OperationStatus Amendment status of the subscription. Possible values are: * `Failed` —The operation status is failed. * `InProgress` —The operation status is in progress. * `Success` —The operation status is successful. _Available in: v65.0_ _Filter group: Small_ Type: `string`. Allowed values: `Failed`, `InProgress`, `Success`. ### CommerceSubscriptionBillingSummary Representation for the Commerce subscription billing summary. * `billingMethod` (_string_) Billing method associated with billing schedules. _Available in: v63.0_ _Filter group: Small_ * `billingPeriodAmount` (_string_) Billing period amount associated with billing schedules. _Available in: v63.0_ _Filter group: Small_ * `billingTerm` (_integer_) Billing term associated with billing schedules. For example, use the value “1” for a one-year or one-month billing term. _Available in: v63.0_ _Filter group: Small_ * `billingTermUnit` (_string_) Billing term unit associated with billing schedules. Possible values are: * `Year` * `Month` _Available in: v63.0_ _Filter group: Small_ * `billingType` (_string_) Billing type associated with billing schedules. Possible values are: * `Advance` * `Arrear` _Available in: v63.0_ _Filter group: Small_ * `cancellationDate` (_string (date-time)_) Cancellation date associated with billing schedules. _Available in: v63.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Curency ISO Code associated with billing schedules. _Available in: v63.0_ _Filter group: Small_ * `nextBillingDate` (_string (date-time)_) Next billing date associated with billing schedules. _Available in: v63.0_ _Filter group: Small_ * `savedPaymentMethod` (_object_) SavedPaymentMethodOutput Saved payment method associated with billing schedules. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `SavedPaymentMethodOutput`. ### ProcessExceptionOutput Process Exception output representation * `category` (_string_) Category of the process exception. * `message` (_string_) Message of the process exception. * `status` (_string_) Status of the process exception. ### BuyerProductSummary Output representation of the buyer product summary. * `canViewProduct` (_boolean_) Specifies whether the context user can view the product ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `error` (_object_) ErrorResponse Error response representation for buyer product summary. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ErrorResponse`. * `fields` (_object_) Collection of fields from product. _Available in: v63.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) Id of the product. _Available in: v63.0_ _Filter group: Small_ * `image` (_object_) ProductMedia Media details associated with a product. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `name` (_string_) Name of the product. _Available in: v63.0_ _Filter group: Small_ * `productClass` (_ConnectProductClassEnumCommerceBuyerexperience_) * `purchaseQuantityRule` (_object_) PurchaseQuantityRule Rule that restricts the quantity of a product that can be purchased. _Available in: v65.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRuleCommerceEinstein`. * `sku` (_string_) SKU of the product. _Available in: v63.0_ _Filter group: Small_ * `success` (_boolean_) Indicates whether the request was successful ( `true` ) or not ( `false` ). _Available in: v63.0_ _Filter group: Small_ * `variationAttributes` (_array of ProductAttributeSummaryCommerceBuyerexperience_) Summary details of a product attribute. _Available in: v63.0_ _Filter group: Small_ ### ProductSellingModelCommerceBuyerexperience Representation of Product Selling Models * `description` (_string_) Description of the product selling model displayed on the UI. _Available in: v60.0_ _Filter group: Small_ * `displayName` (_string_) Name of the product selling model displayed on the UI. _Available in: v60.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product selling model. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) Name of the product selling model. _Available in: v56.0_ _Filter group: Small_ * `pricingTerm` (_integer_) Number of pricing term units in the pricing term. Used with `pricingTermUnit` to define the length of the pricing term. For example, if `pricingTermUnit` is `Months` and this property is 1, the subscription is priced monthly. However, if the `sellingModelType` property is set to `OneTime`, the `pricingTerm` property is empty, because the product isn’t sold as a subscription. The only allowed value for this property is 1. _Available in: v56.0_ _Filter group: Small_ * `pricingTermUnit` (_string_) Unit of time used to define a pricing term. Values are: * `Months` —Product is priced on a monthly basis. * `Annual` —Product is priced on an annual basis. _Available in: v56.0_ _Filter group: Small_ Allowed values: `Annual`, `Months`. * `sellingModelType` (_string_) Type of product selling model. Values are: * `Evergreen` —A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it. * `OneTime` —A product that isn’t sold as a subscription. * `TermDefined` —A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. _Available in: v56.0_ _Filter group: Small_ Allowed values: `Evergreen`, `OneTime`, `TermDefined`. * `subscriptionTermRule` (_object_) SubscriptionTermRuleCommerceBuyerexperience Rules for a subscription term. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `SubscriptionTermRuleCommerceBuyerexperience`. ### BusObjInsightsInput Insights associated with a business objective, or goal. * `targetCompletionDate` (_string (date-time)_) Target date for completion of the goal. _Available in: v62.0_ * `targetValue` (_number (double)_) Target value for the goal. _Available in: v62.0_ ### BusinessObjectiveAssociationInputRequest Business objective association. * `id` (_string_, required) Association ID for the business objective, or goal. _Available in: v59.0_ * `type` (_string_, required) Definition category of the business objective, or goal. Values are: * `Webstore` _Available in: v59.0_ ### BusObjInsightsOutput Insights related to a business objective, or goal. * `currencyIsoCode` (_string_) The three-letter ISO currency code associated with the KPI values. For example, 'USD' for US dollars or 'EUR' for euros. _Available in: v62.0_ _Filter group: Small_ * `current` (_number (double)_) The current value of the KPI metric. This represents the most recent measurement or calculation of the business objective's key performance indicator. _Available in: v59.0_ _Filter group: Small_ * `insights` (_array of InsightsOutput_) A collection of insights related to the business objective. _Available in: v62.0_ _Filter group: Small_ * `kpiDashboardUrl` (_string_) The URL to the dashboard where the KPI details and visualizations can be viewed. _Available in: v62.0_ _Filter group: Small_ * `kpiSummaryText` (_string_) A human-readable summary of the KPI's performance, including the change from the previous value. _Available in: v62.0_ _Filter group: Small_ * `last` (_number (double)_) The previous value of the KPI metric, used for comparison with the current value to track progress or changes over time. _Available in: v59.0_ _Filter group: Small_ * `period` (_string_) The time period between the current and last values, such as 'Daily', 'Weekly', 'Monthly', or 'Quarterly'. This indicates the frequency of KPI measurements. _Available in: v59.0_ _Filter group: Small_ * `targetCompletionDate` (_string (date-time)_) Target date for completion of the goal. _Available in: v62.0_ _Filter group: Small_ * `targetValue` (_number (double)_) Target value for the goal. _Available in: v62.0_ _Filter group: Small_ * `unit` (_object_) ConnectInsightUnitEnum Unit for an insight. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `ConnectInsightUnitEnum`. ### BusObjRecommendationsOutput Details of the recommended actions for a business objective, or goal. * `active` (_integer_) Count of active recommended actions. _Available in: v59.0_ _Filter group: Small_ * `complete` (_integer_) Count of completed recommended actions. _Available in: v59.0_ _Filter group: Small_ * `total` (_integer_) Count of total recommended actions, including both completed and active. _Available in: v59.0_ _Filter group: Small_ ### ActionInfoInput Recommended action information. * `name` (_string_) Name of the Lightning web component used for dynamically rendering the recommended action. _Available in: v60.0_ * `parameters` (_string_, required) Parameters required for processing and displaying the recommended action. _Available in: v60.0_ ### ActionInfoOutput Recommended action information. * `name` (_string_) Name of the Lightning web component used for dynamically rendering the recommended action. _Available in: v60.0_ _Filter group: Small_ * `parameters` (_string_) Parameters required for processing and displaying the recommended action. _Available in: v60.0_ _Filter group: Small_ ### ExternalManagedAccountOutput Externally managed account. * `accountId` (_string (Id)_) ID of the account managed by another account. _Available in: v49.0_ _Filter group: Small_ * `accountName` (_string_) Name of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `address` (_object_) ExternalManagedAccountAddressOutput Default shipping address of the external managed account. _Available in: v53.0_ _Filter group: Small_ Includes all fields of `ExternalManagedAccountAddressOutput`. * `externalManagedAccountId` (_string (Id)_) ID of the external managed account record. _Available in: v49.0_ _Filter group: Small_ * `isMyAccount` (_boolean_) Specifies whether the account is the context user’s account (`true`) or not (`false`). _Available in: v53.0_ _Filter group: Small_ ### ConnectCommerceEinsteinActivityJobStatusEnum Status code for the job. Values are: * `Completed` —Job completed. * `NoData` —Export job completed with no data. * `Pending` —Job is in progress. _Available in: v52.0_ _Filter group: Small_ Type: `string`. Allowed values: `Completed`, `NoData`, `Pending`. ### ProductSummaryCollection Collection of Product Summary representations in product search results. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the product. _Available in: v49.0_ _Filter group: Small_ * `pageSize` (_integer_) Number of products per page in the search results. _Available in: v49.0_ _Filter group: Small_ * `products` (_array of ProductSummary_) Collection of product summaries. _Available in: v49.0_ _Filter group: Medium_ * `total` (_number (int64)_) Total number of products in the search results. _Available in: v49.0_ _Filter group: Small_ ### ConnectCommerceEinsteinStatusEnum Status code for the deployment. _Available in: v52.0_ _Filter group: Small_ Type: `string`. Allowed values: `DataError`, `InProgress`, `InternalError`, `NotDeplyed`, `Success`, `UndeployedSiteError`. ### ErrorResponseOutput Error response output. * `errorCode` (_string_) Error code. _Available in: v48.0_ _Filter group: Small_ * `message` (_string_) Message stating the reason for error, if any. _Available in: v48.0_ _Filter group: Small_ ### FulfillmentGroupOutput Information about one FulfillmentOrder from a request to create fulfillment orders from multiple OrderDeliveryGroupSummaries. If the FulfillmentOrder was created, then its ID is returned. If it failed, then data from the input is returned so you can resubmit it. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `fulfilledFromLocationId` (_string (Id)_) (Creation failed) The input FulfilledFromLocationId. _Available in: v50.0_ _Filter group: Big_ * `fulfillmentOrderId` (_string (Id)_) The FulfillmentOrderId from the successfully created FulfillmentOrder. _Available in: v50.0_ _Filter group: Big_ * `fulfillmentType` (_string_) (Creation failed) The input FulfillmentType. _Available in: v50.0_ _Filter group: Big_ * `orderDeliveryGroupSummaryId` (_string (Id)_) (Creation failed) The input OrderDeliveryGroupSummaryId. _Available in: v50.0_ _Filter group: Big_ * `orderItemSummaries` (_array of OrderItemSummaryOutput_, nullable) (Creation failed) The input list of OrderItemSummaries. _Available in: v50.0_ _Filter group: Big_ * `orderSummaryId` (_string (Id)_) (Creation failed) The input OrderSummaryId. _Available in: v50.0_ _Filter group: Big_ * `referenceId` (_string_) The referenceId from the FulfillmentGroup input representation. Use this value to troubleshoot a failure. _Available in: v50.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### FulfillmentGroupInput A list of OrderItemSummaries to be fulfilled together, and the fulfillment location to handle them. The fulfillment type is one of the values defined for the Type field on the FulfillmentOrder object, such as “Warehouse” or “Retail Store.” The specified type is assigned to the FulfillmentOrder for this fulfillment group. * `fulfilledFromLocationId` (_string (Id)_, required) ID of the fulfillment location. _Available in: v48.0_ * `fulfillmentType` (_string_, required) Fulfillment type. One of the Type field values defined for FulfillmentOrders. _Available in: v48.0_ * `orderItemSummaries` (_array of OrderItemSummaryInput_, required) List of OrderItemSummaries. _Available in: v48.0_ * `referenceId` (_string_) Reference to this input for use in troubleshooting failures. This value is only used by the APIs for creating fulfillment orders for multiple order delivery group summaries. _Available in: v50.0_ ### FulfillmentOrderLineItemInput A FulfillmentOrderLineItem and quantity to cancel. You can cancel less than the full quantity, in which case you reallocate the canceled quantity to a different FulfillmentOrder. * `fulfillmentOrderLineItemId` (_string (Id)_, required) ID of the FulfillmentOrderLineItem. _Available in: v48.0_ * `quantity` (_number (double)_, required) Quantity to cancel. _Available in: v48.0_ ### DistributeToOrdersInput Input representation of a single element within the Distribute To Orders list. * `externalOrderId` (_string_, required) ID of the external order. _Available in: v58.0_ * `itemQuantities` (_array of ItemQuantityInput_, required) Order Item Quantity List _Available in: v58.0_ ### ItemQuantityInput Input representation of an item and its quantity. * `externalItemId` (_string_, required) ID of the external item. _Available in: v58.0_ * `quantity` (_number (double)_, required) Quantity of the external item. _Available in: v58.0_ ### OrderQuantitiesOutput Output groupings of items in an order. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `externalOrderId` (_string_) A string representation of the grouping of SKUs _Available in: v58.0_ * `itemQuantities` (_array of ItemQuantityOutput_) The list of items and quantities _Available in: v58.0_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ItemQuantityOutput The quantity for a specific item. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `externalItemId` (_string_) The identifier for the item with quantity _Available in: v58.0_ * `quantity` (_number (double)_) Quantity requested for the item. _Available in: v58.0_ * `quantityDistributed` (_number (double)_) Quantity that was distributed to this item. _Available in: v58.0_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### TextClassificationsResultWithIdOutput Text classifications result with ID. * `id` (_string_) Request ID for text classifications. _Available in: v59.0_ _Filter group: Small_ * `result` (_object_) TextClassificationsResultOutput Result for text classifications. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `TextClassificationsResultOutput`. * `status` (_string_) Request status for text classification. _Available in: v59.0_ _Filter group: Small_ ### HttpHeaderOutput An HTTP header. * `name` (_string_) Name of the HTTP header. _Available in: v59.0_ * `value` (_string_) Value of the HTTP header. _Available in: v59_ ### ProductReturnRateOutput Return rate of a product (units returned divided by units sold). * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `productId` (_string_) ID of the product. _Available in: v59.0_ _Filter group: Big_ * `returnRate` (_number (double)_) Return rate of specified product. Values range from 0 to 1. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### BalanceStatePreviewOutput The generated preview of all balances for an order or a cart, including totals, adjustments, and taxes. * `grandTotalAmount` (_number (double)_) The grand total of the exchanges, including adjustments, fees, delivery cost, and taxes. _Available in: v61.0_ _Filter group: Big_ * `totalAdjustmentAmount` (_number (double)_) The total amount the order was adjusted by, not including tax. _Available in: v61.0_ _Filter group: Big_ * `totalAdjustmentAmountWithTax` (_number (double)_) The total amount the order was adjusted by, including tax. _Available in: v61.0_ _Filter group: Big_ * `totalAmount` (_number (double)_) The total amount being return, not including tax. _Available in: v61.0_ _Filter group: Big_ * `totalAmountWithTax` (_number (double)_) The total amount being return, including tax. _Available in: v61.0_ _Filter group: Big_ * `totalDeliveryAmount` (_number (double)_) The total cost for delivery, not including tax. _Available in: v61.0_ _Filter group: Big_ * `totalDeliveryAmountWithTax` (_number (double)_) The total cost for delivery, including tax. _Available in: v61.0_ _Filter group: Big_ * `totalFeeAmount` (_number (double)_) The combined total of all fees charged, not including tax. _Available in: v61.0_ _Filter group: Big_ * `totalFeeAmountWithTax` (_number (double)_) The combined total of all fees charged, including tax. _Available in: v61.0_ _Filter group: Big_ * `totalTaxAmount` (_number (double)_) The combined total of all taxes. _Available in: v61.0_ _Filter group: Big_ ### ChangeItemOutput The financial changes resulting from a change to one or more OrderItemSummaries. Most of the values represent the deltas of the values on the associated OrderSummary. The sign of each value is the opposite of the corresponding value on a change order record. For example, a discount is a positive value here and a negative value on a change order record. * `grandTotalAmount` (_number (double)_) Change to the GrandTotalAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAdjDeliveryAmtWithTax` (_number (double)_) Change to the TotalAdjDeliveryAmtWithTax field. _Available in: v49.0_ _Filter group: Big_ * `totalAdjDistAmountWithTax` (_number (double)_) Change to the TotalAdjDistAmountWithTax field. _Available in: v49.0_ _Filter group: Big_ * `totalAdjProductAmtWithTax` (_number (double)_) Change to the TotalAdjProductAmtWithTax field. _Available in: v49.0_ _Filter group: Big_ * `totalAdjustedDeliveryAmount` (_number (double)_) Change to the TotalAdjustedDeliveryAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAdjustedDeliveryTaxAmount` (_number (double)_) Change to the TotalAdjustedDeliveryTaxAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAdjustedProductAmount` (_number (double)_) Change to the TotalAdjustedProductAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAdjustedProductTaxAmount` (_number (double)_) Change to the TotalAdjustedProductTaxAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAdjustmentDistributedAmount` (_number (double)_) Change to the TotalAdjustmentDistributedAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAdjustmentDistributedTaxAmount` (_number (double)_) Change to the TotalAdjustmentDistributedTaxAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalAmount` (_number (double)_) Change to the TotalAmount field. _Available in: v48.0_ _Filter group: Big_ * `totalExcessFundsAmount` (_number (double)_) Amount of excess funds available on the OrderPaymentSummaries related to the OrderSummary. It is equal to the captured amount that is owed as a refund but is not associated with an invoice or credit memo. Excess funds normally occur when order items are canceled before fulfillment but after payment has been captured. This situation is not common in the US, where funds are normally authorized but not captured until the fulfillment process begins. This value includes all current excess funds related to the OrderSummary, not only the funds related to the current change. _Available in: v48.0_ _Filter group: Big_ * `totalFeeAmount` (_number (double)_) Total amount of the fees charged for the change. _Available in: v57.0_ _Filter group: Big_ * `totalFeeTaxAmount` (_number (double)_) Total amount of tax on the fees charged for the change. _Available in: v57.0_ _Filter group: Big_ * `totalRefundableAmount` (_number (double)_) Total amount available to be refunded. It is the sum of the excess funds and any outstanding change order grand total amounts that apply to post-fulfillment changes. This value includes all current refundable amounts related to the OrderSummary, not only the amount related to the current change. _Available in: v48.0_ _Filter group: Big_ * `totalRequiredFundsAmount` (_number (double)_) The required funds associated with added order items. _Available in: v54.0_ _Filter group: Big_ * `totalTaxAmount` (_number (double)_) Change to the TotalTaxAmount field. _Available in: v48.0_ _Filter group: Big_ ### PaymentInfoInput Payment information about additional funds required for an order. * `lastPaymentGatewayLogId` (_string_) Last payment gateway log ID for the new order payment summary. _Available in: v60.0_ * `name` (_string_) Overrides the default name of the order payment summary created. _Available in: v60.0_ * `paymentAuthorizationId` (_string_) Payment authorization ID to be used if needed to fund the exchange order. _Available in: v60.0_ * `paymentIds` (_array of string_) Payment IDs for the new order payment summary. _Available in: v60.0_ * `paymentMethodId` (_string_) Payment method ID for the new order payment summary. _Available in: v60.0_ ### SharedOrderPaymentSummarySequenceInput Shared order payment summary sequence. * `orderPaymentSummaryId` (_string_, required) Shared order payment summary ID. _Available in: v60.0_ * `reservedBalanceAmount` (_number (double)_, required) Balance amount to be reserved. _Available in: v60.0_ ### CreateInvoiceFromChangeOrdersInput OrderSummary and associated change orders to create Invoices for. * `changeOrderIds` (_array of string_, required) List of IDs of change orders to create Invoices for. _Available in: v56.0_ * `orderSummaryId` (_string_, required) ID of the associated Order Summary. _Available in: v56.0_ ### CreateInvoiceFromChangeOrdersOutput List of IDs of invoices created for change orders. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `invoiceId` (_string_) ID of the created invoice. _Available in: v56.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### InnerEnsureFundsAsyncInput ID of an Invoice and ID of the associated OrderSummary. * `invoiceId` (_string_, required) ID of the Invoice to ensure funds for. _Available in: v56.0_ * `isAllowPartial` (_boolean_, required) If true, the invoice can be funded through multiple, partial payments. Optionally, define a sequence to capture multiple payments. If false, the invoice must be funded through a single payment. Default value is false. _Available in: v60.0_ * `isReservedBalanceAmountConsidered` (_boolean_) Is Reserved Balance Amount Considered * `orderSummaryId` (_string_, required) ID of the OrderSummary associated with the Invoice. _Available in: v56.0_ * `sequences` (_array of SequenceOrderPaymentSummaryInput_) The payment sequence in which the funds are captured for the invoice. _Available in: v60.0_ * `isConsiderReservedBalanceAmount` (_boolean_) If true, the reserved balance amount is used for the Order Summary to fund the invoice. If not enough reserved balance amount, any available balance that isn’t reserved by another Order Summary is used. If false, any available balance is used. _Available in: v59.0_ ### AsyncOutput Output representation of the async operation. * `backgroundOperationId` (_string_) ID of the background operation. _Available in: v56.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### AdjustItemInput A price adjustment to an OrderItemSummary. It only supports discounts, not increases. * `adjustmentType` (_string_, required) Describes how the amount is calculated. It can have one of these values: * `AmountTaxOnly` —Value of amount is the tax-only adjustment only. Available in version 65.0 and later. * `AmountWithTax` —Value of amount is the adjustment, including tax. * `AmountWithoutTax` —Value of amount is the adjustment, not including tax. Tax is calculated on the value and added. * `Percentage` —Value of amount is a percentage discount. It is divided by 100, and then multiplied by the TotalPrice and TotalTaxAmount of the OrderItemSummary to determine the adjustment amount. * `ProductOnly` ——Value of amount is the product-only adjustment only. Available in version 65.0 and later. _Available in: v49.0_ Allowed values: `AmountTaxOnly`, `AmountWithTax`, `AmountWithoutTax`, `Percentage`, `ProductOnly`. * `amount` (_number (double)_, required) Value used to calculate the adjustment amount, as described by the adjustmentType. It must be a negative value. _Available in: v49.0_ * `description` (_string_) Description of the adjustment. _Available in: v49.0_ * `orderItemSummaryId` (_string (Id)_, required) ID of the OrderItemSummary. _Available in: v49.0_ * `reason` (_string_, required) Reason for the adjustment. The value must match one of the picklist values on the Reason field of the OrderItemSummaryChange object. _Available in: v49.0_ ### ChangeItemInput Change to an OrderItemSummary, such as a return or cancel. You specify whether to prorate the associated shipping charge based on the price change. The OrderItemSummary can’t be a shipping charge. * `changeItemFees` (_array of ChangeItemFeeInput_) List of input data for fees associated with the order item being returned or canceled. _Available in: v57.0_ * `orderItemSummaryId` (_string (Id)_, required) ID of the order item summary. _Available in: v48.0_ * `quantity` (_number (double)_, required) Quantity to change. Use a positive value. For example, a value of 2 means “cancel or return 2 units.” _Available in: v48.0_ * `reason` (_string_, required) Reason for the change. The value must match one of the picklist values on the Reason field of the OrderItemSummaryChange object. _Available in: v48.0_ * `reasonForChangeText` (_string_) Reason text used for the return insights. The value has a max of 255 characters. _Available in: v59.0_ * `shippingReductionFlag` (_boolean_, required) Specifies whether to prorate the shipping charge. _Available in: v48.0_ ### ChangeOrderAdjustmentGroupSummaryInput A change to an order adjustment group summary. * `changeType` (_string_, required) Whether a new order adjustment group summary is being created or an existing summary is being updated. Valid values are New or Update. _Available in: v66.0_ * `orderAdjustmentGroupSummary` (_object_, required) The order adjustment group summary sObject representation that contains the changes for the Order Adjustment Group Summary entity. _Available in: v66.0_ Additional properties: `any`. * `referenceId` (_string_) The unique reference ID for this order adjustment group summary. This field is valid only if the Change Type value is New. _Available in: v66.0_ ### ChangeOrderDeliveryGroupSummaryInput A change to an order delivery group summary. * `changeType` (_string_, required) Whether a new order delivery group summary is being created or an existing summary is being updated. Valid values are New or Update. _Available in: v66.0_ * `orderDeliveryGroupSummary` (_object_, required) The order delivery group summary sObject representation that contains the changes for the Order Delivery Group Summary entity. _Available in: v66.0_ Additional properties: `any`. * `referenceId` (_string_) The unique reference ID for this order delivery group summary. This field is valid only if the Change Type value is New. _Available in: v66.0_ ### ChangeOrderItemAdjustmentLineSummaryInput A change to an order item adjustment line summary. * `changeType` (_string_, required) Whether a new order item adjustment line summary is being created or an existing summary is being updated. Valid values are New or Update. _Available in: v66.0_ * `orderItemAdjustmentLineSummary` (_object_, required) The order item adjustment line summary sObject representation that contains the changes for the Order Item Adjustment Line Summary entity. _Available in: v66.0_ Additional properties: `any`. * `referenceId` (_string_) The unique reference ID for this adjustment line summary. This field is valid only if the Change Type value is New. _Available in: v66.0_ ### ChangeOrderItemSummaryInput A change to an order item summary. * `changeType` (_string_, required) Whether a new order item summary is being created or an existing summary is being updated. Valid values are New or Update. _Available in: v66.0_ * `orderItemSummary` (_object_, required) The order item summary sObject representation that contains the changes for the Order Item Summary entity. _Available in: v66.0_ Additional properties: `any`. * `referenceId` (_string_) The unique reference ID for this order item summary. This field is valid only if the Change Type value is New. _Available in: v66.0_ ### ChangeOrderItemTaxLineItemSummaryInput A change to an order item tax line item summary. * `changeType` (_string_, required) Whether a new order item tax line item summary is being created or an existing summary is being updated. Valid values are New or Update. _Available in: v66.0_ * `orderItemTaxLineItemSummary` (_object_, required) The order item tax line item summary sObject representation that contains the changes for the Order Item Tax Line Summary entity. _Available in: v66.0_ Additional properties: `any`. * `referenceId` (_string_) The unique reference ID for this order tax line item summary. This field is valid only if the Change Type value is New. _Available in: v66.0_ ### SequenceOrderPaymentSummaryInput Amount to apply to specified OrderPaymentSummary as part of a payment or refund. * `amount` (_number (double)_, required) Amount to apply to the OrderPaymentSummary. _Available in: v56.0_ * `orderPaymentSummaryId` (_string_, required) ID of the OrderPaymentSummary to apply the Amount to. _Available in: v56.0_ ### InvoiceToPayInput Invoice for a fee. * `invoiceId` (_string_, required) ID of the invoice for a fee. _Available in: v56.0_ ### ProductOutput Output representation for product data. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `expand` (_object_) ProductExpandOutput Output representation for expand feature. _Available in: v59.0_ _Filter group: Big_ Includes all fields of `ProductExpandOutput`. * `product` (_string_) Product data. _Available in: v59.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### LocationAvailabilityInput The available quantity of a product at an inventory location. * `externalReferenceId` (_string_) The external reference ID of the inventory location. _Available in: v51.0_ * `quantity` (_number (double)_, required) The available quantity of the product. _Available in: v51.0_ * `stockKeepingUnit` (_string_, required) The Stock Keeping Unit of the product. _Available in: v51.0_ ### QuantityWithSkuInput A quantity of a product. * `quantity` (_number (double)_, required) Quantity of the product. _Available in: v51.0_ * `stockKeepingUnit` (_string_, required) SKU of the product. _Available in: v51.0_ ### AvailableLocationOutput A set of inventory locations that can combine to fulfill an order. * `locations` (_array of string_) A list of inventory locations. _Available in: v51.0_ _Filter group: Big_ ### FindRoutesWithFewestSplitsGroupUsingOCIInput Data used to calculate inventory availability and fulfillment routes for one order involving the fewest number of shipment splits. * `excludeLocations` (_array of string_) List of locations to exclude from the routing calculations. _Available in: v55.0_ * `maximumNumberOfSplits` (_integer_) The maximum allowable number of shipment splits. Routing options that involve more than this number of splits are not returned. Each split represents an additional shipment. Specifying a maximum of 0 returns only locations that can fulfill the entire order in a single shipment. A maximum of 1 returns combinations of locations that can fulfill the order in one or two shipments, and so on. _Available in: v54.0_ * `orderedItems` (_array of FindRoutesWithFewestSplitsUsingOCIItemInput_) Each list element represents a quantity of a product to be routed for fulfillment and the assigned location group or location. At least one element is required _Available in: v54.0_ ### FindRoutesWithFewestSplitsWithInventoryOutput Sets of inventory locations that can combine to fulfill an order, with availability data for those locations. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `inventory` (_object_) OCIGetInventoryAvailabilityOutput Inventory availability data for the location groups and locations specified in the input. _Available in: v54.0_ _Filter group: Big_ Includes all fields of `OCIGetInventoryAvailabilityOutputCommerceOrdermanagement`. * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ * `targetLocations` (_array of AvailableLocationOutput_) Each entry in the list is a set of inventory locations that can combine to fulfill an order. _Available in: v54.0_ _Filter group: Big_ ### TargetLocationInput A set of inventory locations that together can fulfill an order. * `locations` (_array of LocationInput_, required) A list of locations with information about their country and postal codes. _Available in: v51.0_ ### AverageDistanceResultOutput Wraps inventory location shipping distance calculation results. * `distanceCalculation` (_object_) DistanceCalculationOutput Results of the shipping distance calculations. _Available in: v51.0_ _Filter group: Big_ Includes all fields of `DistanceCalculationOutput`. ### ConfirmHeldFOCapacityRequestInput Request to confirm held fulfillment order capacity at one or more locations. * `allOrNothing` (_boolean_) Controls whether a single failed request cancels all other requests in the list (true) or whether some requests can succeed if others fail (false). The default value is false. _Available in: v55.0_ * `capacityRequests` (_array of CapacityRequestInput_, required) List of requests to confirm held fulfillment order capacity. Each request is for one fulfillment order assigned to one location. _Available in: v55.0_ ### ConfirmHeldFOCapacityResponseOutput Response to a request to confirm held fulfillment order capacity at one or more locations. * `capacityResponses` (_array of CapacityResponseOutput_) List of responses to the requests to confirm held fulfillment order capacity at individual locations. _Available in: v55.0_ _Filter group: Big_ ### LocationCapacityOutput Fulfillment order capacity values for a location. * `assigned` (_integer_) Value of the location’s Assigned Fulfillment Order Count. _Available in: v55.0_ _Filter group: Big_ * `capacity` (_integer_) Value of the location’s Fulfillment Order Capacity. This property represents the location’s maximum capacity. _Available in: v55.0_ _Filter group: Big_ * `error` (_object_) ErrorResponse Error returned by the request, if any. _Available in: v55.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `heldCapacity` (_integer_) Number of fulfillment orders that the location is holding capacity for. _Available in: v55.0_ _Filter group: Big_ * `locationId` (_string_) ID of the location. _Available in: v55.0_ _Filter group: Big_ ### HoldFOCapacityRequestInput Request to hold fulfillment order capacity at one or more locations. * `allOrNothing` (_boolean_) Controls whether a single failed request cancels all other requests in the list (true) or whether some requests can succeed if others fail (false). The default value is false. _Available in: v55.0_ * `capacityRequests` (_array of CapacityRequestInput_, required) List of requests to hold fulfillment order capacity. Each request is for one fulfillment order at one location. _Available in: v55.0_ ### HoldFOCapacityResponseOutput Response to a request to hold fulfillment order capacity at one or more locations. * `capacityResponses` (_array of CapacityResponseOutput_) List of responses to the requests to hold fulfillment order capacity at individual locations. _Available in: v55.0_ _Filter group: Big_ ### ReleaseHeldFOCapacityRequestInput Request to release held fulfillment order capacity at one or more locations. * `allOrNothing` (_boolean_) Controls whether a single failed request cancels all other requests in the list (true) or whether some requests can succeed if others fail (false). The default value is false. _Available in: v55.0_ * `capacityRequests` (_array of CapacityRequestInput_, required) List of requests to release held fulfillment order capacity. Each request is for capacity for one fulfillment order held at one location. _Available in: v55.0_ ### ReleaseHeldFOCapacityResponseOutput Response to a request to release held fulfillment order capacity at one or more locations. * `capacityResponses` (_array of CapacityResponseOutput_) List of responses to the requests to release held fulfillment order capacity at individual locations. _Available in: v55.0_ _Filter group: Big_ ### ProductSearchFacetOutput Product search facet value. * `attributeType` (_string_) Attribute type of the facet value. _Available in: v59.0_ _Filter group: Big_ * `displayName` (_string_) Display name of the facet value. _Available in: v59.0_ _Filter group: Big_ * `displayRank` (_integer_) Display rank of the facet value. _Available in: v59.0_ _Filter group: Big_ * `displayType` (_string_) Display type of the facet value. _Available in: v59.0_ _Filter group: Big_ * `facetType` (_string_) Type of the facet. _Available in: v59.0_ _Filter group: Big_ * `nameOrId` (_string_) Name or ID of the facet. _Available in: v59.0_ _Filter group: Big_ * `values` (_array of ProductSearchFacetValueOutput_) A list of facet values for the search. _Available in: v59.0_ _Filter group: Big_ ### ProductSearchProductOutput Product returned by a product search. * `description` (_string_) Description of the product. _Available in: v59.0_ _Filter group: Big_ * `image` (_object_) ProductSearchImageOutput Image of the product. _Available in: v59.0_ _Filter group: Big_ Includes all fields of `ProductSearchImageOutput`. * `name` (_string_) Name of the product. _Available in: v59.0_ _Filter group: Big_ * `productClass` (_string_) Class of the product. _Available in: v59.0_ _Filter group: Big_ * `stockKeepingUnit` (_string_) Stock Keeping Unit (SKU) of the product. _Available in: v59.0_ _Filter group: Big_ * `variationAttributeSet` (_array of ProductVariationAttributeOutput_) Variation attribute set of the product. _Available in: v59.0_ _Filter group: Big_ ### ProductVariationAttributeOutput Details about a product variation attribute. * `apiName` (_string_) API name of the attribute. _Available in: v55.0_ _Filter group: Big_ * `label` (_string_) Label of the attribute. _Available in: v55.0_ _Filter group: Big_ * `variationAttributeValues` (_array of ProductVariationAttributeValueOutput_) List of valid values for the variation attribute. _Available in: v55.0_ _Filter group: Big_ ### ProductBundleChildOutput Output representation of a product details bundle child. * `description` (_string_) Description of the child product. _Available in: v64.0_ _Filter group: Big_ * `name` (_string_) Child product name. _Available in: v64.0_ _Filter group: Big_ * `productId` (_string_) ProductId of the child product. _Available in: v64.0_ _Filter group: Big_ * `quantity` (_number (double)_) Quantity of the child product per bundle. _Available in: v64.0_ _Filter group: Big_ * `stockKeepingUnit` (_string_) Stock Keeping Unit (SKU) of the child product. _Available in: v64.0_ _Filter group: Big_ ### ProductImageGroupOutput Details about a product image group. * `images` (_array of ProductImageOutput_) List of product images in the group. _Available in: v55.0_ _Filter group: Big_ * `viewType` (_string_) The type of product images in the group. _Available in: v55.0_ _Filter group: Big_ ### ProductQuantityRuleOutput Output representation of the product quantity rule * `increment` (_string_) Increment * `maximum` (_string_) Maximum * `minimum` (_string_) Minimum ### ProductVariantOutput Details about a product variation. * `listPrice` (_number (double)_) List price. _Available in: v55.0_ _Filter group: Big_ * `price` (_number (double)_) Price. _Available in: v55.0_ _Filter group: Big_ * `productId` (_string_) Product ID. _Available in: v55.0_ _Filter group: Big_ * `stockKeepingUnit` (_string_) Stock Keeping Unit. _Available in: v55.0_ _Filter group: Big_ * `unitPrice` (_number (double)_) Unit price. _Available in: v55.0_ _Filter group: Big_ * `variationValues` (_object_) The variation attribute values that define the variation. _Available in: v55.0_ _Filter group: Big_ Additional properties: `string`. ### RefundInstructionsHintInput The payment credit sequence, credit types, and refund sequence that provide information for optimal refund processing. * `paymentCreditSequenceItems` (_array of PaymentCreditSequenceItemInput_, required) The Order Payment Summary ID, credit amount, and credit type for individual payment credit items. Each item represents a specific payment method and the amount of credit to be applied to it. _Available in: v65.0_ * `refundSequenceItems` (_array of RefundSequenceItemInput_, required) The Order Payment Summary ID and amount for the individual refund items in a sequence. Each item has a payment method and refund amount to be processed for that method. _Available in: v65.0_ ### ReturnOrderLineItemInput Data for creating a ReturnOrderLineItem for an order item being returned, including data to create ReturnOrderLineItems representing any return fees associated with it. * `canReduceShipping` (_boolean_, required) Whether to refund any associated shipping charge. _Available in: v50.0_ * `orderItemSummaryId` (_string (Id)_, required) ID of the associated OrderItemSummary. If the OrderItemSummary already has an associated ReturnOrderLineItem, then you must specify a different `reasonForReturn`. Duplicating the reason breaks the financial calculations. _Available in: v50.0_ * `quantityExpected` (_number (double)_, required) Quantity expected to be returned. This value also applies to any fees specified in `returnOrderLineItemFees`. _Available in: v50.0_ * `quantityReceived` (_number (double)_) Quantity already physically returned. _Available in: v50.0_ * `reasonForChangeText` (_string_) Reason text used for the return insights. The value has a max of 255 characters. _Available in: v59.0_ * `reasonForReturn` (_string_) Reason for the return. The value must match an entry in both the OrderSummaryChange Reason field and the ReturnOrderLineItem object’s ReasonForReturn picklist. Required if the `returnOrderLifeCycleType` is MANAGED. _Available in: v50.0_ * `returnOrderLineItemFees` (_array of ReturnOrderLineItemFeeInput_) List of input data for return fees associated with the order item being returned. A ReturnOrderLineItem of Type Fee is created to represent each fee. _Available in: v56.0_ ### ReturnOrderItemDeliveryChargeInput ID of a ReturnOrderLineItem representing a delivery charge. * `returnOrderLineItemId` (_string (Id)_, required) ID of a ReturnOrderLineItem to return. _Available in: v52.0_ ### ReturnOrderItemFeeInput ID of a ReturnOrderLineItem representing a return fee, and instructions for updating it. After the update, the ReturnOrderLineItem is read-only. Any remaining quantity of the fee to be processed is added to a new ReturnOrderLineItem. * `quantityReturned` (_number (double)_, required) Quantity of the ReturnOrderLineItem to process. When the fee is a fixed amount, the charge is determined by multiplying the total fee amount by this value divided by the expected quantity. For example, if the fee amount is $10 and the expected quantity is 2, then if the `quantityReturned` is 1, $5 is charged. This value normally equals the quantity returned of the ReturnOrderLineItem for the returned item that the fee applies to. The value must be greater than zero. If this value plus `quantityToCancel` is less than the expected quantity, then the remaining quantity to be returned is added to a new ReturnOrderLineItem. _Available in: v56.0_ * `quantityToCancel` (_number (double)_, required) Quantity of the ReturnOrderLineItem to remove. This value normally equals the quantity canceled of the ReturnOrderLineItem for the returned item that the fee applies to. This value can also be used to cancel a portion of the fee. The value must be zero or greater. If this value plus `quantityReturned` is less than the expected quantity, then the remaining quantity to be returned is added to a new ReturnOrderLineItem. _Available in: v56.0_ * `returnOrderLineItemId` (_string (Id)_, required) ID of the ReturnOrderLineItem representing the return fee. _Available in: v56.0_ ### ReturnOrderItemInput ID of a ReturnOrderLineItem and instructions for updating it. After the update, the ReturnOrderLineItem is read-only. Any remaining quantity to be returned is added to a new ReturnOrderLineItem. * `quantityReceived` (_number (double)_, required) The quantity of the ReturnOrderLineItem that has been received. The value must be zero or greater. This value isn’t used by any standard features, but is provided for use in customizations. _Available in: v52.0_ * `quantityRejected` (_number (double)_, required) The quantity of the ReturnOrderLineItem that has been rejected for return. The value must be zero or greater. This value isn’t used by any standard features, but is provided for use in customizations. _Available in: v52.0_ * `quantityReturned` (_number (double)_, required) The quantity of the ReturnOrderLineItem that has been returned. The value must be greater than zero. If this value plus quantityToCancel is less than the expected return quantity, then the remaining quantity to be returned is added to a new ReturnOrderLineItem. _Available in: v52.0_ * `quantityToCancel` (_number (double)_, required) The quantity of the ReturnOrderLineItem to remove because it’s not being returned. The value must be zero or greater. If this value plus quantityReturned is less than the expected return quantity, then the remaining quantity to be returned is added to a new ReturnOrderLineItem. _Available in: v52.0_ * `reasonForRejection` (_string_) The reason why the rejected quantity, if any, was rejected. This value isn’t used by any standard features, but is provided for use in customizations. _Available in: v52.0_ * `returnOrderLineItemId` (_string (Id)_, required) The ID of the ReturnOrderLineItem. _Available in: v52.0_ ### RefundInstructionsHintOutput Instructions showing the sequence in which credits and refunds were issued to the customer. * `paymentCreditSequence` (_array of PaymentCreditSequenceItemOutput_) The representation of individual payment credit items. Each item represents a specific payment method and the amount of credit to be applied to it. _Available in: v65.0_ _Filter group: Big_ * `refundSequence` (_array of RefundSequenceItemOutput_) The order payment summary ID and value of the processed refund items. _Available in: v65.0_ _Filter group: Big_ ### ReturnOrderItemSplitLineOutput After a change order is created for a ReturnOrderLineItem, that ReturnOrderLineItem is read-only. If the Return Items API is used to return a partial quantity, it creates a new “split” ReturnOrderLineItem to hold the remaining quantity to be returned. In that case, it returns this output property, which contains the IDs of the original and split ReturnOrderLineItems. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `newReturnOrderItemId` (_string_) ID of the new ReturnOrderLineItem that holds the remaining return quantity. _Available in: v52.0_ _Filter group: Big_ * `originalReturnOrderItemId` (_string_) ID of the original ReturnOrderLineItem. _Available in: v52.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### OrderSummaryGraphInput Graph containing the details of an order summary and supporting records. * `orderSummaryGraphId` (_string_, required) Unique ID of the graph. _Available in: v57.0_ * `purchaseDetails` (_array of ObjectInput_, required) List of record data specific to the order, such as the order items and delivery groups. _Available in: v57.0_ * `purchaseSupportDetails` (_array of ObjectInput_, required) List of support record data for the order, such as the customer account and contact. _Available in: v57.0_ ### ProcessingInstructionsInput Object with Processing Instructions * `accountContactDedupeStrategy` (_string_) Strategy for account contact deduplication * `allowOrderOnlyCustomAttributes` (_boolean_) The strategy for setting flag for custom attribute on Order, OrderItem and OrderDeliveryGroup objects only. * `orderSummaryCreationStrategy` (_string_) The strategy for order summary creation ### OrderSummaryGraphOutput Response from creating a pending order summary based on an order summary graph. * `error` (_object_) ErrorResponse Error details, if applicable. _Available in: v57.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `httpHeaders` (_array of NameValuePairOutput_) List of name-value pairs representing the graph’s HTTP headers. If the pending order summary is successfully created, the name is `Location` and the value is the URI of the pending order summary record. For example: `/services/data/v67.0/sobjects/PendingOrderSummary/29sxx0000000000AAA` _Available in: v57.0_ _Filter group: Big_ * `orderSummaryGraphId` (_string_) ID of the order summary graph used to create the pending order summary. _Available in: v57.0_ _Filter group: Big_ * `success` (_boolean_) Whether the graph was successfully processed. _Available in: v57.0_ _Filter group: Big_ ### DeliveryEstimationProductInput Delivery estimation product information. * `name` (_string_) apex\_methods\_system\_string Product name. _Available in: v63.0_ * `productId` (_string_) apex\_methods\_system\_string ID of the product. _Available in: v63.0_ * `quantity` (_string_, required) apex\_methods\_system\_double Product quantity. _Available in: v63.0_ * `stockKeepingUnit` (_string_, required) apex\_methods\_system\_string Product's stock keeping unit (SKU). _Available in: v63.0_ ### DeliveryEstimateOutput Delivery estimation information for products. * `error` (_object_) DeliveryEstimationErrorOutput Any error that was returned, including the error code and error message. _Available in: v63.0_ Includes all fields of `DeliveryEstimationErrorOutput`. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `location` (_string_) apex\_methods\_system\_string Location external reference. _Available in: v63.0_ * `productDeliverEstimations` (_array of ProductDeliverEstimationOutput_) List of product delivery estimations. _Available in: v63.0_ * `shippingCarrierMethodExternalReference` (_string_) apex\_methods\_system\_string Shipping carrier method external reference. _Available in: v63.0_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### DeliveryAddressInput Delivery address. While each field is optional, at least one combination (latitude and longitude, country and postal code, or city, state, and country) must be included. The fields can't be left empty. * `city` (_string_) apex\_methods\_system\_string City in the state for the delivery address. _Available in: v63.0_ * `country` (_string_) apex\_methods\_system\_string Country code for the delivery address. _Available in: v63.0_ * `latitude` (_string_) apex\_methods\_system\_double Latitude for the delivery address. _Available in: v63.0_ * `longitude` (_string_) apex\_methods\_system\_double Longitude for the delivery address. _Available in: v63.0_ * `postalCode` (_string_) apex\_methods\_system\_string Postal code of the delivery address. _Available in: v63.0_ * `state` (_string_) apex\_methods\_system\_string State in the country for the delivery address. _Available in: v63.0_ ### LocationListInput A list of location identifiers used to specify locations excluded from routing consideration. * `locations` (_array of string_, required) The list of location identifiers to exclude. Don't leave any identifier blank. The list can contain up to 100 items. _Available in: v67.0_ ### RoutingProductInput A product to route, including its stock keeping unit (SKU) and requested quantity. * `quantity` (_number (double)_, required) The quantity of the requested product. Enter a value greater than 0. _Available in: v67.0_ * `stockKeepingUnit` (_string_, required) The product's stock keeping unit (SKU). _Available in: v67.0_ ### BestLocationPerSKUOutput A recommended fulfillment location for a specific SKU, including available quantity and score. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `locationId` (_string_) The location's ID. _Available in: v67.0_ _Filter group: Big_ * `quantityAvailableToOrder` (_integer_) The quantity available to order at this location. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ * `unitScore` (_number (double)_) The score for this SKU at this location. _Available in: v67.0_ _Filter group: Big_ ### RouteOutput A single possible fulfillment route, including its aggregated score and the locations that make up the route. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `locations` (_array of RouteLocationOutput_) The fulfillment locations that make up this route. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ * `totalScore` (_number (double)_) The aggregated score for this route. _Available in: v67.0_ _Filter group: Big_ ### OCIBatchUpdateSingleInput Details of one inventory record to update in a batch update. * `actionRequestId` (_string_, required) Idempotent ID that identifies this request. _Available in: v62.0_ * `attributeSet` (_object_) OCIAttributeSetInput Inventory record attribute set. _Available in: v62.0_ Includes all fields of `OCIAttributeSetInput`. * `effectiveDate` (_string_) Effective date of the update. _Available in: v62.0_ * `externalRefId` (_string_) Unique code, reference, or identifier for the record used by external systems. _Available in: v62.0_ * `futureStock` (_array of OCIFutureStockSingleInput_) Inventory that is expected soon. Included in Available To Order. _Available in: v62.0_ * `locationIdentifier` (_string_, required) Identifier of the location where the inventory is reserved. _Available in: v62.0_ * `onHand` (_number (double)_) Physical inventory available, not including Future Quantity. _Available in: v62.0_ * `safetyStockCount` (_number (double)_) Inventory held in reserve that isn’t included in Available To Order and Available To Fulfill. _Available in: v62.0_ * `stockKeepingUnit` (_string_, required) SKU of the product to update. _Available in: v62.0_ * `targetInventory` (_number (double)_) Target Inventory ### OCIBatchUpdateErrorOutput Error returned from an attempt to batch update inventory. * `details` (_object_) OCIBatchUpdateSingleOutput Details of one updated inventory record. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `OCIBatchUpdateSingleOutput`. * `errorCode` (_string_) Error code, if any. _Available in: v62.0_ _Filter group: Small_ * `message` (_string_) Details of the error, if available. _Available in: v62.0_ _Filter group: Small_ ### OCILocationGroupAvailabilityOutput A set of inventory availability data for one inventory location group. * `inventoryRecords` (_array of OCIInventoryRecordOutput_) A list of availability data for individual products. The data combines the quantities for all locations belonging to this location group. _Available in: v51.0_ _Filter group: Big_ * `locationGroupIdentifier` (_string_) The identifier of the location group. _Available in: v51.0_ _Filter group: Big_ ### OCILocationAvailabilityOutput Output representation of one location’s inventory availability * `inventoryRecords` (_array of OCIInventoryRecordOutput_) The Inventory Records _Available in: v51.0_ _Filter group: Big_ * `locationIdentifier` (_string_) The Location Identifier _Available in: v51.0_ _Filter group: Big_ ### OCIFulfillReservationSingleInput An inventory reservation to fulfill. * `actionRequestId` (_string_, required) A UUID that identifies the request. Use the action request IDs in response data to identify which requests succeeded or failed. _Available in: v51.0_ * `externalRefId` (_string_) The external reference ID of the location that’s fulfilling the reservation. _Available in: v51.0_ * `locationIdentifier` (_string_, required) The identifier of the location that’s fulfilling the reservation. _Available in: v51.0_ * `quantity` (_number (double)_, required) The quantity being fulfilled. _Available in: v51.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v58.0_ * `stockKeepingUnit` (_string_, required) The SKU of the product being fulfilled. _Available in: v51.0_ ### OCIFulfillReservationErrorOutput Response to a request to fulfill one inventory reservation. * `details` (_object_) OCIFulfillReservationSingleOutput Details of the fulfilled reservation, if successful. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `OCIFulfillReservationSingleOutput`. * `errorCode` (_string_) Error code, if any. _Available in: v51.0_ _Filter group: Small_ * `message` (_string_) Details of the error, if available. _Available in: v51.0_ _Filter group: Small_ ### OCIReleaseReservationSingleInput A single inventory reservation to release. * `actionRequestId` (_string_, required) A UUID that identifies the request. Use the action request IDs in response data to identify which requests succeeded or failed. _Available in: v51.0_ * `externalRefId` (_string_) The external reference ID of the location or location group that has the reservation. _Available in: v51.0_ * `locationGroupIdentifier` (_string_) The identifier of the location group that has the reservation. The identifier for a location or location group, but not both, is required. _Available in: v51.0_ * `locationIdentifier` (_string_) The identifier of the location that has the reservation. The identifier for a location or location group, but not both, is required. _Available in: v51.0_ * `quantity` (_number (double)_, required) The quantity of reserved inventory to release. _Available in: v51.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v58.0_ * `stockKeepingUnit` (_string_, required) The SKU of the product to release. _Available in: v51.0_ ### OCIReleaseReservationErrorOutput Response to a request to release one inventory reservation. * `details` (_object_) OCIReleaseReservationSingleOutput Details of the released reservation, if successful. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `OCIReleaseReservationSingleOutput`. * `errorCode` (_string_) Error code, if any. _Available in: v51.0_ _Filter group: Small_ * `message` (_string_) Details of the error, if available. _Available in: v51.0_ _Filter group: Small_ ### OCICreateReservationSingleInput A quantity of a product and an Omnichannel Inventory location or location group at which to reserve it. * `locationGroupIdentifier` (_string_) Identifier of the location group at which to reserve inventory. Either locationGroupIdentifier or locationIdentifier is required, but not both _Available in: v51.0_ * `locationIdentifier` (_string_) Identifier of the location at which to reserve inventory. Either locationGroupIdentifier or locationIdentifier is required, but not both _Available in: v51.0_ * `quantity` (_number (double)_, required) The quantity of the product to reserve. _Available in: v51.0_ * `stockKeepingUnit` (_string_, required) The SKU of the product to reserve. _Available in: v51.0_ ### OCICreateReservationSingleOutput Details of an inventory reservation for one product. * `errorCode` (_string_) The error code, if any. _Available in: v51.0_ _Filter group: Small_ * `locationGroupIdentifier` (_string_) Identifier of the location group where the inventory is reserved. _Available in: v51.0_ _Filter group: Small_ * `locationIdentifier` (_string_) Identifier of the location where the inventory is reserved. _Available in: v51.0_ _Filter group: Small_ * `quantity` (_number (double)_) The reserved quantity of the product. _Available in: v51.0_ _Filter group: Small_ * `stockKeepingUnit` (_string_) The SKU of the reserved product. _Available in: v51.0_ _Filter group: Small_ ### OCICreateReservationErrorOutput Error returned from an attempt to create an Omnichannel Inventory reservation. * `errorCode` (_string_) The error code. _Available in: v51.0_ _Filter group: Small_ * `message` (_string_) Details of the error, if available. _Available in: v51.0_ _Filter group: Small_ ### OCITransferReservationSingleInput An inventory reservation transfer. * `actionRequestId` (_string_, required) A UUID that identifies the request. Use the action request IDs in response data to identify which requests succeeded or failed. _Available in: v51.0_ * `externalRefId` (_string_) The external reference ID of the location receiving the transfer. _Available in: v51.0_ * `fromLocationGroupIdentifier` (_string_) The identifier of the location group sending the reservation. The identifier for a sending location or location group, but not both, is required _Available in: v51.0_ * `fromLocationIdentifier` (_string_) The identifier of the location sending the reservation. The identifier for a sending location or location group, but not both, is required _Available in: v51.0_ * `ignoreAvailabilityCheck` (_boolean_) If true, force the transfer even if the receiving location doesn’t have sufficient available inventory. The default value is false. _Available in: v52.0_ * `quantity` (_number (double)_, required) The quantity of inventory being transferred. _Available in: v51.0_ * `reservationId` (_string_) The ID of the inventory reservation. _Available in: v58.0_ * `stockKeepingUnit` (_string_, required) The SKU of the product being transferred. _Available in: v51.0_ * `toLocationGroupIdentifier` (_string_) The identifier of the location group receiving the reservation. The identifier for a receiving location or location group, but not both, is required _Available in: v51.0_ * `toLocationIdentifier` (_string_) The identifier of the location receiving the reservation. The identifier for a receiving location or location group, but not both, is required _Available in: v51.0_ ### OCITransferReservationErrorOutput Response to a request to fulfill one inventory reservation. * `details` (_object_) OCITransferReservationSingleOutput Details of the transferred reservation, if successful. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `OCITransferReservationSingleOutput`. * `errorCode` (_string_) Error code, if any. _Available in: v51.0_ _Filter group: Small_ * `message` (_string_) Details of the error, if available. _Available in: v51.0_ _Filter group: Small_ ### OCIUpdateReservationSingleInput Data to update one Omnichannel Inventory reservation item. * `locationGroupIdentifier` (_string_) Identifier of the location group where the inventory is reserved. Either locationGroupIdentifier or locationIdentifier are required, but not both _Available in: v61.0_ * `locationIdentifier` (_string_) Identifier of the location where the inventory is reserved. Either locationGroupIdentifier or locationIdentifier are required, but not both _Available in: v61.0_ * `quantity` (_number (double)_, required) The quantity of the product to update. _Available in: v61.0_ * `stockKeepingUnit` (_string_, required) The SKU of the product to update. _Available in: v61.0_ ### OCIUpdateReservationSingleOutput Details of an updated reservation for one product. * `adjustment` (_number (double)_) The total reservation adjustment _Available in: v61.0_ _Filter group: Small_ * `errorCode` (_string_) The error code, if any. _Available in: v61.0_ _Filter group: Small_ * `locationGroupIdentifier` (_string_) Identifier of the location group where the inventory is reserved. _Available in: v61.0_ _Filter group: Small_ * `locationIdentifier` (_string_) Identifier of the location where the inventory is reserved. _Available in: v61.0_ _Filter group: Small_ * `quantity` (_number (double)_) The total reservation quantity of the product. _Available in: v61.0_ _Filter group: Small_ * `stockKeepingUnit` (_string_) The SKU of the updated product. _Available in: v61.0_ _Filter group: Small_ ### OCIUpdateReservationErrorOutput Error returned from an attempt to update an Omnichannel Inventory reservation. * `errorCode` (_string_) The error code. _Available in: v61.0_ _Filter group: Small_ * `message` (_string_) Details of the error, if available. _Available in: v61.0_ _Filter group: Small_ ### LocationGroupCheckAvailabilityInput Information needed to check inventory availability in a location group. * `includeInventoryLevel` (_boolean_) Include inventory levels. _Available in: v60.0_ * `locationGroupId` (_string_, required) Location group ID. _Available in: v60.0_ * `products` (_array of ProductCheckAvailabilityInput_, required) List of products in inventory. _Available in: v60.0_ ### LocationCheckAvailabilityInput Information needed to check inventory availability at an individual location. * `includeInventoryLevel` (_boolean_) Include inventory levels. _Available in: v60.0_ * `locationId` (_string_, required) Location ID. _Available in: v60.0_ * `products` (_array of ProductCheckAvailabilityInput_, required) List of products in inventory. _Available in: v60.0_ ### LocationGroupCheckAvailabilityOutput Inventory product availability for a location group. * `inventoryProducts` (_array of InventoryProductCheckAvailabilityOutput_) List of inventory products. _Available in: v60.0_ _Filter group: Big_ * `locationGroupId` (_string_) Location group ID. _Available in: v60.0_ _Filter group: Big_ ### LocationCheckAvailabilityOutput Inventory product availability for a location. * `inventoryProducts` (_array of InventoryProductCheckAvailabilityOutput_) List of inventory products. _Available in: v60.0_ _Filter group: Big_ * `locationId` (_string_) Location ID. _Available in: v60.0_ _Filter group: Big_ ### LocationGroupLevelsOutput Inventory location group levels data. * `inventoryProducts` (_array of InventoryProductOutput_) List of products in inventory. _Available in: v60.0_ _Filter group: Big_ * `locationGroupId` (_string_) ID of the location group. _Available in: v60.0_ _Filter group: Big_ ### LocationLevelsOutput Inventory location levels data. * `inventoryProducts` (_array of InventoryProductOutput_) List of products in inventory. _Available in: v60.0_ _Filter group: Big_ * `locationId` (_string_) Location ID. _Available in: v60.0_ _Filter group: Big_ ### InventoryProductOutput Inventory product data. * `availableToFulfill` (_number (double)_) Available To Fulfill quantity. _Available in: v60.0_ _Filter group: Big_ * `availableToOrder` (_number (double)_) Available To Order quantity. _Available in: v60.0_ _Filter group: Big_ * `onHand` (_number (double)_) On Hand quantity. _Available in: v60.0_ _Filter group: Big_ * `product2Id` (_string_) Product ID. _Available in: v60.0_ _Filter group: Big_ * `stockKeepingUnit` (_string_) Product SKU. _Available in: v60.0_ _Filter group: Big_ * `variants` (_array of InventoryProductOutput_) The product inventory level for variants _This property is recursive: each item has the same structure as `InventoryProductOutput`._ ### InvoiceActionEnum Type of invoice to be created. _Available in: v62.0_ Type: `string`. Allowed values: `Draft`, `Pending`, `Posted`. ### InvoiceAPIConfigurationOverrideInput Input representation of the additional configuration settings to specify whether the generation of payment schedules and payment schedule items must be skipped. * `paymentExclusionReason` (_string_) The reason for the exclusion of the payment for the invoice. _Available in: v63.0_ * `shouldExcludePayment` (_boolean_) Indicates whether to exclude the payment during invoice generation and skip creating the payment schedules and payment schedule items for the invoice ( `true` ) or not ( `false` ). The default value is `false` . _Available in: v63.0_ ### ConnectCartAsyncOperationStatusEnum Async operation status of the cart. Type: `string`. Allowed values: `Completed`, `Errored`, `Processing`. ### CartMessagesSummary Cart messages summary. * `errorCount` (_integer_) In the Cart Item Result, the count of messages with the `Error` severity level. In `ConnectApi.CartItemResult`, the count of messages with the `Error` severity level. _Available in: v49.0_ _Filter group: Small_ * `hasErrors` (_boolean_) Specifies whether there are messages related to the entity (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `limitedMessages` (_array of CartMessage_) 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 entity, and each message supports multiple languages. In `ConnectApi.CartItemResult`, a limited list of messages related to the cart item. In `ConnectApi.CartSummary`, each message can be related to the cart or to another cart-related entity. _Available in: v49.0_ _Filter group: Small_ * `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 entity. In `ConnectApi.CartItemResult`, the ID of the related cart item. In `ConnectApi.CartSummary`, each message can be related to the cart or to another cart-related entity. _Available in: v49.0_ _Filter group: Small_ * `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. _Available in: v50.0_ _Filter group: Small_ ### ConnectCartStatusEnum The status of a cart. Type: `string`. Allowed values: `Active`, `Checkout`, `Closed`, `PendingClosed`, `PendingDelete`, `Processing`. ### ConnectCartTaxTypeEnum Tax type of the cart. Type: `string`. Allowed values: `Automatic`, `Gross`, `Net`. ### ConnectCartTypeEnum Type of cart. Type: `string`. Allowed values: `Cart`, `PayNowReadOnly`, `ReadOnly`, `Template`. ### DeliveryGroupV2 Delivery Group Representation * `availableDeliveryMethods` (_array of DeliveryMethodV2_) List of available delivery methods * `customFields` (_array of object_) Delivery Group Custom Fields Additional properties: `any`. * `deliveryAddress` (_CheckoutAddressV2_) * `desiredDeliveryDate` (_string (date-time)_) Date when customer wants items delivered * `giftMessage` (_string_) Delivery Group Gift Message * `giftToName` (_string_) Delivery Group Gift To Name * `id` (_string (Id)_) Delivery group Id * `isAllDigitalCartItems` (_boolean_) If all the Items in delivery group are digital or not * `isDefault` (_boolean_) If the delivery group is default or not * `isGift` (_boolean_) If the delivery group is a gift or not * `name` (_string_) Delivery Group Name * `selectedDeliveryMethod` (_DeliveryMethodV2_) * `shippingInstructions` (_string_) Special shipping and handling instructions * `totalCartItemCount` (_integer_) Total cart item count in a delivery group where cart item type is PRODUCT * `totalCartItemQuantity` (_number (double)_) Total PRODUCT type cart items including quantity in a delivery group in Double format ### InvalidParameter Invalid Parameter Representation * `detail` (_string_) Detailed message about the invalid parameter. _Available in: v55.0_ _Filter group: Small_ * `name` (_string_) Name of the invalid parameter. _Available in: v55.0_ _Filter group: Small_ ### CheckoutOrderActionParametersInput Input representation of the Checkout order action parameters request. * `registrationAccountId` (_string_) Registered account ID of the guest user. _Available in: v64.0_ ### AbstractCartItem The abstract representation class for cart item * `billingFrequency` (_ConnectBillingFrequencyEnum_) * `cartDeliveryGroupId` (_string (Id)_) The ID of the CartDeliveryGroup. * `cartId` (_string (Id)_) The ID of the Cart. * `cartItemId` (_string (Id)_) The ID of the CartItem. * `childProductCount` (_integer_) The number of child cart items associated with this cart item. * `customFields` (_array of object_) The custom fields for this cart item. Additional properties: `any`. * `isConfigurationAllowed` (_boolean_) Indicates whether configuration is allowed on the cart item. This is true for dynamic bundle cart items and false for all others. * `isShippingChargeNotApplicable` (_boolean_) Set this field to true to waive shipping charges. When set to true, the cart item is classified as a digital good; otherwise, it is treated as a physical good. * `messagesSummary` (_CartMessagesSummary_) * `name` (_string_) The name of this CartItem, may be a product name or charge description. * `parentCartItemId` (_string (Id)_) The Id of the parent Cart Item for this CartItem. * `productDetails` (_CartProductSummary_) * `productId` (_string (Id)_) The Id of the product for this CartItem. * `productSellingModelId` (_string_) The ID of the ProductSellingModel associated with Product2. * `promotionDisplayName` (_string_) Promotion Display Name for Bonus product only. * `quantity` (_string_) The quantity of the CartItem. * `sellingModelType` (_ConnectSellingModelTypeEnumCommerceBuyerexperience_) * `subType` (_ConnectCartItemSubTypeEnum_) * `subscriptionTerm` (_integer_) The number of terms over which the subscription spans. * `type` (_ConnectCartItemTypeEnum_) ### CommerceProductDynamicAttribute Represents the dynamic product attributes. * `displayValue` (_string_) The Display Value of Attribute. * `name` (_string_) The Name of Attribute. * `type` (_string_) The Type of the Attribute value. * `unitOfMeasure` (_UnitOfMeasure_) * `value` (_string_) The Value of Attribute. ### ConnectProductClassEnumCommerceBuyerexperience Indicates the Product Class enum values. Type: `string`. Allowed values: `Bundle`, `Set`, `Simple`, `Variation`, `VariationParent`. ### PurchaseQuantityRuleCommerceEinstein Represents a rule that restricts the quantity of a product that may be purchased * `increment` (_string_) Increment value of the quantity that can be purchased. _Available in: v52.0_ _Filter group: Small_ * `maximum` (_string_) Maximum quantity that can be purchased. _Available in: v52.0_ _Filter group: Small_ * `minimum` (_string_) Minimum quantity that can be purchased. _Available in: v52.0_ _Filter group: Small_ ### ProductMediaCommerceBuyerexperience Representation of a media associated with a product * `alternateText` (_string_) Alternative text for the product media. _Available in: v49.0_ _Filter group: Small_ * `contentVersionId` (_string (Id)_) 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. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the product image. _Available in: v49.0_ _Filter group: Small_ * `mediaType` (_string_) Type of product media. _Available in: v49.0_ _Filter group: Small_ Allowed values: `Document`, `Image`, `Video`. * `sortOrder` (_integer_) Sort order of a media item within a media group. _Available in: v49.0_ _Filter group: Small_ * `thumbnailUrl` (_string (url)_) 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. _Available in: v49.0_ _Filter group: Small_ * `title` (_string_) Title of the product media. _Available in: v49.0_ _Filter group: Small_ * `url` (_string (url)_) URL of the product media. _Available in: v49.0_ _Filter group: Small_ ### CartProductAttributeCommerceWishlist Represents product attributes for cartItems. * `label` (_string_) Label or display name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence of the attribute within the attribute set. _Available in: v50.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v50.0_ _Filter group: Small_ ### Reference A reference to a record. * `id` (_string_) The ID of the record being referenced, which could be an 18-character ID or some other string identifier. _Available in: v23.0_ _Filter group: Small_ * `url` (_string (url)_) The URL to the resource endpoint. _Available in: v23.0_ _Filter group: Small_ ### OrderSummaryAdjustmentAggregatesStatusEnum Order summary adjustment aggregate job status. Values are: * `Failed` —The adjustment aggregate data job for the order summary failed. * `InProgress` —The adjustment aggregate data job for the order summary is in progress. * `NotInitiated` —The adjustment aggregate data job for the order summary is not initiated. * `Submitted` —The adjustment aggregate data job for the order summary is submitted. _Available in: v55.0_ _Filter group: Small_ Type: `string`. Allowed values: `Failed`, `InProgress`, `NotInitiated`, `Submitted`. ### ConnectOrderSummaryAdjustmentTargetTypeEnum Type of price adjustment in promotions. Values are: * `SplitLine` —Price adjustment on an order item. * `Header` —Price adjustment on the entire order. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Header`, `SplitLine`. ### OrderDeliveryMethodLookupOutput Order delivery method lookup output. * `fields` (_object_) Map of requested order delivery method fields. _Available in: v58.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) ID of the order delivery method. _Available in: v58.0_ _Filter group: Small_ ### OrderItemSummaryLookupOutput Order item summary lookup output. * `adjustmentAggregates` (_object_) OrderItemSummaryAdjustmentAggregates Adjustment aggregates for the order item summary. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `OrderItemSummaryAdjustmentAggregates`. * `adjustments` (_array of OrderSummaryAdjustment_) Adjustments associated with the order item summary. _Available in: v58.0_ _Filter group: Small_ * `associatedLineItems` (_array of OrderItemSummaryLookupOutput_) Child product line items associated with the order item summary. _This property is recursive: each item has the same structure as `OrderItemSummaryLookupOutput`._ _Available in: v62.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the order item summary record. _Available in: v58.0_ _Filter group: Small_ * `fields` (_object_) Map of requested order item summary fields. _Available in: v58.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) ID of the order item summary. _Available in: v58.0_ _Filter group: Small_ * `itemClass` (_object_) ConnectProductClassEnum Determine whether a product is sold individually or can have variations. Possible values are: * `Bundle` —A set of products that are grouped and sold as a single unit for one price. * `Set` —A product set is a collection of related products. The parent product is grouped with related child products. * `Simple` —A product without any variations. * `Variation` —A product with variations. For example, size and color options can be added to a t-shirt. * `Variation_Parent` —A collection of product variations grouped under their respective parent products through product variation grouping. _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnumCommerceBuyerexperience`. * `processExceptions` (_array of ProcessExceptionOutputCommerceBuyerexperience_) Process exceptions information for an order item summary. _Available in: v63.0_ _Filter group: Small_ * `product` (_object_) OrderSummaryProductLookupOutput Details of the product associated with order item summary. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `OrderSummaryProductLookupOutput`. * `productSellingModel` (_object_) ProductSellingModel Product selling model information for an order item summary. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ProductSellingModelCommerceBuyerexperience`. * `type` (_string_) Type of the order item (Product or Shipping Charge) ### OrderPaymentMethod Details for the order payment method. * `fields` (_object_) Map of order payment method fields. _Available in: v63.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `id` (_string (Id)_) ID of an order payment method record. _Available in: v63.0_ _Filter group: Small_ ### OrderSummaryProductAttribute Order summary product attribute representation. * `label` (_string_) Label or display name of the attribute. _Available in: v58.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence of the attribute set with regard to the product. _Available in: v58.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v58.0_ _Filter group: Small_ ### OrderItemSummaryAdjustmentAggregates Adjustment aggregates associated with an Order Item Summary record. * `available` (_boolean_) Indicates whether adjustment aggregates are available (`true`) or not (`false`). _Available in: v55.0_ _Filter group: Small_ * `status` (_object_) OrderSummaryAdjustmentAggregatesStatusEnum Order summary adjustment aggregate job status. * `Failed` —The adjustment aggregate data job for the order summary failed. * `InProgress` —The adjustment aggregate data job for the order summary is in progress. * `NotInitiated` —The adjustment aggregate data job for the order summary is not initiated. * `Submitted` —The adjustment aggregate data job for the order summary is submitted. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `OrderSummaryAdjustmentAggregatesStatusEnum`. * `totalLinePromotionAmount` (_string_) Total of all line item promotions applied to this specific product. _Available in: v55.0_ _Filter group: Small_ * `totalPromotionDistAmount` (_string_) Total of all order level promotions applied to this specific product. _Available in: v55.0_ _Filter group: Small_ ### OrderItemSummaryProduct Product mapped to an order item summary. * `canViewProduct` (_boolean_) Specifies whether the context user can view the product (`true`) or not (`false`). _Available in: v51.0_ _Filter group: Small_ * `errorCode` (_string_) Error code for the product with errors. _Available in: v51.0_ _Filter group: Small_ * `errorMessage` (_string_) Error message for the product with errors. _Available in: v51.0_ _Filter group: Small_ * `fields` (_object_) Map of the product fields queried. _Available in: v51.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `media` (_object_) ProductMedia Associated product media. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `productAttributes` (_object_) ProductAttributeSetSummary Summary of the product attributes. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ProductAttributeSetSummaryCommerceBuyerexperience`. * `productId` (_string (Id)_) ID of the product. _Available in: v51.0_ _Filter group: Small_ ### ConnectFacetDisplayTypeEnum Display type of the facet. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `CategoryTree`, `DatePicker`, `MultiSelect`, `Range`, `SingleSelect`. ### ConnectFacetValueSortTypeEnum Specifies the sort order for facet values. Type: `string`. Allowed values: `Alphabetical`, `CountBased`, `NumericAsc`, `NumericDesc`. ### ConnectSearchAttributeTypeEnum Type of attribute. When updating facetable attributes, you must include a `ProductCategory` facet with `nameOrId` set to `Id` and `displayType` set to `categoryTree` , as shown in the JSON example. _Available in: v49.0_ Type: `string`. Allowed values: `Custom`, `PricebookEntry`, `Product2`, `ProductAttribute`, `ProductCategory`, `Standard`. ### BoostBuryQueryContextConditionInput Search Boost bury query context conditions * `locales` (_array of string_) Locales for the query context * `type` (_ConnectSearchQueryContextTypeEnum_) * `values` (_array of string_) Values for the query context ### BoostBuryConditionInput Condition for a boost and bury rule. * `attributeNameOrId` (_string_, required) Identifier of the attribute for the condition. Value is `ID`. _Available in: v59.0_ * `attributeType` (_object_) ConnectSearchAttributeTypeEnum Search attribute type. Value is `Product2`. _Available in: v59.0_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `values` (_array of string_, required) List of up to 100 attribute values for the condition. _Available in: v59.0_ ### BoostBuryQueryContextConditionOutput Search Boost bury query context * `locales` (_array of string_) Locales for the boost bury rule context * `type` (_ConnectSearchQueryContextTypeEnum_) * `values` (_array of string_) Values for the boost bury rule context ### BoostBuryConditionOutput Condition for a boost and bury rule. * `attributeNameOrId` (_string_) Identifier of the attribute for the condition. Value is `ID`. _Available in: v59.0_ _Filter group: Small_ * `attributeType` (_object_) ConnectSearchAttributeTypeEnum Search attribute type. Value is `Product2`. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `ConnectSearchAttributeTypeEnum`. * `values` (_array of string_) List of up to 100 attribute values for the condition. _Available in: v59.0_ _Filter group: Small_ ### ConnectCommerceSearchSortRuleDirectionEnum Direction of the sort rule. Values are: * `Ascending` —Sorts in ascending alphanumeric order (A–Z, 0–9). * `Default` —When no direction is defined, sorts by relevance. * `Descending` —Sorts in descending alphanumeric order (Z–A, 9–0). _Available in: v52.0_ _Filter group: Small_ Type: `string`. Allowed values: `Ascending`, `Default`, `Descending`. ### ConnectCommerceSearchSortRuleLabelSuffixEnum Label suffix of the sort rule. Values are: * `Ascen` —Label suffix for 'Asc' * `Ascending` —Label suffix for 'Ascending' * `Az` —Label suffix for 'A-Z' * `Descen` —Label suffix for 'Desc' * `Descending` —Label suffix for 'Descending' * `FewMany` —Label suffix for 'Few-Many' * `HeavyLight` —Label suffix for 'Heavy-Light' * `HighLow` —Label suffix for 'High-Low' * `HighestLowest` —Label suffix for 'Highest-Lowest' * `LightHeavy` —Label suffix for 'Light-Heavy' * `LowHigh` —Label suffix for 'Low-High' * `LowestHighest` —Label suffix for 'Lowest-Highest' * `ManyFew` —Label suffix for 'Many-Few' * `NewOld` —Label suffix for 'New-Old' * `Newest` —Label suffix for 'Newest' * `NewestOldest` —Label suffix for 'Newest-Oldest' * `NineZero` —Label suffix for '9-0' * `OldNew` —Label suffix for 'Old-New' * `Oldest` —Label suffix for 'Oldest' * `OldestNewest` —Label suffix for 'Oldest-Newest' * `PriceDecreasing` —Label suffix for '$$-$' * `PriceIncreasing` —Label suffix for '$-$$' * `ThickThin` —Label suffix for 'Thick-Thin' * `ThinThick` —Label suffix for 'Thin-Thick' * `Za` —Label suffix for 'Z-A' * `ZeroNine` —Label suffix for '0-9' _Available in: v54.0_ _Filter group: Small_ Type: `string`. Allowed values: `Ascen`, `Ascending`, `Az`, `Descen`, `Descending`, `FewMany`, `HeavyLight`, `HighLow`, `HighestLowest`, `LightHeavy`, `LowHigh`, `LowestHighest`, `ManyFew`, `NewOld`, `Newest`, `NewestOldest`, `NineZero`, `OldNew`, `Oldest`, `OldestNewest`, `PriceDecreasing`, `PriceIncreasing`, `ThickThin`, `ThinThick`, `Za`, `ZeroNine`. ### ConnectCommerceSearchSortRuleTypeEnum Type of sort rule. One of these values: * `Custom`: —Custom field or non-product object sort rule. * `ProductAttributeBased`: Sorts by product attribute fields. * `ProductBased`: Sorts by product field data. * `Relevancy`: Sorts by product and catalog term frequency. * `SortByPricebook`: Sorts by product prices defined in the specified pricebook (version 55.0 and later). Type: `string`. Allowed values: `Custom`, `ProductAttributeBased`, `ProductBased`, `Relevancy`, `SortByPricebook`. ### ConnectCommerceSortStandardFieldEnum A standard field typically used for sorting (for example, Name, StockKeepingUnit, CreatedDate, Family, or ProductCode). Required for ProductAttributeBased or ProductBased sort types. _Available in: v54.0_ Type: `string`. Allowed values: `CreatedDate`, `Family`, `Name`, `ProductCode`, `QuantityUnitOfMeasure`, `StockKeepingUnit`. ### ConnectSearchGroupingOptionEnum Grouping option for search results. Values are: * `BestMatch` —Search results are grouped by the best-match product of the variation group. * `NoGrouping` —Search results aren’t grouped. * `VariationParent` —Search results are grouped by the variation parent. _Available in: v51.0_ Type: `string`. Allowed values: `BestMatch`, `NoGrouping`, `VariationParent`. ### ConnectSearchFacetTypeEnum Search facet type. Value is: _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `DistinctValue`, `Range`. ### ProductCategoryCommerceSearch Representation for basic category data. * `description` (_string_) Description of the category. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the category. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the category. _Available in: v49.0_ _Filter group: Small_ * `urlName` (_string_) Friendly urlName for product category ### ProductSummaryCommerceSearch Product summary. * `defaultImage` (_object_) ProductMedia Default image of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `fields` (_object_) Map of fields belonging to the product. _Available in: v49.0_ _Filter group: Medium_ Additional properties: `FieldValueCommerceSearch`. * `id` (_string (Id)_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the product. _Available in: v49.0_ _Filter group: Small_ * `prices` (_object_) PricingResultLineItem Prices of the product. _Available in: v49.0_ _Filter group: Medium_ Includes all fields of `PricingResultLineItemCommerceEinstein`. * `productClass` (_object_) ConnectProductClassEnum Class of product. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnumCommerceBuyerexperience`. * `productSellingModelInformation` (_object_) CommerceProductSellingModel Product selling model information for the product. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `CommerceProductSellingModelCommerceSearch`. * `purchaseQuantityRule` (_object_) PurchaseQuantityRule If one exists, purchase quantity rule for the product. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRuleCommerceEinstein`. * `urlName` (_string_) SEO-friendly URL name for the product. _Available in: v59.0_ _Filter group: Small_ * `variationAttributeSet` (_object_) ProductAttributeSetSummary Variation attribute set that’s associated with the product. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ProductAttributeSetSummaryCommerceBuyerexperience`. ### DistinctFacetValue Distinct facet value. * `displayMetadata` (_object_) DistinctFacetValueDisplayMetadata Map of metadata required for rendering the facet value. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `DistinctFacetValueDisplayMetadata`. * `displayName` (_string_) Display name of the facet value. _Available in: v49.0_ _Filter group: Small_ * `nameOrId` (_string_) Reserved for internal use. _Available in: v49.0_ _Filter group: Small_ * `productCount` (_integer (int64)_) Number of products in the search result that match the facet value. _Available in: v49.0_ _Filter group: Small_ * `type` (_object_) ConnectSearchFacetTypeEnum Search facet type. Value is: _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectSearchFacetTypeEnum`. ### CommerceProductSummary Summary representation of a product in product search results. * `defaultImage` (_object_) ProductMediaCommerceBuyerexperience Default image of the product. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `fields` (_object_) Map of fields belonging to the product. _Available in: v55.0_ _Filter group: Medium_ Additional properties: `FieldValueCommerceSearch`. * `id` (_string (Id)_) ID of the product. _Available in: v55.0_ _Filter group: Small_ * `isConfigurationAllowed` (_boolean_) Specifies whether the product is configurable for dynamic bundles (`true`) or not (`false`). _Available in: v65.0_ _Filter group: Small_ * `name` (_string_) Name of the product. _Available in: v55.0_ _Filter group: Small_ * `prices` (_object_) PricingResultLineItem Prices of the product. _Available in: v55.0_ _Filter group: Medium_ Includes all fields of `PricingResultLineItem`. * `productClass` (_object_) ConnectProductClassEnum Class of product. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnumCommerceBuyerexperience`. * `productSellingModelInformation` (_object_) CommerceProductSellingModel Product selling model information for the product. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `CommerceProductSellingModelCommerceSearch`. * `productVariationInfo` (_object_) ProductVariationInfo Product variation attributes, metadata, and mappings of attribute combinations to variation product IDs. This field isn't available in stores with displayable fields enabled. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ProductVariationInfoCommerceSearch`. * `purchaseQuantityRule` (_object_) PurchaseQuantityRule If one exists, purchase quantity rule for the product. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRuleCommerceEinstein`. * `urlName` (_string_) SEO-friendly URL name for the product. _Available in: v59.0_ _Filter group: Small_ * `variationAttributeSet` (_object_) CommerceProductAttributeSetSummary Variation attribute set that’s associated with the product. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `CommerceProductAttributeSetSummary`. ### CartAdjustmentGroupInput CartAdjustmentGroup Representation * `adjustmentBasisReference` (_string_) Adjustment Basis Reference * `adjustmentDescription` (_string_) Description of Adjustment * `adjustmentType` (_ConnectAdjustmentTypeEnum_) * `adjustmentValue` (_string_) Price adjustment value * `baseAmount` (_string_) Base Adjustment Amount * `cartId` (_string (Id)_) Cart Id * `id` (_string (Id)_) Id * `priceAdjustmentCauseId` (_string (Id)_) Price Adjustment Cause Id * `priority` (_integer_) The sequence in which adjustments are applied ### CartDeliveryGroupInput Cart Delivery Group Input Representation * `cartDeliveryGroupId` (_string_) Id of CartDeliveryGroup * `cartDeliveryGroupMethods` (_array of CartDeliveryGroupMethodInput_) CartDeliveryGroupMethod List ### CartItemInput An item in a cart. * `cartDeliveryGroupId` (_string (Id)_) ID of the cart delivery group. _Available in: v59.0_ * `cartId` (_string_) Id of Cart * `cartItemPriceAdjustments` (_array of CartItemPriceAdjustmentInput_) Cart Item Price Adjustments * `id` (_string_) Id of Cart Item * `itemDescription` (_string_) Item Description * `itemName` (_string_) Item Name * `listPrice` (_string_) List Price * `product2Id` (_string (Id)_) Product2Id * `productSellingModelId` (_string (Id)_) The ID of the product selling model associated with Product2. _Available in: v59.0_ * `quantity` (_string_, required) Quantity of the cart item. Use a value that can be converted to BigDecimal. _Available in: v49.0_ * `salesPrice` (_string_) Sales Price * `sku` (_string_) SKU * `subType` (_object_) ConnectCartItemSubTypeEnum Subtype of item in a cart. Possible values are: * `Bonus` —A bonus product. * `Gift` —A gift product. _Available in: v64.0_ Includes all fields of `ConnectCartItemSubTypeEnum`. * `subscriptionTerm` (_integer_) The total number of terms in the subscription period. _Available in: v59.0_ * `totalLineBaseAmount` (_string_) Total amount for this cart item, based on sales price and quantity. * `totalListBaseAmount` (_string_) Total amount for this cart item based on list price and quantity * `totalNetAmount` (_string_) TotalNetAmount associated with the cart item. * `type` (_object_) ConnectCartItemTypeEnum Type of item in a cart. Value is `Product`. Required when adding an item to a cart (POST). Not supported when updating an item in a cart (PATCH) _Available in: v49.0_ Includes all fields of `ConnectCartItemTypeEnum`. * `customFields` (_array of SobjectAttributesInputRequest_) 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](https://help.salesforce.com/s/articleView?id=commerce.comm_create_shopper_profile.htm&type=5) 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. _Available in: v61.0_ * `productId` (_string_) ID of the product. Required when adding an item to a cart (POST). Not supported when updating an item in a cart (PATCH) _Available in: v49.0_ ### SobjectAttributesInputRequest Custom fields for an sObject. * `attributes` (_string_, required) Type of sObject, specified in the form `{”type”: “”}` . _Available in: v60.0_ * `` (_string_, required) One or more custom fields, and the Id property of an sObject whose type is specified in the attributes property. For example, if you specified WebCart as the sObject type, you would specify a WebCart Id as the value of the Id property. If you specify an Id, you must set the Id value to the Id of the WebCart or a CartDeliveryGroup in the current checkout session. If you omit the Id property, custom fields are set on the current WebCart or the default CartDeliveryGroup. The custom fields can be of type Checkbox, Currency, Date, Email, LongTextArea, Number, Percent, Phone, Text, TextArea, Url, Address, or Location. Custom fields don’t support updating the `country` and `state` fields of an Address. Instead, specify the `countryCode` and `stateCode`. _Available in: v60.0_ ### CartDeliveryGroupMethodInput Cart Delivery Group Method Input Representation * `cartDeliveryMethodId` (_string_) Id of CartDeliveryMethod * `price` (_string_) Price * `shippingRateId` (_string_) Id of ShippingRate ### ApproachingDiscountOutput Approaching Discount Output Representation * `promotionId` (_string (Id)_) Represents Id of the approaching promotion * `qualifyingAmount` (_string_) Qualifying Amount * `qualifyingProductTotal` (_string_) Qualifying Product Total * `targetType` (_ConnectTargetTypeEnum_) ### BonusProductOutput BonusProduct Output Representation * `adjustmentBasisReference` (_string_) AdjustmentBasisReference * `bonusProductId` (_string_) BonusProductId * `causeId` (_string_) CauseId * `qualifyingItems` (_array of CartItemKeyOutput_) QualifyingItems ### CartAdjustmentGroup Price adjustment that applies to the cart. During checkout, this adjustment is prorated across all eligible items. * `adjustmentBasisReference` (_string_) Reference to coupon, if applicable. _Available in: v56.0_ _Filter group: Small_ * `adjustmentDescription` (_string_) Description of the adjustment. _Available in: v56.0_ _Filter group: Small_ * `adjustmentType` (_object_) ConnectAdjustmentTypeEnum Adjustment type. Possible _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectAdjustmentTypeEnum`. * `adjustmentValue` (_string_) Value of the adjustment. _Available in: v56.0_ _Filter group: Small_ * `baseAmount` (_string_) Base amount of the adjustment. _Available in: v56.0_ _Filter group: Small_ * `cartId` (_string (Id)_) Cart ID associated with the adjustment. _Available in: v56.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the adjustment. _Available in: v56.0_ _Filter group: Small_ * `priceAdjustmentCauseId` (_string (Id)_) ID of the promotion that triggered this adjustment. _Available in: v56.0_ _Filter group: Small_ * `priority` (_integer_) Sequence in which the adjustments are applied. _Available in: v56.0_ _Filter group: Small_ ### CartDeliveryGroupOutput Cart delivery group for a promotion. * `cartDeliveryGroupId` (_string_) ID of the cart delivery group. _Available in: v60.0_ _Filter group: Small_ * `cartDeliveryGroupMethods` (_array of CartDeliveryGroupMethodOutput_) Collection of methods for the delivery group. _Available in: v60.0_ _Filter group: Small_ * `id` (_string_) ID of the cart. _Available in: v60.0_ _Filter group: Small_ ### CartItemOutput Item in a cart. * `cartDeliveryGroupId` (_string (Id)_) ID of the cart delivery group. _Available in: v60.0_ _Filter group: Small_ * `cartId` (_string_) ID of the cart associated with the cart item. _Available in: v56.0_ _Filter group: Small_ * `cartItemPriceAdjustments` (_array of CartItemPriceAdjustment_) List of adjustments for the cart item. _Available in: v56.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the cart item. _Available in: v56.0_ _Filter group: Small_ * `itemDescription` (_string_) Description of the cart item. _Available in: v56.0_ _Filter group: Small_ * `itemName` (_string_) Name of the cart item. _Available in: v56.0_ _Filter group: Small_ * `listPrice` (_string_) List price of the cart item. _Available in: v56.0_ _Filter group: Small_ * `product2Id` (_string (Id)_) Product ID of the cart item. _Available in: v56.0_ _Filter group: Small_ * `quantity` (_string_) Quantity of cart items. _Available in: v56.0_ _Filter group: Small_ * `salesPrice` (_string_) Sales price of the cart item. This is the price per quantity and the value used to compute the discount. _Available in: v56.0_ _Filter group: Small_ * `sku` (_string_) Stock keeping unit of the cart item. _Available in: v56.0_ _Filter group: Small_ * `totalAdjustmentBaseAmount` (_string_) Total adjustment for the cart item. _Available in: v56.0_ _Filter group: Small_ * `totalLineBaseAmount` (_string_) Total amount for the cart item, equal to sales price multiplied by quantity. This is the value used to compute the discount. _Available in: v56.0_ _Filter group: Small_ * `totalListBaseAmount` (_string_) Total amount for the cart item, based on list price and quantity. _Available in: v56.0_ _Filter group: Small_ * `totalNetAmount` (_string_) Total amount for the cart item including all adjustments. _Available in: v56.0_ _Filter group: Small_ * `type` (_object_) ConnectCartItemTypeEnum Type of item in a cart. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectCartItemTypeEnum`. * `billingFrequency` (_string_) Reserved for future use. _Available in: v59.0_ _Filter group: Small_ * `cartData` (_object_) CartItemCollection Collection of items in the cart. _Available in: v64.0_ _Filter group: Small_ Includes all fields of `CartItemCollection`. * `cartItemId` (_string_) ID of the item. If asynchronous cart processing is enabled, this value returns null for POST requests. _Available in: v49.0_ _Filter group: Small_ * `childProductCount` (_integer_) 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. _Available in: v62.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Currency ISO code of the cart. _Available in: v57.0_ _Filter group: Small_ * `customFields` (_array of string_) 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](https://help.salesforce.com/s/articleView?id=commerce.comm_create_shopper_profile.htm&type=5) are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. _Available in: v61.0_ _Filter group: Small_ * `firstPymtTotalAmount` (_string_) For subscription items, the first payment amount after adjustments and taxes. For non-subscription products, the value is the same as `totalAmount`. _Available in: v60.0_ _Filter group: Small_ * `firstPymtTotalListPrice` (_string_) For subscription items, the total list price of the first payment. For non-subscription items, the value is the same as `totalListPrice`. _Available in: v63.0_ _Filter group: Small_ * `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. _Available in: v60.0_ _Filter group: Small_ * `firstPymtTotalTax` (_string_) For subscription items, the tax amount on the first payment. For non-subscription products, the value is the same as `totalTax`. _Available in: v60.0_ _Filter group: Small_ * `isShippingChargeNotApplicable` (_boolean_) Specifies whether the shipping charge for the cart item is waived (`true`) or not (`false`). If the value is `true`, the cart item is classified as a digital product. _Available in: v64.0_ _Filter group: Small_ * `itemizedAdjustmentAmount` (_string_) Total itemized adjustment amount for the item, including promotions and excluding taxes. _Available in: v52.0_ _Filter group: Small_ * `messagesSummary` (_object_) CartMessagesSummaryCommercePromotions Messages summary for the item. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `CartMessagesSummaryCommercePromotions`. * `name` (_string_) Name of the item. _Available in: v49.0_ _Filter group: Small_ * `parentCartItemId` (_string_) ID of the item’s parent cart item. The value is empty if the item is a top-level cart item. _Available in: v62.0_ _Filter group: Small_ * `productClass` (_string_) Class of product. Values are: * `Bundle` * `Set` * `Simple` * `Variation` * `VariationParent` _Available in: v62.0_ _Filter group: Small_ * `productDetails` (_object_) CartItemProduct Summary of the product details. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `CartItemProduct`. * `productId` (_string_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `productSellingModelId` (_string_) Reserved for future use. _Available in: v59.0_ _Filter group: Small_ * `promotionDisplayName` (_string_) Promotion display name for a bonus product. _Available in: v64.0_ _Filter group: Small_ * `sellingModelType` (_string_) Type of product selling model. Values are: * `Evergreen` —A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it. * `OneTime` —A product that isn’t sold as a subscription. * `TermDefined` —A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. _Available in: v60.0_ _Filter group: Small_ Allowed values: `Evergreen`, `OneTime`, `TermDefined`. * `subscriptionTerm` (_integer_) Reserved for future use. _Available in: v59.0_ _Filter group: Small_ * `subType` (_string_) Subtype of item in a cart. Values are: * `Bonus` —A bonus product. * `Gift` —A gift product. _Available in: v64.0_ _Filter group: Small_ Allowed values: `Bonus`, `Gift`. * `totalAdjustmentAmount` (_string_) Total adjustment amount for the item. _Available in: v50.0_ _Filter group: Small_ * `totalAmount` (_string_) Total amount for the item. _Available in: v49.0_ _Filter group: Small_ * `totalListPrice` (_string_) Total list price for the item. _Available in: v49.0_ _Filter group: Small_ * `totalPrice` (_string_) Total price for the item including adjustments but excluding taxes. _Available in: v49.0_ _Filter group: Small_ * `totalTax` (_string_) Total tax for the item. _Available in: v49.0_ _Filter group: Small_ * `unitAdjustedPrice` (_string_) Unit price, including tier level discounts, for the item. This value is informational only and isn’t used in pricing calculations. _Available in: v50.0_ _Filter group: Small_ * `unitAdjustedPriceWithItemAdj` (_string_) Unit price, including both tier and item level discounts, for the item. This value is informational only and isn’t used in pricing calculations. _Available in: v61.0_ _Filter group: Small_ * `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. _Available in: v50.0_ _Filter group: Small_ * `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. _Available in: v61.0_ _Filter group: Small_ ### PromotionPriceAdjustment Price adjustments used in a promotion product evaluation. * `adjustmentAmount` (_string_) Adjustment amount of the promotion. _Available in: v58.0_ _Filter group: Small_ * `adjustmentType` (_object_) ConnectAdjustmentTypeEnum How the price adjustment amount is calculated. * `AdjustmentAmount` —The adjustment is a fixed amount. * `AdjustmentPercentage` —The adjustment is a percentage. _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectAdjustmentTypeEnum`. * `adjustmentValue` (_string_) Value of the price adjustment. _Available in: v58.0_ _Filter group: Small_ * `displayName` (_string_) Localized promotion display name. _Available in: v58.0_ _Filter group: Small_ * `promotionId` (_string_) ID of the promotion. _Available in: v58.0_ _Filter group: Small_ * `termsAndConditions` (_string_) Localized terms and conditions for the promotion. _Available in: v58.0_ _Filter group: Small_ ### ConnectQualifierReferenceTypeEnum Enum for QualifierReference Type Type: `string`. Allowed values: `Transaction`. ### ItemReference Output representation of the item reference. Products and categories are supported for item reference by a promotion. * `id` (_string_) ID of the product or category. _Available in: v62.0_ _Filter group: Small_ * `itemReferenceType` (_object_) ConnectItemReferenceTypeEnum Item reference type. Possible _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectItemReferenceTypeEnum`. * `name` (_string_) Name of the product or category. _Available in: v62.0_ _Filter group: Small_ * `operatorType` (_object_) ConnectPromotionLineItemOperatorTypeEnum Type of operator for the item reference. Possible _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectPromotionLineItemOperatorTypeEnum`. * `value` (_string_) Value of the item referenced. For example, for `Price` in the `itemReferenceType` property, this would be a price value. _Available in: v62.0_ _Filter group: Small_ ### ConnectCompositePromotionQualifierTypeEnum Type of the promotion qualifier. Possible values are: * `Amount` —Minimum spend amount. * `Quantity` —Minimum quantity. _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `Amount`, `Quantity`. ### ConnectSegmentType Type of the promotion segment. Possible _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `BuyerGroup`, `Webstore`. ### ConnectPromotionAdjustmentTypeEnum How the price adjustment is calculated on a promotion. One of these values: * `BonusProduct`: Additional product added to cart at no cost. * `FixedAmountOffLineItemTotal`: Deducts an amount off a product or cost shipping line item. * `FixedAmountOffTransaction`: Deducts a monetary amount off the entire order for a transaction. * `FixedAmountOffUnitPrice`: Deducts an amount off each quantity of a product line item. * `FixedPrice`: Specifies a promotional price for a product, product category, shipping, or shipping rate. * `PercentageDiscount`: Deducts a specified percent from the price of a product, product category, transaction, shipping, or shipping rate. * `TotalFixedPrice`: Specifies a promotional price for a set of products or product categories. Type: `string`. Allowed values: `BonusProduct`, `FixedAmountOffLineItemTotal`, `FixedAmountOffTransaction`, `FixedAmountOffUnitPrice`, `FixedPrice`, `PercentageDiscount`, `TotalFixedPrice`. ### ConnectTargetReferenceTypeEnum Reference type of the promotion target. Possible _Available in: v62.0_ Type: `string`. Allowed values: `Shipping`, `Transaction`. ### PromotionTargetLineItem Line item for a cart item associated with a promotion. * `lineId` (_string_) ID for the line item. _Available in: v53.0_ _Filter group: Small_ ### ItemReferenceInput Input representation of the item reference. Products and categories are supported for item reference by a promotion. * `id` (_string_, required) ID of the product or category. _Available in: v62.0_ * `itemReferenceType` (_object_, required) ConnectItemReferenceTypeEnum Item reference type. Possible _Available in: v62.0_ Includes all fields of `ConnectItemReferenceTypeEnum`. * `name` (_string_, required) Name of the product or category. _Available in: v62.0_ * `operatorType` (_object_, required) ConnectPromotionLineItemOperatorTypeEnum Type of operator for the item reference. Possible _Available in: v62.0_ Includes all fields of `ConnectPromotionLineItemOperatorTypeEnum`. * `value` (_string_, required) Value of the item referenced. For example, for `Price` in the `itemReferenceType` property, this would be a price value. _Available in: v62.0_ ### PaymentConfiguration Payment configuration information for Salesforce Checkout. * `businessAchEnabled` (_boolean_) Is Business ACH Enabled * `paymentMethodManualCaptureEnabled` (_boolean_) Indicates whether manual capture is enabled for the payment method ( `true` ) or not ( `false` ). _Available in: v61.0_ _Filter group: Small_ * `paymentMethodSetDevName` (_string_) Name of the payment method set. _Available in: v61.0_ _Filter group: Small_ ### InventoryDefaultSourceOutput Inventory default source for an application context. * `inventoryCacheTTL` (_integer_) Inventory cache time-to-live (TTL) in seconds. _Available in: v59.0_ _Filter group: Small_ * `inventoryDimension` (_string_) Inventory dimension. _Available in: v59.0_ _Filter group: Small_ * `locationSourceId` (_string (Id)_) Location source ID of the inventory. _Available in: v58.0_ _Filter group: Small_ * `reservationInSeconds` (_integer_) Reservation in seconds. _Available in: v58.0_ _Filter group: Small_ * `webStoreInventoryLocationSourceType` (_string_) Inventory location source type. _Available in: v58.0_ _Filter group: Small_ * `webStoreInventorySourceId` (_string (Id)_) Inventory source ID. _Available in: v58.0_ _Filter group: Small_ ### ConnectShippingTimeUnitEnum Unit of time for processing the shipping order. Possible _Available in: v61.0_ _Filter group: Small_ Type: `string`. Allowed values: `Days`, `Hours`, `Weeks`. ### ShippingRateGroup Output representation of the shipping rate group. * `id` (_string_) ID of the shipping rate group. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the shipping rate group. _Available in: v59.0_ _Filter group: Small_ * `shippingZones` (_array of ShippingZone_) List of shipping zones. _Available in: v59.0_ _Filter group: Small_ ### LineAdjustmentInput Line adjustment input. * `amount` (_string_, required) Adjustment amount. _Available in: v58.0_ * `id` (_string_, required) Adjustment ID. _Available in: v58.0_ * `type` (_object_, required) TaxAdjustmentTypeEnum Type of tax adjustment. Values are: * Promotional – Promotional type tax adjustment. * Tiered – Tiered type tax adjustment. _Available in: v58.0_ Includes all fields of `TaxAdjustmentTypeEnum`. ### TaxesInfo Output representation of the tax rate and tax treatment information for a product. * `countryIsoCode` (_string_) ISO code of the country. _Available in: v56.0_ _Filter group: Small_ * `priority` (_integer_) Priority of the tax treatment. _Available in: v56.0_ _Filter group: Small_ * `stateIsoCode` (_string_) ISO code of the state. _Available in: v56.0_ _Filter group: Small_ * `taxRatePercentage` (_string_) Tax rate percentage for the store. _Available in: v56.0_ _Filter group: Small_ * `taxTreatmentDescription` (_string_) Description of the tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ * `taxTreatmentName` (_string_) Name of the tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ ### TaxAdjustment List of tax adjustments. * `adjustmentTaxAmount` (_string_) Adjustment tax amount. _Available in: v58.0_ _Filter group: Small_ * `countryIsoCode` (_string_) ISO code of the country. Must match one of the valid ISO codes defined within the org’s State-Country picklist. If unspecified, the default value is the default country for the webstore. _Available in: v58.0_ _Filter group: Small_ * `id` (_string_) Adjustment ID. _Available in: v58.0_ _Filter group: Small_ * `stateIsoCode` (_string_) ISO code of the state. Must match one of the valid ISO codes defined within the org’s State-Country picklist. If unspecified, the default value is the default country for the webstore. _Available in: v58.0_ _Filter group: Small_ * `taxRatePercentage` (_string_) Tax rate percentage for the store. _Available in: v58.0_ _Filter group: Small_ * `type` (_object_) TaxAdjustmentTypeEnum Type of tax adjustment. Values are: * Promotional – Promotional type tax adjustment. * Tiered – Tiered type tax adjustment. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `TaxAdjustmentTypeEnum`. ### CalculateTaxesInfo List of calculated tax output. * `countryIsoCode` (_string_) ISO code of the country. _Available in: v56.0_ _Filter group: Small_ * `priority` (_integer_) Priority of the tax treatment. _Available in: v56.0_ _Filter group: Small_ * `stateIsoCode` (_string_) ISO code of the state. _Available in: v56.0_ _Filter group: Small_ * `taxLineAmount` (_string_) Represents tax for particular country or state if present. _Available in: v58.0_ _Filter group: Small_ * `taxRatePercentage` (_string_) Tax rate percentage for the store. _Available in: v56.0_ _Filter group: Small_ * `taxTreatmentDescription` (_string_) Description of the tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ * `taxTreatmentName` (_string_) Name of the tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ ### ConnectElectronicMediaGroupDeveloperNameEnum The API name of the product media group. Possible _Available in: v61.0_ Type: `string`. Allowed values: `Attachment`, `ProductDetailImage`, `ProductListImage`. ### CompositeProductErrorComponents Enum for Entity types errored Type: `string`. Allowed values: `AttributeSet`, `GenericError`, `PriceBookEntry`, `ProductCategory`, `ProductEntitlementPolicyMapping`, `ProductFields`, `ProductMedia`. ### ConnectNavigationMenuItemActionTypeEnum Specifies navigation menu url types Type: `string`. Allowed values: `Event`, `ExternalLink`, `InternalLink`, `Modal`. ### NavigationMenuPageReference Navigation Menu Page Reference * `attributes` (_object_) Attributes for the navigation menu item page reference. _Available in: v59.0_ _Filter group: Small_ Additional properties: `string`. * `state` (_object_) State for the navigation menu item page reference. _Available in: v59.0_ _Filter group: Small_ Additional properties: `string`. * `type` (_string_) Type for the navigation menu item page reference. _Available in: v59.0_ _Filter group: Small_ ### ConnectNavigationMenuItemOpenTargetEnum Specifies navigation menu target types Type: `string`. Allowed values: `CurrentWindow`, `NewWindow`. ### ConnectProductMediaTypeEnum Type of product media. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `Document`, `Image`, `Video`. ### ConnectProductMediaUsageTypeEnum Usage type of a product media item within a media group. Values are: * `Attachment` —Product media group with product documents as attachments. * `Banner` —Product category media group with banner images of the product. * `Listing` —Product media group with listing images of the product. * `Standard` —Product media group with standard images and videos of the product. * `Tile` —Product category media group with tile images of the product. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `Attachment`, `Banner`, `Listing`, `Standard`, `Tile`. ### ProductAttributeSetSummary Summary of a product attribute set. * `apiName` (_string_) API name of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `attributes` (_array of ProductAttributeSummary_) List of attributes in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Display label of the attribute set. _Available in: v50.0_ _Filter group: Small_ ### PricingResultLineItem Pricing result line item. * `error` (_object_) ErrorResponseOutput Error code and message. _Available in: v49.0_ _Filter group: Big_ Includes all fields of `ErrorResponseOutput`. * `listPrice` (_string_) List price for the product. _Available in: v49.0_ _Filter group: Small_ * `lowestUnitPrice` (_string_) Lowest unit price for the product. _Available in: v59.0_ _Filter group: Small_ * `pricebookEntryId` (_string_) ID of the pricebook entry. _Available in: v49.0_ _Filter group: Small_ * `productId` (_string_) ID of the product to price. _Available in: v49.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the execution was successful (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `unitPrice` (_string_) Unit price for the product. _Available in: v49.0_ _Filter group: Small_ ### ProductAttributeInfo Product attribute information. * `allowableValues` (_array of string_) Active attribute picklist values that can be used to create variations. These values are determined by the order of the picklist values in Object Manager. _Available in: v50.0_ _Filter group: Small_ * `apiName` (_string_) API name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `availableValues` (_array of string_) Attribute picklist values that are available for the product in the store. These values are sorted by the order of values in the `allowableValues` property. _Available in: v50.0_ _Filter group: Small_ * `fieldEnumOrId` (_string_) Field ID for custom fields or enumeration value for standard fields. _Available in: v50.0_ _Filter group: Small_ * `groupedBy` (_boolean_) Indicates if the attribute is used to determine grouping. _Available in: v64.0_ _Filter group: Small_ * `label` (_string_) Label of the attribute. _Available in: v50.0_ _Filter group: Small_ * `objectName` (_string_) Name of the object that contains the field. _Available in: v50.0_ _Filter group: Small_ * `options` (_array of ProductAttributeValueMetadata_) List of product attribute value metadata. _Available in: v63.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence value determined by the order of the attributes under Commerce Setup for the attribute set. _Available in: v50.0_ _Filter group: Small_ * `viewType` (_object_) ConnectProductAttributeViewTypeEnum View type for product attributes. _Available in: v63.0_ _Filter group: Small_ Includes all fields of `ConnectProductAttributeViewTypeEnum`. ### ConnectPricingTermUnitEnum Unit of time used to define a pricing term. Values are: * `Months` —Product is priced on a monthly basis. * `Annual` —Product is priced on an annual basis. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Annual`, `Months`. ### ConnectSellingModelTypeEnum Type of product selling model. Values are: * `Evergreen` —A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it. * `OneTime` —A product that isn’t sold as a subscription. * `TermDefined` —A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Evergreen`, `OneTime`, `TermDefined`. ### SubscriptionTermRule Fields necessary to implement the subscription term. * `increment` (_integer_) Number of pricing term units that can be used to increase the subscription term. _Available in: v59.0_ _Filter group: Small_ * `maximum` (_integer_) Maximum number of pricing term units per subscription term. _Available in: v59.0_ _Filter group: Small_ * `minimum` (_integer_) Minimum number of pricing term units per subscription term. _Available in: v59.0_ _Filter group: Small_ ### ProductAttributesToProductEntry Mapping of an attribute value combination to a variation product ID. * `canonicalKey` (_string_) Attribute API values concatenated with an underscore (\_) based on the sequence number of the attributes in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `image` (_ProductMedia_) * `mediaItems` (_array of ProductMedia_) Representation of the listing images of the product. * `productId` (_string (Id)_) Variation product ID for the selection of attributes. _Available in: v50.0_ _Filter group: Small_ * `selectedAttributes` (_array of ProductAttributeSelectionInfo_) Ordered list of attribute values and metadata that can be used to form a key that maps to product ID. _Available in: v50.0_ _Filter group: Small_ * `urlName` (_string_) Variant URL name for the selection of attributes. _Available in: v59.0_ _Filter group: Small_ ### ProductComponentGroup Representation for a product component group associated with the child product. * `id` (_string_) ID of the product component group. _Available in: v65.0_ _Filter group: Small_ * `name` (_string_) Name of the product component group. _Available in: v65.0_ _Filter group: Small_ ### ConnectImportContextEnum Specifies where the import action is triggered from Type: `string`. Allowed values: `Api`, `Global`, `Revenue`, `StoreFront`. ### ImportSettings Import settings applicable to all product rows in a product import .csv file. * `category` (_object_) CategorySettings Category settings for a product import operation. Required for a global import if you specify one or more category-related column headings in your .csv file. For store imports, if you don’t specify a category, import uses the default catalog for the store. _Available in: v54.0_ Includes all fields of `CategorySettings`. * `entitlement` (_object_) EntitlementSettings Entitlement settings for a product import operation. Required for a global import if you specify one or more entitlement-related column headings in your .csv file. For store imports, if you don’t specify an entitlement, import uses the default entitlement for the store. _Available in: v54.0_ Includes all fields of `EntitlementSettings`. * `media` (_object_) MediaSettings Media settings for a product import operation. Required for a global import if you specify one or more media-related column headings in your .csv file. For store imports, if you don’t specify a CMS workspace, import uses the default CMS workspace for the store. _Available in: v54.0_ Includes all fields of `MediaSettings`. * `price` (_object_) PriceSettings Price settings for a product import operation. Required for a global import if you specify one or more price-related column headings in your .csv file. For store imports, if you don’t specify a price, import uses the default price books for the store. _Available in: v54.0_ Includes all fields of `PriceSettings`. * `webstore` (_object_) WebstoreSettings Webstore to associate with an asynchronous product import job. If no webstore is specified, the imported products are made globally available. If webstore is included, the import is for the specified store. ; used only for asynchronous import jobs _Available in: v57.0_ Includes all fields of `WebstoreSettings`. ### ImportSource Specify a product import .csv file for a product import operation. * `contentVersionId` (_string (Id)_) Upload the .csv file to [Salesforce Files](https://help.salesforce.com/s/articleView?id=experience.collab_salesforce_files_parent.htm&type=5) . To get the content version ID, view the file details in the Salesforce Files UI. The second-to-last part of the URL is the content version ID. If you upload the file using the [User Files Connect API](/docs/platform/connect-rest-api/references/connect-rest-api-files#tag/User-Files-Resources/operation/getUserFilesCollection) , the API response includes the content version ID. Required if `sampleData` isn’t specified _Available in: v54.0_ * `sampleData` (_object_) ConnectSampleDataEnum Sample .csv file to import. Values are: * `B2BSampleData` —B2B sample data set. * `Camera` —Camera store sample data set. * `Coffee` —Coffee store sample data set. * `Hardware` —Hardware store sample data set. * `NorthernTrail` —Outdoor goods store sample data set. * `NorthernTrailLarge` —Larger outdoor goods store sample data set. * `Simple` —Two-product sample data set. Required if `contentVersionId` isn’t specified _Available in: v54.0_ Includes all fields of `ConnectSampleDataEnum`. ### Alternative Alternative representation for an extension on a feed element. * `textRepresentation` (_string_) Text representation of the extension. _Available in: v40.0_ _Filter group: Small_ * `thumbnailUrl` (_string_) Thumbnail URL to the extension. _Available in: v40.0_ _Filter group: Small_ * `title` (_string_) Title of the extension. _Available in: v40.0_ _Filter group: Small_ ### PriceAdjustmentScheduleAdjustmentMethodEnum Reserved for future use. _Available in: v59.0_ _Filter group: Small_ Type: `string`. Allowed values: `Range`, `Slab`. ### PriceAdjustmentTier Price adjustment tier. * `adjustmentType` (_object_) PriceAdjustmentTierTypeEnum Type of price adjustment for the tier. Values are: * `AmountBasedAdjustment` —Price is adjusted by a specified amount. * `PercentageBasedAdjustment` —Price is adjusted by a specified percentage. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `PriceAdjustmentTierTypeEnum`. * `adjustmentValue` (_string_) Adjustment value of the tier. _Available in: v49.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the price adjustment tier. _Available in: v49.0_ _Filter group: Small_ * `lowerBound` (_string_) Lower limit of the tier. _Available in: v49.0_ _Filter group: Small_ * `tierUnitPrice` (_string_) Unit price of the tier. _Available in: v49.0_ _Filter group: Small_ * `upperBound` (_string_) Upper limit of the tier. _Available in: v49.0_ _Filter group: Small_ ### PriceAdjustmentScheduleTypeEnum Reserved for future use. _Available in: v59.0_ _Filter group: Small_ Type: `string`. Allowed values: `Term`, `Volume`. ### RenewalPriceDetail Output representation of the Commerce subscription renewal price detail. * `netUnitPrice` (_string_) Forecasted net unit price. _Available in: v67.0_ _Filter group: Small_ * `quantity` (_string_) Renewal quantity. _Available in: v67.0_ _Filter group: Small_ ### ActionDetail Summary of last performed action. * `changes` (_array of FieldChange_) Details of order-related actions. * `errors` (_ErrorResponse_) * `status` (_string_) Status of the last performed action. ### SavedPaymentMethodOutput Payment Saved Payment Method output representation * `accountHolderEmail` (_string_) Email of the customer that holds the saved payment method. _Available in: v58.0_ _Filter group: Small_ * `accountHolderName` (_string_) Name of customer that holds the saved payment method. _Available in: v58.0_ _Filter group: Small_ * `bankAccountType` (_string_) Type of bank account, such as checking or savings. _Available in: v59.0_ _Filter group: Small_ * `bankCode` (_string_) Code of the banking institution that issued the saved payment method. _Available in: v58.0_ _Filter group: Small_ * `bankName` (_string_) Name of the bank that issued the payment method. _Available in: v58.0_ _Filter group: Small_ * `error` (_object_) ErrorResponse Error response if the saved payment method information couldn’t be retrieved. _Available in: v58.0_ _Filter group: Small_ Includes all fields of `ErrorResponse`. * `expiryMonth` (_string_) Month the saved card expires. _Available in: v58.0_ _Filter group: Small_ * `expiryYear` (_string_) Year the saved card expires. _Available in: v58.0_ _Filter group: Small_ * `gatewayCustomerReference` (_string_) Owner associated with the payment method to the payment gateway. _Available in: v60.0_ _Filter group: Small_ * `gatewayRefId` (_string_) ID returned by a payment gateway in a transaction response, indicating that the transaction has happened. _Available in: v59.0_ _Filter group: Big_ * `gatewayResponse` (_object_) Gateway Response Map Additional properties: `object`. * `gatewayToken` (_string_) Token representing the saved payment method that is used for future transactions. _Available in: v58.0_ _Filter group: Small_ * `id` (_string (Id)_) Salesforce ID of the saved payment method record. _Available in: v58.0_ _Filter group: Small_ * `isDefault` (_boolean_) Indicates whether the saved payment method is the default payment method to use for transactions (`true`) or not (`false`). _Available in: v58.0_ _Filter group: Small_ * `isOwner` (_boolean_) Indicates whether the saved payment method is owned by the current logged in user * `isSharedWithinSameAccount` (_boolean_) Indicates whether the saved payment method is shared with other contacts in the same account. * `issuer` (_string_) Issuer of the saved payment method. _Available in: v58.0_ _Filter group: Small_ * `last4` (_string_) Last 4 Digits of the saved card payment method. _Available in: v58.0_ _Filter group: Small_ * `merchantAccountId` (_string_) Salesforce Payments merchant account ID associated with the saved payment method. _Available in: v58.0_ _Filter group: Small_ * `name` (_string_) Name of the saved payment record. _Available in: v58.0_ _Filter group: Small_ * `network` (_string_) Saved payment method card network, for example Visa or Union Pay. _Available in: v58.0_ _Filter group: Small_ * `paymentGatewayId` (_string_) Salesforce ID of the Payment Gateway object record. _Available in: v58.0_ _Filter group: Small_ * `referenceOwnerId` (_string_) Account or Contact record that owns the payment method. _Available in: v58.0_ _Filter group: Small_ * `savedByMerchant` (_boolean_) If saved payment method is created by merchant or not * `status` (_string_) Status of the saved payment method. Possible _Available in: v58.0_ _Filter group: Big_ Allowed values: `Active`, `AwaitingPayment`, `Errored`, `Expired`. * `type` (_string_) Type of saved payment method. Possible values are: * `Au_becs_debit` —BECS * `Bacs_debit` —BACS * `Bancontact` —Bancontact * `Card` —Card * `Ideal` —Ideal * `Sepa_debit` —SEPA Direct Debit * `Us_bank_account` —ACH Direct Debit _Available in: v58.0_ _Filter group: Big_ Allowed values: `Amazon_pay`, `Au_becs_debit`, `Bacs_debit`, `Bancontact`, `Card`, `Ideal`, `Sepa_debit`, `Us_bank_account`. * `usageType` (_string_) Specifies the usage type of the payment method. Possible _Available in: v58.0_ _Filter group: Big_ Allowed values: `OffSession`, `OnSession`. ### ProductAttributeSummaryCommerceBuyerexperience Summary representation of a product attribute * `apiName` (_string_) API name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Display label of the attribute. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence of the attribute in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v50.0_ _Filter group: Small_ ### SubscriptionTermRuleCommerceBuyerexperience Representation of Subscription Term Rules * `increment` (_integer_) Number of pricing term units that can be used to increase the subscription term. _Available in: v59.0_ _Filter group: Small_ * `maximum` (_integer_) Maximum number of pricing term units per subscription term. _Available in: v59.0_ _Filter group: Small_ * `minimum` (_integer_) Minimum number of pricing term units per subscription term. _Available in: v59.0_ _Filter group: Small_ ### InsightsOutput Insight details for a business objective, or goal. * `dashboardUrl` (_string_) URL to the dashboard where the insight can be viewed. _Available in: v62.0_ _Filter group: Small_ * `insightSummaryText` (_string_) A localized, human-readable summary of the insight value's performance, including the change from the previous value. _Available in: v62.0_ _Filter group: Small_ * `name` (_string_) Name of the insight. _Available in: v62.0_ _Filter group: Small_ * `values` (_array of InsightValuesOutput_) List of insight categories. _Available in: v62.0_ _Filter group: Small_ ### ConnectInsightUnitEnum Unit for an insight. _Available in: v59.0_ _Filter group: Small_ Type: `string`. Allowed values: `Count`, `Currency`, `Dollar`, `Number`, `Percent`. ### ExternalManagedAccountAddressOutput Default shipping address for an externally managed account. * `city` (_string_) City of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `country` (_string_) Country of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `geolocationAccuracy` (_string_) Geolocation accuracy of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `latitude` (_string_) Latitude of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `longitude` (_string_) Longitude of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `state` (_string_) State of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `street` (_string_) Street of the external managed account record. _Available in: v53.0_ _Filter group: Small_ * `zip` (_string_) Postal code of the external managed account record. _Available in: v53.0_ _Filter group: Small_ ### ProductSummary Summary representation of a Product in product search results. * `defaultImage` (_object_) ProductMediaCommerceBuyerexperience Default image of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `fields` (_object_) Map of fields belonging to the product. _Available in: v49.0_ _Filter group: Medium_ Additional properties: `FieldValue`. * `id` (_string (Id)_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `name` (_string_) Name of the product. _Available in: v49.0_ _Filter group: Small_ * `prices` (_object_) PricingResultLineItemCommerceEinstein Prices of the product. _Available in: v49.0_ _Filter group: Medium_ Includes all fields of `PricingResultLineItemCommerceEinstein`. * `productClass` (_string_) Class of product. _Available in: v50.0_ _Filter group: Small_ Allowed values: `Bundle`, `Set`, `Simple`, `Variation`, `VariationParent`. * `productSellingModelInformation` (_object_) CommerceProductSellingModel Product selling model information for the product. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `CommerceProductSellingModel`. * `purchaseQuantityRule` (_object_) PurchaseQuantityRuleCommerceEinstein If one exists, purchase quantity rule for the product. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRuleCommerceEinstein`. * `urlName` (_string_) SEO-friendly URL name for the product. _Available in: v59.0_ _Filter group: Small_ * `variationAttributeSet` (_object_) ProductAttributeSetSummaryCommerceBuyerexperience Variation attribute set that’s associated with the product. _Available in: v50.0_ _Filter group: Small_ Includes all fields of `ProductAttributeSetSummaryCommerceBuyerexperience`. ### OrderItemSummaryOutput Details of an OrderItemSummary from a failed FulfillmentOrder in a create multiple fulfillment orders request. * `errors` (_array of ErrorResponseBilling_, nullable) List of errors specific to the OrderItemSummary, if any. _Available in: v50.0_ _Filter group: Big_ * `orderItemSummaryId` (_string (Id)_) ID of the OrderItemSummary. _Available in: v50.0_ _Filter group: Big_ * `quantity` (_number (double)_) Quantity of the OrderItemSummary. _Available in: v50.0_ _Filter group: Big_ * `adjustmentAggregates` (_object_) OrderSummaryAdjustmentAggregatesCommerceOrdermanagement Adjustment aggregates associated with an order item summary. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `OrderSummaryAdjustmentAggregatesCommerceOrdermanagement`. * `fields` (_object_) Map of fields from order item summary and other related objects that were queried. _Available in: v51.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `orderSummaryId` (_string_) ID of the order summary. _Available in: v51.0_ _Filter group: Small_ * `product` (_object_) OrderItemSummaryProductCommerceOrdermanagement Associated product item information. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `OrderItemSummaryProductCommerceOrdermanagement`. ### OrderItemSummaryInput An OrderItemSummary and quantity. * `orderItemSummaryId` (_string (Id)_, required) ID of the OrderItemSummary. _Available in: v48.0_ * `quantity` (_number (double)_, required) Quantity to include. Can't contain a fraction or a decimal. _Available in: v48.0_ ### TextClassificationsResultOutput Text classifications result. * `classificationId` (_string_) Response ID to receive feedback for classification. _Available in: v59.0_ _Filter group: Small_ * `classifications` (_array of ClassificationsOutput_) List of classifications that each text string was given after analysis. _Available in: v59.0_ _Filter group: Big_ * `classificationsId` (_string_) Response identifier to receive feedback for classification. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### ChangeItemFeeInput Input representation for Change Item Fee Input * `amount` (_number (double)_, required) Positive value used to calculate the fee amount, as described by the `amountType`. _Available in: v57.0_ * `amountType` (_string_, required) Describes how the fee amount is calculated. Valid values are: * `AmountWithTax` —Value of `amount` is the fee amount, including tax. * `AmountWithoutTax` —Value of `amount` is the fee amount, not including tax. Tax is calculated on the value and added. * `Percentage` —Value of `amount` is a percentage. To determine the fee amount, `amount` is divided by 100, and then multiplied by the TotalPrice and TotalTaxAmount of the associated OrderItemSummary, prorated for the quantity being returned. * `PercentageGross` —Value of `amount` is a percentage. To determine the fee amount, `amount` is divided by 100, and then multiplied by the TotalLineAmountWithTax of the associated OrderItemSummary, prorated for the quantity being returned. _Available in: v57.0_ Allowed values: `AmountWithTax`, `AmountWithoutTax`, `Percentage`, `PercentageGross`. * `description` (_string_, required) Description of the fee. _Available in: v57.0_ * `priceBookEntryId` (_string_) ID of the price book entry associated with the fee product. Required unless price books are optional in the org _Available in: v57.0_ * `product2Id` (_string_, required) ID of the product representing the fee. _Available in: v57.0_ * `reason` (_string_, required) Reason for the fee. The value must match an entry in the OrderProductSummaryChange object’s Reason picklist. _Available in: v57.0_ ### ProductExpandOutput Expanded product information listing reasons for product returns. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `returnReasons` (_array of string_) Return reasons for products. _Available in: v59.0_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### FindRoutesWithFewestSplitsUsingOCIItemInput A quantity of a product and a location group or location assigned to fulfill it. * `expand` (_array of string_) Expand * `locationGroupIdentifier` (_string_, required) The External Reference of the location group or location assigned to the order item. If you specify a location group, inventory is considered for all locations belonging to that group. _Available in: v54.0_ * `quantity` (_number (double)_, required) Quantity of the product. _Available in: v54.0_ * `stockKeepingUnit` (_string_, required) SKU of the product. _Available in: v54.0_ ### OCIGetInventoryAvailabilityOutputCommerceOrdermanagement Output representation of inventory availability * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `locationGroups` (_array of OCILocationGroupAvailabilityOutputCommerceOrdermanagement_) Location Groups Availability * `locations` (_array of OCILocationAvailabilityOutputCommerceOrdermanagement_) Locations Availability * `success` (_boolean_) Indicates whether the transaction was successful. ### LocationInput Inventory location data used to calculate shipping distance. * `countryCode` (_string_, required) The country code of the location. _Available in: v51.0_ * `locationIdentifier` (_string_, required) The identifier of the location. _Available in: v51.0_ * `postalCode` (_string_, required) The postal code of the location. _Available in: v51.0_ ### DistanceCalculationOutput Shipping distance data for a set of inventory locations. * `averageDistance` (_number (double)_) The average distance from the locations to the order recipient. _Available in: v51.0_ _Filter group: Big_ * `locations` (_array of LocationOutput_) The list of locations and their distances to the order recipient. _Available in: v51.0_ _Filter group: Big_ * `rank` (_integer_) This result’s rank among all results by average distance to the order recipient. _Available in: v51.0_ _Filter group: Big_ ### CapacityRequestInput Request related to a location’s fulfillment order capacity. * `actionRequestId` (_string_, required) Unique string that identifies the request. Can be a UUID. Use the action request IDs in response data to identify which requests succeeded or failed. _Available in: v55.0_ * `locationId` (_string (Id)_, required) ID of the location associated with the request. _Available in: v55.0_ ### CapacityResponseOutput Response to a request related to a location’s fulfillment capacity. * `actionRequestId` (_string_) Unique string that identifies the original capacity request. _Available in: v55.0_ _Filter group: Big_ * `error` (_object_) ErrorResponse Error returned by the request, if any. _Available in: v55.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `success` (_boolean_) Indicates whether the request was successful. _Available in: v55.0_ _Filter group: Big_ ### ProductSearchFacetValueOutput Product search facet value. * `displayName` (_string_) Display name of the search facet. _Available in: v59.0_ _Filter group: Big_ * `nameOrId` (_string_) Unique name or ID of the search facet. _Available in: v59.0_ _Filter group: Big_ * `productCount` (_integer_) Number of products found with the search facet. _Available in: v59.0_ _Filter group: Big_ * `type` (_string_) Type of the search facet. _Available in: v59.0_ _Filter group: Big_ ### ProductSearchImageOutput Product search image. * `alternateText` (_string_) Alternate text for the product image. _Available in: v59.0_ _Filter group: Big_ * `mediaType` (_string_) Media type of the product image. _Available in: v59.0_ _Filter group: Big_ * `sortOrder` (_integer_) Sort order of the product image. _Available in: v59.0_ _Filter group: Big_ * `title` (_string_) Title of the product image. _Available in: v59.0_ _Filter group: Big_ * `url` (_string_) URL of the product image. _Available in: v59.0_ _Filter group: Big_ ### ProductVariationAttributeValueOutput Valid value for a product variation attribute. * `name` (_string_) API Name of the attribute this value belongs to. _Available in: v55.0_ _Filter group: Big_ * `orderable` (_boolean_) Whether the value defines an orderable product variation. _Available in: v55.0_ _Filter group: Big_ * `value` (_string_) Value of the value. _Available in: v55.0_ _Filter group: Big_ ### ProductImageOutput Details about a product image. * `alternateText` (_string_) Alternate text for accessibility. _Available in: v55.0_ _Filter group: Big_ * `mediaType` (_string_) Media type. _Available in: v55.0_ _Filter group: Big_ * `thumbnailUrl` (_string (url)_) URL of the thumbnail version of the product image. _Available in: v55.0_ _Filter group: Big_ * `title` (_string_) Title. _Available in: v55.0_ _Filter group: Big_ * `url` (_string (url)_) URL of the product image. _Available in: v55.0_ _Filter group: Big_ ### PaymentCreditSequenceItemInput Order Payment Summary ID, credit amount, and credit type for individual payment credit items. Each item represents a specific payment method and the amount of credit to be applied to it with the type of credit transaction. * `amount` (_number (double)_) Amount _Available in: v65.0_ * `creditType` (_string_, required) The type of payment credit that will be issued. Must be a valid value on the Credit Type picklist. _Available in: v65.0_ * `orderPaymentSummaryId` (_string (Id)_) Order Payment Summary ID _Available in: v65.0_ * `rank` (_integer_) Rank _Available in: v65.0_ ### RefundSequenceItemInput The Order Payment Summary ID and amount for the individual refund items in a sequence. Each item has a payment method and refund amount to be processed for that method. * `amount` (_number (double)_, required) Amount _Available in: v65.0_ * `orderPaymentSummaryId` (_string (Id)_, required) Order Payment Summary ID _Available in: v65.0_ * `rank` (_integer_) Rank _Available in: v65.0_ ### ReturnOrderLineItemFeeInput Data for creating a ReturnOrderLineItem that represents a return fee. * `amount` (_number (double)_, required) Value used to calculate the fee amount, as described by the `amountType`. It must be a positive value. _Available in: v56.0_ * `amountType` (_string_, required) Describes how the fee amount is calculated. It can have one of these values: * `AmountTaxOnly` —Value of `amount` is the tax-only adjustment only. Available in version 65.0 and later. * `AmountWithTax` —Value of `amount` is the fee amount, including tax. * `AmountWithoutTax` —Value of `amount` is the fee amount, not including tax. Tax is calculated on the value and added. * `Percentage` —Value of `amount` is a percentage. To determine the fee amount, `amount` is divided by 100, and then multiplied by the TotalPrice and TotalTaxAmount of the associated OrderItemSummary, prorated for the quantity being returned. * `PercentageGross` —Value of `amount` is a percentage. To determine the fee amount, `amount` is divided by 100, and then multiplied by the TotalLineAmountWithTax of the associated OrderItemSummary, prorated for the quantity being returned. * `ProductOnly` —Value of `amount` is the product-only adjustment only. Available in version 65.0 and later. _Available in: v56.0_ Allowed values: `AmountTaxOnly`, `AmountWithTax`, `AmountWithoutTax`, `Percentage`, `PercentageGross`, `ProductOnly`. * `description` (_string_, required) Description of the fee. _Available in: v56.0_ * `product2Id` (_string (Id)_, required) ID of the product representing the fee. _Available in: v56.0_ * `reason` (_string_, required) Reason for the fee. The value must match an entry in the ReturnOrderLineItem object’s ReasonForReturn picklist. _Available in: v56.0_ ### PaymentCreditSequenceItemOutput Output representation of Payment Credit Sequence Item * `amount` (_number (double)_) Amount * `creditType` (_string_) Credit Type * `orderPaymentSummaryId` (_string_) Order Payment Summary Id * `rank` (_integer_) Rank ### RefundSequenceItemOutput The order payment summary ID and amount of the processed refund items. * `amount` (_number (double)_) The amount that was refunded. _Available in: v65.0_ _Filter group: Big_ * `orderPaymentSummaryId` (_string_) The order payment summary’s ID. _Available in: v65.0_ _Filter group: Big_ * `rank` (_integer_) Rank ### ObjectInput A graph node. * `attributes` (_object_, required) The properties of the node body. _Available in: v57.0_ Additional properties: `object`. * `referenceId` (_string_, required) The reference ID of the node. _Available in: v57.0_ * `objectId` (_string_) ObjectId _Available in: v58.0_ * `objectType` (_string_) ObjectType _Available in: v58.0_ * `usages` (_object_) UsagesInputRequest Usages _Available in: v59.0_ Includes all fields of `UsagesInputRequest`. ### NameValuePairOutput The name and value of a field. * `name` (_string_) Name. _Available in: v57.0_ _Filter group: Small_ * `value` (_string_) Value. _Available in: v57.0_ _Filter group: Small_ ### DeliveryEstimationErrorOutput Delivery estimation error. * `code` (_string_) apex\_methods\_system\_string Error code. _Available in: v63.0_ * `message` (_string_) apex\_methods\_system\_string Error message, if any. _Available in: v63.0_ ### ProductDeliverEstimationOutput Delivery estimation information for each product. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `estimatedDeliveryDate` (_string | string_) Estimated delivery date. _Available in: v63.0_ One of: `string`, `string`. * `estimatedShipDate` (_string_) apex\_methods\_system\_datetime Estimated shipping date. _Available in: v63.0_ * `quantity` (_string_) apex\_methods\_system\_double Product quantity. _Available in: v63.0_ * `routingCalculationType` (_string_) apex\_methods\_system\_string Routing calculation type. _Available in: v63.0_ * `stockKeepingUnit` (_string_) apex\_methods\_system\_string Product stock keeping unit (SKU). _Available in: v63.0_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### RouteLocationOutput A fulfillment location within a route, including the products fulfilled from that location. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `location` (_string_) The location's ID. _Available in: v67.0_ _Filter group: Big_ * `products` (_array of RouteProductOutput_) Products fulfilled from this location. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### OCIAttributeSetInput An eligibility attribute set. * `groupEligibilityExclusions` (_array of string_) List of group IDs that are excluded from aggregating the location and SKU. _Available in: v62.0_ ### OCIFutureStockSingleInput An expected future inventory restock for one product. * `expectedDate` (_string_, required) Date when the future inventory is expected. _Available in: v62.0_ * `quantity` (_number (double)_, required) Quantity of the future inventory. _Available in: v62.0_ ### OCIBatchUpdateSingleOutput Details of one updated inventory record. * `actionRequestId` (_string_) Idempotent ID that identifies this request. _Available in: v62.0_ _Filter group: Small_ * `externalRefId` (_string_) Unique code, reference, or identifier for the record used by external systems. _Available in: v62.0_ _Filter group: Small_ * `locationIdentifier` (_string_) Location identifier. _Available in: v62.0_ _Filter group: Small_ * `stockKeepingUnit` (_string_) SKU of the product being updated. _Available in: v62.0_ _Filter group: Small_ ### OCIInventoryRecordOutput Inventory availability data for a product. * `attributeSet` (_OCIAttributeSetOutput_) * `availableToFulfill` (_number (double)_) The Available To Fulfill quantity. _Available in: v51.0_ _Filter group: Big_ * `availableToOrder` (_number (double)_) The Available To Order quantity. _Available in: v51.0_ _Filter group: Big_ * `effectiveDate` (_string (date-time)_) The effective date of the inventory. Indicates if the SKU exists in the inventory. _Available in: v51.0_ _Filter group: Big_ * `exists` (_boolean_) Indicates if the SKU exists in the inventory. _Available in: v62.0_ _Filter group: Big_ * `futures` (_array of OCIFutureInventoryOutput_) A list of any expected future inventory restocks. _Available in: v51.0_ _Filter group: Big_ * `onHand` (_number (double)_) The On Hand quantity. _Available in: v51.0_ _Filter group: Big_ * `reserved` (_number (double)_) The Reserved quantity. _Available in: v51.0_ _Filter group: Big_ * `safetyStockCount` (_number (double)_) The Safety Stock Count. _Available in: v51.0_ _Filter group: Big_ * `stockKeepingUnit` (_string_) The SKU of the product. _Available in: v51.0_ _Filter group: Big_ * `targetInventory` (_number (double)_) The Target Inventory ### OCIFulfillReservationSingleOutput Details of a single fulfilled reservation. * `actionRequestId` (_string_) The UUID that identifies the original fulfill reservation request. _Available in: v51.0_ _Filter group: Small_ * `externalRefId` (_string_) The external reference ID of the location that fulfilled the reservation. _Available in: v51.0_ _Filter group: Small_ * `locationIdentifier` (_string_) The identifier of the location that fulfilled the reservation. _Available in: v51.0_ _Filter group: Small_ * `quantity` (_number (double)_) The fulfilled quantity. _Available in: v51.0_ _Filter group: Small_ * `stockKeepingUnit` (_string_) The SKU of the fulfilled product. _Available in: v51.0_ _Filter group: Small_ ### OCIReleaseReservationSingleOutput Details of a single released reservation. * `actionRequestId` (_string_) The UUID that identifies the original release reservation request. _Available in: v51.0_ _Filter group: Small_ * `externalRefId` (_string_) The external reference ID of the location that released the reservation. _Available in: v51.0_ _Filter group: Small_ * `locationGroupIdentifier` (_string_) The identifier of the location group that released the reservation. _Available in: v51.0_ _Filter group: Small_ * `locationIdentifier` (_string_) The identifier of the location that released the reservation. _Available in: v51.0_ _Filter group: Small_ * `quantity` (_number (double)_) The released quantity. _Available in: v51.0_ _Filter group: Small_ * `stockKeepingUnit` (_string_) The SKU of the released product. _Available in: v51.0_ _Filter group: Small_ ### OCITransferReservationSingleOutput Details of a single transferred reservation. * `actionRequestId` (_string_) The UUID that identifies the original transfer reservation request. _Available in: v51.0_ _Filter group: Small_ * `externalRefId` (_string_) The external reference ID of the location that received the reservation. _Available in: v51.0_ _Filter group: Small_ * `fromLocationGroupIdentifier` (_string_) The identifier of the location group that sent the reservation. _Available in: v51.0_ _Filter group: Small_ * `fromLocationIdentifier` (_string_) The identifier of the location that sent the reservation. _Available in: v51.0_ _Filter group: Small_ * `ignoreAvailabilityCheck` (_boolean_) Whether this call ignored availability data at the location that received the reservation. _Available in: v52.0_ _Filter group: Small_ * `quantity` (_number (double)_) The quantity of transferred inventory. _Available in: v51.0_ _Filter group: Small_ * `stockKeepingUnit` (_string_) The SKU of the transferred product. _Available in: v51.0_ _Filter group: Small_ * `toLocationGroupIdentifier` (_string_) The identifier of the location group that received the reservation. _Available in: v51.0_ _Filter group: Small_ * `toLocationIdentifier` (_string_) The identifier of the location that received the reservation. _Available in: v51.0_ _Filter group: Small_ ### ProductCheckAvailabilityInput Information needed to check a product’s availability. * `product2Id` (_string_, required) Product ID. _Available in: v60.0_ * `quantity` (_number (double)_, required) Number of products. _Available in: v60.0_ ### InventoryProductCheckAvailabilityOutput Inventory product availability. * `available` (_boolean_) Requested quantity is either available (true) or unavailable (false). _Available in: v60.0_ _Filter group: Big_ * `inventory` (_object_) InventoryOutput All inventory information associated with the product. _Available in: v60.0_ _Filter group: Big_ Includes all fields of `InventoryOutput`. * `product2Id` (_string_) Product ID. _Available in: v60.0_ _Filter group: Big_ ### CartMessage Cart message. * `message` (_string_) Cart message. _Available in: v49.0_ _Filter group: Small_ * `messageId` (_string (Id)_) ID of the object supplying the message. _Available in: v49.0_ _Filter group: Small_ * `relatedEntityId` (_string (Id)_) ID of the entity, for example, cart, cart item, or cart tax, associated with the message. _Available in: v49.0_ _Filter group: Small_ * `severity` (_string_) Severity of cart message. _Available in: v49.0_ _Filter group: Small_ Allowed values: `Error`, `Info`, `Warning`. * `type` (_string_) Type of message. Standard values include `Inventory`, `Taxes`, `Pricing`, `Shipping`, `Entitlement`, `SystemError`, and `Other`. _Available in: v49.0_ _Filter group: Small_ * `visible` (_boolean_) Specifies whether the message is visible (`true`) or dismissed (`false`). _Available in: v49.0_ _Filter group: Small_ ### DeliveryMethodV2 Delivery Method Representation * `adjustedShippingFee` (_string_) Adjusted Shipping Fee * `carrier` (_string_) Carrier * `classOfService` (_string_) Class of Service * `currencyIsoCode` (_string_) Currency Code * `earliestEstimatedDeliveryTime` (_string (date-time)_) Earliest Estimated Delivery Time * `id` (_string (Id)_) ID * `latestEstimatedDeliveryTime` (_string (date-time)_) Latest Estimated Delivery Time * `name` (_string_) Name * `processTime` (_integer_) Process Time * `processTimeUnit` (_string_) Process Time Unit * `shippingFee` (_string_) Shipping Fee * `totalAdjustmentAmount` (_string_) Total Adjustment Amount * `transitTimeMax` (_integer_) Maximum Transit Time * `transitTimeMin` (_integer_) Minimum Transit Time * `transitTimeUnit` (_string_) Transit Time Unit ### CheckoutAddressV2 Checkout Address Representation * `city` (_string_) City * `companyName` (_string_) CompanyName * `country` (_string_) Country * `firstName` (_string_) FirstName * `lastName` (_string_) LastName * `name` (_string_) Name * `postalCode` (_string_) Postal Code * `region` (_string_) Region * `shipToPhoneNumber` (_string_) Shipping Phone Number * `street` (_string_) Street ### ConnectBillingFrequencyEnum Indicates the billing frequency enum values. Type: `string`. Allowed values: `Annual`, `Monthly`. ### ConnectSellingModelTypeEnumCommerceBuyerexperience Indicates the Selling Model Type enum values. Type: `string`. Allowed values: `Evergreen`, `OneTime`, `TermDefined`. ### ConnectCartItemSubTypeEnum Sub type of cart item. Type: `string`. Allowed values: `Bonus`, `GiftWrap`. ### ConnectCartItemTypeEnum Type of cart item. Type: `string`. Allowed values: `DeliveryCharge`, `Product`. ### UnitOfMeasure Represents the unit of measure for the attribute. * `roundingMethod` (_ConnectRoundMethodEnum_) * `scale` (_integer_) The Scale for the unit of measure. * `unitCode` (_string_) The Code for the unit of measure. ### ProcessExceptionOutputCommerceBuyerexperience Details for the process exception. * `category` (_string_) Category of the process exception. _Available in: v63.0_ _Filter group: Small_ * `message` (_string_) Message of the process exception. _Available in: v63.0_ _Filter group: Small_ * `status` (_string_) Status of the process exception. _Available in: v63.0_ _Filter group: Small_ ### ProductAttributeSetSummaryCommerceBuyerexperience Summary representation of a product attribute set * `apiName` (_string_) API name of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `attributes` (_array of ProductAttributeSummaryCommerceBuyerexperience_) List of attributes in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Display label of the attribute set. _Available in: v50.0_ _Filter group: Small_ ### ConnectSearchQueryContextTypeEnum Specifies the search boost bury rule query context type. Type: `string`. Allowed values: `All`, `Category`, `SearchTerm`. ### FieldValueCommerceSearch Field's value in product search results. * `value` (_string_) Value of the field. _Available in: v49.0_ _Filter group: Small_ ### PricingResultLineItemCommerceEinstein Representation of the Line Item portion of the response for multiple products pricing * `contractId` (_string_) Represents the ID of the contract * `contractItemPriceId` (_string_) Represents the ID of the contract item price * `error` (_object_) ErrorResponseBilling Error code and message. _Available in: v49.0_ _Filter group: Big_ Includes all fields of `ErrorResponseBilling`. * `listPrice` (_string_) List price for the product. _Available in: v49.0_ _Filter group: Small_ * `lowestUnitPrice` (_string_) Lowest unit price for the product. _Available in: v59.0_ _Filter group: Small_ * `pricebookEntryId` (_string (Id)_) ID of the pricebook entry. _Available in: v49.0_ _Filter group: Small_ * `productId` (_string_) ID of the product to price. _Available in: v49.0_ _Filter group: Small_ * `success` (_boolean_) Specifies whether the execution was successful (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `unitPrice` (_string_) Unit price for the product. _Available in: v49.0_ _Filter group: Small_ ### CommerceProductSellingModelCommerceSearch Product selling model information. * `isSubscriptionProduct` (_boolean_) Indicates whether it is a subscription product ( `true` ) or not ( `false` ). _Available in: v59.0_ _Filter group: Small_ ### DistinctFacetValueDisplayMetadata Display metadata representation for a distinct facet value. * `swatch` (_object_) Map of swatch display metadata for the distinct facet value. _Available in: v64.0_ _Filter group: Medium_ Additional properties: `string`. ### ProductVariationInfoCommerceSearch Representation of variant attributes metadataand mappings of attribute combinations to variant product Ids * `attributesToProductMappings` (_array of ProductAttributesToProductEntryCommerceSearch_) List ordered by `ProductAttribute.Sequence` values that map the attribute value combinations to the variation product ID. _Available in: v50.0_ _Filter group: Small_ * `variationAttributeInfo` (_object_) Map of field API name to product attribute information. _Available in: v51.0_ _Filter group: Small_ Additional properties: `ProductAttributeInfoCommerceSearch`. * `variationCount` (_integer_) Total count of available product variations. _Available in: v66.0_ _Filter group: Small_ ### CommerceProductAttributeSetSummary Summary representation of a product attribute set in product search results. * `attributes` (_array of ProductAttributeSummaryCommerceBuyerexperience_) List of all attributes in the attribute set ### ConnectAdjustmentTypeEnum How the price adjustment amount is calculated. * `AdjustmentAmount` —The adjustment is a fixed amount. * `AdjustmentPercentage` —The adjustment is a percentage. _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `AdjustmentAmount`, `AdjustmentPercentage`. ### CartItemPriceAdjustmentInput CartItemPriceAdjustmentGroup Representation * `adjustmentAmountScope` (_ConnectAdjustmentAmountScopeEnum_) * `adjustmentBasisReference` (_string_) Adjustment Basis Reference * `adjustmentDescription` (_string_) Description of Adjustment or its Cause or Basis. * `adjustmentTargetType` (_ConnectAdjustmentTargetTypeEnum_) * `adjustmentType` (_ConnectAdjustmentTypeEnum_) * `adjustmentValue` (_string_) Price adjustment value * `baseAmount` (_string_) Base Adjustment Amount * `cartAdjustmentGroupId` (_string (Id)_) cartAdjustmentGroupId * `cartItemId` (_string (Id)_) CartItemId * `id` (_string (Id)_) Id * `priceAdjustmentCauseId` (_string (Id)_) Price Adjustment Cause * `priority` (_integer_) The sequence in which adjustments are applied. ### ConnectTargetTypeEnum Target type of a promotion discount. One of these values: * `Shipping`: Promotion discounts shipping amount. * `Transaction`: Promotion discounts total transaction amount. Type: `string`. Allowed values: `Shipping`, `Transaction`. ### CartItemKeyOutput CartItemKey Output Representation * `cartItemId` (_string_) CartItemId * `cartItemQuantityIdentifier` (_string_) CartItemQuantityIdentifier ### CartDeliveryGroupMethodOutput Cart Delivery Group Method Output Representation * `cartDeliveryMethodAdjustments` (_array of CartDeliveryMethodAdjustmentOutput_) CartDeliveryMethodAdjustments * `cartDeliveryMethodId` (_string_) CartDeliveryMethodId * `price` (_string_) Price * `shippingRateId` (_string_) ShippingRateId * `totalAdjustmentBaseAmount` (_string_) TotalAdjustmentBaseAmount * `totalNetAmount` (_string_) TotalNetAmount ### CartItemPriceAdjustment Price adjustment that applies to an item in the cart. * `adjustmentAmountScope` (_object_) ConnectAdjustmentAmountScopeEnum Scope of the adjustment amount. Value is `Total` . _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectAdjustmentAmountScopeEnum`. * `adjustmentBasisReference` (_string_) Reference to coupon, if applicable. _Available in: v56.0_ _Filter group: Small_ * `adjustmentDescription` (_string_) Description of the adjustment. _Available in: v56.0_ _Filter group: Small_ * `adjustmentTargetType` (_object_) ConnectAdjustmentTargetTypeEnum Target type of the promotion discount. Possible _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectAdjustmentTargetTypeEnum`. * `adjustmentType` (_object_) ConnectAdjustmentTypeEnum Adjustment type of the promotion discount. Possible _Available in: v56.0_ _Filter group: Small_ Includes all fields of `ConnectAdjustmentTypeEnum`. * `adjustmentValue` (_string_) Value of the adjustment. _Available in: v56.0_ _Filter group: Small_ * `baseAmount` (_string_) Base adjustment amount. _Available in: v56.0_ _Filter group: Small_ * `cartAdjustmentGroupId` (_string (Id)_) Adjustment group ID. _Available in: v56.0_ _Filter group: Small_ * `cartItemId` (_string (Id)_) ID of the cart item. _Available in: v56.0_ _Filter group: Small_ * `id` (_string (Id)_) ID of the cart item price adjustment. _Filter group: Small_ * `priceAdjustmentCauseId` (_string (Id)_) ID of the promotion that triggered this adjustment. _Available in: v56.0_ _Filter group: Small_ * `priority` (_integer_) Sequence in which adjustments are applied. _Available in: v56.0_ _Filter group: Small_ ### CartItemCollection A collection of items in a cart. * `approachingDiscounts` (_array of string_) List of approaching discounts for the cart items. _Available in: v64.0_ _Filter group: Small_ * `cartCoupons` (_object_) CartCouponCollection Collection of coupons in the cart. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `CartCouponCollection`. * `cartItems` (_array of CartItemResult_) Collection of cart item results. _Available in: v49.0_ _Filter group: Big_ * `cartPromotions` (_object_) CartPromotionCollection Collection of promotions in the cart. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `CartPromotionCollection`. * `cartSummary` (_object_) CartSummary Summary of the cart. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `CartSummary`. * `currentPage` (_integer_) 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. _Available in: v60.0_ _Filter group: Small_ * `currentPageToken` (_string_) Token identifying the current page. _Available in: v49.0_ _Filter group: Small_ * `currentPageUrl` (_string_) Connect REST API URL identifying the current page. _Available in: v49.0_ _Filter group: Small_ * `hasErrors` (_boolean_) Specifies whether at least one of the results contains an error. _Available in: v49.0_ _Filter group: Small_ * `nextPageToken` (_string_) Token identifying the next page, or `null` if there isn’t a next page. _Available in: v49.0_ _Filter group: Small_ * `nextPageUrl` (_string_) Connect REST API URL identifying the next page, or `null` if there isn’t a next page. _Available in: v49.0_ _Filter group: Small_ * `previousPageToken` (_string_) Token identifying the previous page, or `null` if there isn’t a previous page. _Available in: v49.0_ _Filter group: Small_ * `previousPageUrl` (_string_) Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page. _Available in: v49.0_ _Filter group: Small_ * `totalItemCount` (_integer_) Total number of unique products in the cart. _Available in: v60.0_ _Filter group: Small_ * `totalNumberOfPages` (_integer_) Total number of pages for the given page size. _Available in: v60.0_ _Filter group: Small_ ### CartMessagesSummaryCommercePromotions Cart messages summary. * `errorCount` (_integer_) In the Cart Item Result, the count of messages with the `Error` severity level. In `ConnectApi.CartItemResult`, the count of messages with the `Error` severity level. _Available in: v49.0_ _Filter group: Small_ * `hasErrors` (_boolean_) Specifies whether there are messages related to the entity (`true`) or not (`false`). _Available in: v49.0_ _Filter group: Small_ * `limitedMessages` (_array of CartMessageCommercePromotions_) 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 entity, and each message supports multiple languages. In `ConnectApi.CartItemResult`, a limited list of messages related to the cart item. In `ConnectApi.CartSummary`, each message can be related to the cart or to another cart-related entity. _Available in: v49.0_ _Filter group: Small_ * `relatedEntityId` (_string_) 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 entity. In `ConnectApi.CartItemResult`, the ID of the related cart item. In `ConnectApi.CartSummary`, each message can be related to the cart or to another cart-related entity. _Available in: v49.0_ _Filter group: Small_ * `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. _Available in: v50.0_ _Filter group: Small_ ### CartItemProduct Product summary for a cart item. * `fields` (_object_) Map of product fields and values. _Available in: v49.0_ _Filter group: Small_ Additional properties: `string`. * `isConfigurationAllowed` (_boolean_) Indicates whether the product supports configuration (`true`) or not (`false`). For dynamic bundles, this field is always `true`, and for static bundles, it is `false`. When `true`, buyers can configure the bundle by selecting which child components to include or exclude before adding it to the cart. _Available in: v65.0_ _Filter group: Small_ * `name` (_string_) Name of the product. _Available in: v49.0_ _Filter group: Small_ * `productClass` (_string_) Class of product. Values are: * `Bundle` * `Set` * `Simple` * `Variation` * `VariationParent` _Available in: v63.0_ _Filter group: Small_ * `productId` (_string_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `productSubscriptionInformation` (_object_) ProductSellingModelCommercePromotions Reserved for future use. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `ProductSellingModelCommercePromotions`. * `purchaseQuantityRule` (_object_) PurchaseQuantityRule If one exists, purchase quantity rule for the product. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `PurchaseQuantityRule`. * `productUrlName` (_string_) SEO-friendly URL name for the product. _Available in: v64.0_ _Filter group: Small_ * `sku` (_string_) SKU of the product. _Available in: v49.0_ _Filter group: Small_ * `thumbnailImage` (_object_) ProductMediaCommerceOrdermanagement Thumbnail image of the product. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceOrdermanagement`. * `variationAttributes` (_object_) Variation attributes associated with the product. _Available in: v50.0_ _Filter group: Small_ Additional properties: `CartProductAttribute`. ### ConnectItemReferenceTypeEnum Item reference type. Possible _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `Attribute`, `Category`, `Price`, `Product`, `StandardShippingRate`. ### ConnectPromotionLineItemOperatorTypeEnum Type of operator for the item reference. Possible _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `EqualTo`, `GreaterThan`, `GreaterThanOrEqualTo`, `LessThan`, `LessThanOrEqualTo`, `NotEqualTo`. ### ShippingZone Output representation of the shipping rate area. * `countries` (_array of Country_) List of supported countries. _Available in: v59.0_ _Filter group: Small_ * `id` (_string_) ID of the shipping rate area. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the shipping rate area. _Available in: v59.0_ _Filter group: Small_ * `standardShippingRates` (_array of StandardShippingRate_) List of the standard shipping rates. _Available in: v59.0_ _Filter group: Small_ ### TaxAdjustmentTypeEnum Type of tax adjustment. Values are: * Promotional – Promotional type tax adjustment. * Tiered – Tiered type tax adjustment. _Available in: v58.0_ _Filter group: Small_ Type: `string`. Allowed values: `Promotional`, `Tiered`. ### ProductAttributeSummary Summary of a product attribute. * `apiName` (_string_) API name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Display label of the attribute. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence of the attribute in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v50.0_ _Filter group: Small_ ### ProductAttributeValueMetadata Metadata for a product attribute value. * `apiName` (_string_) API Name of the product attribute picklist value. For example, `blue__c`. _Available in: v63.0_ _Filter group: Small_ * `colorHexCode` (_string_) Hex code value of a color attribute. For example, `#0000FF`. _Available in: v63.0_ _Filter group: Small_ * `label` (_string_) Label of the picklist value for a custom field product attribute. For example, `Red`. _Available in: v63.0_ _Filter group: Small_ * `variantAvailable` (_boolean_) Specifies whether a variation product exists (`true`) or not (`false`). _Available in: v63.0_ _Filter group: Small_ ### ConnectProductAttributeViewTypeEnum View type for product attributes. _Available in: v63.0_ _Filter group: Small_ Type: `string`. Allowed values: `ColorSwatch`, `Dropdown`, `Pill`. ### ProductAttributeSelectionInfo Product attribute. * `apiName` (_string_) API name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Label of the attribute. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence value determined by the order of the attributes under Commerce Setup for the attribute set. _Available in: v50.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v50.0_ _Filter group: Small_ ### CategorySettings Category settings applicable to all product rows in a product import .csv file. * `productCatalogId` (_string (Id)_) ID of product catalog to associate with each product row in a product import .csv file. Required if you specify one or more category-related column headings in your .csv file _Available in: v54.0_ ### EntitlementSettings Entitlement settings applicable to all product rows in a product import .csv file. * `defaultEntitlementPolicyId` (_string (Id)_) ID of entitlement policy to associate with each product row in a product import .csv file. Required if you specify one or more entitlement-related column headings in your .csv file _Available in: v54.0_ ### MediaSettings Media settings applicable to all product rows in a product import .csv file. * `cmsWorkspaceId` (_string (Id)_) ID of a CMS workspace to associate with each product row in a product import .csv file. Required if you specify one or more media-related column headings in your .csv file. If you are using the `/commerce/management/import/product/jobs` resource, and you specify one or more media-related columns in your .csv file, you must either specify a `cmsWorkspaceId` or use the default CMS workspace assigned to the store by specifying a `webstoreId` in the Webstore Settings Input . If you specify both a `cmsWorkspaceId` and a `webstoreId` , the `cmsWorkspaceId` is used for the import. _Available in: v54.0_ ### PriceSettings Price settings are applicable to all product rows in a product import .csv file. * `pricebookAliasToIdMapping` (_object_) Map of price book aliases and corresponding price book IDs. The aliases defined in the map are associated with each product row in a product import .csv file. The .csv file’s column headings can associate prices to price book aliases. By using alias names in the column headings instead of price book IDs, you improve the readability of the .csv files. By convention, the “original” alias refers to your store’s default strikethrough price book. And the “sales” alias refers to your store’s default price book. For global imports, you can specify other alias names of your choosing for other price books. For store imports, the only aliases allowed are “sales” and “original.” Required if you specify one or more price-related column headings in your .csv file _Available in: v54.0_ Additional properties: `string (Id)`. ### WebstoreSettings ID of a webstore to associate with an asynchronous product import job. * `webstoreId` (_string (Id)_, required) ID of the webstore. _Available in: v57.0_ ### PriceAdjustmentTierTypeEnum Type of price adjustment for the tier. Values are: * `AmountBasedAdjustment` —Price is adjusted by a specified amount. * `PercentageBasedAdjustment` —Price is adjusted by a specified percentage. _Available in: v49.0_ _Filter group: Small_ Type: `string`. Allowed values: `AmountBasedAdjustment`, `OverrideBasedAdjustment`, `PercentageBasedAdjustment`. ### FieldChange Represents a field change in a subscription action. * `field` (_string_) Field name. * `newValue` (_any_) New value of field. * `previousValue` (_any_) Previous value of field. ### InsightValuesOutput Insight value details for a business objective, or goal. * `contextId` (_string_) Salesforce record ID of the record that the insight is based on. _Available in: v62.0_ _Filter group: Small_ * `name` (_string_) Name of the Salesforce record that the insight is based on. _Available in: v62.0_ _Filter group: Small_ * `previousValue` (_number (double)_) Value of the insight for the previous timeframe based on the key performance indicator. _Available in: v62.0_ _Filter group: Small_ * `value` (_number (double)_) Value of the insight for the current timeframe based on the key performance indicator. _Available in: v62.0_ _Filter group: Small_ ### FieldValue Representation of a field's value in product search results. * `value` (_string_) Value of the field. _Available in: v49.0_ _Filter group: Small_ ### CommerceProductSellingModel Representation of Product Selling Model Information * `isSubscriptionProduct` (_boolean_) Indicates whether it is a subscription product or not ### OrderSummaryAdjustmentAggregatesCommerceOrdermanagement Output representation of the a djustment aggregates associated with an order summary. * `available` (_boolean_) Indicates if adjustment aggregate values are available (`true`) or not (`false`). _Available in: v55.0_ _Filter group: Small_ * `status` (_string_) Order summary adjustment aggregate job status. Values are: * `Failed` —The adjustment aggregate data job for the order summary failed. * `InProgress` —The adjustment aggregate data job for the order summary is in progress. * `NotInitiated` —The adjustment aggregate data job for the order summary is not initiated. * `Submitted` —The adjustment aggregate data job for the order summary is submitted. _Available in: v55.0_ _Filter group: Small_ Allowed values: `Failed`, `InProgress`, `NotInitiated`, `Submitted`. * `totalDeliveryPromotionDistAmount` (_string_) Total distributed delivery promotion amounts associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalDeliveryPromotionLineAmount` (_string_) Total delivery promotion line amounts associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalDeliveryPromotionTotalAmount` (_string_) Total delivery promotion amount associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalProductPromotionDistAmount` (_string_) Total distributed product promotion amounts associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalProductPromotionLineAmount` (_string_) Total product promotion line amount associated with an order summary. _Available in: v55.0_ _Filter group: Small_ * `totalProductPromotionTotalAmount` (_string_) Total product promotion amount associated with an order summary. _Available in: v55.0_ _Filter group: Small_ ### OrderItemSummaryProductCommerceOrdermanagement Product mapped to an order item summary. * `canViewProduct` (_boolean_) Specifies whether the context user can view the product (`true`) or not (`false`). _Available in: v51.0_ _Filter group: Small_ * `errorCode` (_string_) Error code for the product with errors. _Available in: v51.0_ _Filter group: Small_ * `errorMessage` (_string_) Error message for the product with errors. _Available in: v51.0_ _Filter group: Small_ * `fields` (_object_) Map of the product fields queried. _Available in: v51.0_ _Filter group: Small_ Additional properties: `object`. RecordField Includes all fields of `RecordField`. * `media` (_object_) ProductMediaCommerceOrdermanagement Associated product media. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceOrdermanagement`. * `productAttributes` (_object_) ProductAttributeSetSummaryCommerceOrdermanagement Summary of the product attributes. _Available in: v51.0_ _Filter group: Small_ Includes all fields of `ProductAttributeSetSummaryCommerceOrdermanagement`. * `productId` (_string_) ID of the product. _Available in: v51.0_ _Filter group: Small_ ### ClassificationsOutput Classifications output representation * `classifications` (_array of string_) Classifications ### OCILocationGroupAvailabilityOutputCommerceOrdermanagement Output representation of one location group’s inventory availability * `inventoryRecords` (_array of OCIInventoryRecordOutputCommerceOrdermanagement_) The Inventory Records * `locationGroupIdentifier` (_string_) The Location Group Identifier ### OCILocationAvailabilityOutputCommerceOrdermanagement Output representation of one location’s inventory availability * `inventoryRecords` (_array of OCIInventoryRecordOutputCommerceOrdermanagement_) The Inventory Records * `locationIdentifier` (_string_) The Location Identifier ### LocationOutput An inventory location’s distance to an order recipient. * `distance` (_number (double)_) The distance from the location to the order recipient. _Available in: v51.0_ _Filter group: Big_ * `locationIdentifier` (_string_) The location identifier. _Available in: v51.0_ _Filter group: Big_ ### UsagesInputRequest Input representation of usages. * `sectionIds` (_array of string_) Section IDs _Available in: v59.0_ * `usedInDocument` (_boolean_) UsedInDocument _Available in: v59.0_ ### RouteProductOutput A product allocated to a fulfillment location within a route, including its allocated quantity and score. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `product` (_string_) The product's SKU. _Available in: v67.0_ _Filter group: Big_ * `quantity` (_integer_) The product quantity allocated to this location. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ * `unitScore` (_number (double)_) The score for this product at this location. _Available in: v67.0_ _Filter group: Big_ ### OCIAttributeSetOutput Details of an attribute set. * `groupEligibilityExclusion` (_array of string_) List of group IDs that are excluded from aggregating the location and SKU. _Available in: v59.0_ _Filter group: Big_ ### OCIFutureInventoryOutput An expected future inventory restock. * `expectedDate` (_string (date-time)_) Date when the future inventory is expected. _Available in: v51.0_ _Filter group: Big_ * `quantity` (_number (double)_) Quantity of the future inventory. _Available in: v51.0_ _Filter group: Big_ ### InventoryOutput Output representation of the inventory * `availableToFulfill` (_number (double)_) The Quantity Available To Fulfill * `availableToOrder` (_number (double)_) The Quantity Available To Order * `onHand` (_number (double)_) The Quantity Available On Hand ### ConnectRoundMethodEnum Rounding Method Type: `string`. Allowed values: `Down`, `Nearest`, `Up`. ### ProductAttributesToProductEntryCommerceSearch Representation for a mapping of an attribute value combination to a variant product Id. * `canonicalKey` (_string_) Attribute API values concatenated with an underscore (\_) based on the sequence number of the attributes in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `image` (_ProductMediaCommerceBuyerexperience_) * `mediaItems` (_array of ProductMediaCommerceBuyerexperience_) Representation of the listing images of the product. * `productId` (_string (Id)_) Variation product ID for the selection of attributes. _Available in: v50.0_ _Filter group: Small_ * `selectedAttributes` (_array of ProductAttributeSelectionInfoCommerceSearch_) Ordered list of attribute values and metadata that can be used to form a key that maps to product ID. _Available in: v50.0_ _Filter group: Small_ * `urlName` (_string_) Variant URL name for the selection of attributes. _Available in: v59.0_ _Filter group: Small_ ### ProductAttributeInfoCommerceSearch Representation for attribute metadata * `allowableValues` (_array of string_) Active attribute picklist values that can be used to create variations. These values are determined by the order of the picklist values in Object Manager. _Available in: v50.0_ _Filter group: Small_ * `apiName` (_string_) API name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `availableValues` (_array of string_) Attribute picklist values that are available for the product in the store. These values are sorted by the order of values in the `allowableValues` property. _Available in: v50.0_ _Filter group: Small_ * `fieldEnumOrId` (_string_) Field ID for custom fields or enumeration value for standard fields. _Available in: v50.0_ _Filter group: Small_ * `groupedBy` (_boolean_) Indicates if the attribute is used to determine grouping. _Available in: v64.0_ _Filter group: Small_ * `label` (_string_) Label of the attribute. _Available in: v50.0_ _Filter group: Small_ * `objectName` (_string_) Name of the object that contains the field. _Available in: v50.0_ _Filter group: Small_ * `options` (_array of ProductAttributeValueMetadataCommerceSearch_) List of product attribute value metadata. _Available in: v63.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence value determined by the order of the attributes under Commerce Setup for the attribute set. _Available in: v50.0_ _Filter group: Small_ * `viewType` (_string_) View type for product attributes. _Available in: v63.0_ _Filter group: Small_ Allowed values: `ColorSwatch`, `Dropdown`, `Pill`. ### ConnectAdjustmentAmountScopeEnum Scope of the price adjustment amount. One of these values: * `Total`: The adjustment scope is the total price. * `Unit`: The adjustment scope is the unit price. * `UnproratedTotal`: The adjustment scope is the unprorated total price. Type: `string`. Allowed values: `Total`, `Unit`, `UnproratedTotal`. ### ConnectAdjustmentTargetTypeEnum Target type of the promotion discount. Possible _Available in: v56.0_ _Filter group: Small_ Type: `string`. Allowed values: `Cart`, `Item`. ### CartDeliveryMethodAdjustmentOutput Cart Delivery Method Adjustment Output Representation * `adjustmentType` (_ConnectAdjustmentTypeEnum_) * `adjustmentValue` (_string_) AdjustmentValue * `baseAmount` (_string_) BaseAmount * `priceAdjustmentCauseId` (_string (Id)_) PriceAdjustmentCauseId * `priority` (_integer_) Priority ### CartCouponCollection Collection of coupons associated with the cart. * `cartCoupons` (_object_) CartCouponList A list of coupons associated with the cart. _Available in: v54.0_ _Filter group: Big_ Includes all fields of `CartCouponList`. * `cartId` (_string_) ID of the cart. _Available in: v54.0_ _Filter group: Small_ * `cartStatus` (_string_) Status of the cart. Values are: * `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 cannot be modified. * `PendingClosed—` Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified. This value is available in API version 57.0 and later. * `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. _Available in: v54.0_ _Filter group: Small_ Allowed values: `Active—`, `Checkout—`, `Closed—`, `PendingClosed—`, `PendingDelete—`, `Processing—`. * `ownerId` (_string_) ID of the user who owns this cart. _Available in: v54.0_ _Filter group: Small_ ### CartItemResult Result after requesting a cart item. * `cartItem` (_sfdc\_commerce\_promotions\_connect\_api\_oas\_sellingModelTypeEnum | CartItemWithoutPrice_) Cart item. _Available in: v49.0_ _Filter group: Small_ One of: `sfdc_commerce_promotions_connect_api_oas_sellingModelTypeEnum`, `CartItemWithoutPrice`. * `message` (_string_) Message when the request isn’t successful. _Available in: v49.0_ _Filter group: Small_ * `status` (_string_) Status for the request. _Available in: v49.0_ _Filter group: Small_ ### CartPromotionCollection Promotions associated with a cart. * `cartId` (_string_) ID of the cart. _Available in: v53.0_ _Filter group: Small_ * `cartStatus` (_string_) Status of the cart. Values are: * `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 cannot be modified. * `PendingClosed—` Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified. This value is available in API version 57.0 and later. * `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. _Available in: v53.0_ _Filter group: Small_ Allowed values: `Active—`, `Checkout—`, `Closed—`, `PendingClosed—`, `PendingDelete—`, `Processing—`. * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the cart. _Available in: v53.0_ _Filter group: Small_ * `promotions` (_array of CartPromotion_) Collection of cart promotions. _Available in: v53.0_ _Filter group: Big_ ### CartSummary Summary of information about a cart and its contents. * `accountId` (_string_) ID of the account for the cart. _Available in: v49.0_ _Filter group: Small_ * `asyncOperationStatus` (_string_) Asynchronous processing status of the cart, if asynchronous processing is enabled for the store. Values are: * `Completed` * `Errored` * `Processing` _Available in: v59.0_ _Filter group: Small_ * `cartId` (_string_) ID of the cart. _Available in: v49.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Three-letter ISO 4217 currency code associated with the cart. _Available in: v49.0_ _Filter group: Small_ * `customFields` (_array of string_) Array of sObjects and viewable custom fields for the sObjects. Field-level security rules from the [shopper profile](https://help.salesforce.com/s/articleView?id=commerce.comm_create_shopper_profile.htm&type=5) 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. This field isn't included in the API response for Checkout resources. _Available in: v61.0_ _Filter group: Small_ * `firstPymtGrandTotalAmount` (_string_) First payment amount for subscription products, plus the total payment amount for non-subscription products. Includes taxes. _Available in: v60.0_ _Filter group: Small_ * `firstPymtTotalAmount` (_string_) The total amount on the first payment of the cart. _Available in: v63.0_ _Filter group: Small_ * `firstPymtTotalListPrice` (_string_) The total list price on the first payment of the cart. _Available in: v63.0_ _Filter group: Small_ * `firstPymtTotalTaxAmount` (_string_) Tax amount on the first payment for any subscription products, plus the total tax amount on non-subscription products. _Available in: v60.0_ _Filter group: Small_ * `grandTotalAmount` (_string_) Grand total amount including shipping and tax for items in the cart, in the currency of the cart. _Available in: v49.0_ _Filter group: Small_ * `hasGift` (_boolean_) Specifies whether the cart contains a gift (`true`) or not (`false`). _Available in: v64.0_ _Filter group: Small_ * `isSecondary` (_boolean_) Specifies whether the cart is secondary (`true`) or not (`false`). _Available in: v53.0_ _Filter group: Small_ * `name` (_string_) Name of the cart. _Available in: v49.0_ _Filter group: Small_ * `ownerId` (_string_) ID of the owner of the cart. _Available in: v49.0_ _Filter group: Small_ * `orderOwnerId` (_string_) ID of the owner of the order. _Available in: v58.0_ _Filter group: Small_ * `purchaseOrderNumber` (_string_) Purchase order for the cart. _Available in: v50.0_ _Filter group: Small_ * `status` (_string_) Status of the cart. Values are: * `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 cannot be modified. * `PendingClosed—` Cart is marked to be closed, but the request isn't completed yet. The cart can’t be modified. This value is available in API version 57.0 and later. * `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. _Available in: v49.0_ _Filter group: Small_ Allowed values: `Active—`, `Checkout—`, `Closed—`, `PendingClosed—`, `PendingDelete—`, `Processing—`. * `taxType` (_string_) Tax type of the cart. * `Automatic` —Automatic taxation policy. * `Gross` —Gross taxation policy. * `Net` —Net taxation policy. _Available in: v55.0_ _Filter group: Small_ Allowed values: `Automatic`, `Gross`, `Net`. * `totalAmountWithItemAdjustment` (_string_) Total amount, including both tier and item level discounts but excluding cart level discounts, for all items in the cart. _Available in: v61.0_ _Filter group: Small_ * `totalCartLevelAdjustmentAmount` (_string_) Total cart level discount amount for the cart. _Available in: v61.0_ _Filter group: Small_ * `totalChargeAmount` (_string_) Total amount for shipping and other charges in the currency of the cart. Includes adjustments from shipping promotions. _Available in: v49.0_ _Filter group: Small_ * `totalListPrice` (_string_) Total list price for all cart items plus shipping adjustments. _Available in: v49.0_ _Filter group: Small_ * `totalProductAmount` (_string_) Total amount including discounts, but excluding shipping and tax, for product items in the cart. _Available in: v49.0_ _Filter group: Small_ * `totalProductAmountAfterAdjustments` (_string_) Total product amount, including promotions. _Available in: v52.0_ _Filter group: Small_ * `totalProductCount` (_string_) Total count of items in the cart. This field may not be accurate when [faster add-to-cart](https://help.salesforce.com/s/articleView?id=commerce.comm_faster_add_to_cart.htm&type=5) is turned on and quantity rules are enabled for products in the cart. _Available in: v49.0_ _Filter group: Small_ * `totalProductLineItemCount` (_integer_) Total count of line items, of the type Product, in the cart. _Available in: v60.0_ _Filter group: Small_ * `totalProductListAmount` (_string_) Total list price for all products in the cart without any adjustments. _Available in: v59.0_ _Filter group: Small_ * `totalPromotionalAdjustmentAmount` (_string_) Total promotional adjustment amount for items in the cart. _Available in: v52.0_ _Filter group: Small_ * `totalSubProductCount` (_string_) Total quantity of all cart items with the selling model type Evergreen or Term-Defined. _Available in: v60.0_ _Filter group: Small_ * `totalTaxAmount` (_string_) Total tax amount for the cart, including tax on shipping, if applicable. _Available in: v49.0_ _Filter group: Small_ * `type` (_string_) Type of cart. Values are: * `Cart` —Cart created by a customer. * `PayNowReadOnly` —Clone of a Template cart that the customer can check out with using the Pay Now feature. * `Template` —Cart created by an internal user. _Available in: v49.0_ _Filter group: Small_ Allowed values: `Cart`, `PayNowReadOnly`, `Template`. * `uniqueProductCount` (_integer_) Total count of unique items, or SKUs, in the cart. This field is supported when [faster add-to-cart](https://help.salesforce.com/s/articleView?id=commerce.comm_faster_add_to_cart.htm&type=5) is turned off. _Available in: v49.0_ _Filter group: Small_ * `webstoreId` (_string_) ID of the webstore of the cart. _Available in: v49.0_ _Filter group: Small_ ### CartMessageCommercePromotions Cart message. * `message` (_string_) Cart message. _Available in: v49.0_ _Filter group: Small_ * `messageId` (_string_) ID of the object supplying the message. _Available in: v49.0_ _Filter group: Small_ * `relatedEntityId` (_string_) ID of the entity, for example, cart, cart item, or cart tax, associated with the message. _Available in: v49.0_ _Filter group: Small_ * `severity` (_string_) Severity of cart message. Values are: * `Error` * `Info` * `Warning` _Available in: v49.0_ _Filter group: Small_ * `type` (_string_) Type of message. Standard values include `Inventory`, `Taxes`, `Pricing`, `Shipping`, `Entitlement`, `SystemError`, and `Other`. _Available in: v49.0_ _Filter group: Small_ * `visible` (_boolean_) Specifies whether the message is visible (`true`) or dismissed (`false`). _Available in: v49.0_ _Filter group: Small_ ### ProductSellingModelCommercePromotions Product selling model for Commerce subscriptions. * `description` (_string_) Description of the product selling model displayed on the UI. _Available in: v60.0_ _Filter group: Small_ * `displayName` (_string_) Name of the product selling model displayed on the UI. _Available in: v60.0_ _Filter group: Small_ * `id` (_string_) ID of the product selling model. _Available in: v56.0_ _Filter group: Small_ * `name` (_string_) Name of the product selling model. _Available in: v56.0_ _Filter group: Small_ * `pricingTerm` (_integer_) Number of pricing term units in the pricing term. Used with `pricingTermUnit` to define the length of the pricing term. For example, if `pricingTermUnit` is `Months` and this property is 1, the subscription is priced monthly. However, if the `sellingModelType` property is set to `OneTime`, the `pricingTerm` property is empty, because the product isn’t sold as a subscription. The only allowed value for this property is 1. _Available in: v56.0_ _Filter group: Small_ * `pricingTermUnit` (_string_) Unit of time used to define a pricing term. Values are: * `Months` —Product is priced on a monthly basis. * `Annual` —Product is priced on an annual basis. _Available in: v56.0_ _Filter group: Small_ Allowed values: `Months`, `Annual`. * `sellingModelType` (_string_) Type of product selling model. Values are: * `Evergreen` —A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it. * `OneTime` —A product that isn’t sold as a subscription. * `TermDefined` —A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. _Available in: v56.0_ _Filter group: Small_ Allowed values: `Evergreen`, `OneTime`, `TermDefined`. * `subscriptionTermRule` (_object_) SubscriptionTermRule Rules for a subscription term. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `SubscriptionTermRule`. ### ProductMediaCommerceOrdermanagement Input representation of product media details. * `alternateText` (_string_) Alternative text for the product media. _Available in: v49.0_ _Filter group: Small_ * `contentVersionId` (_string_) 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. _Available in: v49.0_ _Filter group: Small_ * `id` (_string_) ID of the product image. _Available in: v49.0_ _Filter group: Small_ * `mediaType` (_string_) Type of product media. Values are: * `Document` * `Image` * `Video` _Available in: v49.0_ _Filter group: Small_ * `sortOrder` (_integer_) Sort order of a media item within a media group. _Available in: v49.0_ _Filter group: Small_ * `thumbnailUrl` (_string_) 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. _Available in: v49.0_ _Filter group: Small_ * `title` (_string_) Title of the product media. _Available in: v49.0_ _Filter group: Small_ * `url` (_string_) URL of the product media. _Available in: v49.0_ _Filter group: Small_ * `developerName` (_string_) The API name of the product media group. Possible values are: * `Attachment` * `ProductDetailImage` * `ProductListImage` _Available in: v61.0_ * `mediaId` (_string_) The Salesforce ID of the managed content record associated with the product. _Available in: v61.0_ ### CartProductAttribute Product attribute for a cart item. * `label` (_string_) Label or display name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence of the attribute within the attribute set. _Available in: v50.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v50.0_ _Filter group: Small_ ### Country Output representation of a country. * `isoCode` (_string_) Iso code of the country. _Available in: v60.0_ _Filter group: Small_ * `label` (_string_) Name of the country. _Available in: v60.0_ _Filter group: Small_ ### StandardShippingRate Output representation of the standard shipping rate. * `conditionFactor` (_object_) ConnectShippingRateFactorEnum Conditions factor for the shipping rate area. Possible values are: * `OrderPrice` —Condition based on the order price value. * `OrderWeight` —Condition based on the delivery weight. This value is available in API version 62.0 and later. _Available in: v59.0_ _Filter group: Small_ Includes all fields of `ConnectShippingRateFactorEnum`. * `conditionRangeMax` (_number (double)_) Maximum value of the shipping rate condition. _Available in: v59.0_ _Filter group: Small_ * `conditionRangeMin` (_number (double)_) Minimum value of the shipping rate condition. This value can't be negative. _Available in: v59.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Currency ISO code of the cart. The default value is the org’s default currency. _Available in: v60.0_ _Filter group: Small_ * `id` (_string_) ID of the shipping rate. _Available in: v59.0_ _Filter group: Small_ * `name` (_string_) Name of the standard shipping rate. _Available in: v59.0_ _Filter group: Small_ * `price` (_string_) Price of standard shipping rate. _Available in: v59.0_ _Filter group: Small_ * `transitTimeMax` (_integer_) Maximum value of the shipping transit time. _Available in: v61.0_ _Filter group: Small_ * `transitTimeMin` (_integer_) Minimum value of the shipping transit time. This value can't be negative. _Available in: v61.0_ _Filter group: Small_ * `transitTimeUnit` (_object_) ConnectShippingTimeUnitEnum Transit time unit for shipping calculation. Possible _Available in: v61.0_ _Filter group: Small_ Includes all fields of `ConnectShippingTimeUnitEnum`. * `weightUnit` (_object_) ConnectShippingWeightUnitEnum Unit of measurement for the weight of the cart items. Possible _Available in: v62.0_ _Filter group: Small_ Includes all fields of `ConnectShippingWeightUnitEnum`. ### ProductAttributeSetSummaryCommerceOrdermanagement Summary of a product attribute set. * `apiName` (_string_) API name of the attribute set. _Available in: v50.0_ _Filter group: Small_ * `attributes` (_array of ProductAttributeSummary_) List of attributes in the attribute set. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Display label of the attribute set. _Available in: v50.0_ _Filter group: Small_ ### OCIInventoryRecordOutputCommerceOrdermanagement Output representation of one SKU’s inventory availability” * `attributeSet` (_OCIAttributeSetOutputCommerceOrdermanagement_) * `availableToFulfill` (_number (double)_) The Quantity Available To Fulfill * `availableToOrder` (_number (double)_) The Quantity Available To Order * `effectiveDate` (_string (date-time)_) The Effective Date * `exists` (_boolean_) Indicates whether the record exists * `futures` (_array of OCIFutureInventoryOutputCommerceOrdermanagement_) The Inventory Futures * `onHand` (_number (double)_) The Quantity Available On Hand * `reserved` (_number (double)_) The Quantity Reserved * `safetyStockCount` (_number (double)_) The Safety Stock Count * `stockKeepingUnit` (_string_) The Stock Keeping Unit * `targetInventory` (_number (double)_) The Target Inventory ### ProductAttributeSelectionInfoCommerceSearch Representation for a single attribute * `apiName` (_string_) API name of the attribute. _Available in: v50.0_ _Filter group: Small_ * `label` (_string_) Label of the attribute. _Available in: v50.0_ _Filter group: Small_ * `sequence` (_integer_) Sequence value determined by the order of the attributes under Commerce Setup for the attribute set. _Available in: v50.0_ _Filter group: Small_ * `value` (_string_) Display value of the attribute. _Available in: v50.0_ _Filter group: Small_ ### ProductAttributeValueMetadataCommerceSearch Output representation of Product Attribute value metadata Representation * `apiName` (_string_) API Name of the product attribute picklist value. For example, `blue__c`. _Available in: v63.0_ _Filter group: Small_ * `colorHexCode` (_string_) Hex code value of a color attribute. For example, `#0000FF`. _Available in: v63.0_ _Filter group: Small_ * `label` (_string_) Label of the picklist value for a custom field product attribute. For example, `Red`. _Available in: v63.0_ _Filter group: Small_ * `variantAvailable` (_boolean_) Specifies whether a variation product exists (`true`) or not (`false`). _Available in: v63.0_ _Filter group: Small_ ### CartCouponList List of coupons associated with a cart. * `coupons` (_array of CartCoupon_) List of coupons associated with a cart. _Available in: v54.0_ _Filter group: Small_ ### sfdc\_commerce\_promotions\_connect\_api\_oas\_sellingModelTypeEnum Type: `string`. Value meanings: `Evergreen`: A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it.; `OneTime`: A product that isn’t sold as a subscription.; `TermDefined`: A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends.. ### CartItemWithoutPrice An item without pricing information in a cart. * `billingFrequency` (_string_) Billing frequency for a subscription. Values are: * `Annual` * `Monthly` _Available in: v59.0_ _Filter group: Small_ * `cartDeliveryGroupId` (_string_) ID of the cart delivery group. _Available in: v60.0_ _Filter group: Small_ * `cartId` (_string_) ID of the cart. _Available in: v49.0_ _Filter group: Small_ * `cartItemId` (_string_) ID of the item. _Available in: v49.0_ _Filter group: Small_ * `messagesSummary` (_object_) CartMessagesSummaryCommercePromotions Messages summary for the item. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `CartMessagesSummaryCommercePromotions`. * `name` (_string_) Name of the item. _Available in: v49.0_ _Filter group: Small_ * `productDetails` (_object_) CartItemProduct Summary of the product details. _Available in: v49.0_ _Filter group: Small_ Includes all fields of `CartItemProduct`. * `productId` (_string_) ID of the product. _Available in: v49.0_ _Filter group: Small_ * `productSellingModelId` (_string_) ID of the product selling model. _Available in: v59.0_ _Filter group: Small_ * `quantity` (_string_) Quantity of the item. _Available in: v49.0_ _Filter group: Small_ * `sellingModelType` (_string_) Type of product selling model. Values are: * `Evergreen` —A subscription without an end date. An evergreen subscription continues until the shopper affirmatively cancels it. * `OneTime` —A product that isn’t sold as a subscription. * `TermDefined` —A subscription with a defined end date. The subscription continues for a specified time period. When the term ends, the subscription ends. _Available in: v60.0_ _Filter group: Small_ Allowed values: `Evergreen`, `OneTime`, `TermDefined`. * `subscriptionTerm` (_integer_) Reserved for future use. _Available in: v59.0_ _Filter group: Small_ * `type` (_string_) Type of item in a cart. Values are: * `DeliveryCharge` * `Product` _Available in: v49.0_ _Filter group: Small_ ### CartPromotion Promotion for a cart. * `adjustmentAmount` (_string_) Adjustment amount of the promotion. _Available in: v53.0_ _Filter group: Small_ * `couponCode` (_string_) Coupon code for a promotion. A coupon code is available only for manual promotions, not for automatic promotions. _Available in: v53.0_ _Filter group: Small_ * `currencyIsoCode` (_string_) Currency ISO code of the cart. _Available in: v57.0_ _Filter group: Small_ * `displayName` (_string_) Localized display name of the promotion. _Available in: v53.0_ _Filter group: Small_ * `promotionId` (_string_) ID of the promotion. _Available in: v53.0_ _Filter group: Small_ * `targetType` (_string_) Promotion target type. Values are: * `Cart` —Promotion targets a cart. * `Item` —Promotion targets an item in a cart. _Available in: v53.0_ _Filter group: Small_ Allowed values: `Cart`, `Item`. * `termsAndConditions` (_string_) Localized terms and conditions for the promotion. _Available in: v53.0_ _Filter group: Small_ ### ConnectShippingRateFactorEnum Conditions factor for the shipping rate area. Possible values are: * `OrderPrice` —Condition based on the order price value. * `OrderWeight` —Condition based on the delivery weight. This value is available in API version 62.0 and later. _Available in: v59.0_ _Filter group: Small_ Type: `string`. Allowed values: `OrderPrice`, `OrderWeight`. ### ConnectShippingWeightUnitEnum Unit of measurement for the weight of the cart items. Possible _Available in: v62.0_ _Filter group: Small_ Type: `string`. Allowed values: `Grams`, `Kilograms`, `Ounces`, `Pounds`. ### OCIAttributeSetOutputCommerceOrdermanagement Output representation of Attribute Set * `groupEligibilityExclusion` (_array of string_) The Group Eligibility Exclusion ### OCIFutureInventoryOutputCommerceOrdermanagement Output representation of expected future inventory * `expectedDate` (_string (date-time)_) Expected Date for the future availability * `quantity` (_number (double)_) Quantity for the future availability ### CartCoupon A cart coupon input. * `cartCouponId` (_string_) ID of the cart coupon code. _Available in: v54.0_ _Filter group: Small_ * `couponCode` (_string_) Coupon code. _Available in: v54.0_ _Filter group: Small_ * `customFields` (_array of string_) 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](https://help.salesforce.com/s/articleView?id=commerce.comm_create_shopper_profile.htm&type=5) shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile. _Available in: v63.0_ _Filter group: Small_ ### PaymentResultCode Salesforce Payment Result Code Type: `string`. Allowed values: `Decline`, `Indeterminate`, `PermanentFail`, `RequiresReview`, `Success`, `SystemError`, `ValidationError`. ### ConnectCartMessageSeverityEnum Severity of cart message. Type: `string`. Allowed values: `Error`, `Info`, `Warning`. ### RecordFieldCommerceBuyerexperiencec1de A generic record field object with type, label and text. * `dataName` (_string_) The SObject API field name of this field. * `dataType` (_string_) The SObject API data type of this field. * `label` (_string_) A localized string label describing this field. * `text` (_string_) The text value of this field. Since all fields have a text value, consumers should inspect the field type and if the type is unrecognized to the client, simply render this text value for the field. * `type` (_string_) The type of this field. ### ConnectPricingTermUnitEnumCommerceBuyerexperience Indicates the Pricing Term Unit enum values. Type: `string`. Allowed values: `Annual`, `Months`. ### ConnectProductMediaTypeEnumCommerceBuyerexperience Indicates the type of media used for a product media. Type: `string`. Allowed values: `Document`, `Image`, `Video`. ### AbstractCheckoutAddressInput Abstract address input representation * `city` (_string_) City * `companyName` (_string_) CompanyName * `country` (_string_) Country * `firstName` (_string_) FirstName * `id` (_string_) Id * `lastName` (_string_) LastName * `name` (_string_) Name * `postalCode` (_string_) Postal Code * `region` (_string_) Region * `shipToPhoneNumber` (_string_) Shipping Phone Number * `street` (_string_) Street ### AbstractLabeledRecordField A record field with a label and text value. All fields will degrade to a text value. This graceful degradation allows clients using older versions to consume new content without fear of breaking (assuming the client implements field rendering by using the text as the default case). * `dataName` (_string_) The SObject API field name of this field. * `dataType` (_string_) The SObject API data type of this field. * `label` (_string_) A localized string label describing this field. * `text` (_string_) The text value of this field. Since all fields have a text value, consumers should inspect the field type and if the type is unrecognized to the client, simply render this text value for the field. * `type` (_string_) The type of this field. ### AbstractRecordField A field on a record object. * `type` (_string_) The type of this field. ### AbstractCommerceProductSearchResults The abstract representation class for product search results * `categories` (_object_) SearchCategory Categories from the search results. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `SearchCategory`. * `correlationId` (_string_) Reserved for future use. _Available in: v55.0_ _Filter group: Small_ * `facets` (_array of DistinctValueSearchFacet_) Facets from the search results. _Available in: v55.0_ _Filter group: Medium_ * `locale` (_string_) Locale of the search results. _Available in: v55.0_ _Filter group: Small_ * `productsPage` (_object_) CommerceProductSummaryCollection Page of products from the search results. _Available in: v55.0_ _Filter group: Medium_ Includes all fields of `CommerceProductSummaryCollection`. ### AbstractProductSummary The abstract representation class for product summary * `defaultImage` (_object_) ProductMediaCommerceBuyerexperience Default image of the product. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `ProductMediaCommerceBuyerexperience`. * `fields` (_object_) Map of fields belonging to the product. _Available in: v55.0_ _Filter group: Medium_ Additional properties: `FieldValueCommerceSearch`. * `id` (_string (Id)_) ID of the product. _Available in: v55.0_ _Filter group: Small_ * `name` (_string_) Name of the product. _Available in: v55.0_ _Filter group: Small_ * `productClass` (_object_) ConnectProductClassEnum Class of product. _Available in: v55.0_ _Filter group: Small_ Includes all fields of `ConnectProductClassEnumCommerceBuyerexperience`. * `urlName` (_string_) SEO-friendly URL name for the product. _Available in: v59.0_ _Filter group: Small_ ### FacetValueCommerceSearch Abstract superclass of all facet value representations. * `type` (_object_) ConnectSearchFacetTypeEnum Search facet type. Value is: _Available in: v49.0_ _Filter group: Small_ Includes all fields of `ConnectSearchFacetTypeEnum`. ### AbstractProductAttributeSetSummary The abstract representation class for product attribute set summary * `attributes` (_array of ProductAttributeSummaryCommerceBuyerexperience_) List of all attributes in the attribute set ### ConnectProductAttributeViewTypeEnumCommerceSearch Specifies the product attribute view type either color swatch, dropdown, image swatch, pills Type: `string`. Allowed values: `ColorSwatch`, `Dropdown`, `Pill`. ### BaseTaxesInfo Base tax info representation * `countryIsoCode` (_string_) ISO code of the country. _Available in: v56.0_ _Filter group: Small_ * `priority` (_integer_) Priority of the tax treatment. _Available in: v56.0_ _Filter group: Small_ * `stateIsoCode` (_string_) ISO code of the state. _Available in: v56.0_ _Filter group: Small_ * `taxRatePercentage` (_string_) Tax rate percentage for the store. _Available in: v56.0_ _Filter group: Small_ * `taxTreatmentDescription` (_string_) Description of the tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ * `taxTreatmentName` (_string_) Name of the tax treatment for the store. _Available in: v56.0_ _Filter group: Small_ ### CompositeCommerceProductBaseInput Base input representation for creating products using composite commerce product API * `productFields` (_object_) A map of product field names and their values. _Available in: v61.0_ Additional properties: `string`. * `productMedia` (_array of ProductMediaInput_) A list of media records to be associated with the product. _Available in: v61.0_ * `productPricing` (_object_) ProductPricingInput Details of the product pricing. _Available in: v61.0_ Includes all fields of `ProductPricingInput`. ### ProductListInput Input Representation for Product List. * `additionalContextData` (_array of ContextDataInput_) Additional Context Data * `additionalFields` (_object_) Additional Fields Additional properties: `AdditionalFieldsInput`. * `catalogId` (_string_) Id of the catalog. * `categoryId` (_string_) Id of the category. * `contextDefinition` (_string_) Context Definition Name * `contextMapping` (_string_) Context Mapping Name * `correlationId` (_string_) CorrelationId * `currencyCode` (_string_) Currency code for the prices * `cursor` (_string_) Cursor * `enablePricing` (_boolean_) Enable Pricing * `enableQualification` (_boolean_) Enable Qualification * `executeConfigurationRules` (_boolean_) Execute Configuration Rules * `filter` (_FilterInput_) * `includeCatalogDetails` (_boolean_) Get Catalog details * `limit` (_integer_) Number of item count you want in the response * `offset` (_integer_) Offset size from which you need the catalog count * `orderBy` (_array of string_) Sort by ascending/descending order * `priceBookId` (_string_) Id of the price Book. * `pricingProcedure` (_string_) Pricing Procedure Name * `productClassificationId` (_string_) Id of the productClassification. * `qualificationProcedure` (_string_) Qualification Procedure Name * `relatedObjectFilters` (_array of RelatedObjectFilterInput_) RelatedObjectFilters * `transactionContextId` (_string_) Transaction Context Id * `transactionId` (_string_) Transaction Id * `usePromotions` (_boolean_) Enable Promotion Rules * `userContext` (_UserContextInput_) ### CpqBaseListOutput Base representation for list apis * `apiStatus` (_ApiStatusOutput_) * `contextId` (_string_) ContextId * `correlationId` (_string_) CorrelationId * `cursor` (_string_) Cursor * `facets` (_array of SearchProductsFacet_) List of Facets * `limit` (_integer_) Limit * `offSet` (_integer_) Offset * `query` (_object_) Input Query Object Additional properties: `object`. Additional properties: `object`. * `result` (_array of Connect_) Result object * `total` (_integer_) Totals * `userContext` (_UserContextOutput_) ### Connect ### AdditionalFieldsInput Input Representation for Additional Fields. * `additionalFields` (_object_) additionalFields Additional properties: `AdditionalFieldsInput`. * `fields` (_array of string_) Fields list ### ContextDataInput Input Representation for Context Data * `nodeData` (_object_) Node Data Additional properties: `object`. * `nodeName` (_string_) Node Name ### UserContextInput Input Representation for User Context. * `accountId` (_string_) Account Id * `contactId` (_string_) Contact Id * `contextId` (_string_) Context Id * `internalOrganizationUnitId` (_string_) Internal Organization Unit Id ### BaseProductListInput Input Representation for Base Product List. * `additionalContextData` (_array of ContextDataInput_) Additional Context Data * `additionalFields` (_object_) Additional Fields Additional properties: `AdditionalFieldsInput`. * `catalogId` (_string_) Id of the catalog. * `categoryId` (_string_) Id of the category. * `contextDefinition` (_string_) Context Definition Name * `contextMapping` (_string_) Context Mapping Name * `correlationId` (_string_) CorrelationId * `currencyCode` (_string_) Currency code for the prices * `cursor` (_string_) Cursor * `enablePricing` (_boolean_) Enable Pricing * `enableQualification` (_boolean_) Enable Qualification * `executeConfigurationRules` (_boolean_) Execute Configuration Rules * `filter` (_FilterInput_) * `includeCatalogDetails` (_boolean_) Get Catalog details * `limit` (_integer_) Number of item count you want in the response * `offset` (_integer_) Offset size from which you need the catalog count * `orderBy` (_array of string_) Sort by ascending/descending order * `priceBookId` (_string_) Id of the price Book. * `pricingProcedure` (_string_) Pricing Procedure Name * `productClassificationId` (_string_) Id of the productClassification. * `qualificationProcedure` (_string_) Qualification Procedure Name * `relatedObjectFilters` (_array of RelatedObjectFilterInput_) RelatedObjectFilters * `transactionContextId` (_string_) Transaction Context Id * `transactionId` (_string_) Transaction Id * `usePromotions` (_boolean_) Enable Promotion Rules * `userContext` (_UserContextInput_) ### ApiStatusOutput API Status Output Representation * `messages` (_array of CpqMessageOutput_) API status messages * `statusCode` (_ApiResponseStatusCode_) * `statusMessage` (_string_) Status Message - Display label for API status ### CpqAbstractListOutput Abstract representation for list apis * `apiStatus` (_ApiStatusOutput_) * `contextId` (_string_) ContextId * `correlationId` (_string_) CorrelationId * `cursor` (_string_) Cursor * `limit` (_integer_) Limit * `offSet` (_integer_) Offset * `result` (_array of Connect_) Result object * `total` (_integer_) Totals * `userContext` (_UserContextOutput_) ### UserContextOutput User Context Output Representation * `contextId` (_string_) Context Id ### ConfiguratorProductCatalogOutput Output Representation for the Configurator API's Enterprise Product Catalog * `additionalFields` (_array of ConfiguratorAdditionalFieldsOutput_) Additional Fields * `attributeCategories` (_array of ConfiguratorAttributeCategoryOutput_) List of Attribute Categories * `availabilityDate` (_string (date-time)_) Availability Date * `description` (_string_) Product Description * `discontinuedDate` (_string (date-time)_) Discontinued Date * `displayUrl` (_string_) Display URL * `endOfLifeDate` (_string (date-time)_) End of Life Date * `id` (_string_) Product ID * `isActive` (_boolean_) Is this Product Active * `isAssetizable` (_boolean_) Is this Product Assetizable * `isComponentRequired` (_boolean_) Is Component Required * `isConfigurable` (_boolean_) Is Configurable * `isDefaultComponent` (_boolean_) Is Default Component * `isQuantityEditable` (_boolean_) Is Quantity Editable * `isSoldOnlyWithOtherProds` (_boolean_) Is this Product Sold Only with Other Products * `name` (_string_) Product Name * `nodeType` (_string_) Node Type * `prices` (_array of ConfiguratorPriceOutput_) List of Prices * `productClassification` (_ConfiguratorProductClassificationOutput_) * `productCode` (_string_) Product Code * `productComponentGroups` (_array of ConfiguratorProductComponentGroupOutput_) Set of Product Component Groups * `productRelatedComponent` (_ConfiguratorProductRelatedComponentOutput_) * `productSellingModelOptions` (_array of ConfiguratorProductSellingModelOptionOutput_) List of Product Selling Model Options * `productType` (_string_) Product Type * `productUsageModelType` (_string_) Product Usage Model Type * `qualificationContext` (_ConfiguratorQualificationContextOutput_) * `status` (_string_) Product Status * `unitOfMeasure` (_ConfiguratorUnitOfMeasureOutput_) ### ConfiguratorQualificationContextOutput Output Representation for the Configurator API's Qualification Context * `isQualified` (_boolean_) Is Qualified * `reason` (_string_) Reason ### SearchProductsFacet Search Products Facet Representation * `attributeType` (_string_) Search attribute type of the facet. * `displayName` (_string_) Display name of the facet. * `displayRank` (_integer_) Display rank for the facet. * `nameOrId` (_string_) ID or internal name of the facet. * `values` (_array of FacetValue_) Values of the facet found in the search result. ### FilterInput Input Representation for Filters * `criteria` (_array of FilterCriteriaInput_) filter criteria ### RelatedObjectFilterInput Input Representation for Filters * `criteria` (_array of FilterCriteriaInput_) filter criteria * `objectName` (_string_) Object Name ### CpqMessageOutput Output representation for apis message * `code` (_MessageCode_) * `detail` (_string_) Message detail contains any info needed other than message text * `message` (_string_) Message text * `severity` (_MessageSeverity_) ### ConfiguratorAdditionalFieldsOutput Output Representation for the Configurator API's Additional Fields * `contextAttributeApiName` (_string_) Mapped context attribute API name * `fieldApiName` (_string_) Field Api Name * `fieldName` (_string_) Field Name * `value` (_string_) Field Value ### ConfiguratorAttributeCategoryOutput Output Representation for the Configurator API's Attribute Category * `attributes` (_array of ConfiguratorAttributeOutput_) Attributes of this attribute category * `code` (_string_) Code of this attribute category * `description` (_string_) Description of this attribute category * `id` (_string_) ID of this attribute category * `name` (_string_) Name of this attribute category * `status` (_string_) Status of this attribute category * `totalSize` (_integer_) Total Size of this attribute category * `usageType` (_string_) Usage Type of this attribute category ### ConfiguratorPriceOutput Output Representation for the Configurator API's Prices * `currencyIsoCode` (_string_) Currency ISO Code * `effectiveFrom` (_string_) Effective From * `effectiveTo` (_string_) Effective To * `isDefault` (_boolean_) Default Pricing Model * `isDerived` (_boolean_) Is Derived * `isSelected` (_boolean_) Selected Pricing Model * `pricebookEntryId` (_string_) Pricebook Entry ID * `pricebookId` (_string_) Pricebook ID * `pricingModel` (_ConfiguratorPricingModelOutput_) * `unitPrice` (_number (double)_) Unit Price ### ConfiguratorProductClassificationOutput Output Representation for the Configurator API's Product Classification * `id` (_string_) Product Classification ID ### ConfiguratorProductComponentGroupOutput Output Representation for the Configurator API's Product Component Group * `childGroups` (_array of ConfiguratorProductComponentGroupOutput_) ChildGroups _This property is recursive: each item has the same structure as `ConfiguratorProductComponentGroupOutput`._ * `classifications` (_array of ConfiguratorProductClassificationOutput_) List of Product Classifications * `code` (_string_) Code * `components` (_array of ConfiguratorProductCatalogOutput_) Components * `description` (_string_) Description * `id` (_string_) Product Component Group ID * `maxBundleComponents` (_integer_) Max Bundle Components * `minBundleComponents` (_integer_) Min Bundle Components * `name` (_string_) Name * `parentGroupId` (_string_) ParentGroupId * `parentProductId` (_string_) Parent Product ID * `sequence` (_integer_) Sequence ### ConfiguratorProductRelatedComponentOutput Output Representation for the Configurator API's Product Related Component * `childProductId` (_string_) Child Product ID * `childSellingModelId` (_string_) Child PSM Id * `doesBundlePriceIncludeChild` (_boolean_) Does the bundle price include child products * `id` (_string_) ID of this Product Related Component * `isComponentRequired` (_boolean_) Is Component Required * `isDefaultComponent` (_boolean_) Is Default Component * `isQuantityEditable` (_boolean_) Is Quantity Editable * `maxQuantity` (_number (double)_) Max Quantity * `minQuantity` (_number (double)_) Min Quantity * `parentProductId` (_string_) Parent Product ID * `parentSellingModelId` (_string_) Parent PSM Id * `productClassificationId` (_string_) Product Classification ID * `productComponentGroupId` (_string_) Product Component Group ID * `productInstanceReuse` (_string_) Product Instance Reuse * `productRelationshipTypeId` (_string_) PRT Id * `quantity` (_number (double)_) Default Quantity * `quantityScaleMethod` (_QuantityScaleMethodConnectEnum_) * `sequence` (_integer_) Sequence * `unitOfMeasure` (_ConfiguratorUnitOfMeasureOutput_) ### ConfiguratorProductSellingModelOptionOutput Output Representation for the Configurator API's Product Selling Model Option * `id` (_string_) PSMO ID * `isDefault` (_boolean_) isDefault * `productId` (_string_) Product ID * `productSellingModel` (_ConfiguratorProductSellingModelOutput_) * `productSellingModelId` (_string_) PSM ID ### ConfiguratorUnitOfMeasureOutput Output Representation for the Configurator API's UnitOfMeasure * `id` (_string_) Id of unitOfMeasure * `name` (_string_) Name of unitOfMeasure * `roundingMethod` (_string_) RoundingMethod of unitOfMeasure * `scale` (_integer_) Scale of unitOfMeasure * `unitCode` (_string_) UnitCode of unitOfMeasure ### FacetValue Search Products Facet Value Representation * `displayName` (_string_) Display Name of the facet value. * `nameOrId` (_string_) ID or internal name of the facet value. ### ApiResponseStatusCode Enumerations to represent the fixed API Status Codes to be used for API Responses Type: `string`. Allowed values: `AttributeNotFound`, `CartFetchedSuccessfully`, `CartItemSuccessfullyAdded`, `CartItemsMissingPricingInfoError`, `CartNotAvailable`, `CartPricingContextBuildError`, `CartPricingError`, `CartPricingJsonError`, `CartPricingNoContextError`, `CartPricingUnknownError`, `CartRetrieveError`, `CartSuccessfullyCreated`, `CartSuccessfullyUpdated`, `CartUpdateError`, `CartitemNotFoundError`, `CategoryQualificationFailed`, `ChatContextIdExpired`, `ConfigDeleted`, `DuplicateCartError`, `DuplicateFavName`, `FetchedDetailsSuccessfully`, `GuidedSelectionResponseRetrievalFailed`, `InternalServerError`, `InvalidAccountId`, `InvalidAdditionalFields`, `InvalidCartId`, `InvalidCatalogId`, `InvalidCategoryId`, `InvalidConfiguration`, `InvalidContactId`, `InvalidDepth`, `InvalidFavoriteId`, `InvalidFilter`, `InvalidFilterOperator`, `InvalidInputAttributeError`, `InvalidInputQuantiyError`, `InvalidInternalOrgUnitId`, `InvalidOffset`, `InvalidPageSize`, `InvalidParentCategoryId`, `InvalidPricebookId`, `InvalidProductClassId`, `InvalidProductConfig`, `InvalidProductId`, `InvalidProductSellingModelId`, `InvalidReferenceRecordId`, `InvalidSObject`, `InvalidSearchString`, `InvalidSortDirection`, `InvalidUserId`, `MaxQuantityValidationError`, `MinQuantityValidationError`, `MissingCartId`, `MissingCartItemId`, `MissingCatalogId`, `MissingCategoryId`, `MissingFavoriteData`, `MissingFavoriteDescription`, `MissingFavoriteId`, `MissingFavoriteName`, `MissingFavoriteReferencerecordId`, `MissingFavoriteUserId`, `MissingInputParamActions`, `MissingOrderName`, `MissingOrderSubmissionDate`, `MissingPriceBookId`, `MissingPricingInformation`, `MissingProductId`, `MissingReferenceRecordId`, `MissingSearchTermOrGuidedSelectionResponseId`, `MissingUserContext`, `MissingUserQueryInSearchParam`, `NoCatalogDetails`, `NoCategoryDetails`, `NoCategoryList`, `NoProductFound`, `NoProductIds`, `NoValidActionSpecified`, `NoValidationFound`, `OrderNotfoundError`, `OrderPersistenceError`, `OrderRetrievalError`, `OrderSuccessfullyCreated`, `OrderUpdateError`, `PartialProductsList`, `ProductDiscoveryContextFailed`, `ProductDiscoveryInactiveContext`, `ProductDiscoveryInactivePricingProcedure`, `ProductDiscoveryInactiveQualificationProcedure`, `ProductIdsAboveLimit`, `ProductPricingContextFailed`, `ProductPricingFailed`, `ProductPricingWithWarning`, `ProductQualificationFailed`, `ProductQualificationWithWarning`, `PromotionRulesFailed`, `RelatedObjectFilters`, `RelatedObjectFiltersCriteriaLimitExceeded`, `RelatedObjectFiltersLimitExceeded`, `RelatedObjectFiltersOperatorNotSupported`, `RelatedObjectFiltersPropertyNotSupported`, `RelatedObjectFiltersUnsupportedObjectName`, `RelatedObjectFiltersValueNotSupported`, `RequiredAttributeError`, `UnableToAddToCart`, `UnableToCreateCart`, `UnknownError`. ### QuantityScaleMethodConnectEnum Connect Enum for Quantity Scale Method Type: `string`. Allowed values: `Constant`, `Proportional`. ### FilterCriteriaInput Input Representation for Filter Criteria * `attributeType` (_string_) attributeType * `operator` (_string_) operator * `property` (_string_) property * `value` (_any_) value ### ConfiguratorAttributeOutput Output Representation for the Configurator API's Attributes * `attributeCategoryId` (_string_) Attribute Category ID of the attribute * `attributeNameOverride` (_string_) attribute name override of the attribute * `attributePicklist` (_ConfiguratorAttributePicklistOutput_) * `code` (_string_) Code of the attribute * `dataType` (_string_) Data Type of the attribute * `defaultHelpText` (_string_) Default Value Help Text of the attribute * `defaultValue` (_string_) Default Value of the attribute * `description` (_string_) Description of the attribute * `developerName` (_string_) Developer name of the attribute * `displayType` (_string_) display type of the attribute * `id` (_string_) ID of the attribute * `isCloneable` (_boolean_) Is this attribute cloneable * `isConfigurable` (_boolean_) Is this attribute configurable * `isEncrypted` (_boolean_) Is this attribute encrypted * `isHidden` (_boolean_) Is this attribute hidden * `isPriceImpacting` (_boolean_) Is this attribute price impacting * `isReadOnly` (_boolean_) Is this attribute read only * `isRequired` (_boolean_) Is this attribute required * `label` (_string_) Label of the attribute * `maximumValue` (_string_) Product Attribute Maximum Value * `minimumValue` (_string_) Product Attribute Minimum Value * `name` (_string_) Name of the attribute * `sequence` (_integer_) Sequence Values of this attribute * `status` (_string_) Status of the attribute * `stepValue` (_string_) Product Attribute Step Value * `unitOfMeasure` (_ConfiguratorUnitOfMeasureOutput_) * `userValue` (_string_) User Value of this attribute * `valueDecoder` (_string_) Product Attribute Value Decoder * `valueDescription` (_string_) value description of the attribute ### ConfiguratorPricingModelOutput Output Representation for the Configurator API's Pricing Model * `frequency` (_string_) Frequency * `id` (_string_) Pricing Model ID * `name` (_string_) Name * `occurrence` (_integer_) Occurrence * `pricingModelType` (_string_) Pricing Model Type * `unitOfMeasure` (_string_) Unit of Measure ### ConfiguratorProductSellingModelOutput Output Representation for the Configurator API's Product Selling Model * `doesAutoRenewByDefault` (_boolean_) Does Product Automatically Renew by Default * `id` (_string_) PSM ID * `name` (_string_) PSM Name * `pricingTerm` (_integer_) Pricing Term * `pricingTermUnit` (_string_) Pricing Term Unit * `sellingModelType` (_string_) Selling Model Type * `status` (_string_) PSM Status ### MessageCode Enumerations to represent the fixed Message Codes to be used for messages within API Responses Type: `string`. Allowed values: `CartValidationError`. ### MessageSeverity Enumerations to represent the fixed Message Severity levels to be used for messages within API Responses Type: `string`. Allowed values: `Error`, `Info`, `Warning`. ### ConfiguratorAttributePicklistOutput Output Representation for the Configurator API's Attribute Picklist * `description` (_string_) Description of the attribute pickist * `id` (_string_) ID of the attribute pickist * `name` (_string_) Name of the attribute pickist * `status` (_string_) Status of the attribute pickist * `values` (_array of ConfiguratorAttributePicklistValueOutput_) Values of the attribute picklist ### ConfiguratorAttributePicklistValueOutput Output Representation for the Configurator API's Attribute Picklist Value * `code` (_string_) Code of the attribute value * `description` (_string_) Description of the attribute value * `displayValue` (_string_) Display value of the attribute value * `id` (_string_) ID of the attribute value * `isBooleanValue` (_boolean_) Is this attribute value a boolean * `label` (_string_) Label of the attribute value * `name` (_string_) Name of the attribute value * `sequence` (_integer_) Sequence of the attribute value * `status` (_string_) Status of the attribute value * `textValue` (_string_) Text value of the attribute value ### SavedPaymentMethodAbstractOutput Payment Saved Payment Method output representation * `gatewayResponse` (_object_) Gateway Response Map Additional properties: `object`. ### SavedPaymentMethodStatus Possible values for status values of saved payment methods Type: `string`. Allowed values: `Active`, `AwaitingPayment`, `Errored`, `Expired`. ### SavedPaymentMethodType Possible values for Type values of saved payment methods Type: `string`. Allowed values: `Amazon_pay`, `Au_becs_debit`, `Bacs_debit`, `Bancontact`, `Card`, `Ideal`, `Sepa_debit`, `Us_bank_account`. ### SavedPaymentMethodUsageType Possible values for Usage types of saved payment methods Type: `string`. Allowed values: `OffSession`, `OnSession`. ### CommerceEinsteinBaseActivityJob Holds the status of an activity job * `jobId` (_string_) ID of the job. _Available in: v52.0_ _Filter group: Small_ * `statusCode` (_object_) ConnectCommerceEinsteinActivityJobStatusEnum Status code for the job. Values are: * `Completed` —Job completed. * `NoData` —Export job completed with no data. * `Pending` —Job is in progress. _Available in: v52.0_ _Filter group: Small_ Includes all fields of `ConnectCommerceEinsteinActivityJobStatusEnum`. * `url` (_string (url)_) URL to the job resource. _Available in: v52.0_ _Filter group: Small_ ### BaseOutputCommerceOrdermanagement Base Output Representation * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### BaseSequenceInput Input representation for Base Sequence Input * `amount` (_number (double)_) Amount _Available in: v65.0_ * `orderPaymentSummaryId` (_string (Id)_) Order Payment Summary ID _Available in: v65.0_ * `rank` (_integer_) Rank _Available in: v65.0_ ### AddOrderItemSummaryOutput Output representation of an add order item * `changeBalances` (_ChangeItemOutput_) * `changeOrderId` (_string_) Change Order ID for the add order item summary * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `newItems` (_array of AddItemOutput_) List of items from the add order item summary action * `orderSummaryId` (_string_) Order Summary ID for the add order item summary * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### BaseAsyncOutput Output representation of the async operation * `backgroundOperationId` (_string_) ID of the background operation. _Available in: v56.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### BaseInvoiceOutput Base Output representation of the created invoice * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `invoiceId` (_string_) ID of the created invoice. _Available in: v56.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### CaptureFundsOutput Capture funds output representation * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderPaymentSummaryId` (_string_) Order Payment Summary Id this Capture Funds belongs to * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### EnsurePaymentCreditOutput A list of payment credits created from the credit memo with success status and error information. Shows all payment credits successfully issued to the customer's payment methods and any errors encountered during processing. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `paymentCredits` (_array of PaymentCreditOutput_) The list of payment credits that were created. _Available in: v65.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### CartToExchangeOrderOutput Output representation of cart to exchange order. * `balanceStateExchangeWebCart` (_object_) BalanceStatePreviewOutput The balance state preview for the exchange web cart. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `balanceStateOriginalOrderSummary` (_object_) BalanceStatePreviewOutput The balance state preview for the original order summary. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `balanceStateReturnOrder` (_object_) BalanceStatePreviewOutput The balance state preview for the return order. _Available in: v61.0_ _Filter group: Big_ Includes all fields of `BalanceStatePreviewOutput`. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### PaymentCreditOutput The payment credit ID, amount, and order payment summary ID for a newly created payment credit. Represents a single credit transaction that was applied to a specific payment method with the generated credit ID for tracking. * `amount` (_number (double)_) The amount in the payment credit. _Available in: v65.0_ _Filter group: Big_ * `orderPaymentSummaryId` (_string_) The order payment summary’s ID. _Available in: v65.0_ _Filter group: Big_ * `paymentCreditId` (_string_) The created payment credit’s ID. _Available in: v65.0_ _Filter group: Big_ ### DecomposeOrderSummaryOutput An Apex ConnectApi\_DecomposeOrderSummaryAsynOutputRepresentation record that contains details about the order summary that was sent for decomposition. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `isDecomposable` (_boolean_) Indicates whether the order summary can be decomposed. * `orderSummaryId` (_string_) The ID of the order summary. * `salesTransactionFulfillmentRequestId` (_string_) ID of the Salesforce transaction flow run. * `status` (_string_) The status of the decompose operation. * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### AddItemAdjustmentOutput Output representation of an add order item adjustment line summary * `id` (_string_) The ID for AddItemAdjustment output representation * `name` (_string_) The Name for AddItemAdjustment output representation * `orderItemTaxLineItemSummaries` (_array of AddItemTaxOutput_) The OrderItemTaxLineItemSummaries list for AddItemAdjustment output representation ### PreviewBaseOutput Change order financial values for a preview order action. * `changeBalances` (_object_) ChangeItemOutput Expected financial values for the proposed cancel action. _Available in: v48.0_ _Filter group: Big_ Includes all fields of `ChangeItemOutput`. * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `orderSummaryId` (_string_) The ID of the OrderSummary. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### CancelAllOrderItemsAsyncOutput ID of the asynchronous background operation. * `asyncOperationLogId` (_string_) ID of the background operation. _Available in: v63.0_ _Filter group: Big_ * `errors` (_array of ErrorResponseOutput_) Any errors that were returned. _Available in: v48.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the transaction was successful. _Available in: v48.0_ _Filter group: Big_ ### AddItemOutput Output representation of an add order item * `id` (_string_) The ID for AddItem output representation * `name` (_string_) The Name for AddItem output representation * `orderItemAdjustmentLineSummaries` (_array of AddItemAdjustmentOutput_) The OrderItemAdjustmentLineSummaries list for AddItem output representation * `orderItemTaxLineItemSummaries` (_array of AddItemTaxOutput_) The OrderItemTaxLineItemSummaries list for AddItem output representation ### AddItemTaxOutput Output representation of an add order item tax line item summary * `id` (_string_) The ID for AddItemTax output representation * `name` (_string_) The Name for AddItemTax output representation ### FulfillmentRoutingCriteriaGroupUpdateOutput Output representation for fulfillment criteria group update operations * `criteriaGroupVersionId` (_string_) The ID of the criteria group version * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### MarkdownAvoidanceLocationOutput Location entry on a Markdown Avoidance definition * `city` (_string_) City * `country` (_string_) Country * `id` (_string_) FulfmtRoutgSpecLocation id (used for edit / delete operations) * `isActive` (_boolean_) Whether this location association is active on the spec * `locationId` (_string_) Referenced Location identifier * `locationName` (_string_) Location name * `postalCode` (_string_) Postal code * `state` (_string_) State / region * `street` (_string_) Street ### CDSLocationGraphSyncOutput Output representation of Commerce Delivery Service Location Graph Sync * `description` (_string_) Description * `error` (_string_) Error * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `externalReference` (_string_) External Reference * `finishedAt` (_string (date-time)_) Finished At * `id` (_string_) Id * `lastStatusUpdateAt` (_string (date-time)_) Last Status Update At * `startedAt` (_string (date-time)_) Started At * `status` (_string_) Status * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ * `type` (_string_) Type ### MarkdownAvoidanceCollectionOutput Collection of Markdown Avoidance definitions * `definitions` (_array of MarkdownAvoidanceSummaryOutput_) Definitions in the collection * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### BaseOutput Base Output Representation * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### BaseCriteriaGroupVersionOutput Base output representation for criteria group version operations * `criteriaGroupVersionId` (_string_) The ID of the criteria group version * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### DeliveryConfigurationOutput Output representation of delivery configuration setup * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### FulfillmentRoutingCustomCriteriaOutput Output representation for fulfillment routing custom criteria create operation * `criteriaId` (_string_) The generated ID of the custom criteria * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### MarkdownAvoidanceProductOutput Product entry on a Markdown Avoidance definition * `details` (_string_) Secondary display value: SKU for PRODUCT, count of products for CATEGORY * `id` (_string_) Polymorphic product source id: Product2.Id when type=PRODUCT, ProductCategory.Id when type=CATEGORY. Used by edit-mode clients to round-trip the source reference back through CREATE/UPDATE. * `name` (_string_) Display name for the product reference * `type` (_MarkdownAvoidanceProductType_) ### MarkdownAvoidanceOutput Markdown Avoidance definition with full detail * `description` (_string_) Free-form description * `endDate` (_string (date-time)_) Markdown end date * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `externalReference` (_string_) External reference (CDS-side identifier; sourced from FulfmtRoutgSpec.ExternalReference) * `id` (_string_) Markdown Avoidance definition id * `isActive` (_boolean_) Whether the definition is currently active * `isFutureMarkdownEnabled` (_boolean_) Whether future markdown is enabled * `lastModifiedDate` (_string (date-time)_) Last modified date * `locations` (_array of MarkdownAvoidanceLocationOutput_) Locations affected by this definition * `markdownType` (_string_) Markdown amount type (Percentage or Fixed) * `name` (_string_) Definition name * `products` (_array of MarkdownAvoidanceProductOutput_) Products affected by this definition * `score` (_number (double)_) Markdown score (sourced from FulfmtRoutgSpec.FutureMarkdownAmount) * `startDate` (_string (date-time)_) Markdown start date * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### FulfillmentRoutingCriteriaGroupActionDraftOutput Output representation for fulfillment criteria group draft action operations * `criteriaGroupVersionId` (_string_) The ID of the criteria group version * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### MarkdownAvoidanceUpdateOutput Markdown Avoidance update response * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `id` (_string_) Id of the updated Markdown Avoidance definition * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### MarkdownAvoidanceProductType Kind of product reference on a Markdown Avoidance product entry Type: `string`. Allowed values: `Category`, `Product`. ### FulfillmentRoutingCriteriaGroupCreateOutput Output representation for fulfillment criteria group create operation * `criteriaGroupId` (_string_) The generated ID of the criteria group version * `criteriaGroupVersionId` (_string_) The ID of the criteria group version * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### FulfillmentRoutingCriterionUpdateOutput Output representation for fulfillment routing criterion update operations * `criterionId` (_string_) The ID of the updated fulfillment routing criterion * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### CDSFulfmtRoutgSpecSyncOutput Output representation for the sync response. Indicates success/failure and provides retry guidance for transient errors. * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `message` (_string_) Human-readable message describing the result * `retryable` (_boolean_) Indicates whether the operation can be retried (true for 5xx/timeout errors, false for 4xx errors). This is a hint for the caller - the API does not implement retry logic. Callers should implement exponential backoff with a maximum of 3-5 retry attempts for retryable failures. * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### MarkdownAvoidanceSummaryOutput Markdown Avoidance definition row in the list view * `categoriesAffected` (_integer_) Number of product categories affected by this definition * `endDate` (_string (date-time)_) Markdown end date * `externalReference` (_string_) External reference (CDS-side identifier; sourced from FulfmtRoutgSpec.ExternalReference) * `id` (_string_) Markdown Avoidance definition id * `lastModifiedDate` (_string (date-time)_) Last modified date * `locationsAffected` (_integer_) Number of locations affected by this definition * `markdownType` (_string_) Markdown amount type (Percentage or Fixed) * `name` (_string_) Definition name * `productsAffected` (_integer_) Number of products affected by this definition * `score` (_number (double)_) Markdown score (sourced from FulfmtRoutgSpec.FutureMarkdownAmount) * `startDate` (_string (date-time)_) Markdown start date ### MarkdownAvoidanceCreateOutput Markdown Avoidance create response * `errors` (_array of ErrorResponseBilling_) Any errors that were returned. _Available in: v67.0_ _Filter group: Big_ * `id` (_string_) Id of the created Markdown Avoidance definition * `success` (_boolean_) Indicates whether the request succeeded. _Available in: v67.0_ _Filter group: Big_ ### OCIBaseOutput Base Omnichannel Output representation * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `success` (_boolean_) Indicates whether the transaction was successful. ### OCICancelReservationOutput Output representation of cancel inventory reservation * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `success` (_boolean_) Indicates whether the transaction was successful. ### BaseOutputCommerceInventory Base Output Representation * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `success` (_boolean_) Indicates whether the transaction was successful. ### InventoryReservationItemOutput Output representation of the Inventory Reservation Item * `errorCode` (_string_) Error Code * `errorMessage` (_string_) Error Message * `inventoryItemReservationId` (_string_) Inventory Item Reservation Id * `itemReservationSourceId` (_string_) Item Reservation Source Id * `productId` (_string_) Product Id * `quantity` (_number (double)_) Quantity ### InventoryReservationOutput Output representation Inventory Reservation * `durationInSeconds` (_integer_) Duration In Seconds * `errors` (_array of ErrorResponseBilling_) Any errors that resulted in the transaction * `inventoryReservationId` (_string_) Inventory Reservation Id * `inventoryReservationItems` (_array of InventoryReservationItemOutput_) Inventory Reservation Items * `reservationIdentifier` (_string_) Reservation Identifier * `reservationSourceId` (_string_) Reservation Source Id * `success` (_boolean_) Indicates whether the transaction was successful. ### CreditMemoInput The credit memo that’s being issued as credit. The specified amount from the credit memo balance is issued as payment credit. * `adjustments` (_array of AdjustmentLineInput_) Adjustment List * `amount` (_number (double)_, required) The amount of the credit memo balance that’s being issued as credit. _Available in: v65.0_ * `billingAccountId` (_string (Id)_) Billing Account Id * `billToContactId` (_string (Id)_) Bill To Contact Id * `charges` (_array of ChargeLineInput_) Charge List * `creditDate` (_string (date-time)_) Credit Date * `currencyIsoCode` (_string_) Credit Memo Currency * `description` (_string_) Description * `id` (_string_, required) The ID of the credit memo. _Available in: v65.0_ * `referenceId` (_string (Id)_) Reference Id * `status` (_CreditMemoStatus_) * `taxes` (_array of TaxLineInput_) Tax List * `taxLocaleType` (_TaxLocaleType_) ### StandaloneTaxStrategyEnum Indicates how tax lines should be created for standalone credit memos Type: `string`. Allowed values: `Calculate`, `Ignore`, `ManualOverride`. ### StandaloneCreditMemoTaxInput Connect API representation of Tax input request * `taxAmount` (_number (double)_) Amount of tax that should be applied * `taxCode` (_string_) Tax Code of tax that should be applied * `taxName` (_string_) Name of tax that should be applied * `taxRate` (_number (double)_) Tax Code of tax that should be applied under this invoice line ### AddressInput Address input representation for a payment method, payment intent, or card payment method. * `city` (_string_) City _Available in: v49.0_ * `country` (_string_) Country, specified using the ISO country code. _Available in: v49.0_ * `countryCode` (_string_) Country Code * `latitude` (_number (double)_) latitude * `locationCode` (_string_) locationCode * `longitude` (_number (double)_) longitude * `postalCode` (_string_) Postal code _Available in: v49.0_ * `state` (_string_) State _Available in: v49.0_ * `stateCode` (_string_) State Code * `street` (_string_) Street _Available in: v49.0_ * `companyName` (_string_) Company name _Available in: v49.0_ ### InvoiceInputBillinge381 Input representation of the details of the billing schedule. * `invoices` (_array of InvoiceInputBillinge381_) Invoice List _This property is recursive: each item has the same structure as `InvoiceInputBillinge381`._ * `accountId` (_string_) ID of the account record to create the invoices for. Required if the `billingScheduleIds` or `billingTransactionId` property isn’t specified. _Available in: v63.0_ * `action` (_string_, required) Type of invoice to be created. Valid values are: * Draft * Posted _Available in: v62.0_ * `billingScheduleIds` (_array of string_) List of billing schedule IDs that’s used to create the invoices. You can specify a maximum of 200 billing schedules. Required if the `accountId` or `billingTransactionId` property isn’t specified. _Available in: v62.0_ * `billingTransactionId` (_string_) ID of the billing transaction record, which is the order ID, to create the invoices for. Required if the `accountId` or `billingScheduleIds` property isn’t specified. _Available in: v63.0_ * `configurationOverrides` (_object_) InvoiceAPIConfigurationOverrideInput Additional configuration details for generating an invoice. These details specify whether the generation of payment schedules and payment schedule items must be skipped. _Available in: v63.0_ Includes all fields of `InvoiceAPIConfigurationOverrideInput`. * `correlationId` (_string_) Property that’s tagged against the published `InvoiceProcessedEvent` event, if specified. _Available in: v62.0_ * `invoiceDate` (_string_, required) Stamping date of the invoice in ISO 8601 format. _Available in: v62.0_ * `targetDate` (_string_, required) Date in ISO 8601 format used to decide the billing periods that are included to create invoices. _Available in: v62.0_ ### StandaloneCreditMemoBaseInput Base class for Credit memo Connect input representations. * `addresses` (_CreditMemoAddressesInput_) * `description` (_string_) Description for the Charge Line * `endDate` (_string_) End Date for the Charge Line * `isTaxOnlyCredit` (_boolean_) Credit taxes only field for Charge Line * `productId` (_string (Id)_) Product Id for the Charge Line * `productName` (_string_) Product Name for the Charge Line * `startDate` (_string_) Start Date for the Charge Line * `taxEffectiveDate` (_string_) Tax Effective Date for the Charge Line * `taxStrategy` (_StandaloneTaxStrategyEnum_) * `taxes` (_array of StandaloneCreditMemoTaxInput_) Taxes for the Charge Line * `treatmentId` (_string (Id)_) Treatment ID for the Charge Line ### PrevInvLineOutput Connect API representation for Preview Invoice Lines result. * `billingAddress` (_AddressOutput_) * `billingFrequency` (_string_) The frequency at which the invoice line is created for the billing transaction. * `chargeAmount` (_number (double)_) The charge amount of the invoice line. * `customGroupingKey` (_string_) The custom invoice grouping key from the billing schedule associated with this invoice line. * `description` (_string_) The description of the Invoice Line * `endDate` (_string_) The end date of the billing for the service for invoice lines made from a time-based service. * `lineAmount` (_number (double)_) The line amount of the invoice line. * `productName` (_string_) The name of the product that was charged or ordered to create the invoice line. * `quantity` (_integer_) The number of units of the order product that created the invoice line. * `relatedInvoiceLines` (_array of PrevInvLineOutput_) List of related/child invoice lines taxes _This property is recursive: each item has the same structure as `PrevInvLineOutput`._ * `relatedTaxLines` (_array of PrevInvLineTaxOutput_) List of related/child invoice lines * `shippingAddress` (_AddressOutput_) * `startDate` (_string_) The first date of the billing for the service for invoice lines made from a time-based service. * `taxAmount` (_number (double)_) The tax amount for the invoice line. * `unitPrice` (_number (double)_) The price for one unit of the item on the invoice line. ### TaxLineInput Tax Line input representation * `description` (_string_) Description * `endDate` (_string (date-time)_) End Date * `grossUnitPrice` (_number (double)_) Gross Unit price * `itemTypeValue` (_string_) The reference item type value * `name` (_string_) Name * `productId` (_string (Id)_) ProductId * `referenceItemId` (_string (Id)_) ReferenceItemId * `startDate` (_string (date-time)_) Start Date * `taxAmount` (_number (double)_) Tax Amount * `taxCode` (_string_) Tax Code * `taxEffectiveDate` (_string (date-time)_) Tax Effective Date * `taxName` (_string_) Tax Name * `taxRate` (_number (double)_) Tax Rate ### InvoiceInputBillinga7eb Connect API representation of an invoice service input request * `adjustments` (_array of AdjustmentLineInput_) Adjustment List * `billingAccountId` (_string (Id)_) Billing Account Id * `billToContactId` (_string (Id)_) Bill To Contact Id * `charges` (_array of InvoiceChargeLineInput_) Charge List * `currencyIsoCode` (_string_) Credit Memo Currency * `description` (_string_) Description * `dueDate` (_string (date-time)_) Due Date * `invoiceDate` (_string (date-time)_) Invoice Date * `referenceId` (_string (Id)_) Reference Id * `status` (_InvoiceStatus_) * `taxes` (_array of TaxLineInput_) Tax List * `taxLocaleType` (_TaxLocaleType_) ### TransactionLineInput Transaction line input representation * `description` (_string_) Description * `endDate` (_string (date-time)_) End Date * `grossUnitPrice` (_number (double)_) Gross Unit price * `itemTypeValue` (_string_) The reference item type value * `name` (_string_) Name * `productId` (_string (Id)_) ProductId * `referenceItemId` (_string (Id)_) ReferenceItemId * `startDate` (_string (date-time)_) Start Date ### CreditMemoAddressesInput Connect API representation of Addresses for Credit API * `billingAddress` (_AddressInputBilling_) * `shipFromAddress` (_AddressInputBilling_) * `shippingAddress` (_AddressInputBilling_) ### ReferenceItemBaseInput Base class for all Billing Schedule input representations. * `amount` (_number (double)_) The amount on billing schedule * `billDayOfMonth` (_integer_) The billing day of month * `billToContactId` (_string (Id)_) The Bill To Contact Id * `billingAccountId` (_string (Id)_) The billing account id * `billingAccountIdAsString` (_string_) The Billing Account id * `billingAddress` (_AddressInput_) * `billingMethod` (_BillingMethodEnum_) * `billingScheduleEndDate` (_string_) Billing schedule end date * `billingScheduleStartDate` (_string_) Billing schedule start date * `billingStartMonth` (_integer_) The billing start month indicates the month when billing begins * `billingTerm` (_integer_) The billing term unit * `billingTermUnit` (_InvoiceBillingTermUnitEnum_) * `billingTreatmentId` (_string (Id)_) The billing treatment id * `billingType` (_BillingTypeEnum_) * `currencyIsoCode` (_string_) The currency iso code * `customInvoiceGroupKey` (_string_) The Custom Invoice Group Key * `externalReference` (_string_) external reference id * `externalReferenceItem` (_string_) external reference item id * `invoiceGroupType` (_InvoiceGroupTypeEnum_) * `paymentTermId` (_string (Id)_) The Payment Term Id * `periodBoundary` (_PeriodBoundaryEnum_) * `productId` (_string (Id)_) The id of the product * `productName` (_string_) The name of the product * `prorationPolicyId` (_string (Id)_) The Proration Policy Id * `referenceId` (_string (Id)_) The reference id * `referenceItemId` (_string (Id)_) The reference item id * `referenceItemIdAsString` (_string_) The Reference item id * `shippingAddress` (_AddressInput_) * `taxTreatmentId` (_string (Id)_) The tax treatment id * `taxTreatmentIdAsString` (_string_) The Tax Treatment id ### InvoiceGroupTypeEnum Invoice Group Type Type: `string`. Allowed values: `BillingSchedule`, `Custom`, `Default`. ### AdjustmentLineInput Adjustment Line input representation * `adjustmentAmount` (_number (double)_) Adjustment Amount * `description` (_string_) Description * `endDate` (_string (date-time)_) End Date * `grossUnitPrice` (_number (double)_) Gross Unit price * `itemTypeValue` (_string_) The reference item type value * `name` (_string_) Name * `productId` (_string (Id)_) ProductId * `referenceItemId` (_string (Id)_) ReferenceItemId * `startDate` (_string (date-time)_) Start Date * `taxes` (_array of TaxLineInput_) Tax List ### BillingTypeEnum Billing Type Type: `string`. Allowed values: `Advance`. ### AddressOutput Address output representation. * `city` (_string_) City * `country` (_string_) Country * `latitude` (_number (double)_) Latitude * `locationCode` (_string_) Location Code * `longitude` (_number (double)_) Longitude * `postalCode` (_string_) Postal Code * `state` (_string_) State * `street` (_string_) Street ### PrevInvLineTaxOutput Connect API representation for Preview Invoice Line Tax result. * `taxAmount` (_number (double)_) The amount for the Invoice Line Tax. * `taxName` (_string_) The name of the Invoice Line Tax. * `taxRate` (_number (double)_) The rate of the Invoice Line Tax. ### InvoiceChargeLineInput Connect API representation of an invoice service input request * `adjustments` (_array of AdjustmentLineInput_) Adjustment List * `chargeAmount` (_number (double)_) Charge Amount * `description` (_string_) Description * `endDate` (_string (date-time)_) End Date * `grossUnitPrice` (_number (double)_) Gross Unit price * `itemTypeValue` (_string_) The reference item type value * `name` (_string_) Name * `productId` (_string (Id)_) ProductId * `quantity` (_number (double)_) Quantity * `referenceItemId` (_string (Id)_) ReferenceItemId * `startDate` (_string (date-time)_) Start Date * `taxes` (_array of TaxLineInput_) Tax List * `unitPrice` (_number (double)_) Unit Price ### InvoiceBillingTermUnitEnum Invoice Billing Term Unit Type: `string`. Allowed values: `BillingMilestonePlan`, `Month`, `OneTime`, `Year`. ### InvoiceTransactionHeaderInput Transaction header input representation for invoice * `billingAccountId` (_string (Id)_) Billing Account Id * `billToContactId` (_string (Id)_) Bill To Contact Id * `currencyIsoCode` (_string_) Credit Memo Currency * `description` (_string_) Description * `dueDate` (_string (date-time)_) Due Date * `invoiceDate` (_string (date-time)_) Invoice Date * `referenceId` (_string (Id)_) Reference Id * `status` (_InvoiceStatus_) * `taxLocaleType` (_TaxLocaleType_) ### ChargeLineInput Charge Line input representation * `adjustments` (_array of AdjustmentLineInput_) Adjustment List * `chargeAmount` (_number (double)_) Charge Amount * `description` (_string_) Description * `endDate` (_string (date-time)_) End Date * `grossUnitPrice` (_number (double)_) Gross Unit price * `itemTypeValue` (_string_) The reference item type value * `name` (_string_) Name * `productId` (_string (Id)_) ProductId * `referenceItemId` (_string (Id)_) ReferenceItemId * `startDate` (_string (date-time)_) Start Date * `taxes` (_array of TaxLineInput_) Tax List ### TaxLocaleType Tax Locale type (Gross or Net) Type: `string`. Allowed values: `Gross`, `Net`. ### ReferenceEntityAdjustmentItemInput Connect API representation of a reference entity adjustment item input request * `adjustmentName` (_string_) The name of the adjustment * `amount` (_number (double)_) The amount on billing schedule * `billDayOfMonth` (_integer_) The billing day of month * `billingAccountId` (_string (Id)_) The billing account id * `billingAccountIdAsString` (_string_) The Billing Account id * `billingAddress` (_AddressInput_) * `billingMethod` (_BillingMethodEnum_) * `billingScheduleEndDate` (_string_) Billing schedule end date * `billingScheduleStartDate` (_string_) Billing schedule start date * `billingStartMonth` (_integer_) The billing start month indicates the month when billing begins * `billingTerm` (_integer_) The billing term unit * `billingTermUnit` (_InvoiceBillingTermUnitEnum_) * `billingTreatmentId` (_string (Id)_) The billing treatment id * `billingType` (_BillingTypeEnum_) * `billToContactId` (_string (Id)_) The Bill To Contact Id * `currencyIsoCode` (_string_) The currency iso code * `customInvoiceGroupKey` (_string_) The Custom Invoice Group Key * `externalReference` (_string_) external reference id * `externalReferenceItem` (_string_) external reference item id * `invoiceGroupType` (_InvoiceGroupTypeEnum_) * `paymentTermId` (_string (Id)_) The Payment Term Id * `periodBoundary` (_PeriodBoundaryEnum_) * `productId` (_string (Id)_) The id of the product * `productName` (_string_) The name of the product * `prorationPolicyId` (_string (Id)_) The Proration Policy Id * `referenceId` (_string (Id)_) The reference id * `referenceItemId` (_string (Id)_) The reference item id * `referenceItemIdAsString` (_string_) The Reference item id * `shippingAddress` (_AddressInput_) * `taxTreatmentId` (_string (Id)_) The tax treatment id * `taxTreatmentIdAsString` (_string_) The Tax Treatment id ### CreditMemoTransactionHeaderInput Transaction header input representation for credit memo * `billingAccountId` (_string (Id)_) Billing Account Id * `billToContactId` (_string (Id)_) Bill To Contact Id * `creditDate` (_string (date-time)_) Credit Date * `currencyIsoCode` (_string_) Credit Memo Currency * `description` (_string_) Description * `referenceId` (_string (Id)_) Reference Id * `status` (_CreditMemoStatus_) * `taxLocaleType` (_TaxLocaleType_) ### StandaloneCreditMemoAdjustmentInput Connect API representation for Adjustment Input in Credit Memo API * `addresses` (_CreditMemoAddressesInput_) * `adjustmentAmount` (_number (double)_) Adjustment amount for the credit memo * `description` (_string_) Description for the Charge Line * `endDate` (_string_) End Date for the Charge Line * `isTaxOnlyCredit` (_boolean_) Credit taxes only field for Charge Line * `productId` (_string (Id)_) Product Id for the Charge Line * `productName` (_string_) Product Name for the Charge Line * `startDate` (_string_) Start Date for the Charge Line * `taxEffectiveDate` (_string_) Tax Effective Date for the Charge Line * `taxes` (_array of StandaloneCreditMemoTaxInput_) Taxes for the Charge Line * `taxStrategy` (_StandaloneTaxStrategyEnum_) * `treatmentId` (_string (Id)_) Treatment ID for the Charge Line ### BillingMethodEnum Billing Method Type: `string`. Allowed values: `Evergreen`, `None`, `OrderAmount`, `Usage`. ### CreditMemoStatus Type of credit memo to be created Type: `string`. Allowed values: `Canceled`, `Draft`, `Error`, `Pending`, `Posted`. ### TransactionHeaderInput Transaction header input representation * `billToContactId` (_string (Id)_) Bill To Contact Id * `billingAccountId` (_string (Id)_) Billing Account Id * `currencyIsoCode` (_string_) Credit Memo Currency * `description` (_string_) Description * `referenceId` (_string (Id)_) Reference Id * `taxLocaleType` (_TaxLocaleType_) ### StandaloneCreditMemoChargeInput Connect API representation of a Charge Line input for Credit Memo API * `addresses` (_CreditMemoAddressesInput_) * `adjustments` (_array of StandaloneCreditMemoAdjustmentInput_) Adjustments for the Charge Line * `chargeAmount` (_number (double)_) Charge amount for the credit memo * `description` (_string_) Description for the Charge Line * `endDate` (_string_) End Date for the Charge Line * `isTaxOnlyCredit` (_boolean_) Credit taxes only field for Charge Line * `productId` (_string (Id)_) Product Id for the Charge Line * `productName` (_string_) Product Name for the Charge Line * `startDate` (_string_) Start Date for the Charge Line * `taxEffectiveDate` (_string_) Tax Effective Date for the Charge Line * `taxes` (_array of StandaloneCreditMemoTaxInput_) Taxes for the Charge Line * `taxStrategy` (_StandaloneTaxStrategyEnum_) * `treatmentId` (_string (Id)_) Treatment ID for the Charge Line ### ReferenceEntityItemInput Connect API representation of a reference entity item input request * `amount` (_number (double)_) The amount on billing schedule * `billDayOfMonth` (_integer_) The billing day of month * `billingAccountId` (_string (Id)_) The billing account id * `billingAccountIdAsString` (_string_) The Billing Account id * `billingAddress` (_AddressInput_) * `billingMethod` (_BillingMethodEnum_) * `billingScheduleEndDate` (_string_) Billing schedule end date * `billingScheduleStartDate` (_string_) Billing schedule start date * `billingStartMonth` (_integer_) The billing start month indicates the month when billing begins * `billingTerm` (_integer_) The billing term unit * `billingTermUnit` (_InvoiceBillingTermUnitEnum_) * `billingTreatmentId` (_string (Id)_) The billing treatment id * `billingType` (_BillingTypeEnum_) * `billToContactId` (_string (Id)_) The Bill To Contact Id * `currencyIsoCode` (_string_) The currency iso code * `customInvoiceGroupKey` (_string_) The Custom Invoice Group Key * `externalReference` (_string_) external reference id * `externalReferenceItem` (_string_) external reference item id * `invoiceGroupType` (_InvoiceGroupTypeEnum_) * `paymentTermId` (_string (Id)_) The Payment Term Id * `periodBoundary` (_PeriodBoundaryEnum_) * `productId` (_string (Id)_) The id of the product * `productName` (_string_) The name of the product * `prorationPolicyId` (_string (Id)_) The Proration Policy Id * `quantity` (_number (double)_) Quantity * `referenceId` (_string (Id)_) The reference id * `referenceItemId` (_string (Id)_) The reference item id * `referenceItemIdAsString` (_string_) The Reference item id * `shippingAddress` (_AddressInput_) * `taxTreatmentId` (_string (Id)_) The tax treatment id * `taxTreatmentIdAsString` (_string_) The Tax Treatment id * `unitPrice` (_number (double)_) Unit Price ### InvoiceStatus Type of Invoice to be created (Draft or posted) Type: `string`. Allowed values: `Canceled`, `Draft`, `Pending`, `Posted`. ### PeriodBoundaryEnum Period Boundary Type: `string`. Allowed values: `AlignToCalendar`, `Anniversary`, `DayOfPeriod`, `LastDayOfPeriod`. ### AddressInputBilling Address input representation * `city` (_string_) City _Available in: v49.0_ * `country` (_string_) Country, specified using the ISO country code. _Available in: v49.0_ * `latitude` (_number (double)_) latitude * `longitude` (_number (double)_) longitude * `postalCode` (_string_) Postal code _Available in: v49.0_ * `state` (_string_) State _Available in: v49.0_ * `street` (_string_) Street _Available in: v49.0_