Shop Setting Set

PUT{{api_url}}/shop/setting/{{setting_name}}

Changes the value of one shop setting. Shop settings control how InfiPlex runs your account, so a change takes effect for the whole account: every order, listing, and channel the setting covers.

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.

Body

FieldTypeDescription
setting_valuestringThe new value. Send it in the same form Shop Setting Get returns: "yes" or "no" for toggles, and numbers and dates as strings.

Examples

Set the Amazon seller ID:

{{api_url}}/shop/setting/amazon_seller_id
{"setting_value": "ABC1234567AMZ"}

Stop sending tracking numbers to Amazon:

{{api_url}}/shop/setting/amazon_send_tracking_numbers
{"setting_value": "no"}

Send Amazon inventory as zero at 5 units or fewer:

{{api_url}}/shop/setting/amazon_soa_inventory_set_to_zero
{"setting_value": "5"}

Response

The setting as saved:

{
    "setting_name": "amazon_seller_id",
    "setting_value": "ABC1234567AMZ"
}
FieldTypeDescription
setting_namestringThe setting's name.
setting_valuestringThe value now saved.

Before you build

  • Read the current value with Shop Setting Get before changing it, so you can put it back.
  • Some settings start or stop live marketplace traffic. Setting amazon_pull_orders_enabled to "no" stops Amazon orders from coming into InfiPlex, and setting amazon_send_tracking_numbers to "no" stops tracking from going back to Amazon, until each is turned back on.
  • Your API key needs Setting write permission. A key without it gets 403 Forbidden.

Related guides:

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Headers

KeyValueDescription
Content-Typeapplication/json

Body

{
    "setting_value": "ABC1234567AMZ"
}

Example Request

curl --location --request PUT '{{api_url}}/shop/setting/{{setting_name}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
    "setting_value": "ABC1234567AMZ"
}'

Example Responses

Shop Setting Set

Request

curl --location --request PUT '{{api_url}}/shop/setting/amazon_seller_id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
    "setting_value": "ABC1234567AMZ"
}'

Response 200 OK

{
    "setting_name": "amazon_seller_id",
    "setting_value": "ABC1234567AMZ"
}