Skip to navigation

Get Makeswift Status for a Channel

Returns whether Makeswift is enabled for a storefront channel.

Makeswift is enabled channel by channel, so check each storefront channel your app works with.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Contentmodifystore_v2_content
Contentread-onlystore_v2_content_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access tokens, see API Accounts and OAuth Scopes.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see API Accounts and OAuth Scopes.

For a list of API status codes, see API Status Codes.

Path parameters

channel_idintegerRequired
The ID of the channel.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Response

The Makeswift status of the channel.
dataobject
metaobject
Empty for this endpoint.

Errors

403
Forbidden Error