Configures a shipping provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider's API.
Property
Value
API Name
s_c__Shipping_Provider__c
Label
Shipping Provider
Plural Label
Shipping Providers
Type
Custom Object
Fields
Field Label
API Name
Type
Required
Description
Account
s_c__Account__c
Text(255)
No
The account number of the shipping provider to use, if any. For example, Australia Post requires an account number to be specified, which determines which services are available.
Active
s_c__Active__c
Checkbox
No
Only active Shipping Providers are available to use at the checkout.
API Environment
s_c__Api_Environment__c
Text(255)
No
The environment of the shipping provider's API to use. For example, the Australia Post API requires requests to specify whether to use the "test" or "production" environment.
API Key
s_c__Api_Key__c
Text(255)
Yes
The API key for the shipping provider's API that you will have received from the shipping provider. This is the public part of your credentials, akin to a username.
API Options
s_c__Api_Options__c
LongTextArea(10000)
No
This allows you to provide other options that are required for this API connection to work. The required format of this field depends on the shipping provider being used. Please reference the relevant StoreConnect Shipping Provider documentation for details on what is supported.
API Secret
s_c__Api_Secret__c
Text(255)
Yes
The API secret key for the shipping provider's API that you will have received from the shipping provider. This is the private/secret part of your credentials, akin to a password.
API URL
s_c__Api_Url__c
Text(255)
Yes
The base URL of the shipping provider's API. This will include at least a domain (e.g. "example.com") and possibly a path on that domain (e.g. "/api/v1"). Please do not include a protocol (e.g. "https://").
The geographic zone that this record relates to. A Zone can be related to one or more countries, states, or postcodes, to, for example, refer to a single country, a collection of states, or a metropolitan area within a city.
StoreConnect External ID
s_c__sC_Id__c
Text(36)
No
StoreConnect External ID, do not modify in Salesforce
