{"openapi":"3.1.0","info":{"title":"Beta Checkout Extensions","version":"1.0.0"},"paths":{"/stores/{store_hash}/v3/checkouts/extensions":{"get":{"operationId":"getExtensions","summary":"List Extensions","description":"Returns a list of extensions.","tags":["extensions"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Checkouts | modify | `store_checkouts` |\n|  Checkouts | read-only | `store_checkouts_read_only` |\n|  Checkout Content | modify | `store_checkout_content` |\n|  Checkout Content | read-only | `store_checkout_content_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extensions_getExtensions_Response_200"}}}},"422":{"description":"Failure due to an invalid query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"addExtension","summary":"Create Extension","description":"Creates an extension.","tags":["extensions"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Checkouts | modify | `store_checkouts` |\n|  Checkouts | read-only | `store_checkouts_read_only` |\n|  Checkout Content | modify | `store_checkout_content` |\n|  Checkout Content | read-only | `store_checkout_content_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extensions_addExtension_Response_200"}}}},"422":{"description":"Failure due to an invalid query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionBase"}}}}}},"/stores/{store_hash}/v3/checkouts/extensions/{extension_id}":{"get":{"operationId":"getExtension","summary":"Get Extension","description":"Returns an extension.","tags":["extensions"],"parameters":[{"name":"extension_id","in":"path","description":"The ID of the specific extension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Checkouts | modify | `store_checkouts` |\n|  Checkouts | read-only | `store_checkouts_read_only` |\n|  Checkout Content | modify | `store_checkout_content` |\n|  Checkout Content | read-only | `store_checkout_content_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extensions_getExtension_Response_200"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"updateExtension","summary":"Update Extension","description":"Updates an extension.","tags":["extensions"],"parameters":[{"name":"extension_id","in":"path","description":"The ID of the specific extension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Checkouts | modify | `store_checkouts` |\n|  Checkouts | read-only | `store_checkouts_read_only` |\n|  Checkout Content | modify | `store_checkout_content` |\n|  Checkout Content | read-only | `store_checkout_content_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Extensions_updateExtension_Response_200"}}}},"404":{"description":"The resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtensionBase"}}}}},"delete":{"operationId":"deleteExtension","summary":"Delete Extension","description":"Deletes an Extension.","tags":["extensions"],"parameters":[{"name":"extension_id","in":"path","description":"The ID of the specific extension.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Checkouts | modify | `store_checkouts` |\n|  Checkouts | read-only | `store_checkouts_read_only` |\n|  Checkout Content | modify | `store_checkout_content` |\n|  Checkout Content | read-only | `store_checkout_content_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"204":{"description":"An empty response.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}}},"servers":[{"url":"https://api.bigcommerce.com","description":"https://api.bigcommerce.com"}],"components":{"schemas":{"Extension_Full":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Extension ID"},"name":{"type":"string"},"description":{"type":"string"},"region":{"type":"string"},"url":{"type":"string"},"enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"title":"Extension_Full"},"metaCollection_open":{"type":"object","properties":{},"description":"Response metadata.","title":"metaCollection_open"},"Extensions_getExtensions_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Extension_Full"}},"meta":{"$ref":"#/components/schemas/metaCollection_open"}},"title":"Extensions_getExtensions_Response_200"},"ErrorResponseErrors":{"type":"object","properties":{},"title":"ErrorResponseErrors"},"ErrorResponse":{"type":"object","properties":{"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"},"instance":{"type":"string"},"errors":{"$ref":"#/components/schemas/ErrorResponseErrors"}},"title":"ErrorResponse"},"ExtensionBase":{"type":"object","properties":{"name":{"type":"string","description":"The name of the extension."},"region":{"type":"string","description":"Shipping region."},"url":{"type":"string","description":"Extension URL."},"enabled":{"type":"boolean","description":"Whether the extension is currently active at checkout."}},"title":"ExtensionBase"},"Extensions_addExtension_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Extension_Full"},"meta":{"$ref":"#/components/schemas/metaCollection_open"}},"title":"Extensions_addExtension_Response_200"},"Extensions_getExtension_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Extension_Full"},"meta":{"$ref":"#/components/schemas/metaCollection_open"}},"title":"Extensions_getExtension_Response_200"},"Extensions_updateExtension_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Extension_Full"},"meta":{"$ref":"#/components/schemas/metaCollection_open"}},"title":"Extensions_updateExtension_Response_200"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Checkouts | modify | `store_checkouts` |\n|  Checkouts | read-only | `store_checkouts_read_only` |\n|  Checkout Content | modify | `store_checkout_content` |\n|  Checkout Content | read-only | `store_checkout_content_read_only` |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."}}}}