---
sourceDocument: Brazil Sales Customer Relationship Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/order-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Sales Customer Relationship Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# External ID support in Sales CRM Pricing API

# External ID support in Sales CRM Pricing API {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of External ID support in Sales CRM Pricing API

The Sales CRM Pricing API now supports the use of external IDs in pricing requests, allowing customers to use their own custom identifiers or codes for key reference fields instead of relying solely on ServiceNow sysids.
This capability facilitates integration with other CRM or ERP systems that utilize different unique identifiers for products, accounts, and pricing-related objects.
Show full answer Show less  

## Key Features

* **External ID Usage:** External codes can be used for various reference fields including product offering, unit of measure, price list, cost book, characteristics, pricing adjustment types, accounts, and consumers.
* **Request Flexibility:** Pricing requests can include external IDs, sysids, or a combination of both, with a request flag ("useexternalcode:true") enabling external ID support.
* **Context Variable Configuration:** Administrators must configure context variables that map external codes to ServiceNow reference table columns before using external IDs in pricing requests.
* **Account Resolution:** External account identifiers are resolved through context variables prior to pricing execution, converting them internally to sysids while retaining external codes for response construction.
* **Error Handling:** The system validates all identifiers, reporting errors with detailed messages at the line-item level if identifiers are missing, invalid, or not properly mapped.
* **Response Transparency:** Responses return the identifiers as provided by the caller (external codes or sysids), without exposing internal sysids.
* **Scope:** External ID support applies to REST API pricing requests only and does not affect UI-based pricing flows.

## Key Outcomes

* Enables seamless integration of ServiceNow Sales CRM Pricing API with external systems using their native identifiers, improving interoperability and reducing the need for identifier translation outside ServiceNow.
* Provides flexibility for customers to leverage existing identifiers in pricing calls, simplifying data synchronization and reducing errors related to identifier mismatches.
* Ensures robust validation and error reporting to assist administrators in correctly configuring external ID mappings and resolving issues efficiently.
* Maintains internal consistency by resolving all pricing logic on ServiceNow sysids while preserving external IDs for external communication.  
The Sales CRM Pricing API supports external IDs in pricing requests. You can use your own custom identifiers or codes for selected reference fields instead of a ServiceNow sys_id.

For example, a pricing call can originate from other CRM or ERP systems that may have different identifiers for certain objects. You can map these unique identifiers to ServiceNow reference fields using an external ID, code, or other custom field. A pricing call can then be made using these unique identifiers available on the external system.  
You can use external codes for the following reference fields (objects), including but not limited to:

* Product offering
* Top-level product offering
* Unit of measure
* Price list
* Cost book
* Characteristics and characteristic options
* Pricing adjustment type
* Account
* Consumer

{#external-ids-pricingapi__ul_n24_wl4_bjc}  
Note:  
External IDs apply to REST API pricing requests and do not affect UI‑based flows. Pricing execution can use internal system IDs, external IDs, or a combination of both IDs in pricing requests. For more information on the pricing API, see [Sales CRM Pricing API](https://www.servicenow.com/docs/access?context=sales-crm-pricing-api&version=brazil&pubname=brazil-api-reference&ft:locale=en-US).

## How external IDs work in pricing requests {#external-ids-pricingapi__section_whj_ryb_cjc}

External IDs map to reference fields in ServiceNow reference tables. As an admin, before submitting a pricing request, create the context variables that define the reference fields for external IDs or codes that map to a column in a specified
reference table. For more information, see [Configure context variables for external IDs](https://servicenow-prod.fluidtopics.net/fwaMgm~88IJ1BYeLPkAY6g "Set up a context variable for each external ID to be used in pricing requests and map the variable to a reference field in a ServiceNow reference table.").  
Processing of a pricing request with external IDs involves the following phases:

Request intake
:   The caller sends a Pricing REST API request that can include:

    * External IDs or codes
    * sys_ids
    * A combination of both external IDs and sys_ids

    {#external-ids-pricingapi__ul_qcq_rqc_cjc}

    In your request, you set a request flag (`"use_external_code:true"`) that enables external ID support.

Resolution
:   For each configured reference field, the system attempts to resolve the external value to an internal sys_id.

    * Resolution is driven by context variable configuration.
    * If resolution fails and no sys_id is provided, the request fails.
    {#external-ids-pricingapi__ul_tks_pzc_cjc}

Account resolution using external identifiers
:   Accounts are resolved using context variables rather than request payload fields.

    * External account identifiers are resolved before pricing execution.
    * Resolved account sys_ids are used internally for pricing execution.
    * Original external identifiers are retained for response construction.
    {#external-ids-pricingapi__ul_tbr_f1d_cjc}

Pricing execution
:   All downstream pricing logic runs only on resolved sys_ids. Pricing logic is unaware of whether the original value was an external code or a sys_id.

Response construction
:   The response reflects the identifiers provided in the request (external codes or sys_ids). Resolved sys_ids are not exposed to the caller.

Error handling
:   The system validates all reference identifiers during request processing. Common errors include the following scenarios:

    * External identifier does not exist in the reference table.
    * External code usage is enabled but no context variable mapping exists for an enabled field.
    * Neither a sys_id nor external code is provided.
    * Identifier value is not valid.

    {#external-ids-pricingapi__ul_u2k_f2h_cjc}

    Errors are reported at the line level and identify the failed line item. Error messages may vary depending on the configuration and validation context.  
    If errors occur, verify the following items:

    * Context variable mappings
    * External identifier values
    * Request flag usage
    {#external-ids-pricingapi__ul_lq4_dfh_cjc}

## Context variable configuration and mapping {#external-ids-pricingapi__section_j1w_hn4_bjc}

As an admin, before submitting a REST API pricing request that uses external IDs, create the context variables that map to columns in selected ServiceNow reference tables. For more information, see [Configure context variables for external IDs](https://servicenow-prod.fluidtopics.net/fwaMgm~88IJ1BYeLPkAY6g "Set up a context variable for each external ID to be used in pricing requests and map the variable to a reference field in a ServiceNow reference table.").

