Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

RegisteredExternalService

Represents a registered external service used for checkout integrations by data integrators. This object is available in API version 49.0 and later.

Supported Calls

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

Special Access Rules

The RegisteredExternalService object is available only if the B2B Commerce on Lightning Experience license is enabled.

Fields

Field	Details
ConfigUrl	Type url Properties Create, Filter, Nillable, Sort, Update Description Link to configuration page for the integration.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update 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 Properties Create, Filter, Nillable, Sort, Update Description Link to documentation for the registered external service.
ExtensionPointName	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description This field is available in API version 55.0 and later. Name of an extension point. Possible values are: `Cart_Prices_Extension` `Product_Inventory_CheckInventory`(reserved for future use)
ExternalServiceProviderId	Type reference Properties Create, Filter, Group, Sort, Update Description The ID of an Apex class that implements one of the following interfaces: sfdc_checkout.CartInventoryValidation sfdc_checkout.CartPriceCalculations sfdc_checkout.CartShippingCharges sfdc_checkout.CartTaxCalculations
ExternalServiceProviderType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The types of external service providers. 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`
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The combined language and locale ISO code, which controls the language for labels displayed in an application. 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)
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The master label for the registered external service.
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 are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.