Skip to main content
API docs by Redocly

Shops (2.0.0)

Download OpenAPI specification:Download

URL: https://developer-dashboard.boldcommerce.com/default/contactus Terms of Service

This API allows you to get information about your shop.

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

Integrations

Manages integrations for a given shop.

Uninstall Integration

Uninstalls a public integration for a specific shop by the issued client_id. For the client_id, use your public integration's Client ID value, which can be found in the Developer Dashboard. The access token used to authenticate this request must belong to the public integration matching the given client_id. For more information, refer to Build Public Integrations.

Authorizations:
None
path Parameters
shop_identifier
required
string
Example: abc123def456

Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

client_id
required
string
Example: SEY7wXUZZHq57gjeKs4DmnHyeMsSO2AF

Unique identifier of an integration installed on a store. Available in the response during the initial installation of an integration.

Responses

Response samples

Content type
application/json
{ }

Shops

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

Get Shop Info

Gets information about the current shop.

Authorizations:
OAuthTokenAPIAccessToken

Responses

Response samples

Content type
application/json
{
  • "id": 3654,
  • "shop_identifier": "zp3oafdor9",
  • "organization_id": 142,
  • "shop_domain": "store-zp3oafdor9.mybigcommerce.com",
  • "custom_domain": "example.bigcommerce.com",
  • "platform_slug": "bigcommerce",
  • "shop_owner": "John Doe",
  • "store_name": "acme-inc",
  • "admin_email": "[email protected]",
  • "order_email": "[email protected]",
  • "currency": "CAD",
  • "currency_symbol": "$",
  • "money_format": "${{amount}}",
  • "address": "50 Fultz Blvd",
  • "address_2": "Suite 200",
  • "city": "Winnipeg",
  • "province": "Manitoba",
  • "country": "Canada",
  • "country_code": "CA",
  • "postal_code": "R3Y0L6",
  • "timezone": "America/New_York",
  • "phone": "8005550101",
  • "locale": "en",
  • "plan_name": "Sandbox_Store",
  • "plan_level": "affiliate",
  • "platform_status": "active",
  • "is_price_entered_with_tax": false,
  • "weight_unit": "",
  • "created_at": "2023-03-01T03:00:48Z",
  • "updated_at": "2023-03-30T03:00:48Z",
  • "platform_updated_at": "2022-07-26T15:35:22Z",
  • "redacted_at": null,
  • "sync_status": "string",
  • "setup_required": false,
  • "password_enabled": false,
  • "pre_launch_enabled": false,
  • "has_storefront": true,
  • "base_url": null,
  • "api_base_url": null,
  • "auth_base_url": null,
  • "tax_rounding_mode": null,
  • "inventory_control": null,
  • "currency_precision": null,
  • "shop_enabled": true,
  • "has_ac_shop_platform_creds": true
}