RegisteredExternalService

Represents a registered external service used to provide an extension or integration.

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.

Important

Version 

Introduced in API version 55.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• The RegisteredExternalService object is available only if the B2B Commerce or D2C Commerce license is enabled.

Fields 

ConfigUrl 

• Type: url

• Required: No

• Properties: Filter, Nillable, Sort

• Introduced: API version 51.0

• Description: Link to the configuration page for the integration.

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 59.0

• Description: Description of the external service provider.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

DocumentationUrl 

• Type: url

• Required: No

• Properties: Filter, Nillable, Sort

• Introduced: API version 51.0

• Description: Link to documentation for the registered external service.

ExtensionPointName 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 55.0

• Description: Name of an extension point.

• Possible values:

  • Commerce_Domain_Cart_Calculate — Commerce_Domain_Cart_Calculate

  • Commerce_Domain_Tax_CartCalculator — Commerce_Domain_Tax_CartCalculator

  • Commerce_Domain_Inventory_CartCalculator — Commerce_Domain_Inventory_CartCalculator

  • Commerce_Domain_Promotions_CartCalculator — Commerce_Domain_Promotions_CartCalculator

  • Commerce_Domain_Promotions_ShippingCalculator — Commerce_Domain_Promotions_ShippingCalculator

  • Commerce_Domain_Pricing_CartCalculator — Commerce_Domain_Pricing_CartCalculator

  • Commerce_Domain_Shipping_CartCalculator — Commerce_Domain_Shipping_CartCalculator

  • Commerce_Domain_Inventory_Service — Commerce_Domain_Inventory_Service

  • Commerce_Domain_Pricing_Service — Commerce_Domain_Pricing_Service

  • Commerce_Domain_Tax_Service — Commerce_Domain_Tax_Service

  • Commerce_Domain_BuyerGroup_EvaluationService — Commerce_Domain_BuyerGroup_EvaluationService

  • Commerce_Domain_Checkout_CreateOrder — Commerce_Domain_Checkout_CreateOrder

  • Commerce_Domain_Checkout_PlaceOrder — Commerce_Domain_Checkout_PlaceOrder

  • Commerce_Domain_Shipping_SplitShipment — Commerce_Domain_Shipping_SplitShipment

  • Commerce_Domain_OrderManagement_Product — Commerce_Domain_OrderManagement_Product

  • Commerce_Endpoint_Account_Addresses — Commerce_Endpoint_Account_Addresses

  • Commerce_Endpoint_Account_Address — Commerce_Endpoint_Account_Address

  • Commerce_Endpoint_Catalog_Products — Commerce_Endpoint_Catalog_Products

  • Commerce_Endpoint_Catalog_Product — Commerce_Endpoint_Catalog_Product

  • Commerce_Endpoint_Gift_Wraps — Commerce_Endpoint_Gift_Wraps

  • Commerce_Endpoint_Search_Products — Commerce_Endpoint_Search_Products

  • Commerce_Endpoint_Search_ProductSearch — Commerce_Endpoint_Search_ProductSearch

  • Commerce_Endpoint_Search_ProductsByCategory — Commerce_Endpoint_Search_ProductsByCategory

  • Commerce_Endpoint_Search_Suggestions — Commerce_Endpoint_Search_Suggestions

  • Commerce_Endpoint_Cart_ItemCollection — Commerce_Endpoint_Cart_ItemCollection

  • Commerce_Endpoint_Cart_Item — Commerce_Endpoint_Cart_Item

ExternalServiceProviderId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. The ID of an Apex class functioning as a provider. The Apex class can either implement one of the following interfaces:

• sfdc_checkout.CartInventoryValidation

• sfdc_checkout.CartPriceCalculations

• sfdc_checkout.CartShippingCharges

• sfdc_checkout.CartTaxCalculations

or the Apex class can extend one of the base classes for an extension. See Available Extensions.

This field is a relationship field.

• Relationship name: ExternalServiceProvider
• Relationship type: relationship
• Refers to: ApexClass

ExternalServiceProviderType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The type of external service provider. For an extension, you set the type to Extension, and you specify an extensionPointName. For example, for a Pricing Cart Calculator extension, you specify Commerce_Domain_Pricing_CartCalculator as the extensionPointName. For an integration, you set the type to one of the other possible values, such as Price, and you omit extensionPointName.

• Possible values:

  • Price — Price

  • Promotions — Promotions

  • Inventory — Inventory

  • Shipment — Shipment

  • Tax — Tax

  • Extension — Extension

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Description: The full name of the associated RegisteredExternalService in the Metadata API. The full name can include a namespace prefix.

IconUri 

• Type: url

• Required: No

• Properties: Filter, Nillable, Sort

• Introduced: API version 59.0

• Description: URI of icon for the extension provider.

IsApplication 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 59.0

• Description: Indicates if the extension provider is contained within a managed package.

The default value is false.

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the RegisteredExternalService.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the RegisteredExternalService.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: The metadata for the RegisteredExternalService.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 55.0

• Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

• In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
• In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.