Setting Search
GET
{{api_url}}/shop/setting/searchReturns every shop setting whose name or description contains the search term, with each setting's current value and a description of what it controls. This is how you find the exact setting names that Shop Setting Get and Shop Setting Set need.
Query parameters
| Parameter | Type | Description |
|---|---|---|
search_term | string | Partial match against the setting's name and description. earliest returns every setting whose description mentions the earliest date to pull orders from, one per channel. |
Examples
Every Amazon setting:
{{api_url}}/shop/setting/search?search_term=amazon
Every setting that controls tracking:
{{api_url}}/shop/setting/search?search_term=tracking
Response
Trimmed to three settings:
{
"settings": [
{
"setting_name": "amazon_seller_id",
"setting_value": "A11111122222FLM",
"setting_description": "This is the seller ID for your amazon payments account/mws. This is also known as the Merchant ID"
},
{
"setting_name": "amazon_pull_orders_enabled",
"setting_value": "yes",
"setting_description": "This controls if orders from Amazon.com are pulled into the shop system"
},
{
"setting_name": "amazon_soa_inventory_set_to_zero",
"setting_value": "5",
"setting_description": "This is the threshold value for setting inventory to zero.
Example: If this is set to 5, then any item with inventory less than or equal to 5 will have its inventory set to 0."
}
]
}
| Field | Description |
|---|---|
settings | The matching settings. null when nothing matches. |
setting_name | The setting's exact name, for use with Shop Setting Get and Shop Setting Set. |
setting_value | The setting's current value, as a string. |
setting_description | What the setting controls. |
Before you build
- Because descriptions are searched too, a word for what a setting does works as well as part of its name. Search by channel, such as
amazonorwalmart, or by feature, such astracking,inventory, orpull_orders. - There are no paging parameters. Narrow the term if a search returns more than you need.
- Check for
settings: nullbefore looping. A search with no matches returnsnull, not an empty array. setting_descriptioncan contain HTML, such as and . Strip or render it before displaying it.- Values come back as strings, the same as Shop Setting Get:
"yes"or"no"for toggles, and numbers and dates as strings. - 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.
Query Parameters
| Key | Value | Description |
|---|---|---|
search_term optional | dedicated | Your search term |
Example Request
curl --location --request GET '{{api_url}}/shop/setting/search' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
Setting Search
Request
curl --location --request GET '{{api_url}}/shop/setting/search?search_term=amazon' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
{
"settings": [
{
"setting_name": "amazon_seller_id",
"setting_value": "A11111122222FLM",
"setting_description": "This is the seller ID for your amazon payments account/mws. This is also known as the Merchant ID"
},
{
"setting_name": "amazon_pull_orders_enabled",
"setting_value": "yes",
"setting_description": "This controls if orders from Amazon.com are pulled into the shop system"
},
{
"setting_name": "amazon_pull_orders_from_date",
"setting_value": "4/6/2017",
"setting_description": "This is the earliest date to pull amazon orders from."
},
{
"setting_name": "amazon_send_tracking_numbers",
"setting_value": "yes",
"setting_description": "This controls if tracking numbers are sent back to Amazon for Amazon.com orders."
},
{
"setting_name": "amazon_soa_stock_tracking_enabled",
"setting_value": "no",
"setting_description": "This controls if inventory levels are sent to Amazon on selected SOA products"
},
{
"setting_name": "amazon_soa_price_updating_enabled",
"setting_value": "no",
"setting_description": "This controls if prices are sent to Amazon on selected SOA products"
},
{
"setting_name": "amazon_marketplaces",
"setting_value": "ATVPDKIKX0DER",
"setting_description": "These are the marketplaces used for Amazon. Separate multiple marketplaces with commas. Ex: ATVPDKIKX0DER,A2EUQ1WTGCTBG2,A1AM78C64UM0Y8.<br><strong>Marketplaces:</strong><br>US: ATVPDKIKX0DER<br>CA: A2EUQ1WTGCTBG2<br>MX: A1AM78C64UM0Y8<br>DE: A1PA6795UKMFR9<br>ES: A1RKKUPIHCS9HS<br>FR: A13V1IB3VIYZZH<br>IN: A21TJRUUN4KGV<br>IT: APJ6JRA9NG5V4<br>UK: A1F83G8C2ARO7P<br>JP: A1VC38T7YXB528<br>CN: AAHKV2X7AFYLW"
},
{
"setting_name": "amazon_soa_inventory_set_to_zero",
"setting_value": "5",
"setting_description": "This is the threshold value for setting inventory to zero.<br>Example: If this is set to 5, then any item with inventory less than or equal to 5 will have its inventory set to 0."
}
]
}