Shipping_Provider__c Object Reference

Object Name 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 Description
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.
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.
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.
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.
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://”).
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.
Provider__c Picklist Yes No The shipping provider, e.g. Australia Post.
Store_Id__c Lookup(Store__c) Yes No The store that this shipping provider belongs to.
Zone_Id__c Lookup(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.
sC_Id__c Text 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