Skip to navigation
Additional DocsClosed Beta ProgramsCheckout ExtensionsAPI ReferenceExtensions

Create Extension

Beta
Creates an extension.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Checkoutsmodifystore_checkouts
Checkoutsread-onlystore_checkouts_read_only
Checkout Contentmodifystore_checkout_content
Checkout Contentread-onlystore_checkout_content_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

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

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

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

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Request

This endpoint expects an object.
namestringOptional
The name of the extension.
regionstringOptional
Shipping region.
urlstringOptional
Extension URL.
enabledbooleanOptional
Whether the extension is currently active at checkout.

Response

The requested checkout extension.
dataobjectOptional
metaobjectOptional
Response metadata.

Errors

422
Unprocessable Entity Error