Shop Setting Get
{{api_url}}/shop/setting/{{setting_name}}Returns the current value of one shop setting. Shop settings control how InfiPlex runs your account, for example whether a channel pulls orders, sends tracking, or sends inventory, and thresholds such as the point at which inventory is sent as zero.
setting_name must be the exact setting name. To find names, use Setting Search. It returns each matching setting's name, current value, and a description of what it controls.
Examples
{{api_url}}/shop/setting/amazon_seller_id
{{api_url}}/shop/setting/amazon_pull_orders_enabled
Response
{
"setting_name": "amazon_seller_id",
"setting_value": "1234567890ABC"
}
| Field | Type | Description |
|---|---|---|
setting_name | string | The setting's name. |
setting_value | string | The setting's current value. |
Values are strings
Every value comes back as a string, whatever it represents:
| Kind of setting | Example value |
|---|---|
On/off toggles, such as amazon_pull_orders_enabled | "yes" or "no" |
Numbers, such as amazon_soa_inventory_set_to_zero | "5" |
Dates, such as amazon_pull_orders_from_date | "4/6/2017" |
Lists, such as amazon_marketplaces | "ATVPDKIKX0DER,A2EUQ1WTGCTBG2" |
Marketplace connection links
A few setting names return a one-time authorization link in setting_value instead of a stored value. Send the link to whoever controls the marketplace account. They can connect it to your InfiPlex account without an InfiPlex login of their own. This is how a 3PL gets access to a client's marketplace account.
| Setting name | Connects |
|---|---|
eal__sp_api_connect | Amazon (Selling Partner API) |
eal__etsy_connect | Etsy |
eal__walmart_connect | Walmart |
eal__tiktok_connect | TikTok Shop |
eal__shopify_connect_push | Shopify, push connection |
eal__shopify_connect_pull | Shopify, pull connection |
{{api_url}}/shop/setting/eal__sp_api_connect
{
"setting_name": "eal__sp_api_connect",
"setting_value": "https://v3/admin/shop/tools_external.php?sid=16&type=sp_api_connect&auth_info_key=eHp5aldMR29mWElNV2xJPQ=="
}
The link expires the same day, and anyone holding it can attach an account. Send it only to the person who owns the marketplace account.
Before you build
- To change a setting, use Shop Setting Set. Read the current value here first.
- Your API key needs Setting read permission. A key without it gets
403 Forbidden.
Related guides:
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Example Request
curl --location --request GET '{{api_url}}/shop/setting/{{setting_name}}' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
Shop Setting Get
Request
curl --location --request GET '{{api_url}}/shop/setting/amazon_seller_id' \
--header 'Authorization: Bearer {{auth_token}}'Response 200 OK
{
"setting_name": "amazon_seller_id",
"setting_value": "1234567890ABC"
}