Skip to content

Get shop settings

GET
/settings/shop

Returns the shop-related subset of site settings (currency, ecommerce, invoices, packing slips).

Authorizations

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Responses

shop settings returned

application/json
JSON
{
"currency": "string",
"enable_ecommerce": true,
"order_id_format": "string",
"unit_system": "string",
"enable_credits": true,
"enable_digital_products": true,
"enable_gift_cards": true,
"expose_invisible_products": true,
"reservations_enabled": true,
"max_reservation_time": 0,
"max_reservation_limit": 0,
"generate_free_invoices": true,
"disable_invoices": true,
"invoice_number_format": "string",
"customer_number_format": "string",
"packing_hide_prices": true,
"packing_hide_billing_address": true,
"packing_attach_to_order_notification": true
}

Playground

Authorization

Samples

Part of Nimbu, built by Zenjoy.