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.

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.

get

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Responses

200

Your store's settings and folders.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

idstringOptionalExample: 11

namestringOptionalExample: Order Desk University

app_versionstringOptional

The Order Desk application version this store runs on.

locale_codestringOptional

Locale used for formatting, such as en_US.

timezonestringOptional

The store's timezone. The _local date filters are relative to this.

store_countrystringOptional

Two-letter country code for the store.

store_emailstringOptional

Address customer-facing mail is sent from.

admin_emailstringOptional

Address store notifications are sent to.

normalize_capitalizationstringOptional

Whether addresses are re-capitalized on import. 1 or 0.

normalize_phone_numbersstringOptional

Whether phone numbers are reformatted on import. 1 or 0.

date_formatstringOptional

PHP date format used for full dates in the interface.

short_date_formatstringOptional

PHP date format used for dates without a time.

report_frequencystringOptional

How often summary reports are sent.

dashboard_report_typestringOptional

Period the dashboard reports on, such as daily.

store_urlstringOptional

The public URL of the storefront.

custom_cssstringOptional

Custom CSS applied to the Order Desk interface.

security_po_box_warnstringOptional

Whether to flag orders shipping to a PO box.

security_different_address_warnstringOptional

Whether to flag orders whose shipping and customer addresses differ.

security_different_country_warnstringOptional

Whether to flag orders shipping to a different country.

country_name_formatstringOptional

Whether countries render as codes or full names.

all_orders_namestringOptional

Display name for the all orders view.

api_keystringOptional

The store's API key. The whole response should be treated as sensitive.

smtp_portstringOptional

SMTP port, when outbound mail is configured.

smtp_hoststringOptional

SMTP host, when outbound mail is configured.

smtp_usernamestringOptional

SMTP username, when outbound mail is configured.

smtp_passwordstringOptional

SMTP password, when outbound mail is configured.

smtp_encryptionstringOptional

SMTP encryption mode, when outbound mail is configured.

smtp_headersstringOptional

Extra headers added to outbound mail.

auto_update_stock_countstringOptional

Whether incoming orders decrement inventory automatically.

auto_create_inventory_itemsstringOptional

Whether unknown SKUs create inventory records automatically.

orders_per_pageintegerOptional

How many orders the interface shows per page.

security_quantity_warnintegerOptional

Quantity above which an order is flagged for review. 0 disables this check.

limit_address_field_char_lengthintegerOptional

Maximum characters per address field. 0 means there is no limit.

normalizeCapitalizationintegerOptional

Legacy duplicate of the normalize_capitalization setting.

Other propertiesanyOptional

Other propertiesanyOptional

Other propertiesanyOptional

Other propertiesanyOptional

Other propertiesstringOptional

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

get/store

curl "https://app.orderdesk.me/api/v2/store" \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key"

{
  "status": "success",
  "message": "text",
  "execution_time": "0.1524 seconds",
  "store": {
    "id": "11",
    "name": "Order Desk University",
    "settings": {
      "app_version": "text",
      "locale_code": "text",
      "timezone": "text",
      "store_country": "text",
      "store_email": "text",
      "admin_email": "text",
      "normalize_capitalization": "text",
      "normalize_phone_numbers": "text",
      "date_format": "text",
      "short_date_format": "text",
      "report_frequency": "text",
      "dashboard_report_type": "text",
      "store_url": "text",
      "custom_css": "text",
      "security_po_box_warn": "text",
      "security_different_address_warn": "text",
      "security_different_country_warn": "text",
      "country_name_format": "text",
      "all_orders_name": "text",
      "api_key": "text",
      "smtp_port": "text",
      "smtp_host": "text",
      "smtp_username": "text",
      "smtp_password": "text",
      "smtp_encryption": "text",
      "smtp_headers": "text",
      "auto_update_stock_count": "text",
      "auto_create_inventory_items": "text",
      "orders_per_page": 1,
      "security_quantity_warn": 1,
      "limit_address_field_char_length": 1,
      "normalizeCapitalization": 1,
      "all_orders_column_view": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "shipping_methods": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "default_checkout_data_fields": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "folders": {
      "21654": "New",
      "21655": "Prepared",
      "21656": "Closed",
      "21657": "Canceled"
    }
  }
}