Skip to main content

Shops (2.0.0)

Download OpenAPI specification:Download

This API allows you to get information about your shop.

Refer to the changelog for the latest updates to this API.

Authentication

OAuthToken

Authenticates an API request from a public integration. Generate this token in the Developer Dashboard. Refer to Build Public Integrations for more information.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://apps.boldapps.net/accounts/dashboard/authorize
Token URL: https://api.boldcommerce.com/auth/oauth2/token

APIAccessToken

Authenticates an API request from a private integration. Generate this token in the Bold Account Center. Refer to the Quick Start for more information.

Security Scheme Type API Key
Header parameter name: API Access Token

Shops

Contains information about a shop. Use these endpoints to retrieve information about a given shop.

Get Shop Info

Get information about the current shop

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "shop_identifier": "string",
  • "shop_domain": "string",
  • "custom_domain": "string",
  • "shop_owner": "string",
  • "city": "string",
  • "province": "string",
  • "country": "string",
  • "country_code": "string",
  • "address": "string",
  • "store_name": "string",
  • "admin_email": "string",
  • "order_email": "string",
  • "currency": "string",
  • "currency_symbol": "string",
  • "money_format": "string",
  • "phone": "string",
  • "platform_slug": "string"
}