> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/api-documentation/v2-api-reference/store-settings/store-settings.md).

# Store Settings

Get the store settings and folder list. This is particularly helpful if you are looking for details about a store's folder structure and need to fetch ID numbers.

The folder IDs returned here are used throughout the API. These should be retrieved and cached rather than hardcoded, as they are specific to each store.

{% hint style="warning" %}
The `settings` object includes the store's API key and, where outbound mail is configured, SMTP credentials. This response should not be logged or passed to a browser.
{% endhint %}

```json
{"openapi":"3.0.3","info":{"title":"Order Desk API","version":"2.0"},"tags":[{"name":"Store Settings"}],"servers":[{"url":"https://app.orderdesk.me/api/v2","description":"Production"}],"security":[{"OrderDeskStoreId":[],"OrderDeskApiKey":[]}],"components":{"securitySchemes":{"OrderDeskStoreId":{"type":"apiKey","in":"header","name":"ORDERDESK-STORE-ID","description":"Your store ID, found under Store Settings on the API tab."}},"schemas":{"ResponseEnvelope":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["success","error"],"description":"Either `success` or `error`."},"message":{"type":"string","description":"Describes the result. Always present when an error occurs."},"execution_time":{"type":"string","description":"Time taken to process the request."}}},"Store":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"settings":{"$ref":"#/components/schemas/StoreSettings"},"folders":{"type":"object","additionalProperties":{"type":"string"},"description":"The store's folders, keyed by folder ID. These IDs are used by the `folder_id` field\nthroughout the API.\n"}}},"StoreSettings":{"type":"object","readOnly":true,"description":"The store's configuration as set in the Order Desk interface. These settings are\nread-only through the API. New settings are added over time, so this list should be\ntreated as indicative rather than exhaustive.\n","additionalProperties":true,"properties":{"app_version":{"type":"string","description":"The Order Desk application version this store runs on."},"locale_code":{"type":"string","description":"Locale used for formatting, such as `en_US`."},"timezone":{"type":"string","description":"The store's timezone. The `_local` date filters are relative to this."},"store_country":{"type":"string","description":"Two-letter country code for the store."},"store_email":{"type":"string","description":"Address customer-facing mail is sent from."},"admin_email":{"type":"string","description":"Address store notifications are sent to."},"normalize_capitalization":{"type":"string","description":"Whether addresses are re-capitalized on import. `1` or `0`."},"normalize_phone_numbers":{"type":"string","description":"Whether phone numbers are reformatted on import. `1` or `0`."},"date_format":{"type":"string","description":"PHP date format used for full dates in the interface."},"short_date_format":{"type":"string","description":"PHP date format used for dates without a time."},"report_frequency":{"type":"string","description":"How often summary reports are sent."},"dashboard_report_type":{"type":"string","description":"Period the dashboard reports on, such as `daily`."},"store_url":{"type":"string","description":"The public URL of the storefront."},"custom_css":{"type":"string","description":"Custom CSS applied to the Order Desk interface."},"security_po_box_warn":{"type":"string","description":"Whether to flag orders shipping to a PO box."},"security_different_address_warn":{"type":"string","description":"Whether to flag orders whose shipping and customer addresses differ."},"security_different_country_warn":{"type":"string","description":"Whether to flag orders shipping to a different country."},"country_name_format":{"type":"string","description":"Whether countries render as codes or full names."},"all_orders_name":{"type":"string","description":"Display name for the all orders view."},"api_key":{"type":"string","description":"The store's API key. The whole response should be treated as sensitive."},"smtp_port":{"type":"string","description":"SMTP port, when outbound mail is configured."},"smtp_host":{"type":"string","description":"SMTP host, when outbound mail is configured."},"smtp_username":{"type":"string","description":"SMTP username, when outbound mail is configured."},"smtp_password":{"type":"string","description":"SMTP password, when outbound mail is configured."},"smtp_encryption":{"type":"string","description":"SMTP encryption mode, when outbound mail is configured."},"smtp_headers":{"type":"string","description":"Extra headers added to outbound mail."},"auto_update_stock_count":{"type":"string","description":"Whether incoming orders decrement inventory automatically."},"auto_create_inventory_items":{"type":"string","description":"Whether unknown SKUs create inventory records automatically."},"orders_per_page":{"type":"integer","description":"How many orders the interface shows per page."},"security_quantity_warn":{"type":"integer","description":"Quantity above which an order is flagged for review. `0` disables this check.\n"},"limit_address_field_char_length":{"type":"integer","description":"Maximum characters per address field. `0` means there is no limit."},"normalizeCapitalization":{"type":"integer","description":"Legacy duplicate of the `normalize_capitalization` setting."},"all_orders_column_view":{"type":"array","description":"Columns shown in the all orders view.","items":{"type":"object","additionalProperties":true}},"shipping_methods":{"type":"array","description":"Shipping methods configured for this store.","items":{"type":"object","additionalProperties":true}},"default_checkout_data_fields":{"type":"array","description":"Checkout data fields created on every new order.","items":{"type":"object","additionalProperties":true}}}}},"responses":{"Unauthorized":{"description":"Authentication failed. See the Authentication guide, and\nnote that an invalid store ID blocks your store rather than simply\nfailing the request.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelope"}}}},"RateLimited":{"description":"You are sending too fast. Wait `X-Retry-After` seconds. See\nthe Rate Limits guide.\n","headers":{"X-Tokens-Remaining":{"description":"Number of request tokens currently available.","schema":{"type":"integer"}},"X-Retry-After":{"description":"Seconds to wait before requests can resume.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelope"}}}},"Error":{"description":"The request could not be completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEnvelope"}}}}}},"paths":{"/store":{"get":{"tags":["Store Settings"],"summary":"Store Settings","description":"Get the store settings and folder list. This is particularly helpful if you are\nlooking for details about a store's folder structure and need to fetch ID\nnumbers.\n\nThe folder IDs returned here are used throughout the API. These should be\nretrieved and cached rather than hardcoded, as they are specific to each store.\n\n{% hint style=\"warning\" %}\nThe `settings` object includes the store's API key and, where outbound mail is\nconfigured, SMTP credentials. This response should not be logged or passed to a\nbrowser.\n{% endhint %}\n","operationId":"getStoreSettings","responses":{"200":{"description":"Your store's settings and folders.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"type":"object","properties":{"store":{"$ref":"#/components/schemas/Store"}}}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.orderdesk.com/api-documentation/v2-api-reference/store-settings/store-settings.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.