SDK Setting Field Reference

The SDK Setting record type allows overriding the standard logic:

  • to display custom price tags and an info icon with a custom HTML template.

  • to select additional fields to fill on Order, Order Line Item,Delivery Line Item,and Delivery objects, depending on the setting type.

The Settings record with the SDK Settings record type will be applied when the criteria are met. The search is carried out in the following order:

  1. With the specified order type and sales organization.

  2. With the specified sales organization.

  3. Without specified order type and sales organization.

Object record type API name: SDKSetting

Field API Name Type Description

Icon Name

orders__IconImageName__c

Text(255)

The name of the displayed info icon that is picked among the listed.

Implementation

orders__Implementation__c

Text(255)

The API name of the Apex class for displaying custom price tags or filling in additional fields on the objects depending on the value in the orders__SDKType__c field.

It is recommended to name the Apex class based on its function, e.g.: OrderImplementation.SetUnitPriceAsListPrice

Order Type

orders__OrderType__c

Picklist

The order type for which the settings are configured. Available values:

If not set, the setting will be applied for all order types of the selected Sales Org.

  • Order

  • Return

  • Pre-sale

Parameters

orders__Parameters__c

Long Text Area(32768)

A list of additional fields written in the JSON format, which will be displayed to fill in when the updateDataOnAfterOrderLineItemUpsert SDK Type is selected.

Platform

orders__Platform__c

Picklist

Defines the platform where an SDK Setting will be implemented:

  • CT Mobile

    Currently, SDK is not available on this platform.

  • Salesforce

Sales Organization

orders__SalesOrganizationId__c

Lookup (Sales Organization)

The business unit for which settings are configured.

  • If specified, the setting will be applied to a particular Sales Organization.

  • If blank, the setting can be applied to all sales organizations.

SDK type

orders__SDKType__c

Picklist

A picklist to select where to apply the setting:

  • updateDataOnAfterOrderLineItemUpsert to set additional fields to fill in on the objects.

  • getOrderLineItemPriceTag to override the standard logic and display the custom price tags defined in the HTML file that is requested by the Apex class from the orders__Implementation__c field.

  • To display an info icon containing an embedded HTML template choose among these settings:

    • getOrderLineItemInfoIcon;

    • getPromotionLineItemInfoIcon;

    • getCatalogLineItemInfoIcon;

    • getOrderInfoIcon;

    • getCatalogInfoIcon;

    • getPromotionInfoIcon

Version

orders__Version__c

Text(255)

The field is used to select the version of the SDK.

Currently, the v1 value should be set to apply the setting. Otherwise, the custom logic will not work.
``