s_c__Shipping_Provider__c Object Reference
| Name | s_c__Shipping_Provider__c |
|---|---|
| Type | Custom StoreConnect Object |
| Description | Configures a shipping provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider's API. |
Field Definitions
| Field Name | Type | Required | Unique |
|---|---|---|---|
| s_c__Account__c | Text | No | 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. | |||
| s_c__Active__c | Checkbox(true) | No | No |
| Only active Shipping Providers are available to use at the checkout. | |||
| s_c__Api_Environment__c | Text | No | 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. | |||
| s_c__Api_Key__c | Text | Yes | No |
| 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. | |||
| s_c__Api_Options__c | LongTextArea | No | 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. | |||
| s_c__Api_Secret__c | Text | Yes | No |
| 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. | |||
| s_c__Api_Url__c | Text | Yes | No |
| 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://"). | |||
| s_c__Instructions_Markdown__c | LongTextArea | No | No |
| (Optional) Instruction to show on the checkout shipping selection page when this shipping provider is an option. Use Markdown or HTML to format your text. Find out more at https://help.getstoreconnect.com/documentation/how-to-use-markdown. | |||
| s_c__Provider__c | Picklist | Yes | No |
| The shipping provider, e.g. Australia Post. | |||
| s_c__Store_Id__c | Lookup (s_c__Store__c) | Yes | No |
| The store that this shipping provider belongs to. | |||
| s_c__Zone_Id__c | Lookup (s_c__Zone__c) | Yes | No |
| 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. | |||
| s_c__sC_Id__c | Text [External ID] | No | Yes |
| StoreConnect External ID, do not modify in Salesforce | |||
For more information about how or when to use the above, see our documentation.
Back to Documentation