BigCommerce Docs

This endpoint allows you to generate a temporary OAuth token required to authenticate requests to the Powered by APIs. Franchises support a single OAuth token. Generating a new OAuth token will invalidate the previous OAuth token.

Authentication

X-Auth-Clientstring

The client ID of the franchise API account.

Request

durationdoubleRequired

Response

Success

access_tokenstring>=1 character

expires_atstring>=1 character

Errors

401

Unauthorized Error

403

Forbidden Error

502

Bad Gateway Error

503

Service Unavailable Error

504

Gateway Timeout Error

$	curl -X POST https://api.bigcommerce.com/franchises/account_uuid/v1/oauth/token \
>	-H "Accept: application/json" \
>	-H "X-Auth-Client: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"duration": 900
>	}'

$	curl -X POST https://api.bigcommerce.com/franchises/account_uuid/v1/oauth/token \
>	-H "Accept: application/json" \
>	-H "X-Auth-Client: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"duration": 900
>	}'

Get OAuth Token

Get OAuth Token

Authentication

Headers

Request

Response

Errors

Authentication

Headers

Request

Response

Errors

1	{
2	"access_token": "dlkJcn34f9a8s7dfLkd0123mnoPqrsTuvWxYz",
3	"expires_at": "2024-06-30T18:45:00.000Z"
4	}