--- schema_version: "1" id: cf774e42f56dc9f37d6ec8cbe6107ea409ce7856e5dea64e5c25df25c2397a77 title: RegisteredExternalService collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_registeredexternalservice.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_registeredexternalservice.htm source_site: developer.salesforce.com content_type: documentation content_hash: 747e6bc4a9bcd32ffbf9eb8e0ecd810bb53617dbbd8f92b0508ae2bacca9cd1f description: Represents a registered external service used to provide an extension or integration. This object is available in API version 49.0 and later. --- # RegisteredExternalService Represents a registered external service used to provide an extension or integration. This object is available in API version 49.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_important.png) #### 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. ## 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 | Field | Details | | --- | --- | | ConfigUrl | Type url Properties Filter, Nillable, Sort Description Link to the configuration page for the integration. | | Description | Type string Properties Filter, Group, Nillable, Sort Description Description of the external service provider. This field is available in API version 59.0 and later. | | DeveloperName | Type string 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | DocumentationUrl | Type url Properties Filter, Nillable, Sort Description Link to documentation for the registered external service. | | ExtensionPointName | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description This field is available in API version 55.0 and later. Name of an extension point. Possible values are: - Commerce\_Domain\_Cart\_Calculate - Commerce\_Domain\_Checkout\_CreateOrder - Commerce\_Domain\_Inventory\_CartCalculator - Commerce\_Domain\_Inventory\_Service - Commerce\_Domain\_OrderManagement\_Product - Commerce\_Domain\_Pricing\_CartCalculator - Commerce\_Domain\_Pricing\_Service - Commerce\_Domain\_Promotions\_CartCalculator - Commerce\_Domain\_Promotions\_ShippingCalculator - Commerce\_Domain\_Shipping\_CartCalculator - Commerce\_Domain\_Shipping\_SplitShipment - Commerce\_Domain\_Tax\_CartCalculator - Commerce\_Domain\_Tax\_Service - Commerce\_Endpoint\_Account\_Address - Commerce\_Endpoint\_Account\_Addresses - Commerce\_Endpoint\_Cart\_Item - Commerce\_Endpoint\_Cart\_ItemCollection - Commerce\_Endpoint\_Catalog\_Product - Commerce\_Endpoint\_Catalog\_Products - Commerce\_Endpoint\_Search\_ProductSearch - Commerce\_Endpoint\_Search\_Products - Commerce\_Endpoint\_Search\_ProductsByCategory | | ExternalServiceProviderId | Type reference 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](https://developer.salesforce.com/docs/commerce/salesforce-commerce/guide/available-extensions.html). This field is a relationship field. Relationship Name ExternalServiceProvider Relationship Type Lookup Refers To ApexClass | | ExternalServiceProviderType | Type picklist 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 are: - Extension (this value is available in API version 55.0 and later) - Inventory - Price - Promotions (this value is available in API version 53.0 and later) - Shipment - Tax | | FullName | Type string 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 Properties Filter, Nillable, Sort Description URI of icon for the extension provider. This field is available in API version 59.0 and later. | | IsApplication | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates if the extension provider is contained within a managed package. The default value is false. This field is available in API version 59.0 and later. | | Language | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the RegisteredExternalService. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | ManageableState | Type ManageableState enumerated list 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 | | MasterLabel | Type string Properties Filter, Group, Sort Description Label for the RegisteredExternalService. | | Metadata | Type [https://developer.salesforce.com/docs/atlas.en-us.api\_meta.meta/api\_meta/meta\_flexipage.htm](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_flexipage.htm) Properties Create, Nillable, Update Description The metadata for the RegisteredExternalService. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort 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. |