Orkas is an open-source (MIT), local-first AI team for your desktop: a Commander turns your goal into to-dos and coordinates 16 built-in specialist agents plus Claude Code, Codex, OpenCode, OpenClaw and Hermes, with projects, scheduled automations and connectors. Free app for macOS & Windows; built-in models or your own keys.
JavaScript agent-collaborationagent-harnessagent-orchestrationagent-teamagent-workflowai-assistantai-automationai-employeeai-productivityai-teamai-workflowautonomous-agentsclaude-code-guiclaude-coworkdesktop-agentlocal-firstmulti-agentmulti-agent-systemself-evolving-agentstask-automation
'use strict';
// Generated from the pinned official BigCommerce merchant models.
module.exports = {
"documentation_snapshot": "2026-10-01",
"source_index": "https://docs.bigcommerce.com/openapi.json",
"methods": {
"GET /v3/catalog/brands": {
"operation": "brands_getBrands",
"method": "GET",
"path": "/v3/catalog/brands",
"risk": "R",
"description": "List Brands. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by ID.\n"
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is in this list."
},
"id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is not in this list."
},
"id:min": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is greater than or equal to this value."
},
"id:max": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is less than or equal to this value."
},
"id:greater": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is greater than this value."
},
"id:less": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is less than this value."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by name.\n"
},
"name:like": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by part of a name. For example, `name:like=new` returns brands with names that include `new`."
},
"page_title": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by page_title.\n"
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products."
},
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"sort": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsGetParametersSort",
"description": "Field name to sort by."
},
"direction": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__CatalogBrandsGetParametersSort",
"admin-catalog-brands__CatalogBrandsGetParametersDirection"
],
"wire": [
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:greater",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:less",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page_title",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sort",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Brands_getBrands_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Brands_getBrands_Response_200",
"admin-catalog-brands__brand_Full",
"admin-catalog-brands__customUrl_Full",
"admin-catalog-brands__metaCollection_Full",
"admin-catalog-brands__pagination_Full",
"admin-catalog-brands__PaginationFullLinks"
]
},
"POST /v3/catalog/brands": {
"operation": "brands_createBrand",
"method": "POST",
"path": "/v3/catalog/brands",
"risk": "H",
"description": "Create Brand. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "The name of the brand. Must be unique.\nRequired in POST."
},
"page_title": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The title shown in the browser while viewing the brand.\n"
},
"meta_keywords": {
"type": "array",
"description": "An array of meta keywords to include in the HTML.\n",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10
},
"meta_description": {
"type": "string",
"minLength": 0,
"maxLength": 65535,
"description": "A meta description to include.\n"
},
"search_keywords": {
"type": "string",
"minLength": 0,
"maxLength": 65535,
"description": "A comma-separated list of keywords that can be used to locate this brand.\n"
},
"image_url": {
"type": "string",
"description": "Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.\n",
"maxLength": 262144
},
"custom_url": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsPostRequestBodyContentApplicationJsonSchemaCustomUrl",
"description": "The custom URL for the brand on the storefront. If not provided, the URL will be autogenerated from the brand name."
}
},
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__CatalogBrandsPostRequestBodyContentApplicationJsonSchemaCustomUrl"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Brands_createBrand_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Brands_createBrand_Response_200",
"admin-catalog-brands__CatalogBrandsPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-brands__CatalogBrandsPostResponsesContentApplicationJsonSchemaDataCustomUrl",
"admin-catalog-brands__metaEmpty_Full"
]
},
"DELETE /v3/catalog/brands": {
"operation": "brands_deleteBrands",
"method": "DELETE",
"path": "/v3/catalog/brands",
"risk": "D",
"description": "Delete Brands. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by name.\n"
},
"page_title": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by page_title.\n"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page_title",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/brands/{brand_id}": {
"operation": "brands_getBrand",
"method": "GET",
"path": "/v3/catalog/brands/{brand_id}",
"risk": "R",
"description": "Get Brand. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
}
},
"required": [
"brand_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Brands_getBrand_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Brands_getBrand_Response_200",
"admin-catalog-brands__brand_Full",
"admin-catalog-brands__customUrl_Full",
"admin-catalog-brands__metaEmpty_Full"
]
},
"PUT /v3/catalog/brands/{brand_id}": {
"operation": "brands_updateBrand",
"method": "PUT",
"path": "/v3/catalog/brands/{brand_id}",
"risk": "H",
"description": "Update Brand. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
}
},
"required": [
"brand_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"description": "Unique ID of the brand.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "The name of the brand. Must be unique.\nRequired in POST."
},
"page_title": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The title shown in the browser while viewing the brand.\n"
},
"meta_keywords": {
"type": "array",
"description": "An array of meta keywords to include in the HTML.\n",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10
},
"meta_description": {
"type": "string",
"minLength": 0,
"maxLength": 65535,
"description": "A meta description to include.\n"
},
"search_keywords": {
"type": "string",
"minLength": 0,
"maxLength": 65535,
"description": "A comma-separated list of keywords that can be used to locate this brand.\n"
},
"image_url": {
"type": "string",
"description": "Image URL used for this category on the storefront. Images can be uploaded via form file post to `/brands/{brandId}/image`, or by providing a publicly accessible URL in this field.\n",
"maxLength": 262144
},
"custom_url": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsBrandIdPutRequestBodyContentApplicationJsonSchemaCustomUrl",
"description": "The custom URL for the brand on the storefront."
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__CatalogBrandsBrandIdPutRequestBodyContentApplicationJsonSchemaCustomUrl"
],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Brands_updateBrand_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Brands_updateBrand_Response_200",
"admin-catalog-brands__CatalogBrandsBrandIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-brands__CatalogBrandsBrandIdPutResponsesContentApplicationJsonSchemaDataCustomUrl",
"admin-catalog-brands__metaEmpty_Full"
]
},
"DELETE /v3/catalog/brands/{brand_id}": {
"operation": "brands_deleteBrand",
"method": "DELETE",
"path": "/v3/catalog/brands/{brand_id}",
"risk": "D",
"description": "Delete Brand. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
}
},
"required": [
"brand_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/brands/metafields": {
"operation": "batchMetafields_getBrandsMetafields",
"method": "GET",
"path": "/v3/catalog/brands/metafields",
"risk": "R",
"description": "List Brand Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products."
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"key:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"namespace:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter."
},
"direction": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__CatalogBrandsMetafieldsGetParametersDirection",
"admin-catalog-brands__CatalogBrandsMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__MetaFieldCollectionResponse"
}
},
"response_definitions": [
"admin-catalog-brands__MetaFieldCollectionResponse",
"admin-catalog-brands__Metafield",
"admin-catalog-brands__MetafieldPermissionSet",
"admin-catalog-brands__MetafieldResourceType",
"admin-catalog-brands__CollectionMeta",
"admin-catalog-brands__CollectionMetaPagination",
"admin-catalog-brands__CollectionMetaPaginationLinks"
]
},
"POST /v3/catalog/brands/metafields": {
"operation": "batchMetafields_createBrandsMetafields",
"method": "POST",
"path": "/v3/catalog/brands/metafields",
"risk": "H",
"description": "Create Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__CatalogBrandsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-brands__CatalogBrandsMetafieldsPostRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-brands__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-brands__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-brands__Metafield",
"admin-catalog-brands__MetafieldPermissionSet",
"admin-catalog-brands__MetafieldResourceType",
"admin-catalog-brands__CollectionMeta",
"admin-catalog-brands__CollectionMetaPagination",
"admin-catalog-brands__CollectionMetaPaginationLinks",
"admin-catalog-brands__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-brands__Error",
"admin-catalog-brands__ErrorDetail",
"admin-catalog-brands__WriteCollectionPartialSuccessMeta"
]
},
"PUT /v3/catalog/brands/metafields": {
"operation": "batchMetafields_updateBrandsMetafields",
"method": "PUT",
"path": "/v3/catalog/brands/metafields",
"risk": "H",
"description": "Update Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [
[
"errors"
]
],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-brands__CatalogBrandsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__CatalogBrandsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-brands__CatalogBrandsMetafieldsPutRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__MetaFieldCollectionResponse_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-brands__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-brands__Metafield",
"admin-catalog-brands__MetafieldPermissionSet",
"admin-catalog-brands__MetafieldResourceType",
"admin-catalog-brands__CollectionMeta",
"admin-catalog-brands__CollectionMetaPagination",
"admin-catalog-brands__CollectionMetaPaginationLinks"
]
},
"DELETE /v3/catalog/brands/metafields": {
"operation": "batchMetafields_deleteBrandsMetafields",
"method": "DELETE",
"path": "/v3/catalog/brands/metafields",
"risk": "D",
"description": "Delete Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__MetaFieldCollectionDeleteResponseSuccess"
},
"422": {
"$ref": "#/$defs/admin-catalog-brands__MetaFieldCollectionResponsePartialSuccess_DELETE"
}
},
"response_definitions": [
"admin-catalog-brands__MetaFieldCollectionDeleteResponseSuccess",
"admin-catalog-brands__WriteCollectionSuccessMeta",
"admin-catalog-brands__MetaFieldCollectionResponsePartialSuccess_DELETE",
"admin-catalog-brands__Error",
"admin-catalog-brands__ErrorDetail",
"admin-catalog-brands__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/catalog/brands/{brand_id}/image": {
"operation": "images_deleteBrandImage",
"method": "DELETE",
"path": "/v3/catalog/brands/{brand_id}/image",
"risk": "D",
"description": "Delete Brand Image. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
}
},
"required": [
"brand_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/brands/{brand_id}/metafields": {
"operation": "metafields_getBrandMetafields",
"method": "GET",
"path": "/v3/catalog/brands/{brand_id}/metafields",
"risk": "R",
"description": "List Brand Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
}
},
"required": [
"brand_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by ID.\n"
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is in this list."
},
"id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is not in this list."
},
"id:min": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is greater than or equal to this value."
},
"id:max": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is less than or equal to this value."
},
"id:greater": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is greater than this value."
},
"id:less": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose ID is less than this value."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products."
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:greater",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:less",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Metafields_getBrandMetafields_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Metafields_getBrandMetafields_Response_200",
"admin-catalog-brands__metafield_Full",
"admin-catalog-brands__MetafieldBasePermissionSet",
"admin-catalog-brands__MetafieldFullResourceType",
"admin-catalog-brands__metaCollection_Full",
"admin-catalog-brands__pagination_Full",
"admin-catalog-brands__PaginationFullLinks"
]
},
"POST /v3/catalog/brands/{brand_id}/metafields": {
"operation": "metafields_createBrandMetafield",
"method": "POST",
"path": "/v3/catalog/brands/{brand_id}/metafields",
"risk": "H",
"description": "Create Brand Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
}
},
"required": [
"brand_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-brands__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__metafield_Base",
"admin-catalog-brands__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Metafields_createBrandMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Metafields_createBrandMetafield_Response_200",
"admin-catalog-brands__metafield_Full",
"admin-catalog-brands__MetafieldBasePermissionSet",
"admin-catalog-brands__MetafieldFullResourceType",
"admin-catalog-brands__CatalogBrandsBrandIdMetafieldsPostResponsesContentApplicationJsonSchemaMeta"
]
},
"GET /v3/catalog/brands/{brand_id}/metafields/{metafield_id}": {
"operation": "metafields_getBrandMetafield",
"method": "GET",
"path": "/v3/catalog/brands/{brand_id}/metafields/{metafield_id}",
"risk": "R",
"description": "Get Brand Metafield. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"brand_id",
"metafield_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Metafields_getBrandMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Metafields_getBrandMetafield_Response_200",
"admin-catalog-brands__metafield_Full",
"admin-catalog-brands__MetafieldBasePermissionSet",
"admin-catalog-brands__MetafieldFullResourceType",
"admin-catalog-brands__metaEmpty_Full"
]
},
"PUT /v3/catalog/brands/{brand_id}/metafields/{metafield_id}": {
"operation": "metafields_updateBrandMetafield",
"method": "PUT",
"path": "/v3/catalog/brands/{brand_id}/metafields/{metafield_id}",
"risk": "H",
"description": "Update Brand Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"brand_id",
"metafield_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-brands__MetafieldBase_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-brands__MetafieldBase_Put",
"admin-catalog-brands__MetafieldBasePutPermissionSet"
],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-brands__Metafields_updateBrandMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-brands__Metafields_updateBrandMetafield_Response_200",
"admin-catalog-brands__metafield_Full",
"admin-catalog-brands__MetafieldBasePermissionSet",
"admin-catalog-brands__MetafieldFullResourceType",
"admin-catalog-brands__metaEmpty_Full"
]
},
"DELETE /v3/catalog/brands/{brand_id}/metafields/{metafield_id}": {
"operation": "metafields_deleteBrandMetafield",
"method": "DELETE",
"path": "/v3/catalog/brands/{brand_id}/metafields/{metafield_id}",
"risk": "D",
"description": "Delete Brand Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-brands.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the brand to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"brand_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "brand_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/categories/metafields": {
"operation": "batchMetafields_getCategoriesMetafields",
"method": "GET",
"path": "/v3/catalog/categories/metafields",
"risk": "R",
"description": "List Category Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of results.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of results.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"key:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"namespace:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter."
},
"direction": {
"$ref": "#/$defs/admin-catalog-categories__CatalogCategoriesMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-categories__CatalogCategoriesMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'\n"
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'\n"
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'\n"
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-categories__CatalogCategoriesMetafieldsGetParametersDirection",
"admin-catalog-categories__CatalogCategoriesMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionResponse"
}
},
"response_definitions": [
"admin-catalog-categories__MetaFieldCollectionResponse",
"admin-catalog-categories__Metafield",
"admin-catalog-categories__MetafieldPermissionSet",
"admin-catalog-categories__MetafieldResourceType",
"admin-catalog-categories__CollectionMeta",
"admin-catalog-categories__CollectionMetaPagination",
"admin-catalog-categories__CollectionMetaPaginationLinks"
]
},
"POST /v3/catalog/categories/metafields": {
"operation": "batchMetafields_createCategoriesMetafields",
"method": "POST",
"path": "/v3/catalog/categories/metafields",
"risk": "H",
"description": "Create Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-categories__CatalogCategoriesMetafieldsPostRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-categories__CatalogCategoriesMetafieldsPostRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-categories__CatalogCategoriesMetafieldsPostRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-categories__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-categories__Metafield",
"admin-catalog-categories__MetafieldPermissionSet",
"admin-catalog-categories__MetafieldResourceType",
"admin-catalog-categories__CollectionMeta",
"admin-catalog-categories__CollectionMetaPagination",
"admin-catalog-categories__CollectionMetaPaginationLinks",
"admin-catalog-categories__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-categories__Error",
"admin-catalog-categories__ErrorDetail",
"admin-catalog-categories__WriteCollectionPartialSuccessMeta"
]
},
"PUT /v3/catalog/categories/metafields": {
"operation": "batchMetafields_updateCategoriesMetafields",
"method": "PUT",
"path": "/v3/catalog/categories/metafields",
"risk": "H",
"description": "Update Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-categories__CatalogCategoriesMetafieldsPutRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-categories__CatalogCategoriesMetafieldsPutRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-categories__CatalogCategoriesMetafieldsPutRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-categories__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-categories__Metafield",
"admin-catalog-categories__MetafieldPermissionSet",
"admin-catalog-categories__MetafieldResourceType",
"admin-catalog-categories__CollectionMeta",
"admin-catalog-categories__CollectionMetaPagination",
"admin-catalog-categories__CollectionMetaPaginationLinks",
"admin-catalog-categories__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-categories__Error",
"admin-catalog-categories__ErrorDetail",
"admin-catalog-categories__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/catalog/categories/metafields": {
"operation": "batchMetafields_deleteCategoriesMetafields",
"method": "DELETE",
"path": "/v3/catalog/categories/metafields",
"risk": "D",
"description": "Delete Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionDeleteResponseSuccess"
},
"422": {
"$ref": "#/$defs/admin-catalog-categories__MetaFieldCollectionResponsePartialSuccess_DELETE"
}
},
"response_definitions": [
"admin-catalog-categories__MetaFieldCollectionDeleteResponseSuccess",
"admin-catalog-categories__WriteCollectionSuccessMeta",
"admin-catalog-categories__MetaFieldCollectionResponsePartialSuccess_DELETE",
"admin-catalog-categories__Error",
"admin-catalog-categories__ErrorDetail",
"admin-catalog-categories__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/catalog/categories/{category_id}/image": {
"operation": "images_deleteCategoryImage",
"method": "DELETE",
"path": "/v3/catalog/categories/{category_id}/image",
"risk": "D",
"description": "Delete Category Image. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
}
},
"required": [
"category_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/categories/{category_id}/metafields": {
"operation": "metafields_getCategoryMetafields",
"method": "GET",
"path": "/v3/catalog/categories/{category_id}/metafields",
"risk": "R",
"description": "List Category Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
}
},
"required": [
"category_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by metafield ID.\n"
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Explicitly include objects by passing a comma-separated list of IDs."
},
"id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Exclude objects by passing a comma-separated list of IDs."
},
"id:min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is greater than or equal to this value."
},
"id:max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is less than or equal to this value."
},
"id:greater": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is greater than this value."
},
"id:less": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is less than this value."
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of results.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of results.\n"
},
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:greater",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:less",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__Metafields_getCategoryMetafields_Response_200"
}
},
"response_definitions": [
"admin-catalog-categories__Metafields_getCategoryMetafields_Response_200",
"admin-catalog-categories__metafield_Full",
"admin-catalog-categories__MetafieldBasePermissionSet",
"admin-catalog-categories__MetafieldFullResourceType",
"admin-catalog-categories__metaCollection_Full",
"admin-catalog-categories__pagination_Full",
"admin-catalog-categories__PaginationFullLinks"
]
},
"POST /v3/catalog/categories/{category_id}/metafields": {
"operation": "metafields_createCategoryMetafield",
"method": "POST",
"path": "/v3/catalog/categories/{category_id}/metafields",
"risk": "H",
"description": "Create Category Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
}
},
"required": [
"category_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-categories__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-categories__metafield_Base",
"admin-catalog-categories__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__Metafields_createCategoryMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-categories__Metafields_createCategoryMetafield_Response_200",
"admin-catalog-categories__metafield_Full",
"admin-catalog-categories__MetafieldBasePermissionSet",
"admin-catalog-categories__MetafieldFullResourceType",
"admin-catalog-categories__metaEmpty_Full"
]
},
"GET /v3/catalog/categories/{category_id}/metafields/{metafield_id}": {
"operation": "metafields_getCategoryMetafield",
"method": "GET",
"path": "/v3/catalog/categories/{category_id}/metafields/{metafield_id}",
"risk": "R",
"description": "Get Category Metafield. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"category_id",
"metafield_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__Metafields_getCategoryMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-categories__Metafields_getCategoryMetafield_Response_200",
"admin-catalog-categories__metafield_Full",
"admin-catalog-categories__MetafieldBasePermissionSet",
"admin-catalog-categories__MetafieldFullResourceType",
"admin-catalog-categories__metaEmpty_Full"
]
},
"PUT /v3/catalog/categories/{category_id}/metafields/{metafield_id}": {
"operation": "metafields_updateCategoryMetafield",
"method": "PUT",
"path": "/v3/catalog/categories/{category_id}/metafields/{metafield_id}",
"risk": "H",
"description": "Update Category Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"category_id",
"metafield_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-categories__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-categories__metafield_Base",
"admin-catalog-categories__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__Metafields_updateCategoryMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-categories__Metafields_updateCategoryMetafield_Response_200",
"admin-catalog-categories__metafield_Full",
"admin-catalog-categories__MetafieldBasePermissionSet",
"admin-catalog-categories__MetafieldFullResourceType",
"admin-catalog-categories__metaEmpty_Full"
]
},
"DELETE /v3/catalog/categories/{category_id}/metafields/{metafield_id}": {
"operation": "metafields_deleteCategoryMetafield",
"method": "DELETE",
"path": "/v3/catalog/categories/{category_id}/metafields/{metafield_id}",
"risk": "D",
"description": "Delete Category Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"category_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/categories/{category_id}/products/sort-order": {
"operation": "sortOrder_getCategorySortOrders",
"method": "GET",
"path": "/v3/catalog/categories/{category_id}/products/sort-order",
"risk": "R",
"description": "Get Product Sort Order. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
}
},
"required": [
"category_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of results.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-categories__Sort_order_getCategorySortOrders_Response_200"
}
},
"response_definitions": [
"admin-catalog-categories__Sort_order_getCategorySortOrders_Response_200",
"admin-catalog-categories__productSortOrder",
"admin-catalog-categories__metaCollection_Full",
"admin-catalog-categories__pagination_Full",
"admin-catalog-categories__PaginationFullLinks"
]
},
"PUT /v3/catalog/categories/{category_id}/products/sort-order": {
"operation": "sortOrder_updateCategorySortOrders",
"method": "PUT",
"path": "/v3/catalog/categories/{category_id}/products/sort-order",
"risk": "H",
"description": "Update Product Sort Order. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-categories.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"category_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Category` to which the resource belongs.\n"
}
},
"required": [
"category_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of results.\n"
}
},
"required": [],
"additionalProperties": false
},
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-categories__productSortOrder"
},
"maxItems": 10
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-categories__productSortOrder"
],
"wire": [
{
"name": "category_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-categories__productSortOrder"
}
}
},
"response_definitions": [
"admin-catalog-categories__productSortOrder"
]
},
"GET /v3/catalog/trees": {
"operation": "categoryTrees_getCategoryTrees",
"method": "GET",
"path": "/v3/catalog/trees",
"risk": "R",
"description": "List Category Trees. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter by supplying a comma-separated list of category tree IDs."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter by supplying a comma-separated list of channel IDs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-category-trees__CategoryTreeList"
}
},
"response_definitions": [
"admin-catalog-category-trees__CategoryTreeList",
"admin-catalog-category-trees__Tree",
"admin-catalog-category-trees__MetaPaginationObject",
"admin-catalog-category-trees__MetaPaginationObjectPagination",
"admin-catalog-category-trees__MetaPaginationObjectPaginationLinks"
]
},
"PUT /v3/catalog/trees": {
"operation": "categoryTrees_upsertCategoryTrees",
"method": "PUT",
"path": "/v3/catalog/trees",
"risk": "H",
"description": "Upsert Category Trees. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-catalog-category-trees__CategoryTreeListRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-category-trees__CategoryTreeListRequest",
"admin-catalog-category-trees__Tree"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-category-trees__CategoryTree"
}
},
"response_definitions": [
"admin-catalog-category-trees__CategoryTree",
"admin-catalog-category-trees__Tree",
"admin-catalog-category-trees__metaEmpty_Full"
]
},
"DELETE /v3/catalog/trees": {
"operation": "categoryTrees_deleteCategoryTrees",
"method": "DELETE",
"path": "/v3/catalog/trees",
"risk": "D",
"description": "Delete Category Trees. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter by supplying a comma-separated list of category tree IDs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/trees/{tree_id}/categories": {
"operation": "categoryTrees_getCategoryTree",
"method": "GET",
"path": "/v3/catalog/trees/{tree_id}/categories",
"risk": "R",
"description": "Get Category Tree. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"tree_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the category tree."
}
},
"required": [
"tree_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"depth": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Max depth for a tree of categories."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "tree_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "depth",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-category-trees__CategoryNodeTree"
}
},
"response_definitions": [
"admin-catalog-category-trees__CategoryNodeTree",
"admin-catalog-category-trees__CategoryNode",
"admin-catalog-category-trees__metaEmpty_Full"
]
},
"GET /v3/catalog/trees/categories": {
"operation": "categories_getAllCategories",
"method": "GET",
"path": "/v3/catalog/trees/categories",
"risk": "R",
"description": "List Categories. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"category_uuid:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter using a comma-separated list of one or more category UUIDs. To use category IDs, use the `category_id:in` parameter."
},
"category_uuid:not_in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter using a comma-separated list to exclude one or more category UUIDs. To exclude using category IDs, use the `category_id:not_in` parameter."
},
"category_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter using a comma-separated list of one or more category IDs. To use category UUIDs, use the `category_uuid:in` parameter."
},
"category_id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter using a comma-separated list to exclude one or more category IDs. To exclude using category UUIDs, use the `category_uuid:not_in` parameter."
},
"tree_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter using a comma-separated list of one or more category tree IDs."
},
"tree_id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter using a comma-separated list to exclude one or more category tree IDs."
},
"parent_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose parent ID is in this list."
},
"parent_id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter results to those whose parent ID is not in this list."
},
"page_title": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by page_title.\n"
},
"page_title:like": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by substring in the page title property. `page_title:like=oil` returns both `Soil and mulch` and `Oil pastels`."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by name.\n"
},
"name:like": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by substring in the name property. `name:like=stick` returns both `Stickers` and `Lipstick colors`."
},
"keyword": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name."
},
"is_visible": {
"type": "boolean",
"description": "Filter items based on whether the product is currently visible on the storefront."
},
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_uuid:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "category_uuid:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "category_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "category_id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "tree_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "tree_id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "parent_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "parent_id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page_title",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page_title:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "keyword",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_visible",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-category-trees__CategoryList"
}
},
"response_definitions": [
"admin-catalog-category-trees__CategoryList",
"admin-catalog-category-trees__GetCategories",
"admin-catalog-category-trees__name",
"admin-catalog-category-trees__category_id",
"admin-catalog-category-trees__category_uuid",
"admin-catalog-category-trees__tree_id",
"admin-catalog-category-trees__parent_id",
"admin-catalog-category-trees__GetCategoriesDefaultProductSort",
"admin-catalog-category-trees__url",
"admin-catalog-category-trees__MetaPagination",
"admin-catalog-category-trees__MetaPaginationPagination",
"admin-catalog-category-trees__MetaPaginationPaginationLinks"
]
},
"POST /v3/catalog/trees/categories": {
"operation": "categories_createCategories",
"method": "POST",
"path": "/v3/catalog/trees/categories",
"risk": "H",
"description": "Create Categories. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-catalog-category-trees__CreateCategories"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-category-trees__CreateCategories",
"admin-catalog-category-trees__CreateCategoriesItems",
"admin-catalog-category-trees__name",
"admin-catalog-category-trees__url",
"admin-catalog-category-trees__parent_id",
"admin-catalog-category-trees__tree_id",
"admin-catalog-category-trees__CreateCategoriesItemsDefaultProductSort"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-catalog-category-trees__SuccessResponse"
}
},
"response_definitions": [
"admin-catalog-category-trees__SuccessResponse",
"admin-catalog-category-trees__GetCategories",
"admin-catalog-category-trees__name",
"admin-catalog-category-trees__category_id",
"admin-catalog-category-trees__category_uuid",
"admin-catalog-category-trees__tree_id",
"admin-catalog-category-trees__parent_id",
"admin-catalog-category-trees__GetCategoriesDefaultProductSort",
"admin-catalog-category-trees__url",
"admin-catalog-category-trees__MetaData"
]
},
"PUT /v3/catalog/trees/categories": {
"operation": "categories_updateCategories",
"method": "PUT",
"path": "/v3/catalog/trees/categories",
"risk": "H",
"description": "Update Categories. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-catalog-category-trees__UpdateCategories"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-category-trees__UpdateCategories",
"admin-catalog-category-trees__UpdateCategoriesItems",
"admin-catalog-category-trees__category_id",
"admin-catalog-category-trees__name",
"admin-catalog-category-trees__tree_id",
"admin-catalog-category-trees__parent_id",
"admin-catalog-category-trees__UpdateCategoriesItemsDefaultProductSort",
"admin-catalog-category-trees__url"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-category-trees__SuccessNoContentResponse"
}
},
"response_definitions": [
"admin-catalog-category-trees__SuccessNoContentResponse",
"admin-catalog-category-trees__MetaData"
]
},
"DELETE /v3/catalog/trees/categories": {
"operation": "categories_deleteTreeCategories",
"method": "DELETE",
"path": "/v3/catalog/trees/categories",
"risk": "D",
"description": "Delete Categories. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-category-trees.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"category_uuid:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Filter using a comma-separated list of one or more category UUIDs. To use category IDs, use the `category_id:in` parameter."
},
"category_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter using a comma-separated list of one or more category IDs. To use category UUIDs, use the `category_uuid:in` parameter."
},
"tree_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter using a comma-separated list of one or more category tree IDs."
},
"parent_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter results to those whose parent ID is in this list."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "category_uuid:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "category_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "tree_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "parent_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"202": {
"$ref": "#/$defs/admin-catalog-category-trees__SuccessNoContentResponse"
}
},
"response_definitions": [
"admin-catalog-category-trees__SuccessNoContentResponse",
"admin-catalog-category-trees__MetaData"
]
},
"GET /v3/catalog/products/{product_id}/modifiers": {
"operation": "productModifiers_getProductModifiers",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/modifiers",
"risk": "R",
"description": "List Product Modifiers. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Product_modifiers_getProductModifiers_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Product_modifiers_getProductModifiers_Response_200",
"admin-catalog-product-modifiers__productModifier_Full",
"admin-catalog-product-modifiers__ProductModifierBaseType",
"admin-catalog-product-modifiers__config_Full",
"admin-catalog-product-modifiers__ConfigFullDateLimitMode",
"admin-catalog-product-modifiers__ConfigFullFileTypesMode",
"admin-catalog-product-modifiers__ConfigFullNumberLimitMode",
"admin-catalog-product-modifiers__ConfigFullProductListShippingCalc",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaCollection_Full",
"admin-catalog-product-modifiers__pagination_Full",
"admin-catalog-product-modifiers__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/modifiers": {
"operation": "productModifiers_createProductModifier",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/modifiers",
"risk": "H",
"description": "Create Product Modifier. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-product-modifiers__productModifier_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-modifiers__productModifier_Post",
"admin-catalog-product-modifiers__ProductModifierPostType",
"admin-catalog-product-modifiers__config_Full",
"admin-catalog-product-modifiers__ConfigFullDateLimitMode",
"admin-catalog-product-modifiers__ConfigFullFileTypesMode",
"admin-catalog-product-modifiers__ConfigFullNumberLimitMode",
"admin-catalog-product-modifiers__ConfigFullProductListShippingCalc",
"admin-catalog-product-modifiers__productModifierOptionValue_Post",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Product_modifiers_createProductModifier_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Product_modifiers_createProductModifier_Response_200",
"admin-catalog-product-modifiers__productModifier_Full",
"admin-catalog-product-modifiers__ProductModifierBaseType",
"admin-catalog-product-modifiers__config_Full",
"admin-catalog-product-modifiers__ConfigFullDateLimitMode",
"admin-catalog-product-modifiers__ConfigFullFileTypesMode",
"admin-catalog-product-modifiers__ConfigFullNumberLimitMode",
"admin-catalog-product-modifiers__ConfigFullProductListShippingCalc",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/modifiers/{modifier_id}": {
"operation": "productModifiers_getProductModifier",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}",
"risk": "R",
"description": "Get Product Modifier. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
}
},
"required": [
"product_id",
"modifier_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Product_modifiers_getProductModifier_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Product_modifiers_getProductModifier_Response_200",
"admin-catalog-product-modifiers__productModifier_Full",
"admin-catalog-product-modifiers__ProductModifierBaseType",
"admin-catalog-product-modifiers__config_Full",
"admin-catalog-product-modifiers__ConfigFullDateLimitMode",
"admin-catalog-product-modifiers__ConfigFullFileTypesMode",
"admin-catalog-product-modifiers__ConfigFullNumberLimitMode",
"admin-catalog-product-modifiers__ConfigFullProductListShippingCalc",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/modifiers/{modifier_id}": {
"operation": "productModifiers_updateProductModifier",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}",
"risk": "H",
"description": "Update Product Modifier. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
}
},
"required": [
"product_id",
"modifier_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaType",
"description": "BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST.\n"
},
"required": {
"type": "boolean",
"description": "Whether or not this modifier is required at checkout. Required in a /POST.\n"
},
"sort_order": {
"type": "integer",
"description": "The order the modifiers display on the product detail page.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"config": {
"$ref": "#/$defs/admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaConfig",
"description": "The values for option config can vary based on the Modifier created. See [Configs](#configs) to learn more about the type-specific `config` fields."
},
"option_values": {
"type": "array",
"description": "Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See [Option Values](#option-values) for more details.",
"items": {
"$ref": "#/$defs/admin-catalog-product-modifiers__productModifierOptionValue_Full"
},
"maxItems": 10
},
"display_name": {
"type": "string",
"description": "The name of the option shown on the storefront.\n",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaType",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaConfig",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaConfigDateLimitMode",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaConfigFileTypesMode",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaConfigNumberLimitMode",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdPutRequestBodyContentApplicationJsonSchemaConfigProductListShippingCalc",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Product_modifiers_updateProductModifier_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Product_modifiers_updateProductModifier_Response_200",
"admin-catalog-product-modifiers__productModifier_Full",
"admin-catalog-product-modifiers__ProductModifierBaseType",
"admin-catalog-product-modifiers__config_Full",
"admin-catalog-product-modifiers__ConfigFullDateLimitMode",
"admin-catalog-product-modifiers__ConfigFullFileTypesMode",
"admin-catalog-product-modifiers__ConfigFullNumberLimitMode",
"admin-catalog-product-modifiers__ConfigFullProductListShippingCalc",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/modifiers/{modifier_id}": {
"operation": "productModifiers_deleteProductModifier",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}",
"risk": "D",
"description": "Delete Product Modifier. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
}
},
"required": [
"product_id",
"modifier_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/modifiers/{modifier_id}/values": {
"operation": "values_getProductModifierValues",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values",
"risk": "R",
"description": "List Product Modifier Values. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
}
},
"required": [
"product_id",
"modifier_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Values_getProductModifierValues_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Values_getProductModifierValues_Response_200",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaCollection_Full",
"admin-catalog-product-modifiers__pagination_Full",
"admin-catalog-product-modifiers__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/modifiers/{modifier_id}/values": {
"operation": "values_createProductModifierValue",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values",
"risk": "H",
"description": "Create Product Modifier Value. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
}
},
"required": [
"product_id",
"modifier_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"label",
"sort_order"
],
"properties": {
"is_default": {
"type": "boolean",
"description": "The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. Read-only on this endpoint; use [Update Product Modifier](/developer/api-reference/rest/admin/catalog/product-modifiers/update-product-modifier) with the full `option_values` array to change the default.\n"
},
"label": {
"type": "string",
"description": "The text display identifying the value on the storefront. Required in a /POST.\n",
"maxLength": 262144
},
"sort_order": {
"type": "integer",
"description": "The order in which the value will be displayed on the product page. Required in a /POST.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"value_data": {
"$ref": "#/$defs/admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaValueData",
"description": "Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexadecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.\n"
},
"adjusters": {
"$ref": "#/$defs/admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjusters"
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaValueData",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjusters",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjustersPrice",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjustersPriceAdjuster",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjustersWeight",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjustersWeightAdjuster",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesPostRequestBodyContentApplicationJsonSchemaAdjustersPurchasingDisabled"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Values_createProductModifierValue_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Values_createProductModifierValue_Response_200",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}": {
"operation": "values_getProductModifierValue",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}",
"risk": "R",
"description": "Get Product Modifier Value. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
},
"value_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier value.\n"
}
},
"required": [
"product_id",
"modifier_id",
"value_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "value_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Values_getProductModifierValue_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Values_getProductModifierValue_Response_200",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}": {
"operation": "values_updateProductModifierValue",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}",
"risk": "H",
"description": "Update Product Modifier Value. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
},
"value_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier value.\n"
}
},
"required": [
"product_id",
"modifier_id",
"value_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"label",
"sort_order"
],
"properties": {
"is_default": {
"type": "boolean",
"description": "The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. Read-only on this endpoint; use [Update Product Modifier](/developer/api-reference/rest/admin/catalog/product-modifiers/update-product-modifier) with the full `option_values` array to change the default.\n"
},
"label": {
"type": "string",
"description": "The text display identifying the value on the storefront. Required in a /POST.\n",
"maxLength": 262144
},
"sort_order": {
"type": "integer",
"description": "The order in which the value will be displayed on the product page. Required in a /POST.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"value_data": {
"$ref": "#/$defs/admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaValueData",
"description": "Extra data describing the value, based on the type of option or modifier with which the value is associated. See [Option Values](#option-values) for more details.\n"
},
"adjusters": {
"$ref": "#/$defs/admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjusters"
},
"id": {
"type": "integer",
"description": "The unique numeric ID of the value; increments sequentially.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaValueData",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjusters",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjustersPrice",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjustersPriceAdjuster",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjustersWeight",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjustersWeightAdjuster",
"admin-catalog-product-modifiers__CatalogProductsProductIdModifiersModifierIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaAdjustersPurchasingDisabled"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "value_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-modifiers__Values_updateProductModifierValue_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-modifiers__Values_updateProductModifierValue_Response_200",
"admin-catalog-product-modifiers__productModifierOptionValue_Full",
"admin-catalog-product-modifiers__ProductModifierOptionValueBaseValueData",
"admin-catalog-product-modifiers__adjusters_Full",
"admin-catalog-product-modifiers__adjuster_Full",
"admin-catalog-product-modifiers__AdjusterFullAdjuster",
"admin-catalog-product-modifiers__AdjustersFullPurchasingDisabled",
"admin-catalog-product-modifiers__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}": {
"operation": "values_deleteProductModifierValue",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}",
"risk": "D",
"description": "Delete Product Modifier Value. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-modifiers.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product to which the resource belongs.\n"
},
"modifier_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier.\n"
},
"value_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the product modifier value.\n"
}
},
"required": [
"product_id",
"modifier_id",
"value_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "modifier_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "value_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/options": {
"operation": "productVariantOptions_getProductVariantOptions",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/options",
"risk": "R",
"description": "List Product Variant Options. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Product_variant_options_getProductVariantOptions_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Product_variant_options_getProductVariantOptions_Response_200",
"admin-catalog-product-variant-options__productOption_Full",
"admin-catalog-product-variant-options__ProductOptionBaseType",
"admin-catalog-product-variant-options__productOptionConfig_Full",
"admin-catalog-product-variant-options__ProductOptionConfigFullDateLimitMode",
"admin-catalog-product-variant-options__ProductOptionConfigFullFileTypesMode",
"admin-catalog-product-variant-options__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-product-variant-options__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-product-variant-options__productOptionOptionValue_Full",
"admin-catalog-product-variant-options__ProductOptionOptionValueBaseValueData",
"admin-catalog-product-variant-options__metaCollection_Full",
"admin-catalog-product-variant-options__pagination_Full",
"admin-catalog-product-variant-options__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/options": {
"operation": "productVariantOptions_createProductVariantOption",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/options",
"risk": "H",
"description": "Create Product Variant Option. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"description": "The unique numerical ID of the product to which the option belongs.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "The name of the option shown on the storefront.\n"
},
"type": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaType",
"description": "The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.\n"
},
"config": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaConfig",
"description": "The values for option config can vary based on the Modifier created."
},
"sort_order": {
"type": "integer",
"description": "Order in which the option is displayed on the storefront. ",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"option_values": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaOptionValuesItems"
},
"maxItems": 10
},
"image_url": {
"type": "string",
"description": "Publicly available image url",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaType",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaConfig",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaConfigDateLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaConfigFileTypesMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaConfigNumberLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaConfigProductListShippingCalc",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaOptionValuesItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostRequestBodyContentApplicationJsonSchemaOptionValuesItemsValueData"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Product_variant_options_createProductVariantOption_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Product_variant_options_createProductVariantOption_Response_200",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataConfig",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataConfigDateLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataConfigFileTypesMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataConfigNumberLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataConfigProductListShippingCalc",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataOptionValuesItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaDataOptionValuesItemsValueData",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsPostResponsesContentApplicationJsonSchemaMeta"
]
},
"GET /v3/catalog/products/{product_id}/options/{option_id}": {
"operation": "productVariantOptions_getProductVariantOption",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/options/{option_id}",
"risk": "R",
"description": "Get Product Variant Option. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
}
},
"required": [
"product_id",
"option_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Product_variant_options_getProductVariantOption_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Product_variant_options_getProductVariantOption_Response_200",
"admin-catalog-product-variant-options__productOption_Full",
"admin-catalog-product-variant-options__ProductOptionBaseType",
"admin-catalog-product-variant-options__productOptionConfig_Full",
"admin-catalog-product-variant-options__ProductOptionConfigFullDateLimitMode",
"admin-catalog-product-variant-options__ProductOptionConfigFullFileTypesMode",
"admin-catalog-product-variant-options__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-product-variant-options__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-product-variant-options__productOptionOptionValue_Full",
"admin-catalog-product-variant-options__ProductOptionOptionValueBaseValueData",
"admin-catalog-product-variant-options__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/options/{option_id}": {
"operation": "productVariantOptions_updateProductVariantOption",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/options/{option_id}",
"risk": "H",
"description": "Update Product Variant Option. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
}
},
"required": [
"product_id",
"option_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"id": {
"type": [
"integer",
"null"
],
"description": "The unique numerical ID of the option, increments sequentially.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"product_id": {
"type": "integer",
"description": "The unique numerical ID of the product to which the option belongs.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "The name of the option shown on the storefront.\n"
},
"type": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaType",
"description": "The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.\n"
},
"config": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaConfig",
"description": "The values for option config can vary based on the Modifier created."
},
"sort_order": {
"type": "integer",
"description": "Order in which the option is displayed on the storefront. ",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"option_values": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaOptionValuesItems"
},
"maxItems": 10
},
"image_url": {
"type": "string",
"description": "Publicly available image url",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaType",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaConfig",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaConfigDateLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaConfigFileTypesMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaConfigNumberLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaConfigProductListShippingCalc",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaOptionValuesItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutRequestBodyContentApplicationJsonSchemaOptionValuesItemsValueData"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Product_variant_options_updateProductVariantOption_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Product_variant_options_updateProductVariantOption_Response_200",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataConfig",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataConfigDateLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataConfigFileTypesMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataConfigNumberLimitMode",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataConfigProductListShippingCalc",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataOptionValuesItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdPutResponsesContentApplicationJsonSchemaDataOptionValuesItemsValueData",
"admin-catalog-product-variant-options__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/options/{option_id}": {
"operation": "productVariantOptions_deleteProductVariantOption",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/options/{option_id}",
"risk": "D",
"description": "Delete Product Variant Option. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
}
},
"required": [
"product_id",
"option_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/options/{option_id}/values": {
"operation": "values_getProductVariantOptionValues",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/options/{option_id}/values",
"risk": "R",
"description": "List Product Variant Option Values. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
}
},
"required": [
"product_id",
"option_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesGetParametersExcludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesGetParametersIncludeFieldsSchemaItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesGetParametersExcludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Values_getProductVariantOptionValues_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Values_getProductVariantOptionValues_Response_200",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesGetResponsesContentApplicationJsonSchemaDataItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesGetResponsesContentApplicationJsonSchemaDataItemsValueData",
"admin-catalog-product-variant-options__metaCollection_Full",
"admin-catalog-product-variant-options__pagination_Full",
"admin-catalog-product-variant-options__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/options/{option_id}/values": {
"operation": "values_createProductVariantOptionValue",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/options/{option_id}/values",
"risk": "H",
"description": "Create Product Variant Option Value. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
}
},
"required": [
"product_id",
"option_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"label",
"sort_order"
],
"properties": {
"is_default": {
"type": "boolean",
"description": "The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. Read-only on this endpoint; use [Update Product Variant Option](/developer/api-reference/rest/admin/catalog/product-variant-options/update-product-variant-option) with the full `option_values` array to change the default.\n"
},
"label": {
"type": "string",
"description": "The text display identifying the value on the storefront. Required in a /POST.\n",
"maxLength": 262144
},
"sort_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The order in which the value will be displayed on the product page. Required in a /POST.\n"
},
"value_data": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesPostRequestBodyContentApplicationJsonSchemaValueData",
"description": "Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.\n"
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesPostRequestBodyContentApplicationJsonSchemaValueData"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Values_createProductVariantOptionValue_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Values_createProductVariantOptionValue_Response_200",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesPostResponsesContentApplicationJsonSchemaDataValueData",
"admin-catalog-product-variant-options__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}": {
"operation": "values_getProductVariantOptionValue",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}",
"risk": "R",
"description": "Get Product Variant Option Value. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
},
"value_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Modifier/Option Value`.\n"
}
},
"required": [
"product_id",
"option_id",
"value_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdGetParametersExcludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdGetParametersIncludeFieldsSchemaItems",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdGetParametersExcludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "value_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Values_getProductVariantOptionValue_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Values_getProductVariantOptionValue_Response_200",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdGetResponsesContentApplicationJsonSchemaDataValueData",
"admin-catalog-product-variant-options__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}": {
"operation": "values_updateProductVariantOptionValue",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}",
"risk": "H",
"description": "Update Product Variant Option Value. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
},
"value_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Modifier/Option Value`.\n"
}
},
"required": [
"product_id",
"option_id",
"value_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"label",
"sort_order"
],
"properties": {
"is_default": {
"type": "boolean",
"description": "The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. Read-only on this endpoint; use [Update Product Variant Option](/developer/api-reference/rest/admin/catalog/product-variant-options/update-product-variant-option) with the full `option_values` array to change the default.\n"
},
"label": {
"type": "string",
"description": "The text display identifying the value on the storefront. Required in a /POST.\n",
"maxLength": 262144
},
"sort_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The order in which the value will be displayed on the product page. Required in a /POST.\n"
},
"value_data": {
"$ref": "#/$defs/admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaValueData",
"description": "Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state.\n"
},
"id": {
"type": "integer",
"description": "The unique numeric ID of the value; increments sequentially.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdPutRequestBodyContentApplicationJsonSchemaValueData"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "value_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variant-options__Values_updateProductVariantOptionValue_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variant-options__Values_updateProductVariantOptionValue_Response_200",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-product-variant-options__CatalogProductsProductIdOptionsOptionIdValuesValueIdPutResponsesContentApplicationJsonSchemaDataValueData",
"admin-catalog-product-variant-options__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}": {
"operation": "values_deleteProductVariantOptionValue",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}",
"risk": "D",
"description": "Delete Product Variant Option Value. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variant-options.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"option_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Option`.\n"
},
"value_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Modifier/Option Value`.\n"
}
},
"required": [
"product_id",
"option_id",
"value_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "option_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "value_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/variants": {
"operation": "productVariants_getProductVariants",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/variants",
"risk": "R",
"description": "List Product Variants. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Product_variants_getProductVariants_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Product_variants_getProductVariants_Response_200",
"admin-catalog-product-variants__productVariant_Full",
"admin-catalog-product-variants__productVariantOptionValue_Full",
"admin-catalog-product-variants__metaCollection_Full",
"admin-catalog-product-variants__pagination_Full",
"admin-catalog-product-variants__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/variants": {
"operation": "productVariants_createProductVariant",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/variants",
"risk": "H",
"description": "Create Product Variant. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-product-variants__productVariant_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__productVariant_Post",
"admin-catalog-product-variants__productVariantOptionValue_Full"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Product_variants_createProductVariant_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Product_variants_createProductVariant_Response_200",
"admin-catalog-product-variants__productVariant_Full",
"admin-catalog-product-variants__productVariantOptionValue_Full",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/variants/{variant_id}": {
"operation": "productVariants_getProductVariant",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}",
"risk": "R",
"description": "Get Product Variant. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
}
},
"required": [
"product_id",
"variant_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Product_variants_getProductVariant_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Product_variants_getProductVariant_Response_200",
"admin-catalog-product-variants__productVariant_Full",
"admin-catalog-product-variants__productVariantOptionValue_Full",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/variants/{variant_id}": {
"operation": "productVariants_updateProductVariant",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}",
"risk": "H",
"description": "Update Product Variant. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
}
},
"required": [
"product_id",
"variant_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-product-variants__productVariant_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__productVariant_Put"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Product_variants_updateProductVariant_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Product_variants_updateProductVariant_Response_200",
"admin-catalog-product-variants__productVariant_Full",
"admin-catalog-product-variants__productVariantOptionValue_Full",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/variants/{variant_id}": {
"operation": "productVariants_deleteProductVariant",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}",
"risk": "D",
"description": "Delete Product Variant. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
}
},
"required": [
"product_id",
"variant_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/variants/metafields": {
"operation": "batchMetafields_getVariantsMetafields",
"method": "GET",
"path": "/v3/catalog/variants/metafields",
"risk": "R",
"description": "List Product Variant Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"key:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"namespace:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter."
},
"direction": {
"$ref": "#/$defs/admin-catalog-product-variants__CatalogVariantsMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variants__CatalogVariantsMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'\n"
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'\n"
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'\n"
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__CatalogVariantsMetafieldsGetParametersDirection",
"admin-catalog-product-variants__CatalogVariantsMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionResponse"
}
},
"response_definitions": [
"admin-catalog-product-variants__MetaFieldCollectionResponse",
"admin-catalog-product-variants__Metafield",
"admin-catalog-product-variants__MetafieldPermissionSet",
"admin-catalog-product-variants__MetafieldResourceType",
"admin-catalog-product-variants__CollectionMeta",
"admin-catalog-product-variants__CollectionMetaPagination",
"admin-catalog-product-variants__CollectionMetaPaginationLinks"
]
},
"POST /v3/catalog/variants/metafields": {
"operation": "batchMetafields_createVariantsMetafields",
"method": "POST",
"path": "/v3/catalog/variants/metafields",
"risk": "H",
"description": "Create Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variants__CatalogVariantsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__CatalogVariantsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-product-variants__CatalogVariantsMetafieldsPostRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-product-variants__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-product-variants__Metafield",
"admin-catalog-product-variants__MetafieldPermissionSet",
"admin-catalog-product-variants__MetafieldResourceType",
"admin-catalog-product-variants__CollectionMeta",
"admin-catalog-product-variants__CollectionMetaPagination",
"admin-catalog-product-variants__CollectionMetaPaginationLinks",
"admin-catalog-product-variants__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-product-variants__Error",
"admin-catalog-product-variants__ErrorDetail",
"admin-catalog-product-variants__WriteCollectionPartialSuccessMeta"
]
},
"PUT /v3/catalog/variants/metafields": {
"operation": "batchMetafields_updateVariantsMetafields",
"method": "PUT",
"path": "/v3/catalog/variants/metafields",
"risk": "H",
"description": "Update Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variants__CatalogVariantsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__CatalogVariantsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-product-variants__CatalogVariantsMetafieldsPutRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-product-variants__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-product-variants__Metafield",
"admin-catalog-product-variants__MetafieldPermissionSet",
"admin-catalog-product-variants__MetafieldResourceType",
"admin-catalog-product-variants__CollectionMeta",
"admin-catalog-product-variants__CollectionMetaPagination",
"admin-catalog-product-variants__CollectionMetaPaginationLinks",
"admin-catalog-product-variants__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-product-variants__Error",
"admin-catalog-product-variants__ErrorDetail",
"admin-catalog-product-variants__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/catalog/variants/metafields": {
"operation": "batchMetafields_deleteVariantsMetafields",
"method": "DELETE",
"path": "/v3/catalog/variants/metafields",
"risk": "D",
"description": "Delete Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionDeleteResponseSuccess"
},
"422": {
"$ref": "#/$defs/admin-catalog-product-variants__MetaFieldCollectionResponsePartialSuccess_DELETE"
}
},
"response_definitions": [
"admin-catalog-product-variants__MetaFieldCollectionDeleteResponseSuccess",
"admin-catalog-product-variants__WriteCollectionSuccessMeta",
"admin-catalog-product-variants__MetaFieldCollectionResponsePartialSuccess_DELETE",
"admin-catalog-product-variants__Error",
"admin-catalog-product-variants__ErrorDetail",
"admin-catalog-product-variants__WriteCollectionPartialSuccessMeta"
]
},
"POST /v3/catalog/products/{product_id}/variants/{variant_id}/image": {
"operation": "images_createProductVariantImage",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}/image",
"risk": "H",
"description": "Create Product Variant Image. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
}
},
"required": [
"product_id",
"variant_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"image_url": {
"type": "string",
"description": "A public URL for a GIF, JPEG, or PNG image. Limit of 8MB per file.\n",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Images_createProductVariantImage_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Images_createProductVariantImage_Response_200",
"admin-catalog-product-variants__CatalogProductsProductIdVariantsVariantIdImagePostResponsesContentApplicationJsonSchemaData",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/variants/{variant_id}/metafields": {
"operation": "metafields_getProductVariantMetafields",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}/metafields",
"risk": "R",
"description": "List Product Variant Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
}
},
"required": [
"product_id",
"variant_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"resource_id:in": {
"type": "string",
"maxLength": 262144,
"description": "A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "resource_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Metafields_getProductVariantMetafields_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Metafields_getProductVariantMetafields_Response_200",
"admin-catalog-product-variants__metafield_Full",
"admin-catalog-product-variants__MetafieldBasePermissionSet",
"admin-catalog-product-variants__MetafieldFullResourceType",
"admin-catalog-product-variants__categoriesTree_Resp",
"admin-catalog-product-variants__categoriesTreeNode_Full",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"POST /v3/catalog/products/{product_id}/variants/{variant_id}/metafields": {
"operation": "metafields_createProductVariantMetafield",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}/metafields",
"risk": "H",
"description": "Create Product Variant Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
}
},
"required": [
"product_id",
"variant_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-product-variants__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__metafield_Base",
"admin-catalog-product-variants__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Metafields_createProductVariantMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Metafields_createProductVariantMetafield_Response_200",
"admin-catalog-product-variants__metafield_Full",
"admin-catalog-product-variants__MetafieldBasePermissionSet",
"admin-catalog-product-variants__MetafieldFullResourceType",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}": {
"operation": "metafields_getProductVariantMetafield",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}",
"risk": "R",
"description": "Get Product Variant Metafield. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"product_id",
"variant_id",
"metafield_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Metafields_getProductVariantMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Metafields_getProductVariantMetafield_Response_200",
"admin-catalog-product-variants__metafield_Full",
"admin-catalog-product-variants__MetafieldBasePermissionSet",
"admin-catalog-product-variants__MetafieldFullResourceType",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}": {
"operation": "metafields_updateProductVariantMetafield",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}",
"risk": "H",
"description": "Update Product Variant Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"product_id",
"variant_id",
"metafield_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-product-variants__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__metafield_Base",
"admin-catalog-product-variants__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Metafields_updateProductVariantMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Metafields_updateProductVariantMetafield_Response_200",
"admin-catalog-product-variants__metafield_Full",
"admin-catalog-product-variants__MetafieldBasePermissionSet",
"admin-catalog-product-variants__MetafieldFullResourceType",
"admin-catalog-product-variants__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}": {
"operation": "metafields_deleteProductVariantMetafield",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/variants/{variant_id}/metafields/{metafield_id}",
"risk": "D",
"description": "Delete Product Variant Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
},
"variant_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the variant on a product, or on an associated Price List Record.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"product_id",
"variant_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "variant_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/variants": {
"operation": "variantsBatch_getVariants",
"method": "GET",
"path": "/v3/catalog/variants",
"risk": "R",
"description": "List Variants. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by variant ID."
},
"sku": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by variant SKU. To filter by product / base variant SKU, see [Get all products](/developer/api-reference/rest/admin/catalog/products/get-products). "
},
"upc": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by UPC.\n"
},
"include_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"product_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of IDs of products you want to request. For example, `?product_id:in=77,80,81`."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sku",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "upc",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "product_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Variants__Batch__getVariants_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Variants__Batch__getVariants_Response_200",
"admin-catalog-product-variants__CatalogVariantsGetResponsesContentApplicationJsonSchemaDataItems",
"admin-catalog-product-variants__CatalogVariantsGetResponsesContentApplicationJsonSchemaDataItemsOptionValuesItems",
"admin-catalog-product-variants__metaCollection_Full",
"admin-catalog-product-variants__pagination_Full",
"admin-catalog-product-variants__PaginationFullLinks"
]
},
"PUT /v3/catalog/variants": {
"operation": "variantsBatch_updateVariantsBatch",
"method": "PUT",
"path": "/v3/catalog/variants",
"risk": "H",
"description": "Update Variants (batch). Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-product-variants.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-product-variants__CatalogVariantsPutRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-product-variants__CatalogVariantsPutRequestBodyContentApplicationJsonSchemaItems"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-product-variants__Variants__Batch__updateVariantsBatch_Response_200"
}
},
"response_definitions": [
"admin-catalog-product-variants__Variants__Batch__updateVariantsBatch_Response_200",
"admin-catalog-product-variants__CatalogVariantsPutResponsesContentApplicationJsonSchemaDataItems",
"admin-catalog-product-variants__CatalogVariantsPutResponsesContentApplicationJsonSchemaDataItemsOptionValuesItems",
"admin-catalog-product-variants__CatalogVariantsPutResponsesContentApplicationJsonSchemaMeta",
"admin-catalog-product-variants__CatalogVariantsPutResponsesContentApplicationJsonSchemaMetaPagination",
"admin-catalog-product-variants__CatalogVariantsPutResponsesContentApplicationJsonSchemaMetaPaginationLinks"
]
},
"GET /v3/catalog/products": {
"operation": "products_getProducts",
"method": "GET",
"path": "/v3/catalog/products",
"risk": "R",
"description": "List Products. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by product ID.\n"
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to filter by one or more product IDs."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to filter by one or more channel IDs."
},
"id:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to exclude one or more product IDs."
},
"include": {
"$ref": "#/$defs/admin-catalog-products__IncludeParamBase",
"description": "A comma-separated list of sub-resources to return with a product object.\nWhen you specify `options` or `modifiers`, results are limited to 10 per page."
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"direction": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"sort": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersSort",
"description": "Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date.\n"
},
"categories": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filters by a single category ID, returning only products assigned exclusively to that category. A product that also belongs to one or more other categories will not be returned — to match products in a category regardless of their other memberships, use `categories:in` instead."
},
"categories:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of category IDs. Returns products that belong to any of the specified categories."
},
"id:min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is greater than or equal to this value."
},
"id:max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is less than or equal to this value."
},
"id:greater": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is greater than this value."
},
"id:less": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose ID is less than this value."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by name.\n"
},
"mpn": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by Manufacturer Part Number (MPN).\n"
},
"upc": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by UPC.\n"
},
"price": {
"type": "number",
"description": "Filter items by price.\n"
},
"weight": {
"type": "number",
"description": "Filter items by weight.\n"
},
"condition": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersCondition",
"description": "Filter items by condition.\n"
},
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by brand ID.\n"
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_modified`."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_modified`. If the `date modified:max` does not include hours, minutes and seconds, the API automatically adds the current time of the request to the date. For example, `date_modified:max=2025-01-15` or `date_modified:max=2025-01-15T00:03:17Z`."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_modified`. If the `date modified:min` does not include hours, minutes and seconds, the API automatically adds the current time of the request to the date. For example, `date_modified:min=2025-01-15` or `date_modified:min=2025-01-15T00:03:17Z`."
},
"date_last_imported": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_last_imported."
},
"date_last_imported:not": {
"type": "string",
"maxLength": 262144,
"description": "Filter products by specifying a date they were NOT last imported. For example, `date_last_imported:not=2015-08-21T22%3A53%3A23%2B00%3A00`."
},
"date_last_imported:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_last_imported. For example, `date_last_imported:max=2015-08-21T22%3A53%3A23%2B00%3A00`."
},
"date_last_imported:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_last_imported. For example, `date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00`."
},
"is_visible": {
"type": "boolean",
"description": "Filter items based on whether the product is currently visible on the storefront."
},
"is_featured": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersIsFeatured",
"description": "Filter items by is_featured. `1` for true, `0` for false."
},
"is_free_shipping": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by is_free_shipping. `1` for true, `0` for false."
},
"inventory_level": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by inventory_level.\n"
},
"inventory_level:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of inventory levels. Returns a list of all products that have any of the listed inventory amounts."
},
"inventory_level:not_in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of inventory levels. Returns a list of all products that have inventory amounts other than those specified."
},
"inventory_level:min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose inventory level is greater than or equal to this value."
},
"inventory_level:max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose inventory level is less than or equal to this value."
},
"inventory_level:greater": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose inventory level is greater than this value."
},
"inventory_level:less": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those whose inventory level is less than this value."
},
"inventory_low": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by inventory_low. Values: 1, 0.\n"
},
"out_of_stock": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`.\n"
},
"total_sold": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by total_sold.\n"
},
"type": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersType",
"description": "Filter items by type."
},
"keyword": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name."
},
"keyword_context": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersKeywordContext",
"description": "Set context used by the search algorithm to return results targeted towards the specified group. Use `merchant` to help merchants search their own catalog. Use `shopper` to return shopper-facing search results."
},
"availability": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsGetParametersAvailability",
"description": "Filter items by availability. Values are: available, disabled, preorder.\n"
},
"sku": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by main SKU. To filter by variant SKU, see [Get all variants](/developer/api-reference/rest/admin/catalog/product-variants/get-product-variants). "
},
"sku:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "A comma-separated list of SKUs. Returns a list of products with those SKUs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__IncludeParamBase",
"admin-catalog-products__IncludeParamBaseItems",
"admin-catalog-products__CatalogProductsGetParametersIncludeFieldsSchemaItems",
"admin-catalog-products__CatalogProductsGetParametersDirection",
"admin-catalog-products__CatalogProductsGetParametersSort",
"admin-catalog-products__CatalogProductsGetParametersCondition",
"admin-catalog-products__CatalogProductsGetParametersIsFeatured",
"admin-catalog-products__CatalogProductsGetParametersType",
"admin-catalog-products__CatalogProductsGetParametersKeywordContext",
"admin-catalog-products__CatalogProductsGetParametersAvailability"
],
"wire": [
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sort",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "categories",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "categories:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:greater",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:less",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "mpn",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "upc",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "price",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "weight",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "condition",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "brand_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_last_imported",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_last_imported:not",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_last_imported:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_last_imported:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_visible",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_featured",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_free_shipping",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level:not_in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level:greater",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level:less",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_low",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "out_of_stock",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "total_sold",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "keyword",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "keyword_context",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "availability",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sku",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sku:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Products_getProducts_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Products_getProducts_Response_200",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItems",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsType",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsInventoryTracking",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsAvailability",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsGiftWrappingOptionsType",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingRulesItems",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingRulesItemsType",
"admin-catalog-products__CatalogProductsGetResponsesContentApplicationJsonSchemaDataItemsBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__primaryImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__productOption_Base",
"admin-catalog-products__ProductOptionBaseType",
"admin-catalog-products__productOptionConfig_Full",
"admin-catalog-products__ProductOptionConfigFullDateLimitMode",
"admin-catalog-products__ProductOptionConfigFullFileTypesMode",
"admin-catalog-products__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-products__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-products__productOptionOptionValue_Full",
"admin-catalog-products__ProductOptionOptionValueBaseValueData",
"admin-catalog-products__productModifier_Full",
"admin-catalog-products__ProductModifierBaseType",
"admin-catalog-products__config_Full",
"admin-catalog-products__ConfigFullDateLimitMode",
"admin-catalog-products__ConfigFullFileTypesMode",
"admin-catalog-products__ConfigFullNumberLimitMode",
"admin-catalog-products__ConfigFullProductListShippingCalc",
"admin-catalog-products__productModifierOptionValue_Full",
"admin-catalog-products__ProductModifierOptionValueBaseValueData",
"admin-catalog-products__adjusters_Full",
"admin-catalog-products__adjuster_Full",
"admin-catalog-products__AdjusterFullAdjuster",
"admin-catalog-products__AdjustersFullPurchasingDisabled",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"PUT /v3/catalog/products": {
"operation": "products_updateProducts",
"method": "PUT",
"path": "/v3/catalog/products",
"risk": "H",
"description": "Update Products (batch). Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsPutParametersIncludeFieldsSchemaItems"
},
"maxItems": 10,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__product_Put_Collection"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsPutParametersIncludeFieldsSchemaItems",
"admin-catalog-products__product_Put_Collection",
"admin-catalog-products__ProductPutCollectionItems",
"admin-catalog-products__ProductPutCollectionItemsType",
"admin-catalog-products__ProductPutCollectionItemsInventoryTracking",
"admin-catalog-products__ProductPutCollectionItemsAvailability",
"admin-catalog-products__ProductPutCollectionItemsGiftWrappingOptionsType",
"admin-catalog-products__ProductPutCollectionItemsCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__ProductPutCollectionItemsOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__ProductPutCollectionItemsBulkPricingRulesItems",
"admin-catalog-products__ProductPutCollectionItemsBulkPricingRulesItemsType",
"admin-catalog-products__ProductPutCollectionItemsBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType"
],
"wire": [
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Products_updateProducts_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Products_updateProducts_Response_200",
"admin-catalog-products__product_Full",
"admin-catalog-products__ProductBaseResponseType",
"admin-catalog-products__ProductBaseResponseInventoryTracking",
"admin-catalog-products__ProductBaseResponseAvailability",
"admin-catalog-products__ProductBaseResponseGiftWrappingOptionsType",
"admin-catalog-products__ProductBaseResponseCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__ProductBaseResponseOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItems",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItemsType",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__primaryImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__productOption_Base",
"admin-catalog-products__ProductOptionBaseType",
"admin-catalog-products__productOptionConfig_Full",
"admin-catalog-products__ProductOptionConfigFullDateLimitMode",
"admin-catalog-products__ProductOptionConfigFullFileTypesMode",
"admin-catalog-products__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-products__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-products__productOptionOptionValue_Full",
"admin-catalog-products__ProductOptionOptionValueBaseValueData",
"admin-catalog-products__productModifier_Full",
"admin-catalog-products__ProductModifierBaseType",
"admin-catalog-products__config_Full",
"admin-catalog-products__ConfigFullDateLimitMode",
"admin-catalog-products__ConfigFullFileTypesMode",
"admin-catalog-products__ConfigFullNumberLimitMode",
"admin-catalog-products__ConfigFullProductListShippingCalc",
"admin-catalog-products__productModifierOptionValue_Full",
"admin-catalog-products__ProductModifierOptionValueBaseValueData",
"admin-catalog-products__adjusters_Full",
"admin-catalog-products__adjuster_Full",
"admin-catalog-products__AdjusterFullAdjuster",
"admin-catalog-products__AdjustersFullPurchasingDisabled"
]
},
"POST /v3/catalog/products": {
"operation": "products_createProduct",
"method": "POST",
"path": "/v3/catalog/products",
"risk": "H",
"description": "Create Product. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsPostParametersIncludeFieldsSchemaItems"
},
"maxItems": 10,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__product_Base_POST"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsPostParametersIncludeFieldsSchemaItems",
"admin-catalog-products__product_Base_POST",
"admin-catalog-products__ProductBasePostType",
"admin-catalog-products__ProductBasePostInventoryTracking",
"admin-catalog-products__ProductBasePostAvailability",
"admin-catalog-products__ProductBasePostGiftWrappingOptionsType",
"admin-catalog-products__ProductBasePostCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__ProductBasePostOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__ProductBasePostBulkPricingRulesItems",
"admin-catalog-products__ProductBasePostBulkPricingRulesItemsType",
"admin-catalog-products__ProductBasePostBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__productVariant_Full",
"admin-catalog-products__productVariantOptionValue_Full"
],
"wire": [
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Products_createProduct_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Products_createProduct_Response_200",
"admin-catalog-products__product_Full",
"admin-catalog-products__ProductBaseResponseType",
"admin-catalog-products__ProductBaseResponseInventoryTracking",
"admin-catalog-products__ProductBaseResponseAvailability",
"admin-catalog-products__ProductBaseResponseGiftWrappingOptionsType",
"admin-catalog-products__ProductBaseResponseCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__ProductBaseResponseOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItems",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItemsType",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__primaryImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__productOption_Base",
"admin-catalog-products__ProductOptionBaseType",
"admin-catalog-products__productOptionConfig_Full",
"admin-catalog-products__ProductOptionConfigFullDateLimitMode",
"admin-catalog-products__ProductOptionConfigFullFileTypesMode",
"admin-catalog-products__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-products__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-products__productOptionOptionValue_Full",
"admin-catalog-products__ProductOptionOptionValueBaseValueData",
"admin-catalog-products__productModifier_Full",
"admin-catalog-products__ProductModifierBaseType",
"admin-catalog-products__config_Full",
"admin-catalog-products__ConfigFullDateLimitMode",
"admin-catalog-products__ConfigFullFileTypesMode",
"admin-catalog-products__ConfigFullNumberLimitMode",
"admin-catalog-products__ConfigFullProductListShippingCalc",
"admin-catalog-products__productModifierOptionValue_Full",
"admin-catalog-products__ProductModifierOptionValueBaseValueData",
"admin-catalog-products__adjusters_Full",
"admin-catalog-products__adjuster_Full",
"admin-catalog-products__AdjusterFullAdjuster",
"admin-catalog-products__AdjustersFullPurchasingDisabled",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products": {
"operation": "products_deleteProducts",
"method": "DELETE",
"path": "/v3/catalog/products",
"risk": "D",
"description": "Delete Products. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by name.\n"
},
"sku": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by main SKU. To filter by variant SKU, see [Get all variants](/developer/api-reference/rest/admin/catalog/product-variants/get-product-variants). "
},
"price": {
"type": "number",
"description": "Filter items by price.\n"
},
"weight": {
"type": "number",
"description": "Filter items by weight.\n"
},
"condition": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsDeleteParametersCondition",
"description": "Filter items by condition.\n"
},
"brand_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by brand ID.\n"
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_modified`."
},
"date_last_imported": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_last_imported."
},
"is_visible": {
"type": "boolean",
"description": "Filter items based on whether the product is currently visible on the storefront."
},
"is_featured": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsDeleteParametersIsFeatured",
"description": "Filter items by is_featured. `1` for true, `0` for false."
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Pass a comma-separated list to filter by one or more product IDs."
},
"inventory_level": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by inventory_level.\n"
},
"total_sold": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter items by total_sold.\n"
},
"type": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsDeleteParametersType",
"description": "Filter items by type."
},
"categories": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filters by a single category ID, returning only products assigned exclusively to that category. A product that also belongs to one or more other categories will not be returned — to match products in a category regardless of their other memberships, use `categories:in` instead."
},
"keyword": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsDeleteParametersCondition",
"admin-catalog-products__CatalogProductsDeleteParametersIsFeatured",
"admin-catalog-products__CatalogProductsDeleteParametersType"
],
"wire": [
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sku",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "price",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "weight",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "condition",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "brand_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_last_imported",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_visible",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_featured",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "inventory_level",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "total_sold",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "categories",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "keyword",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}": {
"operation": "products_getProduct",
"method": "GET",
"path": "/v3/catalog/products/{product_id}",
"risk": "R",
"description": "Get Product. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/admin-catalog-products__IncludeParamBase",
"description": "A comma-separated list of sub-resources to return with a product object."
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__IncludeParamBase",
"admin-catalog-products__IncludeParamBaseItems",
"admin-catalog-products__CatalogProductsProductIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Products_getProduct_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Products_getProduct_Response_200",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataInventoryTracking",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataAvailability",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataGiftWrappingOptionsType",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataBulkPricingRulesItems",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataBulkPricingRulesItemsType",
"admin-catalog-products__CatalogProductsProductIdGetResponsesContentApplicationJsonSchemaDataBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__primaryImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__productOption_Base",
"admin-catalog-products__ProductOptionBaseType",
"admin-catalog-products__productOptionConfig_Full",
"admin-catalog-products__ProductOptionConfigFullDateLimitMode",
"admin-catalog-products__ProductOptionConfigFullFileTypesMode",
"admin-catalog-products__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-products__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-products__productOptionOptionValue_Full",
"admin-catalog-products__ProductOptionOptionValueBaseValueData",
"admin-catalog-products__productModifier_Full",
"admin-catalog-products__ProductModifierBaseType",
"admin-catalog-products__config_Full",
"admin-catalog-products__ConfigFullDateLimitMode",
"admin-catalog-products__ConfigFullFileTypesMode",
"admin-catalog-products__ConfigFullNumberLimitMode",
"admin-catalog-products__ConfigFullProductListShippingCalc",
"admin-catalog-products__productModifierOptionValue_Full",
"admin-catalog-products__ProductModifierOptionValueBaseValueData",
"admin-catalog-products__adjusters_Full",
"admin-catalog-products__adjuster_Full",
"admin-catalog-products__AdjusterFullAdjuster",
"admin-catalog-products__AdjustersFullPurchasingDisabled",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}": {
"operation": "products_updateProduct",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}",
"risk": "H",
"description": "Update Product. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/admin-catalog-products__IncludeParamBase",
"description": "A comma-separated list of sub-resources to return with a product object.\nWhen you specify `options` or `modifiers`, results are limited to 10 per page."
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdPutParametersIncludeFieldsSchemaItems"
},
"maxItems": 10,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__product_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__IncludeParamBase",
"admin-catalog-products__IncludeParamBaseItems",
"admin-catalog-products__CatalogProductsProductIdPutParametersIncludeFieldsSchemaItems",
"admin-catalog-products__product_Put",
"admin-catalog-products__ProductBasePutType",
"admin-catalog-products__ProductBasePutInventoryTracking",
"admin-catalog-products__ProductBasePutAvailability",
"admin-catalog-products__ProductBasePutGiftWrappingOptionsType",
"admin-catalog-products__ProductBasePutCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__ProductBasePutOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__ProductBasePutBulkPricingRulesItems",
"admin-catalog-products__ProductBasePutBulkPricingRulesItemsType",
"admin-catalog-products__ProductBasePutBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Products_updateProduct_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Products_updateProduct_Response_200",
"admin-catalog-products__product_Full",
"admin-catalog-products__ProductBaseResponseType",
"admin-catalog-products__ProductBaseResponseInventoryTracking",
"admin-catalog-products__ProductBaseResponseAvailability",
"admin-catalog-products__ProductBaseResponseGiftWrappingOptionsType",
"admin-catalog-products__ProductBaseResponseCondition",
"admin-catalog-products__customUrl_Full",
"admin-catalog-products__ProductBaseResponseOpenGraphType",
"admin-catalog-products__productCustomField_Put",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItems",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItemsType",
"admin-catalog-products__ProductBaseResponseBulkPricingRulesItemsAmount",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__primaryImage_Full",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__productOption_Base",
"admin-catalog-products__ProductOptionBaseType",
"admin-catalog-products__productOptionConfig_Full",
"admin-catalog-products__ProductOptionConfigFullDateLimitMode",
"admin-catalog-products__ProductOptionConfigFullFileTypesMode",
"admin-catalog-products__ProductOptionConfigFullNumberLimitMode",
"admin-catalog-products__ProductOptionConfigFullProductListShippingCalc",
"admin-catalog-products__productOptionOptionValue_Full",
"admin-catalog-products__ProductOptionOptionValueBaseValueData",
"admin-catalog-products__productModifier_Full",
"admin-catalog-products__ProductModifierBaseType",
"admin-catalog-products__config_Full",
"admin-catalog-products__ConfigFullDateLimitMode",
"admin-catalog-products__ConfigFullFileTypesMode",
"admin-catalog-products__ConfigFullNumberLimitMode",
"admin-catalog-products__ConfigFullProductListShippingCalc",
"admin-catalog-products__productModifierOptionValue_Full",
"admin-catalog-products__ProductModifierOptionValueBaseValueData",
"admin-catalog-products__adjusters_Full",
"admin-catalog-products__adjuster_Full",
"admin-catalog-products__AdjusterFullAdjuster",
"admin-catalog-products__AdjustersFullPurchasingDisabled",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}": {
"operation": "products_deleteProduct",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}",
"risk": "D",
"description": "Delete Product. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/metafields": {
"operation": "batchMetafields_getProductsMetafields",
"method": "GET",
"path": "/v3/catalog/products/metafields",
"risk": "R",
"description": "List Product Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"key:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"namespace:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter."
},
"direction": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'\n"
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'\n"
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'\n"
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsMetafieldsGetParametersDirection",
"admin-catalog-products__CatalogProductsMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionResponse"
}
},
"response_definitions": [
"admin-catalog-products__MetaFieldCollectionResponse",
"admin-catalog-products__Metafield",
"admin-catalog-products__MetafieldPermissionSet",
"admin-catalog-products__MetafieldResourceType",
"admin-catalog-products__CollectionMeta",
"admin-catalog-products__CollectionMetaPagination",
"admin-catalog-products__CollectionMetaPaginationLinks"
]
},
"POST /v3/catalog/products/metafields": {
"operation": "batchMetafields_createProductsMetafields",
"method": "POST",
"path": "/v3/catalog/products/metafields",
"risk": "H",
"description": "Create Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-products__CatalogProductsMetafieldsPostRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-products__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-products__Metafield",
"admin-catalog-products__MetafieldPermissionSet",
"admin-catalog-products__MetafieldResourceType",
"admin-catalog-products__WriteCollectionSuccessMeta",
"admin-catalog-products__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-products__Error",
"admin-catalog-products__ErrorDetail",
"admin-catalog-products__WriteCollectionPartialSuccessMeta"
]
},
"PUT /v3/catalog/products/metafields": {
"operation": "batchMetafields_updateProductsMetafields",
"method": "PUT",
"path": "/v3/catalog/products/metafields",
"risk": "H",
"description": "Update Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems",
"admin-catalog-products__CatalogProductsMetafieldsPutRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-catalog-products__MetaFieldCollectionResponse_POST_PUT",
"admin-catalog-products__Metafield",
"admin-catalog-products__MetafieldPermissionSet",
"admin-catalog-products__MetafieldResourceType",
"admin-catalog-products__WriteCollectionSuccessMeta",
"admin-catalog-products__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-catalog-products__Error",
"admin-catalog-products__ErrorDetail",
"admin-catalog-products__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/catalog/products/metafields": {
"operation": "batchMetafields_deleteProductsMetafields",
"method": "DELETE",
"path": "/v3/catalog/products/metafields",
"risk": "D",
"description": "Delete Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionDeleteResponseSuccess"
},
"422": {
"$ref": "#/$defs/admin-catalog-products__MetaFieldCollectionResponsePartialSuccess_DELETE"
}
},
"response_definitions": [
"admin-catalog-products__MetaFieldCollectionDeleteResponseSuccess",
"admin-catalog-products__WriteCollectionSuccessMeta",
"admin-catalog-products__MetaFieldCollectionResponsePartialSuccess_DELETE",
"admin-catalog-products__Error",
"admin-catalog-products__ErrorDetail",
"admin-catalog-products__WriteCollectionPartialSuccessMeta"
]
},
"GET /v3/catalog/products/{product_id}/bulk-pricing-rules": {
"operation": "bulkPricingRules_getAllBulkPricingRules",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/bulk-pricing-rules",
"risk": "R",
"description": "List Bulk Pricing Rules. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdBulkPricingRulesGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Bulk_pricing_rules_getAllBulkPricingRules_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Bulk_pricing_rules_getAllBulkPricingRules_Response_200",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesGetResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesGetResponsesContentApplicationJsonSchemaDataAmount",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/bulk-pricing-rules": {
"operation": "bulkPricingRules_createBulkPricingRule",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/bulk-pricing-rules",
"risk": "H",
"description": "Create Bulk Pricing Rule. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__bulkPricingRule_Full"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__bulkPricingRule_Full",
"admin-catalog-products__BulkPricingRuleFullType",
"admin-catalog-products__BulkPricingRuleFullAmount"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Bulk_pricing_rules_createBulkPricingRule_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Bulk_pricing_rules_createBulkPricingRule_Response_200",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesPostResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesPostResponsesContentApplicationJsonSchemaDataAmount",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}": {
"operation": "bulkPricingRules_getBulkPricingRule",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}",
"risk": "R",
"description": "Get Bulk Pricing Rule. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"bulk_pricing_rule_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `BulkPricingRule`.\n"
}
},
"required": [
"product_id",
"bulk_pricing_rule_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "bulk_pricing_rule_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Bulk_pricing_rules_getBulkPricingRule_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Bulk_pricing_rules_getBulkPricingRule_Response_200",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdGetResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdGetResponsesContentApplicationJsonSchemaDataAmount",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}": {
"operation": "bulkPricingRules_updateBulkPricingRule",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}",
"risk": "H",
"description": "Update Bulk Pricing Rule. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"bulk_pricing_rule_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `BulkPricingRule`.\n"
}
},
"required": [
"product_id",
"bulk_pricing_rule_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"id",
"quantity_min",
"quantity_max",
"type",
"amount"
],
"properties": {
"id": {
"type": "integer",
"description": "Unique ID of the *Bulk Pricing Rule*. Read-Only.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"quantity_min": {
"type": "integer",
"minimum": 0,
"description": "The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. For `fixed` rules, the minimum quantity canʼt be less than two.\nRequired in /POST.\n",
"maximum": 9007199254740991
},
"quantity_max": {
"type": "integer",
"minimum": 0,
"description": "The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the `quantity_min` value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.\nRequired in /POST.",
"maximum": 9007199254740991
},
"type": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutRequestBodyContentApplicationJsonSchemaType",
"description": "The type of adjustment that is made. Values: `price` - the adjustment amount per product; `percent` - the adjustment as a percentage of the original price; `fixed` - the adjusted absolute price of the product.\nRequired in /POST."
},
"amount": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutRequestBodyContentApplicationJsonSchemaAmount",
"description": "You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments.\nDivide the adjustment percentage by 100 and send the result in string format. For example, represent 10% as “.10”. The response will return a float value for both `price` and `percentage` adjustments. \nRequired in /POST."
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutRequestBodyContentApplicationJsonSchemaType",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutRequestBodyContentApplicationJsonSchemaAmount"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "bulk_pricing_rule_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Bulk_pricing_rules_updateBulkPricingRule_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Bulk_pricing_rules_updateBulkPricingRule_Response_200",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__CatalogProductsProductIdBulkPricingRulesBulkPricingRuleIdPutResponsesContentApplicationJsonSchemaDataAmount",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}": {
"operation": "bulkPricingRules_deleteBulkPricingRule",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}",
"risk": "D",
"description": "Delete Bulk Pricing Rule. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"bulk_pricing_rule_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `BulkPricingRule`.\n"
}
},
"required": [
"product_id",
"bulk_pricing_rule_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "bulk_pricing_rule_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/category-assignments": {
"operation": "categoryAssignments_getProductsCategoryAssignments",
"method": "GET",
"path": "/v3/catalog/products/category-assignments",
"risk": "R",
"description": "List Products Category Assignments. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"product_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to filter by one or more product IDs."
},
"category_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to filter by one or more category IDs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "product_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "category_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Category_assignments_getProductsCategoryAssignments_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Category_assignments_getProductsCategoryAssignments_Response_200",
"admin-catalog-products__ProductCategoryAssignment",
"admin-catalog-products__MetaPaginationObject",
"admin-catalog-products__MetaPaginationObjectPagination",
"admin-catalog-products__MetaPaginationObjectPaginationLinks"
]
},
"PUT /v3/catalog/products/category-assignments": {
"operation": "categoryAssignments_createProductsCategoryAssignments",
"method": "PUT",
"path": "/v3/catalog/products/category-assignments",
"risk": "H",
"description": "Create Products Category Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__ProductCategoryAssignment"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__ProductCategoryAssignment"
],
"wire": [],
"responses": {
"204": null
},
"response_definitions": []
},
"DELETE /v3/catalog/products/category-assignments": {
"operation": "categoryAssignments_deleteProductsCategoryAssignments",
"method": "DELETE",
"path": "/v3/catalog/products/category-assignments",
"risk": "D",
"description": "Delete Products Category Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"product_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Pass a comma-separated list to filter by one or more product IDs."
},
"category_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Pass a comma-separated list to filter by one or more category IDs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "category_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/channel-assignments": {
"operation": "channelAssignments_getProductsChannelAssignments",
"method": "GET",
"path": "/v3/catalog/products/channel-assignments",
"risk": "R",
"description": "List Products Channel Assignments. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"product_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to filter by one or more product IDs."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Pass a comma-separated list to filter by one or more channel IDs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "product_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Channel_assignments_getProductsChannelAssignments_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Channel_assignments_getProductsChannelAssignments_Response_200",
"admin-catalog-products__ProductChannelAssignment",
"admin-catalog-products__MetaPaginationObject",
"admin-catalog-products__MetaPaginationObjectPagination",
"admin-catalog-products__MetaPaginationObjectPaginationLinks"
]
},
"PUT /v3/catalog/products/channel-assignments": {
"operation": "channelAssignments_createProductsChannelAssignments",
"method": "PUT",
"path": "/v3/catalog/products/channel-assignments",
"risk": "H",
"description": "Create Products Channel Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__ProductChannelAssignment"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__ProductChannelAssignment"
],
"wire": [],
"responses": {
"204": null
},
"response_definitions": []
},
"DELETE /v3/catalog/products/channel-assignments": {
"operation": "channelAssignments_deleteProductsChannelAssignments",
"method": "DELETE",
"path": "/v3/catalog/products/channel-assignments",
"risk": "D",
"description": "Delete Products Channel Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"product_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Pass a comma-separated list to filter by one or more product IDs."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Pass a comma-separated list to filter by one or more channel IDs."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/complex-rules": {
"operation": "complexRules_getProductComplexRules",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/complex-rules",
"risk": "R",
"description": "List Complex Rules. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdComplexRulesGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdComplexRulesGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Complex_rules_getProductComplexRules_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Complex_rules_getProductComplexRules_Response_200",
"admin-catalog-products__complexRule_Base",
"admin-catalog-products__adjuster_Full",
"admin-catalog-products__AdjusterFullAdjuster",
"admin-catalog-products__complexRuleConditionBase",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/complex-rules": {
"operation": "complexRules_createProductComplexRule",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/complex-rules",
"risk": "H",
"description": "Create Complex Rule. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"conditions"
],
"properties": {
"sort_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The priority to give this rule when making adjustments to the product properties.\n"
},
"enabled": {
"type": "boolean",
"description": "Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty.\n"
},
"stop": {
"type": "boolean",
"description": "Flag for determining whether other rules should not be applied after this rule has been applied.\n"
},
"purchasing_disabled": {
"type": "boolean",
"description": "Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.\n"
},
"purchasing_disabled_message": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "Message displayed on the storefront when a rule disables the purchasing of a product.\n"
},
"purchasing_hidden": {
"type": "boolean",
"description": "Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.\n"
},
"image_url": {
"type": "string",
"description": "The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.\n",
"maxLength": 262144
},
"price_adjuster": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdComplexRulesPostRequestBodyContentApplicationJsonSchemaPriceAdjuster",
"description": "Adjuster for Complex Rules."
},
"weight_adjuster": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdComplexRulesPostRequestBodyContentApplicationJsonSchemaWeightAdjuster",
"description": "Adjuster for Complex Rules."
},
"conditions": {
"$ref": "#/$defs/admin-catalog-products__conditionsRequest"
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostRequestBodyContentApplicationJsonSchemaPriceAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostRequestBodyContentApplicationJsonSchemaPriceAdjusterAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostRequestBodyContentApplicationJsonSchemaWeightAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostRequestBodyContentApplicationJsonSchemaWeightAdjusterAdjuster",
"admin-catalog-products__conditionsRequest",
"admin-catalog-products__ConditionsRequestItems",
"admin-catalog-products__modifierCondition",
"admin-catalog-products__variantCondition"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Complex_rules_createProductComplexRule_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Complex_rules_createProductComplexRule_Response_200",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostResponsesContentApplicationJsonSchemaDataPriceAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostResponsesContentApplicationJsonSchemaDataPriceAdjusterAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostResponsesContentApplicationJsonSchemaDataWeightAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesPostResponsesContentApplicationJsonSchemaDataWeightAdjusterAdjuster",
"admin-catalog-products__complexRuleConditionBase",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}": {
"operation": "complexRules_getProductComplexRule",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}",
"risk": "R",
"description": "Get Product Complex Rule. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"complex_rule_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `ComplexRule`.\n"
}
},
"required": [
"product_id",
"complex_rule_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "complex_rule_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Complex_rules_getProductComplexRule_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Complex_rules_getProductComplexRule_Response_200",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetResponsesContentApplicationJsonSchemaDataPriceAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetResponsesContentApplicationJsonSchemaDataPriceAdjusterAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetResponsesContentApplicationJsonSchemaDataWeightAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdGetResponsesContentApplicationJsonSchemaDataWeightAdjusterAdjuster",
"admin-catalog-products__complexRuleConditionBase",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}": {
"operation": "complexRules_updateProductComplexRule",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}",
"risk": "H",
"description": "Update Product Complex Rule. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"complex_rule_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `ComplexRule`.\n"
}
},
"required": [
"product_id",
"complex_rule_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"sort_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The priority to give this rule when making adjustments to the product properties.\n"
},
"enabled": {
"type": "boolean",
"description": "Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty.\n"
},
"stop": {
"type": "boolean",
"description": "Flag for determining whether other rules should not be applied after this rule has been applied.\n"
},
"purchasing_disabled": {
"type": "boolean",
"description": "Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.\n"
},
"purchasing_disabled_message": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "Message displayed on the storefront when a rule disables the purchasing of a product.\n"
},
"purchasing_hidden": {
"type": "boolean",
"description": "Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.\n"
},
"image_url": {
"type": "string",
"description": "The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.\n",
"maxLength": 262144
},
"price_adjuster": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutRequestBodyContentApplicationJsonSchemaPriceAdjuster",
"description": "Adjuster for Complex Rules."
},
"weight_adjuster": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutRequestBodyContentApplicationJsonSchemaWeightAdjuster",
"description": "Adjuster for Complex Rules."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__complexRuleConditionPut"
},
"maxItems": 10
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutRequestBodyContentApplicationJsonSchemaPriceAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutRequestBodyContentApplicationJsonSchemaPriceAdjusterAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutRequestBodyContentApplicationJsonSchemaWeightAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutRequestBodyContentApplicationJsonSchemaWeightAdjusterAdjuster",
"admin-catalog-products__complexRuleConditionPut"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "complex_rule_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Complex_rules_updateProductComplexRule_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Complex_rules_updateProductComplexRule_Response_200",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutResponsesContentApplicationJsonSchemaDataPriceAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutResponsesContentApplicationJsonSchemaDataPriceAdjusterAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutResponsesContentApplicationJsonSchemaDataWeightAdjuster",
"admin-catalog-products__CatalogProductsProductIdComplexRulesComplexRuleIdPutResponsesContentApplicationJsonSchemaDataWeightAdjusterAdjuster",
"admin-catalog-products__complexRuleConditionBase",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}": {
"operation": "complexRules_deleteProductComplexRule",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}",
"risk": "D",
"description": "Delete Product Complex Rule. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"complex_rule_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `ComplexRule`.\n"
}
},
"required": [
"product_id",
"complex_rule_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "complex_rule_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/custom-fields": {
"operation": "customFields_getProductCustomFields",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/custom-fields",
"risk": "R",
"description": "List Product Custom Fields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdCustomFieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdCustomFieldsGetParametersExcludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdCustomFieldsGetParametersIncludeFieldsSchemaItems",
"admin-catalog-products__CatalogProductsProductIdCustomFieldsGetParametersExcludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Custom_fields_getProductCustomFields_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Custom_fields_getProductCustomFields_Response_200",
"admin-catalog-products__customFieldData",
"admin-catalog-products__metaCollectionFull",
"admin-catalog-products__MetaCollectionFullPagination",
"admin-catalog-products__MetaCollectionFullPaginationLinks"
]
},
"POST /v3/catalog/products/{product_id}/custom-fields": {
"operation": "customFields_createProductCustomField",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/custom-fields",
"risk": "H",
"description": "Create Product Custom Field. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__customFieldPost"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__customFieldPost"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Custom_fields_createProductCustomField_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Custom_fields_createProductCustomField_Response_200",
"admin-catalog-products__customFieldData",
"admin-catalog-products__metaEmptyFull"
]
},
"GET /v3/catalog/products/{product_id}/custom-fields/{custom_field_id}": {
"operation": "customFields_getProductCustomField",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}",
"risk": "R",
"description": "Get Product Custom Field. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"custom_field_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `CustomField`.\n"
}
},
"required": [
"product_id",
"custom_field_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdCustomFieldsCustomFieldIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdCustomFieldsCustomFieldIdGetParametersExcludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdCustomFieldsCustomFieldIdGetParametersIncludeFieldsSchemaItems",
"admin-catalog-products__CatalogProductsProductIdCustomFieldsCustomFieldIdGetParametersExcludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "custom_field_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Custom_fields_getProductCustomField_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Custom_fields_getProductCustomField_Response_200",
"admin-catalog-products__customFieldData",
"admin-catalog-products__metaEmptyFull"
]
},
"PUT /v3/catalog/products/{product_id}/custom-fields/{custom_field_id}": {
"operation": "customFields_updateProductCustomField",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}",
"risk": "H",
"description": "Update Product Custom Field. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"custom_field_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `CustomField`.\n"
}
},
"required": [
"product_id",
"custom_field_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__customFieldPut"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__customFieldPut"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "custom_field_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Custom_fields_updateProductCustomField_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Custom_fields_updateProductCustomField_Response_200",
"admin-catalog-products__customFieldData",
"admin-catalog-products__metaEmptyFull"
]
},
"DELETE /v3/catalog/products/{product_id}/custom-fields/{custom_field_id}": {
"operation": "customFields_deleteProductCustomField",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/custom-fields/{custom_field_id}",
"risk": "D",
"description": "Delete Product Custom Field. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"custom_field_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `CustomField`.\n"
}
},
"required": [
"product_id",
"custom_field_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "custom_field_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/images": {
"operation": "images_getProductImages",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/images",
"risk": "R",
"description": "List Product Images. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdImagesGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdImagesGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Images_getProductImages_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Images_getProductImages_Response_200",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/images": {
"operation": "images_createProductImage",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/images",
"risk": "H",
"description": "Create Product Image. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__productImage_Post_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__productImage_Post_Put"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Images_createProductImage_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Images_createProductImage_Response_200",
"admin-catalog-products__CatalogProductsProductIdImagesPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdImagesPostResponsesContentApplicationJsonSchemaData0",
"admin-catalog-products__CatalogProductsProductIdImagesPostResponsesContentApplicationJsonSchemaData1",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/images/{image_id}": {
"operation": "images_getProductImage",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/images/{image_id}",
"risk": "R",
"description": "Get Product Image. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"image_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Image` that is being operated on.\n"
}
},
"required": [
"product_id",
"image_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdImagesImageIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdImagesImageIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "image_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Images_getProductImage_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Images_getProductImage_Response_200",
"admin-catalog-products__productImage_Full",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/images/{image_id}": {
"operation": "images_updateProductImage",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/images/{image_id}",
"risk": "H",
"description": "Update Product Image. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"image_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Image` that is being operated on.\n"
}
},
"required": [
"product_id",
"image_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__productImage_Post_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__productImage_Post_Put"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "image_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Images_updateProductImage_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Images_updateProductImage_Response_200",
"admin-catalog-products__CatalogProductsProductIdImagesImageIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdImagesImageIdPutResponsesContentApplicationJsonSchemaData0",
"admin-catalog-products__CatalogProductsProductIdImagesImageIdPutResponsesContentApplicationJsonSchemaData1",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/images/{image_id}": {
"operation": "images_deleteProductImage",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/images/{image_id}",
"risk": "D",
"description": "Delete Product Image. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"image_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Image` that is being operated on.\n"
}
},
"required": [
"product_id",
"image_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "image_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/metafields": {
"operation": "metafields_getProductMetafields",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/metafields",
"risk": "R",
"description": "List Product Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"resource_id:in": {
"type": "string",
"maxLength": 262144,
"description": "A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "resource_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Metafields_getProductMetafields_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Metafields_getProductMetafields_Response_200",
"admin-catalog-products__metafield_Full",
"admin-catalog-products__MetafieldBasePermissionSet",
"admin-catalog-products__MetafieldFullResourceType",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/metafields": {
"operation": "metafields_createProductMetafield",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/metafields",
"risk": "H",
"description": "Create Product Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__metafield_Base",
"admin-catalog-products__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Metafields_createProductMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Metafields_createProductMetafield_Response_200",
"admin-catalog-products__metafield_Full",
"admin-catalog-products__MetafieldBasePermissionSet",
"admin-catalog-products__MetafieldFullResourceType",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/metafields/{metafield_id}": {
"operation": "metafields_getProductMetafield",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/metafields/{metafield_id}",
"risk": "R",
"description": "Get Product Metafield. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"product_id",
"metafield_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdMetafieldsMetafieldIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdMetafieldsMetafieldIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Metafields_getProductMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Metafields_getProductMetafield_Response_200",
"admin-catalog-products__metafield_Full",
"admin-catalog-products__MetafieldBasePermissionSet",
"admin-catalog-products__MetafieldFullResourceType",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/metafields/{metafield_id}": {
"operation": "metafields_updateProductMetafield",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/metafields/{metafield_id}",
"risk": "H",
"description": "Update Product Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"product_id",
"metafield_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-catalog-products__metafield_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__metafield_Base",
"admin-catalog-products__MetafieldBasePermissionSet"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Metafields_updateProductMetafield_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Metafields_updateProductMetafield_Response_200",
"admin-catalog-products__metafield_Full",
"admin-catalog-products__MetafieldBasePermissionSet",
"admin-catalog-products__MetafieldFullResourceType",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/metafields/{metafield_id}": {
"operation": "metafields_deleteProductMetafield",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/metafields/{metafield_id}",
"risk": "D",
"description": "Delete Product Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Metafield`.\n"
}
},
"required": [
"product_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/products/{product_id}/reviews": {
"operation": "reviews_getProductReviews",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/reviews",
"risk": "R",
"description": "List Product Reviews. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdReviewsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"status": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdReviewsGetParametersStatus",
"description": "Filter items by status. `1` for approved, `0` for pending."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdReviewsGetParametersIncludeFieldsSchemaItems",
"admin-catalog-products__CatalogProductsProductIdReviewsGetParametersStatus"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "status",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Reviews_getProductReviews_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Reviews_getProductReviews_Response_200",
"admin-catalog-products__CatalogProductsProductIdReviewsGetResponsesContentApplicationJsonSchemaDataItems",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/reviews": {
"operation": "reviews_createProductReview",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/reviews",
"risk": "H",
"description": "Create Product Review. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"title",
"date_reviewed"
],
"properties": {
"title": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The title for the product review.\nRequired in /POST."
},
"text": {
"type": "string",
"description": "The text for the product review.\n",
"maxLength": 262144
},
"status": {
"type": "string",
"description": "The status of the product review. Must be one of `approved`, `disapproved` or `pending`.\n",
"maxLength": 262144
},
"rating": {
"type": "integer",
"description": "The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"email": {
"type": "string",
"description": "The email of the reviewer. Must be a valid email, or an empty string.",
"maxLength": 262144
},
"name": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The name of the reviewer."
},
"date_reviewed": {
"type": "string",
"description": "Date the product was reviewed. Required in /POST.\n",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Reviews_createProductReview_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Reviews_createProductReview_Response_200",
"admin-catalog-products__CatalogProductsProductIdReviewsPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/reviews/{review_id}": {
"operation": "reviews_getProductReview",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/reviews/{review_id}",
"risk": "R",
"description": "Get Product Review. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"review_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `review` that is being operated on.\n"
}
},
"required": [
"product_id",
"review_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdReviewsReviewIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdReviewsReviewIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "review_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Reviews_getProductReview_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Reviews_getProductReview_Response_200",
"admin-catalog-products__CatalogProductsProductIdReviewsReviewIdGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/reviews/{review_id}": {
"operation": "reviews_updateProductReview",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/reviews/{review_id}",
"risk": "H",
"description": "Update Product Review. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"review_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `review` that is being operated on.\n"
}
},
"required": [
"product_id",
"review_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"title",
"date_reviewed"
],
"properties": {
"title": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The title for the product review.\nRequired in /POST."
},
"text": {
"type": "string",
"description": "The text for the product review.\n",
"maxLength": 262144
},
"status": {
"type": "string",
"description": "The status of the product review. Must be one of `approved`, `disapproved` or `pending`.\n",
"maxLength": 262144
},
"rating": {
"type": "integer",
"description": "The rating of the product review. Must be one of 0, 1, 2, 3, 4, 5.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"email": {
"type": "string",
"description": "The email of the reviewer. Must be a valid email, or an empty string.",
"maxLength": 262144
},
"name": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The name of the reviewer."
},
"date_reviewed": {
"type": "string",
"description": "Date the product was reviewed. Required in /POST.\n",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "review_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Reviews_updateProductReview_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Reviews_updateProductReview_Response_200",
"admin-catalog-products__CatalogProductsProductIdReviewsReviewIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/reviews/{review_id}": {
"operation": "reviews_deleteProductReview",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/reviews/{review_id}",
"risk": "D",
"description": "Delete Product Review. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"review_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `review` that is being operated on.\n"
}
},
"required": [
"product_id",
"review_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "review_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/catalog/summary": {
"operation": "summary_getCatalogSummary",
"method": "GET",
"path": "/v3/catalog/summary",
"risk": "R",
"description": "Get Catalog Summary. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Summary_getCatalogSummary_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Summary_getCatalogSummary_Response_200",
"admin-catalog-products__CatalogSummaryGetResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/videos": {
"operation": "videos_getProductVideos",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/videos",
"risk": "R",
"description": "List Product Videos. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdVideosGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdVideosGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Videos_getProductVideos_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Videos_getProductVideos_Response_200",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__metaCollection_Full",
"admin-catalog-products__pagination_Full",
"admin-catalog-products__PaginationFullLinks"
]
},
"POST /v3/catalog/products/{product_id}/videos": {
"operation": "videos_createProductVideo",
"method": "POST",
"path": "/v3/catalog/products/{product_id}/videos",
"risk": "H",
"description": "Create Product Video. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
}
},
"required": [
"product_id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The title for the video. If left blank, this will be filled in according to data on a host site.\n"
},
"description": {
"type": "string",
"description": "The description for the video. If left blank, this will be filled in according to data on a host site.\n",
"maxLength": 262144
},
"sort_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered.\n"
},
"type": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdVideosPostRequestBodyContentApplicationJsonSchemaType",
"description": "The video type (a short name of a host site).\n"
},
"video_id": {
"type": "string",
"minLength": 0,
"maxLength": 25,
"description": "The ID of the video on a host site.\n"
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdVideosPostRequestBodyContentApplicationJsonSchemaType"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Videos_createProductVideo_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Videos_createProductVideo_Response_200",
"admin-catalog-products__CatalogProductsProductIdVideosPostResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdVideosPostResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__metaEmpty_Full"
]
},
"GET /v3/catalog/products/{product_id}/videos/{id}": {
"operation": "videos_getProductVideo",
"method": "GET",
"path": "/v3/catalog/products/{product_id}/videos/{id}",
"risk": "R",
"description": "Get Product Video. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The BigCommerce ID of the `Video`"
}
},
"required": [
"product_id",
"id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdVideosIdGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdVideosIdGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_fields",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Videos_getProductVideo_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Videos_getProductVideo_Response_200",
"admin-catalog-products__productVideo_Full",
"admin-catalog-products__ProductVideoBaseType",
"admin-catalog-products__metaEmpty_Full"
]
},
"PUT /v3/catalog/products/{product_id}/videos/{id}": {
"operation": "videos_updateProductVideo",
"method": "PUT",
"path": "/v3/catalog/products/{product_id}/videos/{id}",
"risk": "H",
"description": "Update Product Video. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The BigCommerce ID of the `Video`"
}
},
"required": [
"product_id",
"id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 0,
"maxLength": 255,
"description": "The title for the video. If left blank, this will be filled in according to data on a host site.\n"
},
"description": {
"type": "string",
"description": "The description for the video. If left blank, this will be filled in according to data on a host site.\n",
"maxLength": 262144
},
"sort_order": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647,
"description": "The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the videoʼs new `sort_order` value will have their `sort_order`s reordered.\n"
},
"type": {
"$ref": "#/$defs/admin-catalog-products__CatalogProductsProductIdVideosIdPutRequestBodyContentApplicationJsonSchemaType",
"description": "The video type (a short name of a host site).\n"
},
"id": {
"type": "integer",
"description": "The unique numeric ID of the product video; increments sequentially.\n",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-catalog-products__CatalogProductsProductIdVideosIdPutRequestBodyContentApplicationJsonSchemaType"
],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-catalog-products__Videos_updateProductVideo_Response_200"
}
},
"response_definitions": [
"admin-catalog-products__Videos_updateProductVideo_Response_200",
"admin-catalog-products__CatalogProductsProductIdVideosIdPutResponsesContentApplicationJsonSchemaData",
"admin-catalog-products__CatalogProductsProductIdVideosIdPutResponsesContentApplicationJsonSchemaDataType",
"admin-catalog-products__metaEmpty_Full"
]
},
"DELETE /v3/catalog/products/{product_id}/videos/{id}": {
"operation": "videos_deleteProductVideo",
"method": "DELETE",
"path": "/v3/catalog/products/{product_id}/videos/{id}",
"risk": "D",
"description": "Delete Product Video. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-catalog-products.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the `Product` to which the resource belongs.\n"
},
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The BigCommerce ID of the `Video`"
}
},
"required": [
"product_id",
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "product_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/marketing/abandoned-cart-emails": {
"operation": "abandonedCartEmails_getAbandonedCartEmailTemplates",
"method": "GET",
"path": "/v3/marketing/abandoned-cart-emails",
"risk": "R",
"description": "List Abandoned Cart Email Templates. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-level data."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_getAbandonedCartEmailTemplates_Response_200"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_getAbandonedCartEmailTemplates_Response_200",
"admin-content-abandoned-cart-emails__AbandondedCartEmail",
"admin-content-abandoned-cart-emails__NotifyAtMinutes",
"admin-content-abandoned-cart-emails__CouponCode",
"admin-content-abandoned-cart-emails__Template",
"admin-content-abandoned-cart-emails__TranslationDefinition",
"admin-content-abandoned-cart-emails__TranslationDefinitionKeys",
"admin-content-abandoned-cart-emails__metaCollection_open"
]
},
"POST /v3/marketing/abandoned-cart-emails": {
"operation": "abandonedCartEmails_createAbandonedCartEmailTemplate",
"method": "POST",
"path": "/v3/marketing/abandoned-cart-emails",
"risk": "H",
"description": "Create Abandoned Cart Email Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-level data."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__AbandondedCartEmailPayload"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-abandoned-cart-emails__AbandondedCartEmailPayload",
"admin-content-abandoned-cart-emails__CouponCode",
"admin-content-abandoned-cart-emails__NotifyAtMinutes",
"admin-content-abandoned-cart-emails__Template",
"admin-content-abandoned-cart-emails__TranslationDefinition",
"admin-content-abandoned-cart-emails__TranslationDefinitionKeys"
],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_createAbandonedCartEmailTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_createAbandonedCartEmailTemplate_Response_200",
"admin-content-abandoned-cart-emails__AbandondedCartEmail",
"admin-content-abandoned-cart-emails__NotifyAtMinutes",
"admin-content-abandoned-cart-emails__CouponCode",
"admin-content-abandoned-cart-emails__Template",
"admin-content-abandoned-cart-emails__TranslationDefinition",
"admin-content-abandoned-cart-emails__TranslationDefinitionKeys",
"admin-content-abandoned-cart-emails__metaCollection_open"
]
},
"GET /v3/marketing/abandoned-cart-emails/{id}": {
"operation": "abandonedCartEmails_getAbandonedCartEmailTemplate",
"method": "GET",
"path": "/v3/marketing/abandoned-cart-emails/{id}",
"risk": "R",
"description": "Get Email Template. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "ID of the Abandoned Cart Email template."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_getAbandonedCartEmailTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_getAbandonedCartEmailTemplate_Response_200",
"admin-content-abandoned-cart-emails__AbandondedCartEmail",
"admin-content-abandoned-cart-emails__NotifyAtMinutes",
"admin-content-abandoned-cart-emails__CouponCode",
"admin-content-abandoned-cart-emails__Template",
"admin-content-abandoned-cart-emails__TranslationDefinition",
"admin-content-abandoned-cart-emails__TranslationDefinitionKeys",
"admin-content-abandoned-cart-emails__metaCollection_open"
]
},
"PUT /v3/marketing/abandoned-cart-emails/{id}": {
"operation": "abandonedCartEmails_updateAbandonedCartEmailTemplate",
"method": "PUT",
"path": "/v3/marketing/abandoned-cart-emails/{id}",
"risk": "H",
"description": "Update Email Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "ID of the Abandoned Cart Email template."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__AbandondedCartEmailPayload"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-abandoned-cart-emails__AbandondedCartEmailPayload",
"admin-content-abandoned-cart-emails__CouponCode",
"admin-content-abandoned-cart-emails__NotifyAtMinutes",
"admin-content-abandoned-cart-emails__Template",
"admin-content-abandoned-cart-emails__TranslationDefinition",
"admin-content-abandoned-cart-emails__TranslationDefinitionKeys"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_updateAbandonedCartEmailTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_updateAbandonedCartEmailTemplate_Response_200",
"admin-content-abandoned-cart-emails__AbandondedCartEmail",
"admin-content-abandoned-cart-emails__NotifyAtMinutes",
"admin-content-abandoned-cart-emails__CouponCode",
"admin-content-abandoned-cart-emails__Template",
"admin-content-abandoned-cart-emails__TranslationDefinition",
"admin-content-abandoned-cart-emails__TranslationDefinitionKeys",
"admin-content-abandoned-cart-emails__metaCollection_open"
]
},
"DELETE /v3/marketing/abandoned-cart-emails/{id}": {
"operation": "abandonedCartEmails_deleteAbandonedCartEmailTemplate",
"method": "DELETE",
"path": "/v3/marketing/abandoned-cart-emails/{id}",
"risk": "D",
"description": "Delete Email Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "ID of the Abandoned Cart Email template."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/marketing/abandoned-cart-emails/default": {
"operation": "abandonedCartEmails_getDefaultAbandonedCartEmailTemplate",
"method": "GET",
"path": "/v3/marketing/abandoned-cart-emails/default",
"risk": "R",
"description": "Get Default Email Template. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_getDefaultAbandonedCartEmailTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__Abandoned_Cart_Emails_getDefaultAbandonedCartEmailTemplate_Response_200",
"admin-content-abandoned-cart-emails__MarketingAbandonedCartEmailsDefaultGetResponsesContentApplicationJsonSchemaTranslationsItems",
"admin-content-abandoned-cart-emails__MarketingAbandonedCartEmailsDefaultGetResponsesContentApplicationJsonSchemaTranslationsItemsKeys"
]
},
"GET /v3/marketing/abandoned-cart-emails/settings": {
"operation": "templateSettings_getAbandonedCartEmailTemplateSettings",
"method": "GET",
"path": "/v3/marketing/abandoned-cart-emails/settings",
"risk": "R",
"description": "Get Email Template Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-specific settings."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__AbandonedCartSettings"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__AbandonedCartSettings"
]
},
"PUT /v3/marketing/abandoned-cart-emails/settings": {
"operation": "templateSettings_updateAbandonedCartEmailTemplateSettings",
"method": "PUT",
"path": "/v3/marketing/abandoned-cart-emails/settings",
"risk": "H",
"description": "Update Email Template Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-abandoned-cart-emails.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-level data."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__AbandonedCartSettings"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-abandoned-cart-emails__AbandonedCartSettings"
],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-abandoned-cart-emails__AbandonedCartSettings"
}
},
"response_definitions": [
"admin-content-abandoned-cart-emails__AbandonedCartSettings"
]
},
"GET /v3/storefront/custom-template-associations": {
"operation": "customTemplateAssociations_getCustomTemplateAssociations",
"method": "GET",
"path": "/v3/storefront/custom-template-associations",
"risk": "R",
"description": "List Custom Template Associations. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-custom-template-associations.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Return results or act upon only template associations in the specified channel."
},
"entity_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. "
},
"type": {
"$ref": "#/$defs/admin-content-custom-template-associations__StorefrontCustomTemplateAssociationsGetParametersType",
"description": "Filter associations by type."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Number of results to return per page."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Which page number to return, based on the limit value. Used to paginate large collections."
},
"is_valid": {
"type": "boolean",
"description": "Optional toggle to filter for exclusively valid or invalid associations entries. An invalid entry is one where its file name does not match up to an existing custom layout file in the currently active theme for the channel."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-custom-template-associations__StorefrontCustomTemplateAssociationsGetParametersType"
],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "entity_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_valid",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-custom-template-associations__Custom_Template_Associations_getCustomTemplateAssociations_Response_200"
}
},
"response_definitions": [
"admin-content-custom-template-associations__Custom_Template_Associations_getCustomTemplateAssociations_Response_200",
"admin-content-custom-template-associations__CustomTemplateAssociation",
"admin-content-custom-template-associations__CustomTemplateAssociationEntityType",
"admin-content-custom-template-associations__MetaPaginationObject",
"admin-content-custom-template-associations__MetaPaginationObjectPagination",
"admin-content-custom-template-associations__MetaPaginationObjectPaginationLinks"
]
},
"PUT /v3/storefront/custom-template-associations": {
"operation": "customTemplateAssociations_upsertCustomTemplateAssociations",
"method": "PUT",
"path": "/v3/storefront/custom-template-associations",
"risk": "H",
"description": "Upsert Custom Template Associations. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-custom-template-associations.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-custom-template-associations__CustomTemplateAssociationUpsert"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-custom-template-associations__CustomTemplateAssociationUpsert",
"admin-content-custom-template-associations__CustomTemplateAssociationUpsertEntityType"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-custom-template-associations__Custom_Template_Associations_upsertCustomTemplateAssociations_Response_200"
}
},
"response_definitions": [
"admin-content-custom-template-associations__Custom_Template_Associations_upsertCustomTemplateAssociations_Response_200"
]
},
"DELETE /v3/storefront/custom-template-associations": {
"operation": "customTemplateAssociations_deleteCustomTemplateAssociations",
"method": "DELETE",
"path": "/v3/storefront/custom-template-associations",
"risk": "D",
"description": "Delete Custom Template Associations. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-custom-template-associations.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "A comma-separated string that specifies a list of association IDs to delete."
},
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Return results or act upon only template associations in the specified channel."
},
"type": {
"$ref": "#/$defs/admin-content-custom-template-associations__StorefrontCustomTemplateAssociationsDeleteParametersType",
"description": "Filter associations by type."
},
"entity_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "A comma-separated list of entity IDs to return or act upon. Must be used together with the `type` filter. Currently, all supported entities have integer-type IDs. "
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-custom-template-associations__StorefrontCustomTemplateAssociationsDeleteParametersType"
],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "entity_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/marketing/email-templates": {
"operation": "emailTemplates_getEmailTemplates",
"method": "GET",
"path": "/v3/marketing/email-templates",
"risk": "R",
"description": "List Email Templates. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-email-templates.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-specific settings. If omitted, you will interact with the global setting only."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-email-templates__Email_Templates_getEmailTemplates_Response_200"
}
},
"response_definitions": [
"admin-content-email-templates__Email_Templates_getEmailTemplates_Response_200",
"admin-content-email-templates__EmailTemplatesCollection",
"admin-content-email-templates__EmailTemplate",
"admin-content-email-templates__EmailTemplateTypeId",
"admin-content-email-templates__LocaleCollection",
"admin-content-email-templates__LocaleObject",
"admin-content-email-templates__LocaleObjectKeys",
"admin-content-email-templates__MarketingEmailTemplatesGetResponsesContentApplicationJsonSchemaMeta"
]
},
"GET /v3/marketing/email-templates/{template-name}": {
"operation": "emailTemplates_getEmailTemplate",
"method": "GET",
"path": "/v3/marketing/email-templates/{template-name}",
"risk": "R",
"description": "Get Email Template. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-email-templates.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"template-name": {
"type": "string",
"maxLength": 262144,
"description": "The name of the email template."
}
},
"required": [
"template-name"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-specific settings. If omitted, you will interact with the global setting only."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "template-name",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-email-templates__Email_Templates_getEmailTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-email-templates__Email_Templates_getEmailTemplate_Response_200",
"admin-content-email-templates__EmailTemplate",
"admin-content-email-templates__EmailTemplateTypeId",
"admin-content-email-templates__LocaleCollection",
"admin-content-email-templates__LocaleObject",
"admin-content-email-templates__LocaleObjectKeys",
"admin-content-email-templates__MarketingEmailTemplatesTemplateNameGetResponsesContentApplicationJsonSchemaMeta"
]
},
"PUT /v3/marketing/email-templates/{template-name}": {
"operation": "emailTemplates_updateEmailTemplate",
"method": "PUT",
"path": "/v3/marketing/email-templates/{template-name}",
"risk": "H",
"description": "Update Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-email-templates.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"template-name": {
"type": "string",
"maxLength": 262144,
"description": "The name of the email template."
}
},
"required": [
"template-name"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Channel ID to use for channel-specific settings. If omitted, you will interact with the global setting only."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-email-templates__EmailTemplateUpdate"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-email-templates__EmailTemplateUpdate",
"admin-content-email-templates__LocaleCollection",
"admin-content-email-templates__LocaleObject",
"admin-content-email-templates__LocaleObjectKeys"
],
"wire": [
{
"name": "template-name",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-email-templates__Email_Templates_updateEmailTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-email-templates__Email_Templates_updateEmailTemplate_Response_200",
"admin-content-email-templates__EmailTemplate",
"admin-content-email-templates__EmailTemplateTypeId",
"admin-content-email-templates__LocaleCollection",
"admin-content-email-templates__LocaleObject",
"admin-content-email-templates__LocaleObjectKeys",
"admin-content-email-templates__MarketingEmailTemplatesTemplateNamePutResponsesContentApplicationJsonSchemaMeta"
]
},
"DELETE /v3/marketing/email-templates/{template-name}": {
"operation": "emailTemplates_deleteEmailTemplateOverride",
"method": "DELETE",
"path": "/v3/marketing/email-templates/{template-name}",
"risk": "D",
"description": "Delete Email Template Override. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-email-templates.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"template-name": {
"type": "string",
"maxLength": 262144,
"description": "The name of the email template."
}
},
"required": [
"template-name"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Required Channel ID. This delete operation will delete overridden settings for this channel, thus restoring them to the global defaults."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path",
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "template-name",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-email-templates__Email_Templates_deleteEmailTemplateOverride_Response_200"
}
},
"response_definitions": [
"admin-content-email-templates__Email_Templates_deleteEmailTemplateOverride_Response_200"
]
},
"GET /v3/content/scripts": {
"operation": "scripts_getScripts",
"method": "GET",
"path": "/v3/content/scripts",
"risk": "R",
"description": "List Scripts. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing-scripts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products."
},
"sort": {
"$ref": "#/$defs/admin-content-marketing-scripts__ContentScriptsGetParametersSort",
"description": "Field name to sort the scripts by. Note: Since `id` increments when new scripts are added, you can use that field to sort by script create date.\n"
},
"direction": {
"$ref": "#/$defs/admin-content-marketing-scripts__ContentScriptsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filters list of scripts by the associated channel ID."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing-scripts__ContentScriptsGetParametersSort",
"admin-content-marketing-scripts__ContentScriptsGetParametersDirection"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sort",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing-scripts__Scripts_getScripts_Response_200"
}
},
"response_definitions": [
"admin-content-marketing-scripts__Scripts_getScripts_Response_200",
"admin-content-marketing-scripts__script_Full",
"admin-content-marketing-scripts__ScriptBaseLoadMethod",
"admin-content-marketing-scripts__ScriptBaseLocation",
"admin-content-marketing-scripts__ScriptBaseVisibility",
"admin-content-marketing-scripts__ScriptBaseKind",
"admin-content-marketing-scripts__ScriptBaseConsentCategory",
"admin-content-marketing-scripts__CollectionMeta",
"admin-content-marketing-scripts__CollectionMetaPagination",
"admin-content-marketing-scripts__CollectionMetaPaginationLinks"
]
},
"POST /v3/content/scripts": {
"operation": "scripts_createScript",
"method": "POST",
"path": "/v3/content/scripts",
"risk": "H",
"description": "Create Script. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing-scripts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-marketing-scripts__script_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing-scripts__script_Post",
"admin-content-marketing-scripts__ScriptBaseLoadMethod",
"admin-content-marketing-scripts__ScriptBaseLocation",
"admin-content-marketing-scripts__ScriptBaseVisibility",
"admin-content-marketing-scripts__ScriptBaseKind",
"admin-content-marketing-scripts__ScriptBaseConsentCategory"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing-scripts__script_Response"
}
},
"response_definitions": [
"admin-content-marketing-scripts__script_Response",
"admin-content-marketing-scripts__script_Full",
"admin-content-marketing-scripts__ScriptBaseLoadMethod",
"admin-content-marketing-scripts__ScriptBaseLocation",
"admin-content-marketing-scripts__ScriptBaseVisibility",
"admin-content-marketing-scripts__ScriptBaseKind",
"admin-content-marketing-scripts__ScriptBaseConsentCategory",
"admin-content-marketing-scripts__Meta"
]
},
"GET /v3/content/scripts/{uuid}": {
"operation": "scripts_getScript",
"method": "GET",
"path": "/v3/content/scripts/{uuid}",
"risk": "R",
"description": "Get Script. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing-scripts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific script."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing-scripts__script_Response"
}
},
"response_definitions": [
"admin-content-marketing-scripts__script_Response",
"admin-content-marketing-scripts__script_Full",
"admin-content-marketing-scripts__ScriptBaseLoadMethod",
"admin-content-marketing-scripts__ScriptBaseLocation",
"admin-content-marketing-scripts__ScriptBaseVisibility",
"admin-content-marketing-scripts__ScriptBaseKind",
"admin-content-marketing-scripts__ScriptBaseConsentCategory",
"admin-content-marketing-scripts__Meta"
]
},
"PUT /v3/content/scripts/{uuid}": {
"operation": "scripts_updateScript",
"method": "PUT",
"path": "/v3/content/scripts/{uuid}",
"risk": "H",
"description": "Update Script. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing-scripts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific script."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-marketing-scripts__script_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing-scripts__script_Put",
"admin-content-marketing-scripts__ScriptBaseLoadMethod",
"admin-content-marketing-scripts__ScriptBaseLocation",
"admin-content-marketing-scripts__ScriptBaseVisibility",
"admin-content-marketing-scripts__ScriptBaseKind",
"admin-content-marketing-scripts__ScriptBaseConsentCategory"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing-scripts__script_Response"
}
},
"response_definitions": [
"admin-content-marketing-scripts__script_Response",
"admin-content-marketing-scripts__script_Full",
"admin-content-marketing-scripts__ScriptBaseLoadMethod",
"admin-content-marketing-scripts__ScriptBaseLocation",
"admin-content-marketing-scripts__ScriptBaseVisibility",
"admin-content-marketing-scripts__ScriptBaseKind",
"admin-content-marketing-scripts__ScriptBaseConsentCategory",
"admin-content-marketing-scripts__Meta"
]
},
"DELETE /v3/content/scripts/{uuid}": {
"operation": "scripts_deleteScript",
"method": "DELETE",
"path": "/v3/content/scripts/{uuid}",
"risk": "D",
"description": "Delete Script. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing-scripts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific script."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/banners": {
"operation": "banners_getBanners",
"method": "GET",
"path": "/v2/banners",
"risk": "R",
"description": "List Banners. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"min_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Optional filter param `/api/v2/banners?min_id={value}`"
},
"max_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Optional filter param `/api/v2/banners?max_id={value}`"
},
"page": {
"type": "number",
"description": "Optional filter param `/api/v2/banners?page={number}`"
},
"limit": {
"type": "number",
"description": "Optional filter param `/api/v2/banners?limit={count}`"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "min_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "max_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-marketing__banner_Full"
}
}
},
"response_definitions": [
"admin-content-marketing__banner_Full",
"admin-content-marketing__BannerBasePage",
"admin-content-marketing__BannerBaseLocation",
"admin-content-marketing__BannerBaseDateType"
]
},
"POST /v2/banners": {
"operation": "banners_createBanner",
"method": "POST",
"path": "/v2/banners",
"risk": "H",
"description": "Create Banner. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-marketing__banner_Base"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__banner_Base",
"admin-content-marketing__BannerBasePage",
"admin-content-marketing__BannerBaseLocation",
"admin-content-marketing__BannerBaseDateType"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__banner_Full"
}
},
"response_definitions": [
"admin-content-marketing__banner_Full",
"admin-content-marketing__BannerBasePage",
"admin-content-marketing__BannerBaseLocation",
"admin-content-marketing__BannerBaseDateType"
]
},
"DELETE /v2/banners": {
"operation": "banners_deleteBanners",
"method": "DELETE",
"path": "/v2/banners",
"risk": "D",
"description": "Delete All Banners. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/banners/{id}": {
"operation": "banners_getBanner",
"method": "GET",
"path": "/v2/banners/{id}",
"risk": "R",
"description": "Get Banner. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the banner."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__banner_Full"
}
},
"response_definitions": [
"admin-content-marketing__banner_Full",
"admin-content-marketing__BannerBasePage",
"admin-content-marketing__BannerBaseLocation",
"admin-content-marketing__BannerBaseDateType"
]
},
"PUT /v2/banners/{id}": {
"operation": "banners_updateBanner",
"method": "PUT",
"path": "/v2/banners/{id}",
"risk": "H",
"description": "Update Banner. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the banner."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-marketing__banner_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__banner_Put",
"admin-content-marketing__BannerBasePage",
"admin-content-marketing__BannerBaseLocation",
"admin-content-marketing__BannerBaseDateType"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__banner_Full"
}
},
"response_definitions": [
"admin-content-marketing__banner_Full",
"admin-content-marketing__BannerBasePage",
"admin-content-marketing__BannerBaseLocation",
"admin-content-marketing__BannerBaseDateType"
]
},
"DELETE /v2/banners/{id}": {
"operation": "banners_deleteBanner",
"method": "DELETE",
"path": "/v2/banners/{id}",
"risk": "D",
"description": "Delete Banner. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the banner."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/banners/count": {
"operation": "banners_getBannersCount",
"method": "GET",
"path": "/v2/banners/count",
"risk": "R",
"description": "Get Count of Store Banners. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__Banners_getBannersCount_Response_200"
}
},
"response_definitions": [
"admin-content-marketing__Banners_getBannersCount_Response_200"
]
},
"GET /v2/coupons": {
"operation": "coupons_getCoupons",
"method": "GET",
"path": "/v2/coupons",
"risk": "R",
"description": "List Coupons. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 262144,
"description": "Optional filter param. `/api/v2/coupons?id={value}`"
},
"code": {
"type": "string",
"maxLength": 262144,
"description": "Optional filter param `/api/v2/coupons?code={value}`"
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Optional filter param `/api/v2/coupons?name={value}`"
},
"type": {
"$ref": "#/$defs/admin-content-marketing__CouponsGetParametersType",
"description": "The type of discount."
},
"min_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Optional filter param `/api/v2/coupons?min_id={value}`"
},
"max_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Optional filter param`/api/v2/coupons?max_id={value}`"
},
"page": {
"type": "number",
"description": "Number of pages `/api/v2/coupons?page={number}`"
},
"limit": {
"type": "number",
"description": "Count per page `/api/v2/coupons?limit={count}`"
},
"exclude_type": {
"$ref": "#/$defs/admin-content-marketing__CouponsGetParametersExcludeType",
"description": "Exclude a type of coupon."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__CouponsGetParametersType",
"admin-content-marketing__CouponsGetParametersExcludeType"
],
"wire": [
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "code",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "min_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "max_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "exclude_type",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-marketing__coupon_Full"
}
}
},
"response_definitions": [
"admin-content-marketing__coupon_Full",
"admin-content-marketing__CouponBaseType",
"admin-content-marketing__CouponBaseAppliesTo",
"admin-content-marketing__CouponBaseRestrictedTo"
]
},
"POST /v2/coupons": {
"operation": "coupons_createCoupon",
"method": "POST",
"path": "/v2/coupons",
"risk": "H",
"description": "Create Coupon. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-marketing__coupon_Base"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__coupon_Base",
"admin-content-marketing__CouponBaseType",
"admin-content-marketing__CouponBaseAppliesTo",
"admin-content-marketing__CouponBaseRestrictedTo"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-content-marketing__coupon_Full"
}
},
"response_definitions": [
"admin-content-marketing__coupon_Full",
"admin-content-marketing__CouponBaseType",
"admin-content-marketing__CouponBaseAppliesTo",
"admin-content-marketing__CouponBaseRestrictedTo"
]
},
"DELETE /v2/coupons": {
"operation": "coupons_deleteCoupons",
"method": "DELETE",
"path": "/v2/coupons",
"risk": "D",
"description": "Delete All Coupons. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Optional param to identify a comma-separated list of IDs for coupons to delete in a batch. `/api/v2/coupons?id:in=1,2,3`"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/coupons/count": {
"operation": "coupons_getCouponsCount",
"method": "GET",
"path": "/v2/coupons/count",
"risk": "R",
"description": "Get Count of Coupons. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__Coupons_getCouponsCount_Response_200"
}
},
"response_definitions": [
"admin-content-marketing__Coupons_getCouponsCount_Response_200"
]
},
"PUT /v2/coupons/{id}": {
"operation": "coupons_updateCoupon",
"method": "PUT",
"path": "/v2/coupons/{id}",
"risk": "H",
"description": "Update Coupon. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of the coupon."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-marketing__coupon_Base"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__coupon_Base",
"admin-content-marketing__CouponBaseType",
"admin-content-marketing__CouponBaseAppliesTo",
"admin-content-marketing__CouponBaseRestrictedTo"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__coupon_Full"
}
},
"response_definitions": [
"admin-content-marketing__coupon_Full",
"admin-content-marketing__CouponBaseType",
"admin-content-marketing__CouponBaseAppliesTo",
"admin-content-marketing__CouponBaseRestrictedTo"
]
},
"DELETE /v2/coupons/{id}": {
"operation": "coupons_deleteCoupon",
"method": "DELETE",
"path": "/v2/coupons/{id}",
"risk": "D",
"description": "Delete Coupon. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of the coupon."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/gift_certificates/{id}": {
"operation": "giftCertificates_getGiftCertificate",
"method": "GET",
"path": "/v2/gift_certificates/{id}",
"risk": "R",
"description": "Get Gift Certificate. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the gift certificate."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__giftCertificate_Full"
}
},
"response_definitions": [
"admin-content-marketing__giftCertificate_Full",
"admin-content-marketing__GiftCertificateFullTemplate",
"admin-content-marketing__GiftCertificateFullStatus"
]
},
"PUT /v2/gift_certificates/{id}": {
"operation": "giftCertificates_updateGiftCertificate",
"method": "PUT",
"path": "/v2/gift_certificates/{id}",
"risk": "H",
"description": "Update Gift Certificate. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the gift certificate."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-marketing__giftCertificate_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__giftCertificate_Put",
"admin-content-marketing__GiftCertificatePutTemplate",
"admin-content-marketing__GiftCertificatePutStatus"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-marketing__giftCertificate_Full"
}
},
"response_definitions": [
"admin-content-marketing__giftCertificate_Full",
"admin-content-marketing__GiftCertificateFullTemplate",
"admin-content-marketing__GiftCertificateFullStatus"
]
},
"DELETE /v2/gift_certificates/{id}": {
"operation": "giftCertificates_deleteGiftCertificate",
"method": "DELETE",
"path": "/v2/gift_certificates/{id}",
"risk": "D",
"description": "Delete Gift Certificate. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the gift certificate."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/gift_certificates": {
"operation": "giftCertificates_getGiftCertificates",
"method": "GET",
"path": "/v2/gift_certificates",
"risk": "R",
"description": "List Gift Certificates. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"min_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those with an ID greater than or equal to this value."
},
"max_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter results to those with an ID less than or equal to this value."
},
"code": {
"type": "string",
"maxLength": 262144,
"description": "Filter gift certificates by code."
},
"order_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter gift certificates by the associated order ID."
},
"to_name": {
"type": "string",
"maxLength": 262144,
"description": "Filter gift certificates by recipient name."
},
"to_email": {
"type": "string",
"maxLength": 262144,
"description": "Filter gift certificates by recipient email address."
},
"from_name": {
"type": "string",
"maxLength": 262144,
"description": "Filter gift certificates by sender name."
},
"from_email": {
"type": "string",
"maxLength": 262144,
"description": "Filter gift certificates by sender email address."
},
"page": {
"type": "number",
"description": "The page number of the results to return, starting at 1."
},
"limit": {
"type": "number",
"description": "The number of results to return per page."
},
"sort": {
"$ref": "#/$defs/admin-content-marketing__GiftCertificatesGetParametersSort",
"description": "Field to sort results by."
},
"direction": {
"$ref": "#/$defs/admin-content-marketing__GiftCertificatesGetParametersDirection",
"description": "Sort direction. Defaults to asc."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__GiftCertificatesGetParametersSort",
"admin-content-marketing__GiftCertificatesGetParametersDirection"
],
"wire": [
{
"name": "min_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "max_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "code",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "order_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "to_name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "to_email",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "from_name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "from_email",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sort",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-marketing__giftCertificate_Full"
}
}
},
"response_definitions": [
"admin-content-marketing__giftCertificate_Full",
"admin-content-marketing__GiftCertificateFullTemplate",
"admin-content-marketing__GiftCertificateFullStatus"
]
},
"POST /v2/gift_certificates": {
"operation": "giftCertificates_createGiftCertificate",
"method": "POST",
"path": "/v2/gift_certificates",
"risk": "H",
"description": "Create Gift Certificate. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-marketing__giftCertificate_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-marketing__giftCertificate_Post",
"admin-content-marketing__GiftCertificatePostTemplate",
"admin-content-marketing__GiftCertificatePostStatus"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-content-marketing__giftCertificate_Full"
}
},
"response_definitions": [
"admin-content-marketing__giftCertificate_Full",
"admin-content-marketing__GiftCertificateFullTemplate",
"admin-content-marketing__GiftCertificateFullStatus"
]
},
"DELETE /v2/gift_certificates": {
"operation": "giftCertificates_deleteGiftCertificates",
"method": "DELETE",
"path": "/v2/gift_certificates",
"risk": "D",
"description": "Delete All Gift Certificates. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-marketing.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/content/page-widgets": {
"operation": "pageWidgets_getPageWidgets",
"method": "GET",
"path": "/v3/content/page-widgets",
"risk": "R",
"description": "Get Page Snapshot. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-page-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the channel for which you want to retrieve page widgets. Defaults to the first channel created on the store."
},
"template_file": {
"type": "string",
"maxLength": 262144,
"description": "The template file that you would like to target. Leave it empty if the request is for Global regions."
},
"entity_id": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a page you would like to target. For product pages, choose product ID. For category pages, choose category ID. Home page does not support `entity_id`. Leave empty if the request is for global regions."
}
},
"required": [],
"additionalProperties": false
},
"header": {
"type": "object",
"properties": {
"X-Correlation-Id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "template_file",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "entity_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "X-Correlation-Id",
"location": "header",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-page-widgets__Page_Widgets_getPageWidgets_Response_200"
}
},
"response_definitions": [
"admin-content-page-widgets__Page_Widgets_getPageWidgets_Response_200",
"admin-content-page-widgets__ContentPageWidgetsGetResponsesContentApplicationJsonSchemaData",
"admin-content-page-widgets__region",
"admin-content-page-widgets__RegionChildrenItems",
"admin-content-page-widgets__layout",
"admin-content-page-widgets__LayoutConfiguration",
"admin-content-page-widgets__dropzone",
"admin-content-page-widgets__DropzoneConfiguration",
"admin-content-page-widgets__widget",
"admin-content-page-widgets__WidgetConfiguration",
"admin-content-page-widgets__WidgetStorefrontApiQueryParams",
"admin-content-page-widgets__WidgetType",
"admin-content-page-widgets__LayoutType",
"admin-content-page-widgets__metaCollection",
"admin-content-page-widgets__pagination",
"admin-content-page-widgets__PaginationLinks"
]
},
"POST /v3/content/page-widgets": {
"operation": "pageWidgets_createPageWidgets",
"method": "POST",
"path": "/v3/content/page-widgets",
"risk": "H",
"description": "Publish or Overwrite Page Content. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-page-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"X-Correlation-Id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-page-widgets__publish"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-page-widgets__publish",
"admin-content-page-widgets__region",
"admin-content-page-widgets__RegionChildrenItems",
"admin-content-page-widgets__layout",
"admin-content-page-widgets__LayoutConfiguration",
"admin-content-page-widgets__dropzone",
"admin-content-page-widgets__DropzoneConfiguration",
"admin-content-page-widgets__widget",
"admin-content-page-widgets__WidgetConfiguration",
"admin-content-page-widgets__WidgetStorefrontApiQueryParams",
"admin-content-page-widgets__WidgetType",
"admin-content-page-widgets__LayoutType"
],
"wire": [
{
"name": "X-Correlation-Id",
"location": "header",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/content/pages": {
"operation": "pagesBulk_getPages",
"method": "GET",
"path": "/v3/content/pages",
"risk": "R",
"description": "List Pages. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Return only pages associated with the specified channel."
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated string of page IDs to fetch. Supports bulk operations. If none of the page IDs passed exist, the query will return an empty `data` array."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Name of the page."
},
"name:like": {
"type": "string",
"maxLength": 262144,
"description": "Return only pages whose `name` or `body` contain the supplied string."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The number of results to return per request. See `meta.pagination.per_page` in the response body."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ordered grouping of results to return. See `meta.pagination.current_page` in the response body."
},
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-pages__ContentPagesGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "Include the requested property in the response. The `body` property returns the page’s markup, text, or raw content."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-pages__ContentPagesGetParametersIncludeSchemaItems"
],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-pages__PagesCollectionResponse"
}
},
"response_definitions": [
"admin-content-pages__PagesCollectionResponse",
"admin-content-pages__PagesCollectionResponseDataItems",
"admin-content-pages__typePage",
"admin-content-pages__TypePageType",
"admin-content-pages__typeBlog",
"admin-content-pages__TypeBlogType",
"admin-content-pages__typeContactForm",
"admin-content-pages__TypeContactFormType",
"admin-content-pages__typeRaw",
"admin-content-pages__TypeRawType",
"admin-content-pages__typeLink",
"admin-content-pages__TypeLinkType",
"admin-content-pages__ResponseMeta",
"admin-content-pages__ResponseMetaPagination",
"admin-content-pages__ResponseMetaPaginationLinks"
]
},
"POST /v3/content/pages": {
"operation": "pagesBulk_createPages",
"method": "POST",
"path": "/v3/content/pages",
"risk": "H",
"description": "Create Pages. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-pages__ContentPagesPostParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "Include the requested property in the response. The `body` property returns the page’s markup, text, or raw content."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-pages__Pages__Bulk__createPages_Request"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-pages__ContentPagesPostParametersIncludeSchemaItems",
"admin-content-pages__Pages__Bulk__createPages_Request",
"admin-content-pages__PagesBulkCreatePagesRequest0",
"admin-content-pages__typePage",
"admin-content-pages__TypePageType",
"admin-content-pages__typeBlog",
"admin-content-pages__TypeBlogType",
"admin-content-pages__typeContactForm",
"admin-content-pages__TypeContactFormType",
"admin-content-pages__typeRaw",
"admin-content-pages__TypeRawType",
"admin-content-pages__typeLink",
"admin-content-pages__TypeLinkType",
"admin-content-pages__PagesBulkCreatePagesRequest1",
"admin-content-pages__ContentPagesPostRequestBodyContentApplicationJsonSchemaOneOf1Items"
],
"wire": [
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"201": {
"$ref": "#/$defs/admin-content-pages__Pages__Bulk__createPages_Response_201"
}
},
"response_definitions": [
"admin-content-pages__Pages__Bulk__createPages_Response_201",
"admin-content-pages__ContentPagesPostResponsesContentApplicationJsonSchemaData",
"admin-content-pages__typePage",
"admin-content-pages__TypePageType",
"admin-content-pages__typeBlog",
"admin-content-pages__TypeBlogType",
"admin-content-pages__typeContactForm",
"admin-content-pages__TypeContactFormType",
"admin-content-pages__typeRaw",
"admin-content-pages__TypeRawType",
"admin-content-pages__typeLink",
"admin-content-pages__TypeLinkType",
"admin-content-pages__ResponseMeta",
"admin-content-pages__ResponseMetaPagination",
"admin-content-pages__ResponseMetaPaginationLinks"
]
},
"PUT /v3/content/pages": {
"operation": "pagesBulk_updatePages",
"method": "PUT",
"path": "/v3/content/pages",
"risk": "H",
"description": "Update Pages. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-pages__ContentPagesPutParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "Include the requested property in the response. The `body` property returns the page’s markup, text, or raw content."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-pages__Pages__Bulk__updatePages_Request"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-pages__ContentPagesPutParametersIncludeSchemaItems",
"admin-content-pages__Pages__Bulk__updatePages_Request",
"admin-content-pages__PagePutBulk",
"admin-content-pages__PagePutObjType",
"admin-content-pages__PagesBulkUpdatePagesRequest1"
],
"wire": [
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-pages__PagesCollectionResponse"
}
},
"response_definitions": [
"admin-content-pages__PagesCollectionResponse",
"admin-content-pages__PagesCollectionResponseDataItems",
"admin-content-pages__typePage",
"admin-content-pages__TypePageType",
"admin-content-pages__typeBlog",
"admin-content-pages__TypeBlogType",
"admin-content-pages__typeContactForm",
"admin-content-pages__TypeContactFormType",
"admin-content-pages__typeRaw",
"admin-content-pages__TypeRawType",
"admin-content-pages__typeLink",
"admin-content-pages__TypeLinkType",
"admin-content-pages__ResponseMeta",
"admin-content-pages__ResponseMetaPagination",
"admin-content-pages__ResponseMetaPaginationLinks"
]
},
"DELETE /v3/content/pages": {
"operation": "pagesBulk_deletePages",
"method": "DELETE",
"path": "/v3/content/pages",
"risk": "D",
"description": "Delete Pages. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Request deletion of multiple pages by passing a comma-separated string of corresponding page IDs. Supports bulk operations."
},
"delete_children": {
"type": "boolean",
"description": "When you explicitly set this query parameter to `true`, deleting a parent page will recursively delete all its immediate children and their descendants.\nOtherwise, if you set this query parameter to `false` or not provided, deleting a parent page will update its immediate children by setting their `parent_id` to `0` and their `is_visible` status to `false`.\n"
}
},
"required": [
"id:in"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "delete_children",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/content/pages/{pageId}": {
"operation": "pagesSingle_getPage",
"method": "GET",
"path": "/v3/content/pages/{pageId}",
"risk": "R",
"description": "Get Page. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"pageId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the page to be operated on."
}
},
"required": [
"pageId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-pages__ContentPagesPageIdGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "Include the requested property in the response. The `body` property returns the page’s markup, text, or raw content."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-pages__ContentPagesPageIdGetParametersIncludeSchemaItems"
],
"wire": [
{
"name": "pageId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-pages__SinglePageResponse"
}
},
"response_definitions": [
"admin-content-pages__SinglePageResponse",
"admin-content-pages__SinglePageResponseData",
"admin-content-pages__typePage",
"admin-content-pages__TypePageType",
"admin-content-pages__typeBlog",
"admin-content-pages__TypeBlogType",
"admin-content-pages__typeContactForm",
"admin-content-pages__TypeContactFormType",
"admin-content-pages__typeRaw",
"admin-content-pages__TypeRawType",
"admin-content-pages__typeLink",
"admin-content-pages__TypeLinkType",
"admin-content-pages__ResponseMeta",
"admin-content-pages__ResponseMetaPagination",
"admin-content-pages__ResponseMetaPaginationLinks"
]
},
"PUT /v3/content/pages/{pageId}": {
"operation": "pagesSingle_updatePage",
"method": "PUT",
"path": "/v3/content/pages/{pageId}",
"risk": "H",
"description": "Update Page. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"pageId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the page to be operated on."
}
},
"required": [
"pageId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-pages__ContentPagesPageIdPutParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "Include the requested property in the response. The `body` property returns the page’s markup, text, or raw content."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-pages__PagePutObj"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-pages__ContentPagesPageIdPutParametersIncludeSchemaItems",
"admin-content-pages__PagePutObj",
"admin-content-pages__PagePutObjType"
],
"wire": [
{
"name": "pageId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-pages__SinglePageResponse"
}
},
"response_definitions": [
"admin-content-pages__SinglePageResponse",
"admin-content-pages__SinglePageResponseData",
"admin-content-pages__typePage",
"admin-content-pages__TypePageType",
"admin-content-pages__typeBlog",
"admin-content-pages__TypeBlogType",
"admin-content-pages__typeContactForm",
"admin-content-pages__TypeContactFormType",
"admin-content-pages__typeRaw",
"admin-content-pages__TypeRawType",
"admin-content-pages__typeLink",
"admin-content-pages__TypeLinkType",
"admin-content-pages__ResponseMeta",
"admin-content-pages__ResponseMetaPagination",
"admin-content-pages__ResponseMetaPaginationLinks"
]
},
"DELETE /v3/content/pages/{pageId}": {
"operation": "pagesSingle_deletePage",
"method": "DELETE",
"path": "/v3/content/pages/{pageId}",
"risk": "D",
"description": "Delete Page. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-pages.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"pageId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the page to be operated on."
}
},
"required": [
"pageId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "pageId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/storefront/redirects": {
"operation": "redirects_getRedirects",
"method": "GET",
"path": "/v3/storefront/redirects",
"risk": "R",
"description": "List Redirects. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-store-content-redirects.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"site_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filters items by site ID."
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filters items by redirect ID. Also accepts comma-separated values to filter for multiple redirects."
},
"id:min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filters items by minimum redirect ID."
},
"id:max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filters items by maximum redirect ID."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items to return per page."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of items. Used to paginate large collections."
},
"sort": {
"$ref": "#/$defs/admin-content-store-content-redirects__StorefrontRedirectsGetParametersSort",
"description": "Field name to sort by. Since redirect IDs increment when new redirects are added, you can sort by ID to return results in redirect create date order.\n"
},
"direction": {
"$ref": "#/$defs/admin-content-store-content-redirects__StorefrontRedirectsGetParametersDirection",
"description": "Sort direction. Acceptable values are `asc`, `desc`."
},
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-store-content-redirects__StorefrontRedirectsGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "Indicates whether to include redirect sub-resources. Only `to_url` is supported."
},
"keyword": {
"type": "string",
"maxLength": 262144,
"description": "Filters redirects by the specified keyword. Will only search from the beginning of a URL path. For example, `blue` will match `/blue` and `/blue-shirt` , **not** `/royal-blue-shirt`."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content-redirects__StorefrontRedirectsGetParametersSort",
"admin-content-store-content-redirects__StorefrontRedirectsGetParametersDirection",
"admin-content-store-content-redirects__StorefrontRedirectsGetParametersIncludeSchemaItems"
],
"wire": [
{
"name": "site_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sort",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "keyword",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content-redirects__Redirects_getRedirects_Response_200"
}
},
"response_definitions": [
"admin-content-store-content-redirects__Redirects_getRedirects_Response_200",
"admin-content-store-content-redirects__301RedirectRead",
"admin-content-store-content-redirects__RedirectTo",
"admin-content-store-content-redirects__RedirectToType",
"admin-content-store-content-redirects__MetaPaginationObject",
"admin-content-store-content-redirects__MetaPaginationObjectPagination",
"admin-content-store-content-redirects__MetaPaginationObjectPaginationLinks"
]
},
"PUT /v3/storefront/redirects": {
"operation": "redirects_upsertRedirects",
"method": "PUT",
"path": "/v3/storefront/redirects",
"risk": "H",
"description": "Upsert Redirects. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content-redirects.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-store-content-redirects__301RedirectUpsert"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content-redirects__301RedirectUpsert",
"admin-content-store-content-redirects__RedirectTo",
"admin-content-store-content-redirects__RedirectToType"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-content-store-content-redirects__Redirects_upsertRedirects_Response_201"
}
},
"response_definitions": [
"admin-content-store-content-redirects__Redirects_upsertRedirects_Response_201",
"admin-content-store-content-redirects__301RedirectRead",
"admin-content-store-content-redirects__RedirectTo",
"admin-content-store-content-redirects__RedirectToType",
"admin-content-store-content-redirects__MetaPaginationObject",
"admin-content-store-content-redirects__MetaPaginationObjectPagination",
"admin-content-store-content-redirects__MetaPaginationObjectPaginationLinks"
]
},
"DELETE /v3/storefront/redirects": {
"operation": "redirects_deleteRedirects",
"method": "DELETE",
"path": "/v3/storefront/redirects",
"risk": "D",
"description": "Delete Redirects. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content-redirects.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "A comma-separated list of redirect IDs to delete explicitly."
},
"site_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "To delete all redirects for a given site, provide the site ID."
}
},
"required": [
"id:in"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "site_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/storefront/redirects/imex/jobs": {
"operation": "importExport_getRedirectImportExportJobs",
"method": "GET",
"path": "/v3/storefront/redirects/imex/jobs",
"risk": "R",
"description": "List Redirect Import-Export Jobs. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-store-content-redirects.json",
"partial_http": [],
"error_paths": [
[
"data",
"*",
"errors"
]
],
"failed_count_paths": [
[
"data",
"*",
"failed_items"
]
],
"failed_status_paths": [
{
"path": [
"data",
"*",
"status"
],
"values": [
"failed",
"aborted"
]
}
],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 262144,
"description": "Filters results by redirect import-export job ID."
},
"type": {
"$ref": "#/$defs/admin-content-store-content-redirects__ImportExportJobType",
"description": "Filters results by the type of the redirect import-export job."
},
"status": {
"$ref": "#/$defs/admin-content-store-content-redirects__ImportExportJobStatus",
"description": "Filters results by the status of the Redirect Import-Export job."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Determines the number of items returned per page. The default is 10 items per page."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number to return when the number of items returned exceeds the page limit. Used to paginate large collections."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content-redirects__ImportExportJobType",
"admin-content-store-content-redirects__ImportExportJobStatus"
],
"wire": [
{
"name": "id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "status",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content-redirects__Import-Export_getRedirectImportExportJobs_Response_200"
}
},
"response_definitions": [
"admin-content-store-content-redirects__Import-Export_getRedirectImportExportJobs_Response_200",
"admin-content-store-content-redirects__301RedirectImportExportJobRead",
"admin-content-store-content-redirects__ImportExportJobType",
"admin-content-store-content-redirects__ImportExportJobStatus",
"admin-content-store-content-redirects__ImportErrors",
"admin-content-store-content-redirects__ImportErrorsItems",
"admin-content-store-content-redirects__MetaPaginationObject",
"admin-content-store-content-redirects__MetaPaginationObjectPagination",
"admin-content-store-content-redirects__MetaPaginationObjectPaginationLinks"
]
},
"POST /v3/storefront/redirects/imex/export": {
"operation": "importExport_createRedirectExportJob",
"method": "POST",
"path": "/v3/storefront/redirects/imex/export",
"risk": "H",
"description": "Create Redirects Export Job. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content-redirects.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"properties": {
"site_id": {
"type": [
"integer",
"null"
],
"description": "The site ID for which you wish to export redirects. If no site ID is provided, the request exports all redirects for all sites.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"redirect_ids": {
"type": "array",
"description": "A list of the redirect IDs you wish to export. If no redirect IDs are provided, the request exports all redirects for the given site selection.",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
},
"include_dynamic_target_urls": {
"type": "boolean",
"description": "If true, the exported CSV will contain an additional read-only column containing the target URL for dynamic redirects."
}
},
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-content-store-content-redirects__Import-Export_createRedirectExportJob_Response_201"
}
},
"response_definitions": [
"admin-content-store-content-redirects__Import-Export_createRedirectExportJob_Response_201"
]
},
"GET /v2/blog/posts": {
"operation": "blogPosts_getBlogPosts",
"method": "GET",
"path": "/v2/blog/posts",
"risk": "R",
"description": "List Blog Posts. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"is_published": {
"type": "boolean",
"description": "Filter param."
},
"url": {
"type": "string",
"maxLength": 262144,
"description": "Filter param. Value must be URL encoded."
},
"tag": {
"type": "string",
"maxLength": 262144,
"description": "Filter param."
},
"published_date": {
"type": "string",
"maxLength": 262144,
"description": "Filter param."
},
"page": {
"type": "integer",
"maximum": 50,
"minimum": -9007199254740991,
"description": "Filter param."
},
"limit": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Filter param."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "is_published",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "url",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "tag",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "published_date",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-store-content__blogPost_Full"
}
}
},
"response_definitions": [
"admin-content-store-content__blogPost_Full",
"admin-content-store-content__publishedDate"
]
},
"POST /v2/blog/posts": {
"operation": "blogPosts_createBlogPosts",
"method": "POST",
"path": "/v2/blog/posts",
"risk": "H",
"description": "Create Blog Post. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-store-content__blogPost_Base_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content__blogPost_Base_Post"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content__blogPost_Base_Res"
}
},
"response_definitions": [
"admin-content-store-content__blogPost_Base_Res",
"admin-content-store-content__publishedDate"
]
},
"DELETE /v2/blog/posts": {
"operation": "blogPosts_deleteBlogPosts",
"method": "DELETE",
"path": "/v2/blog/posts",
"risk": "D",
"description": "Delete Blog Posts. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"maximum": 250,
"minimum": -9007199254740991,
"description": "Filter param."
},
"limit": {
"type": "integer",
"maximum": 50,
"minimum": -9007199254740991,
"description": "Filter param."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/blog/posts/{id}": {
"operation": "blogPosts_getBlogPost",
"method": "GET",
"path": "/v2/blog/posts/{id}",
"risk": "R",
"description": "Get Blog Post. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the blog post."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content__blogPost_Full"
}
},
"response_definitions": [
"admin-content-store-content__blogPost_Full",
"admin-content-store-content__publishedDate"
]
},
"PUT /v2/blog/posts/{id}": {
"operation": "blogPosts_updateBlogPost",
"method": "PUT",
"path": "/v2/blog/posts/{id}",
"risk": "H",
"description": "Update Blog Post. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the blog post."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-store-content__blogPost_Base_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content__blogPost_Base_Post"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content__blogPost_Base_Res"
}
},
"response_definitions": [
"admin-content-store-content__blogPost_Base_Res",
"admin-content-store-content__publishedDate"
]
},
"DELETE /v2/blog/posts/{id}": {
"operation": "blogPosts_deleteBlogPost",
"method": "DELETE",
"path": "/v2/blog/posts/{id}",
"risk": "D",
"description": "Delete Blog Post. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the blog post."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/blog/posts/count": {
"operation": "blogPosts_getBlogPostsCount",
"method": "GET",
"path": "/v2/blog/posts/count",
"risk": "R",
"description": "Get Count of Blog Posts. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content__count_Response"
}
},
"response_definitions": [
"admin-content-store-content__count_Response"
]
},
"GET /v2/blog/tags": {
"operation": "blogTags_getBlogTags",
"method": "GET",
"path": "/v2/blog/tags",
"risk": "R",
"description": "List Blog Tags. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-content-store-content__blogTags"
}
}
},
"response_definitions": [
"admin-content-store-content__blogTags",
"admin-content-store-content__BlogTagsItems"
]
},
"POST /v2/redirects": {
"operation": "redirects_createRedirect",
"method": "POST",
"path": "/v2/redirects",
"risk": "H",
"description": "Create Redirect. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-store-content__redirect"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content__redirect",
"admin-content-store-content__forward"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content__redirect"
}
},
"response_definitions": [
"admin-content-store-content__redirect",
"admin-content-store-content__forward"
]
},
"PUT /v2/redirects/{id}": {
"operation": "redirects_updateRedirect",
"method": "PUT",
"path": "/v2/redirects/{id}",
"risk": "H",
"description": "Update Redirect. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the redirect URL."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"path",
"forward"
],
"properties": {
"id": {
"type": "integer",
"description": "Numeric ID of the redirect.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"path": {
"type": "string",
"description": "The path from which to redirect.",
"maxLength": 262144
},
"forward": {
"$ref": "#/$defs/admin-content-store-content__RedirectsIdPutRequestBodyContentApplicationJsonSchemaForward"
},
"url": {
"type": "string",
"description": "URL of the redirect. READ-ONLY.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-store-content__RedirectsIdPutRequestBodyContentApplicationJsonSchemaForward"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-store-content__redirect"
}
},
"response_definitions": [
"admin-content-store-content__redirect",
"admin-content-store-content__forward"
]
},
"DELETE /v2/redirects/{id}": {
"operation": "redirects_deleteRedirect",
"method": "DELETE",
"path": "/v2/redirects/{id}",
"risk": "D",
"description": "Delete Redirect. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-store-content.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "ID of the redirect URL."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/themes": {
"operation": "themes_getStoreThemes",
"method": "GET",
"path": "/v3/themes",
"risk": "R",
"description": "List Themes. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__ThemesCollectionResponse"
}
},
"response_definitions": [
"admin-content-themes__ThemesCollectionResponse",
"admin-content-themes__ThemesCollectionResponseDataItems",
"admin-content-themes__ThemesCollectionResponseDataItemsVariationsItems",
"admin-content-themes__ThemesCollectionResponseMeta"
]
},
"GET /v3/themes/{uuid}": {
"operation": "themes_getStoreTheme",
"method": "GET",
"path": "/v3/themes/{uuid}",
"risk": "R",
"description": "Get Theme. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The theme identifier."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__ThemeResponse"
}
},
"response_definitions": [
"admin-content-themes__ThemeResponse",
"admin-content-themes__Theme",
"admin-content-themes__ThemeVariationsItems",
"admin-content-themes__CollectionMeta"
]
},
"DELETE /v3/themes/{uuid}": {
"operation": "themes_deleteStoreTheme",
"method": "DELETE",
"path": "/v3/themes/{uuid}",
"risk": "D",
"description": "Delete Theme. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The theme identifier."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"POST /v3/themes/{uuid}/actions/download": {
"operation": "themeActions_downloadStoreTheme",
"method": "POST",
"path": "/v3/themes/{uuid}/actions/download",
"risk": "H",
"description": "Download Theme. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The theme identifier."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-themes__WhichThemeToDownload"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-themes__WhichThemeToDownload",
"admin-content-themes__WhichThemeToDownloadWhich"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__JobId"
}
},
"response_definitions": [
"admin-content-themes__JobId"
]
},
"POST /v3/themes/actions/activate": {
"operation": "themeActions_activateStoreTheme",
"method": "POST",
"path": "/v3/themes/actions/activate",
"risk": "H",
"description": "Activate Theme. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID for the channel where you want to activate the theme."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-themes__Activate"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-themes__Activate",
"admin-content-themes__ActivateWhich"
],
"wire": [
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/themes/{uuid}/configurations": {
"operation": "themeConfigurations_getThemeConfiguration",
"method": "GET",
"path": "/v3/themes/{uuid}/configurations",
"risk": "R",
"description": "Get Theme Configuration. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The theme identifier."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"uuid:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter configurations by passing a comma-separated list of configuration UUIDs."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter configurations by passing a comma-separated list of channel IDs."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"variation_uuid": {
"type": "string",
"maxLength": 262144,
"description": "Filter configurations by a variation_uuid."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "uuid:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "variation_uuid",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__Theme_Configurations_getThemeConfiguration_Response_200"
}
},
"response_definitions": [
"admin-content-themes__Theme_Configurations_getThemeConfiguration_Response_200",
"admin-content-themes__themeConfiguration_Full",
"admin-content-themes__ThemeConfigurationFullSettings",
"admin-content-themes__ThemesCollectionMeta"
]
},
"POST /v3/themes/{uuid}/configurations/validate": {
"operation": "themeConfigurations_validateThemeConfiguration",
"method": "POST",
"path": "/v3/themes/{uuid}/configurations/validate",
"risk": "R",
"description": "Validate Theme Configuration. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The theme identifier."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-themes__themeConfiguration_Write"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-themes__themeConfiguration_Write",
"admin-content-themes__ThemeConfigurationWriteSettings"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__Theme_Configurations_validateThemeConfiguration_Response_200"
}
},
"response_definitions": [
"admin-content-themes__Theme_Configurations_validateThemeConfiguration_Response_200"
]
},
"GET /v3/themes/custom-templates/{version_uuid}": {
"operation": "themeCustomTemplates_getThemeCustomTemplates",
"method": "GET",
"path": "/v3/themes/custom-templates/{version_uuid}",
"risk": "R",
"description": "List Custom Templates. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"version_uuid": {
"type": "string",
"maxLength": 262144,
"description": "The UUID of the theme version."
}
},
"required": [
"version_uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "version_uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__Theme_Custom_Templates_getThemeCustomTemplates_Response_200"
}
},
"response_definitions": [
"admin-content-themes__Theme_Custom_Templates_getThemeCustomTemplates_Response_200",
"admin-content-themes__ThemesCustomTemplatesVersionUuidGetResponsesContentApplicationJsonSchemaData",
"admin-content-themes__OpenMeta"
]
},
"GET /v3/themes/jobs/{job_id}": {
"operation": "themeJobs_getStoreThemeJob",
"method": "GET",
"path": "/v3/themes/jobs/{job_id}",
"risk": "R",
"description": "Get Theme Job. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-themes.json",
"partial_http": [],
"error_paths": [
[
"data",
"errors"
]
],
"failed_count_paths": [],
"failed_status_paths": [
{
"path": [
"data",
"status"
],
"values": [
"FAILED"
]
}
],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"job_id": {
"type": "string",
"maxLength": 262144,
"description": "The job identifier."
}
},
"required": [
"job_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "job_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-themes__JobResponse"
}
},
"response_definitions": [
"admin-content-themes__JobResponse",
"admin-content-themes__JobResponseData",
"admin-content-themes__JobResponseDataErrorsItems",
"admin-content-themes__JobResponseDataResult",
"admin-content-themes__JobResponseDataStatus",
"admin-content-themes__JobResponseDataWarningsItems",
"admin-content-themes__OpenMeta"
]
},
"GET /v3/content/placements": {
"operation": "placement_getPlacements",
"method": "GET",
"path": "/v3/content/placements",
"risk": "R",
"description": "List Placements. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"widget_template_kind": {
"type": "string",
"maxLength": 262144,
"description": "The kind of widget template."
},
"template_file": {
"type": "string",
"maxLength": 262144,
"description": "The template file, for example: `pages/home`."
},
"widget_uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific widget."
},
"widget_template_uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific widget template."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of channel ids to filter the results by."
},
"site_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of site IDs to filter the results by."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "widget_template_kind",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "template_file",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "widget_uuid",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "widget_template_uuid",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "site_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Placement_getPlacements_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Placement_getPlacements_Response_200",
"admin-content-widgets__placement_Full",
"admin-content-widgets__PlacementBaseStatus",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__metaCollection",
"admin-content-widgets__pagination",
"admin-content-widgets__PaginationLinks"
]
},
"POST /v3/content/placements": {
"operation": "placement_createPlacement",
"method": "POST",
"path": "/v3/content/placements",
"risk": "H",
"description": "Create Placement. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-widgets__placement_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__placement_Post",
"admin-content-widgets__PlacementBaseStatus"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Placement_createPlacement_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Placement_createPlacement_Response_200",
"admin-content-widgets__placement_Full",
"admin-content-widgets__PlacementBaseStatus",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"GET /v3/content/placements/{uuid}": {
"operation": "placement_getPlacement",
"method": "GET",
"path": "/v3/content/placements/{uuid}",
"risk": "R",
"description": "Get Placement. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific placement."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Placement_getPlacement_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Placement_getPlacement_Response_200",
"admin-content-widgets__placement_Full",
"admin-content-widgets__PlacementBaseStatus",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"PUT /v3/content/placements/{uuid}": {
"operation": "placement_updatePlacement",
"method": "PUT",
"path": "/v3/content/placements/{uuid}",
"risk": "H",
"description": "Update Placement. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific placement."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-widgets__placement_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__placement_Put",
"admin-content-widgets__PlacementBaseStatus"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Placement_updatePlacement_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Placement_updatePlacement_Response_200",
"admin-content-widgets__placement_Full",
"admin-content-widgets__PlacementBaseStatus",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"DELETE /v3/content/placements/{uuid}": {
"operation": "placement_deletePlacement",
"method": "DELETE",
"path": "/v3/content/placements/{uuid}",
"risk": "D",
"description": "Delete Placement. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific placement."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/content/regions": {
"operation": "regions_getContentRegions",
"method": "GET",
"path": "/v3/content/regions",
"risk": "R",
"description": "List Theme Regions. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"template_file": {
"type": "string",
"maxLength": 262144,
"description": "The template file, for example: `templateFile=pages/home`."
},
"channel_id": {
"type": "string",
"maxLength": 262144,
"description": "The channel ID."
}
},
"required": [
"template_file"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "template_file",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Regions_getContentRegions_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Regions_getContentRegions_Response_200",
"admin-content-widgets__themeRegion",
"admin-content-widgets__Meta"
]
},
"GET /v3/content/widgets": {
"operation": "widget_getWidgets",
"method": "GET",
"path": "/v3/content/widgets",
"risk": "R",
"description": "List Widgets. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"widget_template_kind": {
"type": "string",
"maxLength": 262144,
"description": "The kind of widget template."
},
"widget_template_uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific widget template."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "The URL-encoded name of the widget."
},
"name:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Use to pass in comma-separated list of widget names. Example: `/widgets?name:in=test-widget-name,header%20images`"
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of channel ids to filter the results by."
},
"site_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of site IDs to filter the results by."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "widget_template_kind",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "widget_template_uuid",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "site_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_getWidgets_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_getWidgets_Response_200",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__metaCollection",
"admin-content-widgets__pagination",
"admin-content-widgets__PaginationLinks"
]
},
"POST /v3/content/widgets": {
"operation": "widget_createWidget",
"method": "POST",
"path": "/v3/content/widgets",
"risk": "H",
"description": "Create Widget. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-widgets__widget_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__widget_Post",
"admin-content-widgets__WidgetPostWidgetConfiguration"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_createWidget_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_createWidget_Response_200",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"GET /v3/content/widgets/{uuid}": {
"operation": "widget_getWidget",
"method": "GET",
"path": "/v3/content/widgets/{uuid}",
"risk": "R",
"description": "Get Widget. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific widget."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_getWidget_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_getWidget_Response_200",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"PUT /v3/content/widgets/{uuid}": {
"operation": "widget_updateWidget",
"method": "PUT",
"path": "/v3/content/widgets/{uuid}",
"risk": "H",
"description": "Update Widget. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific widget."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-widgets__widget_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__widget_Put",
"admin-content-widgets__WidgetBaseWidgetConfiguration"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_updateWidget_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_updateWidget_Response_200",
"admin-content-widgets__widget_Full",
"admin-content-widgets__WidgetBaseWidgetConfiguration",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"DELETE /v3/content/widgets/{uuid}": {
"operation": "widget_deleteWidget",
"method": "DELETE",
"path": "/v3/content/widgets/{uuid}",
"risk": "D",
"description": "Delete Widget. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific widget."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/content/widget-templates": {
"operation": "widgetTemplate_getWidgetTemplates",
"method": "GET",
"path": "/v3/content/widget-templates",
"risk": "R",
"description": "List Widget Templates. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"widget_template_kind": {
"type": "string",
"maxLength": 262144,
"description": "The kind of widget template."
},
"channel_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "A comma-separated list of channel ids to filter the results by."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "widget_template_kind",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "channel_id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_Template_getWidgetTemplates_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_Template_getWidgetTemplates_Response_200",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__metaCollection",
"admin-content-widgets__pagination",
"admin-content-widgets__PaginationLinks"
]
},
"POST /v3/content/widget-templates": {
"operation": "widgetTemplate_createWidgetTemplate",
"method": "POST",
"path": "/v3/content/widget-templates",
"risk": "H",
"description": "Create Widget Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-content-widgets__widgetTemplate_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__widgetTemplate_Post",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_Template_createWidgetTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_Template_createWidgetTemplate_Response_200",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"POST /v3/content/widget-templates/{uuid}/preview": {
"operation": "widgetTemplate_previewWidget",
"method": "POST",
"path": "/v3/content/widget-templates/{uuid}/preview",
"risk": "H",
"description": "Render Widget Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific template."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-widgets__WidgetTemplatePreview"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__WidgetTemplatePreview",
"admin-content-widgets__WidgetTemplatePreviewWidgetConfiguration"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__WidgetTemplatePreviewResponse"
}
},
"response_definitions": [
"admin-content-widgets__WidgetTemplatePreviewResponse",
"admin-content-widgets__WidgetTemplatePreviewResponseData"
]
},
"GET /v3/content/widget-templates/{uuid}": {
"operation": "widgetTemplate_getWidgetTemplate",
"method": "GET",
"path": "/v3/content/widget-templates/{uuid}",
"risk": "R",
"description": "Get Widget Template. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific template."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"version_uuid": {
"type": "string",
"maxLength": 262144,
"description": "This is an optional query parameter used to fetch a specific widget template version."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "version_uuid",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_Template_getWidgetTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_Template_getWidgetTemplate_Response_200",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"PUT /v3/content/widget-templates/{uuid}": {
"operation": "widgetTemplate_updateWidgetTemplate",
"method": "PUT",
"path": "/v3/content/widget-templates/{uuid}",
"risk": "H",
"description": "Update Widget Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific template."
}
},
"required": [
"uuid"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-content-widgets__widgetTemplate_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-content-widgets__widgetTemplate_Put",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional"
],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-content-widgets__Widget_Template_updateWidgetTemplate_Response_200"
}
},
"response_definitions": [
"admin-content-widgets__Widget_Template_updateWidgetTemplate_Response_200",
"admin-content-widgets__widgetTemplate_Full",
"admin-content-widgets__widgetSchema",
"admin-content-widgets__WidgetSchemaItems",
"admin-content-widgets__widgetSchemaTab",
"admin-content-widgets__WidgetSchemaTabType",
"admin-content-widgets__WidgetSchemaTabSectionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsType",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaTabSectionsItemsSettingsItemsConditional",
"admin-content-widgets__widgetSchemaArray",
"admin-content-widgets__WidgetSchemaArrayType",
"admin-content-widgets__WidgetSchemaArrayThumbnail",
"admin-content-widgets__WidgetSchemaArraySchemaItems",
"admin-content-widgets__widgetSchemaHidden",
"admin-content-widgets__WidgetSchemaHiddenType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsType",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMeta",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsTypeMetaSelectOptionsItems",
"admin-content-widgets__WidgetSchemaHiddenSettingsItemsConditional",
"admin-content-widgets__Meta"
]
},
"DELETE /v3/content/widget-templates/{uuid}": {
"operation": "widgetTemplate_deleteWidgetTemplate",
"method": "DELETE",
"path": "/v3/content/widget-templates/{uuid}",
"risk": "D",
"description": "Delete Widget Template. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-content-widgets.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"maxLength": 262144,
"description": "The identifier for a specific template."
}
},
"required": [
"uuid"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "uuid",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/abandoned-carts/{token}": {
"operation": "abandonedCarts_getAbandonedCart",
"method": "GET",
"path": "/v3/abandoned-carts/{token}",
"risk": "R",
"description": "Get Abandoned Cart. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-abandoned-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"token": {
"type": "string",
"maxLength": 262144,
"description": "Unique cart `UUID`.\n\nUnique cart `UUID` token that is generated for abandoned cart emails."
}
},
"required": [
"token"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "token",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-abandoned-carts__Abandoned_Carts_getAbandonedCart_Response_200"
}
},
"response_definitions": [
"admin-management-abandoned-carts__Abandoned_Carts_getAbandonedCart_Response_200",
"admin-management-abandoned-carts__abandonedCartInfo_Full",
"admin-management-abandoned-carts__metaEmpty_Full"
]
},
"GET /v3/abandoned-carts/settings": {
"operation": "abandonedCartsSettings_getGlobalAbandonedCartSettings",
"method": "GET",
"path": "/v3/abandoned-carts/settings",
"risk": "R",
"description": "Get Global Abandoned Cart Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-abandoned-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-abandoned-carts__GlobalAbandonedCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-abandoned-carts__GlobalAbandonedCartSettingsResponse",
"admin-management-abandoned-carts__AbandonedCartSettings",
"admin-management-abandoned-carts__AbandonedCartSettingsMerchantAbandonedCartEmailFrequencyType",
"admin-management-abandoned-carts__metaEmpty_Full"
]
},
"PUT /v3/abandoned-carts/settings": {
"operation": "abandonedCartsSettings_updateGlobalAbandonedCartSettings",
"method": "PUT",
"path": "/v3/abandoned-carts/settings",
"risk": "H",
"description": "Update Global Abandoned Cart Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-abandoned-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-abandoned-carts__GlobalAbandonedCartSettingsRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-abandoned-carts__GlobalAbandonedCartSettingsRequest",
"admin-management-abandoned-carts__GlobalAbandonedCartSettingsRequestMerchantAbandonedCartEmailFrequencyType"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-abandoned-carts__GlobalAbandonedCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-abandoned-carts__GlobalAbandonedCartSettingsResponse",
"admin-management-abandoned-carts__AbandonedCartSettings",
"admin-management-abandoned-carts__AbandonedCartSettingsMerchantAbandonedCartEmailFrequencyType",
"admin-management-abandoned-carts__metaEmpty_Full"
]
},
"GET /v3/abandoned-carts/settings/channels/{channel_id}": {
"operation": "abandonedCartsSettings_getChannelAbandonedCartSettings",
"method": "GET",
"path": "/v3/abandoned-carts/settings/channels/{channel_id}",
"risk": "R",
"description": "Get Channel Abandoned Cart Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-abandoned-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The channel ID of the settings overrides"
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-abandoned-carts__ChannelAbandonedCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-abandoned-carts__ChannelAbandonedCartSettingsResponse",
"admin-management-abandoned-carts__ChannelAbandonedCartSettings",
"admin-management-abandoned-carts__ChannelAbandonedCartSettingsMerchantAbandonedCartEmailFrequencyType",
"admin-management-abandoned-carts__metaEmpty_Full"
]
},
"PUT /v3/abandoned-carts/settings/channels/{channel_id}": {
"operation": "abandonedCartsSettings_updateChannelAbandonedCartSettings",
"method": "PUT",
"path": "/v3/abandoned-carts/settings/channels/{channel_id}",
"risk": "H",
"description": "Update Channel Abandoned Cart Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-abandoned-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The channel ID of the settings overrides"
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-abandoned-carts__ChannelAbandonedCartSettingsRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-abandoned-carts__ChannelAbandonedCartSettingsRequest",
"admin-management-abandoned-carts__ChannelAbandonedCartSettingsRequestMerchantAbandonedCartEmailFrequencyType"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-abandoned-carts__ChannelAbandonedCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-abandoned-carts__ChannelAbandonedCartSettingsResponse",
"admin-management-abandoned-carts__ChannelAbandonedCartSettings",
"admin-management-abandoned-carts__ChannelAbandonedCartSettingsMerchantAbandonedCartEmailFrequencyType",
"admin-management-abandoned-carts__metaEmpty_Full"
]
},
"GET /v3/carts/metafields": {
"operation": "batchMetafields_getCartsMetafields",
"method": "GET",
"path": "/v3/carts/metafields",
"risk": "R",
"description": "List Cart Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"key:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"namespace:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter"
},
"direction": {
"$ref": "#/$defs/admin-management-carts__CartsMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.'\n"
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.'\n"
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the minimum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.'\n"
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.'\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsMetafieldsGetParametersDirection",
"admin-management-carts__CartsMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponse_Batch"
}
},
"response_definitions": [
"admin-management-carts__MetaFieldCollectionResponse_Batch",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType",
"admin-management-carts__CollectionMeta",
"admin-management-carts__CollectionMetaPagination",
"admin-management-carts__CollectionMetaPaginationLinks"
]
},
"POST /v3/carts/metafields": {
"operation": "batchMetafields_createCartsMetafields",
"method": "POST",
"path": "/v3/carts/metafields",
"risk": "H",
"description": "Create Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsMetafieldsPostRequestBodyContentApplicationJsonSchemaItems",
"admin-management-carts__CartsMetafieldsPostRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponse_Batch_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-management-carts__MetaFieldCollectionResponse_Batch_POST_PUT",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType",
"admin-management-carts__WriteCollectionPartialSuccessMeta",
"admin-management-carts__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-management-carts__Error",
"admin-management-carts__ErrorDetail"
]
},
"PUT /v3/carts/metafields": {
"operation": "batchMetafields_updateCartsMetafields",
"method": "PUT",
"path": "/v3/carts/metafields",
"risk": "H",
"description": "Update Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsMetafieldsPutRequestBodyContentApplicationJsonSchemaItems",
"admin-management-carts__CartsMetafieldsPutRequestBodyContentApplicationJsonSchemaItemsPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponse_Batch_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-management-carts__MetaFieldCollectionResponse_Batch_POST_PUT",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType",
"admin-management-carts__WriteCollectionPartialSuccessMeta",
"admin-management-carts__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-management-carts__Error",
"admin-management-carts__ErrorDetail"
]
},
"DELETE /v3/carts/metafields": {
"operation": "batchMetafields_deleteCartsMetafields",
"method": "DELETE",
"path": "/v3/carts/metafields",
"risk": "D",
"description": "Delete Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionDeleteResponseSuccess"
},
"422": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponsePartialSuccess_DELETE"
}
},
"response_definitions": [
"admin-management-carts__MetaFieldCollectionDeleteResponseSuccess",
"admin-management-carts__WriteCollectionSuccessMeta",
"admin-management-carts__MetaFieldCollectionResponsePartialSuccess_DELETE",
"admin-management-carts__Error",
"admin-management-carts__ErrorDetail",
"admin-management-carts__WriteCollectionPartialSuccessMeta"
]
},
"POST /v3/carts": {
"operation": "cartsSingle_createCart",
"method": "POST",
"path": "/v3/carts",
"risk": "H",
"description": "Create Cart. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsPostParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts.\n* `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.\n* `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.\n* `line_items.physical_items.stock_position`: Returns backorder and stock availability details for physical items.\n* `line_items.digital_items.stock_position`: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.\n* `promotions.banners`: Returns a list of eligible banners."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__CartCreatePostData"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsPostParametersIncludeSchemaItems",
"admin-management-carts__CartCreatePostData",
"admin-management-carts__CartCreatePostDataLineItemsItems",
"admin-management-carts__cart_PostVariant",
"admin-management-carts__CartPostVariantGiftWrapping",
"admin-management-carts__CartPostVariantGiftWrappingWrapDetailsItems",
"admin-management-carts__cart_PostModifier",
"admin-management-carts__CartPostModifierOptionSelectionsItems",
"admin-management-carts__cart_PostCustomItem",
"admin-management-carts__CartPostCustomItemItems",
"admin-management-carts__CartCreatePostDataGiftCertificatesItems",
"admin-management-carts__CartCreatePostDataGiftCertificatesItemsTheme",
"admin-management-carts__CartCreatePostDataGiftCertificatesItemsSender",
"admin-management-carts__CartCreatePostDataGiftCertificatesItemsRecipient",
"admin-management-carts__CartCreatePostDataCurrency"
],
"wire": [
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-carts__Carts__Single__createCart_Response_201"
}
},
"response_definitions": [
"admin-management-carts__Carts__Single__createCart_Response_201",
"admin-management-carts__Cart_Full",
"admin-management-carts__CartFullCurrency",
"admin-management-carts__AppliedCoupon",
"admin-management-carts__AppliedCouponCouponType",
"admin-management-carts__CartFullDiscountsItems",
"admin-management-carts__LineItemsGet",
"admin-management-carts__ItemPhysicalGet",
"admin-management-carts__ItemPhysicalGetDiscountsItems",
"admin-management-carts__ItemPhysicalGetDiscountsItemsId",
"admin-management-carts__ItemPhysicalGetCoupons",
"admin-management-carts__ItemPhysicalGetCoupons1",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1Items",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemPhysicalGetGiftWrapping",
"admin-management-carts__ItemPhysicalGetStockPosition",
"admin-management-carts__ItemDigitalGet",
"admin-management-carts__ItemDigitalGetDiscountsItems",
"admin-management-carts__ItemDigitalGetDiscountsItemsId",
"admin-management-carts__ItemDigitalGetCoupons",
"admin-management-carts__ItemDigitalGetCoupons1",
"admin-management-carts__ItemDigitalGetCouponsOneOf1Items",
"admin-management-carts__ItemDigitalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemGiftCertificateGet",
"admin-management-carts__ItemGiftCertificateGetSender",
"admin-management-carts__ItemGiftCertificateGetRecipient",
"admin-management-carts__ItemCustomGet",
"admin-management-carts__CartFullPromotions",
"admin-management-carts__CartFullPromotionsBanners",
"admin-management-carts__metaCollection_open"
]
},
"GET /v3/carts/{cartId}": {
"operation": "cartsSingle_getCart",
"method": "GET",
"path": "/v3/carts/{cartId}",
"risk": "R",
"description": "Get Cart. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cartId": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a specific cart."
}
},
"required": [
"cartId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts.\n* `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.\n* `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.\n* `line_items.physical_items.stock_position`: Returns backorder and stock availability details for physical items.\n* `line_items.digital_items.stock_position`: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.\n* `promotions.banners`: Returns a list of eligible banners."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdGetParametersIncludeSchemaItems"
],
"wire": [
{
"name": "cartId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__Carts__Single__getCart_Response_200"
}
},
"response_definitions": [
"admin-management-carts__Carts__Single__getCart_Response_200",
"admin-management-carts__Cart_Full",
"admin-management-carts__CartFullCurrency",
"admin-management-carts__AppliedCoupon",
"admin-management-carts__AppliedCouponCouponType",
"admin-management-carts__CartFullDiscountsItems",
"admin-management-carts__LineItemsGet",
"admin-management-carts__ItemPhysicalGet",
"admin-management-carts__ItemPhysicalGetDiscountsItems",
"admin-management-carts__ItemPhysicalGetDiscountsItemsId",
"admin-management-carts__ItemPhysicalGetCoupons",
"admin-management-carts__ItemPhysicalGetCoupons1",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1Items",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemPhysicalGetGiftWrapping",
"admin-management-carts__ItemPhysicalGetStockPosition",
"admin-management-carts__ItemDigitalGet",
"admin-management-carts__ItemDigitalGetDiscountsItems",
"admin-management-carts__ItemDigitalGetDiscountsItemsId",
"admin-management-carts__ItemDigitalGetCoupons",
"admin-management-carts__ItemDigitalGetCoupons1",
"admin-management-carts__ItemDigitalGetCouponsOneOf1Items",
"admin-management-carts__ItemDigitalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemGiftCertificateGet",
"admin-management-carts__ItemGiftCertificateGetSender",
"admin-management-carts__ItemGiftCertificateGetRecipient",
"admin-management-carts__ItemCustomGet",
"admin-management-carts__CartFullPromotions",
"admin-management-carts__CartFullPromotionsBanners",
"admin-management-carts__metaCollection_open"
]
},
"PUT /v3/carts/{cartId}": {
"operation": "cartsSingle_updateCart",
"method": "PUT",
"path": "/v3/carts/{cartId}",
"risk": "H",
"description": "Update Customer ID. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cartId": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a specific cart."
}
},
"required": [
"cartId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdPutParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts.\n* `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.\n* `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.\n* `line_items.physical_items.stock_position`: Returns backorder and stock availability details for physical items.\n* `line_items.digital_items.stock_position`: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.\n* `promotions.banners`: Returns a list of eligible banners."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__CartUpdatePutRequestData"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdPutParametersIncludeSchemaItems",
"admin-management-carts__CartUpdatePutRequestData"
],
"wire": [
{
"name": "cartId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-carts__Carts__Single__updateCart_Response_201"
}
},
"response_definitions": [
"admin-management-carts__Carts__Single__updateCart_Response_201",
"admin-management-carts__Cart_Full",
"admin-management-carts__CartFullCurrency",
"admin-management-carts__AppliedCoupon",
"admin-management-carts__AppliedCouponCouponType",
"admin-management-carts__CartFullDiscountsItems",
"admin-management-carts__LineItemsGet",
"admin-management-carts__ItemPhysicalGet",
"admin-management-carts__ItemPhysicalGetDiscountsItems",
"admin-management-carts__ItemPhysicalGetDiscountsItemsId",
"admin-management-carts__ItemPhysicalGetCoupons",
"admin-management-carts__ItemPhysicalGetCoupons1",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1Items",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemPhysicalGetGiftWrapping",
"admin-management-carts__ItemPhysicalGetStockPosition",
"admin-management-carts__ItemDigitalGet",
"admin-management-carts__ItemDigitalGetDiscountsItems",
"admin-management-carts__ItemDigitalGetDiscountsItemsId",
"admin-management-carts__ItemDigitalGetCoupons",
"admin-management-carts__ItemDigitalGetCoupons1",
"admin-management-carts__ItemDigitalGetCouponsOneOf1Items",
"admin-management-carts__ItemDigitalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemGiftCertificateGet",
"admin-management-carts__ItemGiftCertificateGetSender",
"admin-management-carts__ItemGiftCertificateGetRecipient",
"admin-management-carts__ItemCustomGet",
"admin-management-carts__CartFullPromotions",
"admin-management-carts__CartFullPromotionsBanners",
"admin-management-carts__metaCollection_open"
]
},
"DELETE /v3/carts/{cartId}": {
"operation": "cartsSingle_deleteCart",
"method": "DELETE",
"path": "/v3/carts/{cartId}",
"risk": "D",
"description": "Delete Cart. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cartId": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a specific cart."
}
},
"required": [
"cartId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "cartId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"POST /v3/carts/{cartId}/items": {
"operation": "items_addCartLineItems",
"method": "POST",
"path": "/v3/carts/{cartId}/items",
"risk": "H",
"description": "Add Cart Line Items. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cartId": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a specific cart."
}
},
"required": [
"cartId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdItemsPostParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts.\n* `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.\n* `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.\n* `line_items.physical_items.stock_position`: Returns backorder and stock availability details for physical items.\n* `line_items.digital_items.stock_position`: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.\n* `promotions.banners`: Returns a list of eligible banners."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__Cart_Line_Item_Update_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdItemsPostParametersIncludeSchemaItems",
"admin-management-carts__Cart_Line_Item_Update_Post",
"admin-management-carts__CartLineItemUpdatePostLineItems",
"admin-management-carts__CartLineItemUpdatePostLineItems0",
"admin-management-carts__cart_PostVariant",
"admin-management-carts__CartPostVariantGiftWrapping",
"admin-management-carts__CartPostVariantGiftWrappingWrapDetailsItems",
"admin-management-carts__CartLineItemUpdatePostLineItems1",
"admin-management-carts__cart_PostModifier",
"admin-management-carts__CartPostModifierOptionSelectionsItems",
"admin-management-carts__CartLineItemUpdatePostGiftCertificatesItems",
"admin-management-carts__CartLineItemUpdatePostGiftCertificatesItemsTheme",
"admin-management-carts__CartLineItemUpdatePostGiftCertificatesItemsSender",
"admin-management-carts__CartLineItemUpdatePostGiftCertificatesItemsRecipient",
"admin-management-carts__cart_PostCustomItem",
"admin-management-carts__CartPostCustomItemItems"
],
"wire": [
{
"name": "cartId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-carts__Items_addCartLineItems_Response_201"
}
},
"response_definitions": [
"admin-management-carts__Items_addCartLineItems_Response_201",
"admin-management-carts__Cart_Full",
"admin-management-carts__CartFullCurrency",
"admin-management-carts__AppliedCoupon",
"admin-management-carts__AppliedCouponCouponType",
"admin-management-carts__CartFullDiscountsItems",
"admin-management-carts__LineItemsGet",
"admin-management-carts__ItemPhysicalGet",
"admin-management-carts__ItemPhysicalGetDiscountsItems",
"admin-management-carts__ItemPhysicalGetDiscountsItemsId",
"admin-management-carts__ItemPhysicalGetCoupons",
"admin-management-carts__ItemPhysicalGetCoupons1",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1Items",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemPhysicalGetGiftWrapping",
"admin-management-carts__ItemPhysicalGetStockPosition",
"admin-management-carts__ItemDigitalGet",
"admin-management-carts__ItemDigitalGetDiscountsItems",
"admin-management-carts__ItemDigitalGetDiscountsItemsId",
"admin-management-carts__ItemDigitalGetCoupons",
"admin-management-carts__ItemDigitalGetCoupons1",
"admin-management-carts__ItemDigitalGetCouponsOneOf1Items",
"admin-management-carts__ItemDigitalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemGiftCertificateGet",
"admin-management-carts__ItemGiftCertificateGetSender",
"admin-management-carts__ItemGiftCertificateGetRecipient",
"admin-management-carts__ItemCustomGet",
"admin-management-carts__CartFullPromotions",
"admin-management-carts__CartFullPromotionsBanners",
"admin-management-carts__metaCollection_open"
]
},
"PUT /v3/carts/{cartId}/items/{itemId}": {
"operation": "items_updateCartLineItem",
"method": "PUT",
"path": "/v3/carts/{cartId}/items/{itemId}",
"risk": "H",
"description": "Update Cart Line Item. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cartId": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a specific cart."
},
"itemId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the line item."
}
},
"required": [
"cartId",
"itemId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdItemsItemIdPutParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts.\n* `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.\n* `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.\n* `line_items.physical_items.stock_position`: Returns backorder and stock availability details for physical items.\n* `line_items.digital_items.stock_position`: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.\n* `promotions.banners`: Returns a list of eligible banners."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__Cart_Line_Item_Update_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdItemsItemIdPutParametersIncludeSchemaItems",
"admin-management-carts__Cart_Line_Item_Update_Put",
"admin-management-carts__CartLineItemUpdatePutLineItem",
"admin-management-carts__cart_PostVariant",
"admin-management-carts__CartPostVariantGiftWrapping",
"admin-management-carts__CartPostVariantGiftWrappingWrapDetailsItems",
"admin-management-carts__cart_PostModifier",
"admin-management-carts__CartPostModifierOptionSelectionsItems",
"admin-management-carts__CartLineItemUpdatePutGiftCertificatesItems",
"admin-management-carts__CartLineItemUpdatePutGiftCertificatesItemsTheme",
"admin-management-carts__CartLineItemUpdatePutGiftCertificatesItemsSender",
"admin-management-carts__CartLineItemUpdatePutGiftCertificatesItemsRecipient",
"admin-management-carts__cart_PostCustomItem",
"admin-management-carts__CartPostCustomItemItems"
],
"wire": [
{
"name": "cartId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "itemId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__Items_updateCartLineItem_Response_200"
}
},
"response_definitions": [
"admin-management-carts__Items_updateCartLineItem_Response_200",
"admin-management-carts__Cart_Full",
"admin-management-carts__CartFullCurrency",
"admin-management-carts__AppliedCoupon",
"admin-management-carts__AppliedCouponCouponType",
"admin-management-carts__CartFullDiscountsItems",
"admin-management-carts__LineItemsGet",
"admin-management-carts__ItemPhysicalGet",
"admin-management-carts__ItemPhysicalGetDiscountsItems",
"admin-management-carts__ItemPhysicalGetDiscountsItemsId",
"admin-management-carts__ItemPhysicalGetCoupons",
"admin-management-carts__ItemPhysicalGetCoupons1",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1Items",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemPhysicalGetGiftWrapping",
"admin-management-carts__ItemPhysicalGetStockPosition",
"admin-management-carts__ItemDigitalGet",
"admin-management-carts__ItemDigitalGetDiscountsItems",
"admin-management-carts__ItemDigitalGetDiscountsItemsId",
"admin-management-carts__ItemDigitalGetCoupons",
"admin-management-carts__ItemDigitalGetCoupons1",
"admin-management-carts__ItemDigitalGetCouponsOneOf1Items",
"admin-management-carts__ItemDigitalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemGiftCertificateGet",
"admin-management-carts__ItemGiftCertificateGetSender",
"admin-management-carts__ItemGiftCertificateGetRecipient",
"admin-management-carts__ItemCustomGet",
"admin-management-carts__CartFullPromotions",
"admin-management-carts__CartFullPromotionsBanners",
"admin-management-carts__metaCollection_open"
]
},
"DELETE /v3/carts/{cartId}/items/{itemId}": {
"operation": "items_deleteCartLineItem",
"method": "DELETE",
"path": "/v3/carts/{cartId}/items/{itemId}",
"risk": "D",
"description": "Delete Cart Line Item. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cartId": {
"type": "string",
"maxLength": 262144,
"description": "The identifier of a specific cart."
},
"itemId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the line item."
}
},
"required": [
"cartId",
"itemId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdItemsItemIdDeleteParametersIncludeSchemaItems"
},
"maxItems": 10,
"description": "* `redirect_urls`: Create a direct link to a cart. This can be used for the /POST request for carts.\n* `line_items.physical_items.options`: The cart returns an abbreviated result. Use this to return physical items product options. To return the extended cart object, use in a /POST request.\n* `line_items.digital_items.options`: The cart returns an abbreviated result. Use this to return digital items product options. To return the extended cart object, use in a /POST request.\n* `line_items.physical_items.stock_position`: Returns backorder and stock availability details for physical items.\n* `line_items.digital_items.stock_position`: Returns backorder and stock availability details for digital items. Since digital products cannot be backordered, backorder values are always zero.\n* `promotions.banners`: Returns a list of eligible banners."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__CartLineItemDelete"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdItemsItemIdDeleteParametersIncludeSchemaItems",
"admin-management-carts__CartLineItemDelete"
],
"wire": [
{
"name": "cartId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "itemId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__Cart_Full"
}
},
"response_definitions": [
"admin-management-carts__Cart_Full",
"admin-management-carts__CartFullCurrency",
"admin-management-carts__AppliedCoupon",
"admin-management-carts__AppliedCouponCouponType",
"admin-management-carts__CartFullDiscountsItems",
"admin-management-carts__LineItemsGet",
"admin-management-carts__ItemPhysicalGet",
"admin-management-carts__ItemPhysicalGetDiscountsItems",
"admin-management-carts__ItemPhysicalGetDiscountsItemsId",
"admin-management-carts__ItemPhysicalGetCoupons",
"admin-management-carts__ItemPhysicalGetCoupons1",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1Items",
"admin-management-carts__ItemPhysicalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemPhysicalGetGiftWrapping",
"admin-management-carts__ItemPhysicalGetStockPosition",
"admin-management-carts__ItemDigitalGet",
"admin-management-carts__ItemDigitalGetDiscountsItems",
"admin-management-carts__ItemDigitalGetDiscountsItemsId",
"admin-management-carts__ItemDigitalGetCoupons",
"admin-management-carts__ItemDigitalGetCoupons1",
"admin-management-carts__ItemDigitalGetCouponsOneOf1Items",
"admin-management-carts__ItemDigitalGetCouponsOneOf1ItemsDiscountType",
"admin-management-carts__ItemGiftCertificateGet",
"admin-management-carts__ItemGiftCertificateGetSender",
"admin-management-carts__ItemGiftCertificateGetRecipient",
"admin-management-carts__ItemCustomGet",
"admin-management-carts__CartFullPromotions",
"admin-management-carts__CartFullPromotionsBanners"
]
},
"GET /v3/carts/{cart_id}/metafields": {
"operation": "metafields_getCartMetafields",
"method": "GET",
"path": "/v3/carts/{cart_id}/metafields",
"risk": "R",
"description": "List Cart Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the `Cart` to which the transactions belong."
}
},
"required": [
"cart_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"direction": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdMetafieldsGetParametersDirection"
],
"wire": [
{
"name": "cart_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetafieldResponse"
}
},
"response_definitions": [
"admin-management-carts__MetafieldResponse",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType"
]
},
"POST /v3/carts/{cart_id}/metafields": {
"operation": "metafields_createCartMetafield",
"method": "POST",
"path": "/v3/carts/{cart_id}/metafields",
"risk": "H",
"description": "Create Cart Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the `Cart` to which the transactions belong."
}
},
"required": [
"cart_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__MetafieldBase_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__MetafieldBase_Post",
"admin-management-carts__MetafieldBasePostPermissionSet"
],
"wire": [
{
"name": "cart_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponse"
}
},
"response_definitions": [
"admin-management-carts__MetaFieldCollectionResponse",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType",
"admin-management-carts__metaCollection_open"
]
},
"GET /v3/carts/{cart_id}/metafields/{metafield_id}": {
"operation": "metafields_getCartMetafield",
"method": "GET",
"path": "/v3/carts/{cart_id}/metafields/{metafield_id}",
"risk": "R",
"description": "Get Cart Metafield. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the `Cart` to which the transactions belong."
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The unique ID of the subject `Metafield`."
}
},
"required": [
"cart_id",
"metafield_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespaces."
},
"direction": {
"$ref": "#/$defs/admin-management-carts__CartsCartIdMetafieldsMetafieldIdGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__CartsCartIdMetafieldsMetafieldIdGetParametersDirection"
],
"wire": [
{
"name": "cart_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetafieldResponse"
}
},
"response_definitions": [
"admin-management-carts__MetafieldResponse",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType"
]
},
"PUT /v3/carts/{cart_id}/metafields/{metafield_id}": {
"operation": "metafields_updateCartMetafield",
"method": "PUT",
"path": "/v3/carts/{cart_id}/metafields/{metafield_id}",
"risk": "H",
"description": "Update Cart Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the `Cart` to which the transactions belong."
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The unique ID of the subject `Metafield`."
}
},
"required": [
"cart_id",
"metafield_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__MetafieldBase_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__MetafieldBase_Post",
"admin-management-carts__MetafieldBasePostPermissionSet"
],
"wire": [
{
"name": "cart_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponse"
},
"422": {
"$ref": "#/$defs/admin-management-carts__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-management-carts__MetaFieldCollectionResponse",
"admin-management-carts__Metafield",
"admin-management-carts__MetafieldBasePermissionSet",
"admin-management-carts__MetafieldBaseResourceType",
"admin-management-carts__metaCollection_open",
"admin-management-carts__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-management-carts__Error",
"admin-management-carts__ErrorDetail",
"admin-management-carts__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/carts/{cart_id}/metafields/{metafield_id}": {
"operation": "metafields_deleteCartMetafield",
"method": "DELETE",
"path": "/v3/carts/{cart_id}/metafields/{metafield_id}",
"risk": "D",
"description": "Delete Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the `Cart` to which the transactions belong."
},
"metafield_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The unique ID of the subject `Metafield`."
}
},
"required": [
"cart_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "cart_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/carts/settings": {
"operation": "settings_getGlobalCartSettings",
"method": "GET",
"path": "/v3/carts/settings",
"risk": "R",
"description": "Get Global Cart Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__GlobalCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-carts__GlobalCartSettingsResponse",
"admin-management-carts__CartSettings",
"admin-management-carts__metaCollection_open"
]
},
"PUT /v3/carts/settings": {
"operation": "settings_updateGlobalCartSettings",
"method": "PUT",
"path": "/v3/carts/settings",
"risk": "H",
"description": "Update Global Cart Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-carts__GlobalCartSettingsRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__GlobalCartSettingsRequest"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__GlobalCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-carts__GlobalCartSettingsResponse",
"admin-management-carts__CartSettings",
"admin-management-carts__metaCollection_open"
]
},
"GET /v3/carts/settings/channels/{channel_id}": {
"operation": "settings_getChannelCartSettings",
"method": "GET",
"path": "/v3/carts/settings/channels/{channel_id}",
"risk": "R",
"description": "Get Channel Cart Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The channel ID of the settings overrides.\n\n### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|Information & Settings | modify | `store_v2_information`|\n|Information & Settings | read-only| `store_v2_information`|"
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__ChannelCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-carts__ChannelCartSettingsResponse",
"admin-management-carts__ChannelCartSettings",
"admin-management-carts__metaCollection_open"
]
},
"PUT /v3/carts/settings/channels/{channel_id}": {
"operation": "settings_updateChannelCartSettings",
"method": "PUT",
"path": "/v3/carts/settings/channels/{channel_id}",
"risk": "H",
"description": "Update Channel Cart Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-carts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The channel ID of the settings overrides.\n\n### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|Information & Settings | modify | `store_v2_information`|\n|Information & Settings | read-only| `store_v2_information`|"
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-carts__ChannelCartSettingsRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-carts__ChannelCartSettingsRequest"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-carts__ChannelCartSettingsResponse"
}
},
"response_definitions": [
"admin-management-carts__ChannelCartSettingsResponse",
"admin-management-carts__ChannelCartSettings",
"admin-management-carts__metaCollection_open"
]
},
"GET /v3/channels": {
"operation": "channels_getChannels",
"method": "GET",
"path": "/v3/channels",
"risk": "R",
"description": "List Channels. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/admin-management-channels__ChannelsGetParametersInclude",
"description": "Channels subresources that can be included in the response."
},
"available": {
"type": "boolean",
"description": "Filter items based on whether the channel is currently available for integration. Setting this query parameter to `true` will return channels with the status of `prelaunch`, `active` , `inactive`, and `connected`. Setting this query parameter to `false` will return channels with the status of `disconnected`, `archived`, `deleted`, and `terminated`."
},
"status:in": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-channels__ChannelsGetParametersStatusInSchemaItems"
},
"maxItems": 100,
"description": "Filter items by a comma-separated list of statuses."
},
"type:in": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-channels__ChannelsGetParametersTypeInSchemaItems"
},
"maxItems": 100,
"description": "Filter items by a comma-separated list of types."
},
"platform:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by a comma-separated list of platforms. For a list of supported platforms, see [Platform](/developer/api-reference/rest/admin/management/channels#platform)."
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created after this date."
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created before this date."
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified after this date."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified before this date."
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page for paginated responses."
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number for a paginated response."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__ChannelsGetParametersInclude",
"admin-management-channels__ChannelsGetParametersStatusInSchemaItems",
"admin-management-channels__ChannelsGetParametersTypeInSchemaItems"
],
"wire": [
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "available",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "status:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "platform:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Channels_getChannels_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Channels_getChannels_Response_200",
"admin-management-channels__ChannelWithoutCurrencies",
"admin-management-channels__ChannelId",
"admin-management-channels__ExternalId",
"admin-management-channels__IsListableFromUI",
"admin-management-channels__IsVisible",
"admin-management-channels__ChannelStatus",
"admin-management-channels__ChannelName",
"admin-management-channels__ChannelType",
"admin-management-channels__ChannelPlatform",
"admin-management-channels__ChannelDateCreated",
"admin-management-channels__ChannelDateModified",
"admin-management-channels__IconUrl",
"admin-management-channels__MetaWithFullPagination",
"admin-management-channels__pagination_Full",
"admin-management-channels__PaginationFullLinks"
]
},
"POST /v3/channels": {
"operation": "channels_createChannel",
"method": "POST",
"path": "/v3/channels",
"risk": "H",
"description": "Create Channel. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-channels__CreateChannelReq"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__CreateChannelReq",
"admin-management-channels__ExternalId",
"admin-management-channels__IsListableFromUI",
"admin-management-channels__IsVisible",
"admin-management-channels__ChannelStatus",
"admin-management-channels__ChannelName",
"admin-management-channels__ChannelType",
"admin-management-channels__ChannelPlatform"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Channels_createChannel_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Channels_createChannel_Response_200",
"admin-management-channels__ChannelWithoutCurrencies",
"admin-management-channels__ChannelId",
"admin-management-channels__ExternalId",
"admin-management-channels__IsListableFromUI",
"admin-management-channels__IsVisible",
"admin-management-channels__ChannelStatus",
"admin-management-channels__ChannelName",
"admin-management-channels__ChannelType",
"admin-management-channels__ChannelPlatform",
"admin-management-channels__ChannelDateCreated",
"admin-management-channels__ChannelDateModified",
"admin-management-channels__IconUrl",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}": {
"operation": "channels_getChannel",
"method": "GET",
"path": "/v3/channels/{channel_id}",
"risk": "R",
"description": "Get Channel. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/admin-management-channels__ChannelsChannelIdGetParametersInclude",
"description": "Channels subresources that can be included in the response."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__ChannelsChannelIdGetParametersInclude"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Channels_getChannel_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Channels_getChannel_Response_200",
"admin-management-channels__ChannelWithCurrencies",
"admin-management-channels__ChannelId",
"admin-management-channels__ExternalId",
"admin-management-channels__IsListableFromUI",
"admin-management-channels__IsVisible",
"admin-management-channels__ChannelStatus",
"admin-management-channels__ChannelName",
"admin-management-channels__ChannelType",
"admin-management-channels__ChannelPlatform",
"admin-management-channels__ChannelDateCreated",
"admin-management-channels__ChannelDateModified",
"admin-management-channels__IconUrl",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"PUT /v3/channels/{channel_id}": {
"operation": "channels_updateChannel",
"method": "PUT",
"path": "/v3/channels/{channel_id}",
"risk": "H",
"description": "Update Channel. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__UpdateChannelReq"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__UpdateChannelReq",
"admin-management-channels__ExternalId",
"admin-management-channels__IsListableFromUI",
"admin-management-channels__IsVisible",
"admin-management-channels__ChannelName",
"admin-management-channels__ChannelStatus"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Channels_updateChannel_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Channels_updateChannel_Response_200",
"admin-management-channels__ChannelWithoutCurrencies",
"admin-management-channels__ChannelId",
"admin-management-channels__ExternalId",
"admin-management-channels__IsListableFromUI",
"admin-management-channels__IsVisible",
"admin-management-channels__ChannelStatus",
"admin-management-channels__ChannelName",
"admin-management-channels__ChannelType",
"admin-management-channels__ChannelPlatform",
"admin-management-channels__ChannelDateCreated",
"admin-management-channels__ChannelDateModified",
"admin-management-channels__IconUrl",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}/active-theme": {
"operation": "activeTheme_getChannelActiveTheme",
"method": "GET",
"path": "/v3/channels/{channel_id}/active-theme",
"risk": "R",
"description": "Get Channel Active Theme. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Active_Theme_getChannelActiveTheme_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Active_Theme_getChannelActiveTheme_Response_200",
"admin-management-channels__ActiveTheme",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/metafields": {
"operation": "batchMetafields_getChannelsMetafields",
"method": "GET",
"path": "/v3/channels/metafields",
"risk": "R",
"description": "List Channel Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key.\n"
},
"key:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter."
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespace."
},
"namespace:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter."
},
"direction": {
"$ref": "#/$defs/admin-management-channels__ChannelsMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`."
},
"include_fields": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-channels__ChannelsMetafieldsGetParametersIncludeFieldsSchemaItems"
},
"maxItems": 100,
"description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified after this date."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified before this date."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created after this date."
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created before this date."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__ChannelsMetafieldsGetParametersDirection",
"admin-management-channels__ChannelsMetafieldsGetParametersIncludeFieldsSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include_fields",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__MetaFieldCollectionResponse"
}
},
"response_definitions": [
"admin-management-channels__MetaFieldCollectionResponse",
"admin-management-channels__Metafield",
"admin-management-channels__MetafieldPermissionSet",
"admin-management-channels__MetafieldResourceType",
"admin-management-channels__CollectionMeta",
"admin-management-channels__CollectionMetaPagination",
"admin-management-channels__CollectionMetaPaginationLinks"
]
},
"POST /v3/channels/metafields": {
"operation": "batchMetafields_createChannelsMetafields",
"method": "POST",
"path": "/v3/channels/metafields",
"risk": "H",
"description": "Create Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [
[
"errors"
]
],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-channels__MetafieldPost"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__MetafieldPost",
"admin-management-channels__MetafieldBasePostPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__MetaFieldCollectionResponse_POST_PUT"
}
},
"response_definitions": [
"admin-management-channels__MetaFieldCollectionResponse_POST_PUT",
"admin-management-channels__Metafield",
"admin-management-channels__MetafieldPermissionSet",
"admin-management-channels__MetafieldResourceType",
"admin-management-channels__CollectionMeta",
"admin-management-channels__CollectionMetaPagination",
"admin-management-channels__CollectionMetaPaginationLinks"
]
},
"PUT /v3/channels/metafields": {
"operation": "batchMetafields_updateChannelsMetafields",
"method": "PUT",
"path": "/v3/channels/metafields",
"risk": "H",
"description": "Update Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-channels__MetafieldPut"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__MetafieldPut",
"admin-management-channels__MetafieldBasePutPermissionSet"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__MetaFieldCollectionResponse_POST_PUT"
},
"422": {
"$ref": "#/$defs/admin-management-channels__MetaFieldCollectionResponsePartialSuccess_POST_PUT"
}
},
"response_definitions": [
"admin-management-channels__MetaFieldCollectionResponse_POST_PUT",
"admin-management-channels__Metafield",
"admin-management-channels__MetafieldPermissionSet",
"admin-management-channels__MetafieldResourceType",
"admin-management-channels__CollectionMeta",
"admin-management-channels__CollectionMetaPagination",
"admin-management-channels__CollectionMetaPaginationLinks",
"admin-management-channels__MetaFieldCollectionResponsePartialSuccess_POST_PUT",
"admin-management-channels__Error",
"admin-management-channels__ErrorDetail",
"admin-management-channels__WriteCollectionPartialSuccessMeta"
]
},
"DELETE /v3/channels/metafields": {
"operation": "batchMetafields_deleteChannelsMetafields",
"method": "DELETE",
"path": "/v3/channels/metafields",
"risk": "D",
"description": "Delete Multiple Metafields. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__MetaFieldCollectionDeleteResponseSuccess"
},
"422": {
"$ref": "#/$defs/admin-management-channels__MetaFieldCollectionResponsePartialSuccess_DELETE"
}
},
"response_definitions": [
"admin-management-channels__MetaFieldCollectionDeleteResponseSuccess",
"admin-management-channels__WriteCollectionSuccessMeta",
"admin-management-channels__MetaFieldCollectionResponsePartialSuccess_DELETE",
"admin-management-channels__Error",
"admin-management-channels__ErrorDetail",
"admin-management-channels__WriteCollectionPartialSuccessMeta"
]
},
"GET /v3/channels/currency-assignments": {
"operation": "currencyAssignments_getAllCurrencyAssignments",
"method": "GET",
"path": "/v3/channels/currency-assignments",
"risk": "R",
"description": "List Channels Currency Assignments. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_getAllCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_getAllCurrencyAssignments_Response_200",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"POST /v3/channels/currency-assignments": {
"operation": "currencyAssignments_createMultipleChannelsCurrencyAssignments",
"method": "POST",
"path": "/v3/channels/currency-assignments",
"risk": "H",
"description": "Create Multiple Channels Currency Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-channels__UpsertMultipleChannelsCurrencyAssignmentsReq"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__UpsertMultipleChannelsCurrencyAssignmentsReq",
"admin-management-channels__CurrencyRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_createMultipleChannelsCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_createMultipleChannelsCurrencyAssignments_Response_200",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"PUT /v3/channels/currency-assignments": {
"operation": "currencyAssignments_updateMultipleChannelsCurrencyAssignments",
"method": "PUT",
"path": "/v3/channels/currency-assignments",
"risk": "H",
"description": "Update Multiple Channels Currency Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-channels__UpsertMultipleChannelsCurrencyAssignmentsReq"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__UpsertMultipleChannelsCurrencyAssignmentsReq",
"admin-management-channels__CurrencyRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_updateMultipleChannelsCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_updateMultipleChannelsCurrencyAssignments_Response_200",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}/currency-assignments": {
"operation": "currencyAssignments_getSingleChannelCurrencyAssignments",
"method": "GET",
"path": "/v3/channels/{channel_id}/currency-assignments",
"risk": "R",
"description": "List Channel Currency Assignments. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_getSingleChannelCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_getSingleChannelCurrencyAssignments_Response_200",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"POST /v3/channels/{channel_id}/currency-assignments": {
"operation": "currencyAssignments_createSingleChannelCurrencyAssignments",
"method": "POST",
"path": "/v3/channels/{channel_id}/currency-assignments",
"risk": "H",
"description": "Create Channel Currency Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__CurrencyRequiredWithoutChannelId"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__CurrencyRequiredWithoutChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_createSingleChannelCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_createSingleChannelCurrencyAssignments_Response_200",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"PUT /v3/channels/{channel_id}/currency-assignments": {
"operation": "currencyAssignments_updateSingleChannelCurrencyAssignments",
"method": "PUT",
"path": "/v3/channels/{channel_id}/currency-assignments",
"risk": "H",
"description": "Update Channel Currency Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__CurrencyRequiredWithoutChannelId"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__CurrencyRequiredWithoutChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_updateSingleChannelCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_updateSingleChannelCurrencyAssignments_Response_200",
"admin-management-channels__CurrencyNotRequiredWithChannelId",
"admin-management-channels__ChannelId",
"admin-management-channels__EnabledCurrencies",
"admin-management-channels__DefaultCurrency",
"admin-management-channels__EmptyMeta"
]
},
"DELETE /v3/channels/{channel_id}/currency-assignments": {
"operation": "currencyAssignments_deleteSingleChannelCurrencyAssignments",
"method": "DELETE",
"path": "/v3/channels/{channel_id}/currency-assignments",
"risk": "D",
"description": "Delete Channel Currency Assignments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Currency_Assignments_deleteSingleChannelCurrencyAssignments_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Currency_Assignments_deleteSingleChannelCurrencyAssignments_Response_200",
"admin-management-channels__ChannelId",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}/listings": {
"operation": "listings_getChannelListings",
"method": "GET",
"path": "/v3/channels/{channel_id}/listings",
"risk": "R",
"description": "List Channel Listings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page for paginated responses."
},
"after": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the prior listing ID in a limited (paginated) list of listings."
},
"product_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter items by a comma-separated list of product IDs."
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created after this date."
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date created. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields created before this date."
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified after this date."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date modified. For example, `date_created=2024-05-14T09:34:00` or `date_created=2024-05-14`. Returns metafields modified before this date."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "after",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "product_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Listings_getChannelListings_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Listings_getChannelListings_Response_200",
"admin-management-channels__Listing",
"admin-management-channels__ChannelIdForListing",
"admin-management-channels__ListingId",
"admin-management-channels__ExternalId",
"admin-management-channels__ProductId",
"admin-management-channels__ListingState",
"admin-management-channels__ChannelProductName",
"admin-management-channels__ChannelProductDescription",
"admin-management-channels__ChannelListingDateCreated",
"admin-management-channels__ChannelListingDateModified",
"admin-management-channels__ChannelProductVariantFull",
"admin-management-channels__VariantId",
"admin-management-channels__VariantState",
"admin-management-channels__ChannelProductVariantName",
"admin-management-channels__ChannelProductVariantDescription",
"admin-management-channels__ChannelListingVariantDateCreated",
"admin-management-channels__ChannelListingVariantDateModified",
"admin-management-channels__MetaWithPartialPagination",
"admin-management-channels__pagination_Partial",
"admin-management-channels__PaginationPartialLinks"
]
},
"POST /v3/channels/{channel_id}/listings": {
"operation": "listings_createChannelListings",
"method": "POST",
"path": "/v3/channels/{channel_id}/listings",
"risk": "H",
"description": "Create Channel Listings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__CreateMultipleListingsReq"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__CreateMultipleListingsReq",
"admin-management-channels__UpsertListingWithoutListingIdReq",
"admin-management-channels__ProductId",
"admin-management-channels__ExternalId",
"admin-management-channels__ListingState",
"admin-management-channels__ChannelProductName",
"admin-management-channels__ChannelProductDescription",
"admin-management-channels__ChannelProductMultipleVariants",
"admin-management-channels__ChannelProductVariantPartial",
"admin-management-channels__VariantId",
"admin-management-channels__VariantState",
"admin-management-channels__ChannelProductVariantName",
"admin-management-channels__ChannelProductVariantDescription"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Listings_createChannelListings_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Listings_createChannelListings_Response_200",
"admin-management-channels__Listing",
"admin-management-channels__ChannelIdForListing",
"admin-management-channels__ListingId",
"admin-management-channels__ExternalId",
"admin-management-channels__ProductId",
"admin-management-channels__ListingState",
"admin-management-channels__ChannelProductName",
"admin-management-channels__ChannelProductDescription",
"admin-management-channels__ChannelListingDateCreated",
"admin-management-channels__ChannelListingDateModified",
"admin-management-channels__ChannelProductVariantFull",
"admin-management-channels__VariantId",
"admin-management-channels__VariantState",
"admin-management-channels__ChannelProductVariantName",
"admin-management-channels__ChannelProductVariantDescription",
"admin-management-channels__ChannelListingVariantDateCreated",
"admin-management-channels__ChannelListingVariantDateModified",
"admin-management-channels__MetaWithPartialPagination",
"admin-management-channels__pagination_Partial",
"admin-management-channels__PaginationPartialLinks"
]
},
"PUT /v3/channels/{channel_id}/listings": {
"operation": "listings_updateChannelListings",
"method": "PUT",
"path": "/v3/channels/{channel_id}/listings",
"risk": "H",
"description": "Update Channel Listings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__UpdateMultipleListingsReq"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__UpdateMultipleListingsReq",
"admin-management-channels__UpsertListingWithListingIdReq",
"admin-management-channels__ListingId",
"admin-management-channels__ProductId",
"admin-management-channels__ExternalId",
"admin-management-channels__ListingState",
"admin-management-channels__ChannelProductName",
"admin-management-channels__ChannelProductDescription",
"admin-management-channels__ChannelProductMultipleVariants",
"admin-management-channels__ChannelProductVariantPartial",
"admin-management-channels__VariantId",
"admin-management-channels__VariantState",
"admin-management-channels__ChannelProductVariantName",
"admin-management-channels__ChannelProductVariantDescription"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Listings_updateChannelListings_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Listings_updateChannelListings_Response_200",
"admin-management-channels__Listing",
"admin-management-channels__ChannelIdForListing",
"admin-management-channels__ListingId",
"admin-management-channels__ExternalId",
"admin-management-channels__ProductId",
"admin-management-channels__ListingState",
"admin-management-channels__ChannelProductName",
"admin-management-channels__ChannelProductDescription",
"admin-management-channels__ChannelListingDateCreated",
"admin-management-channels__ChannelListingDateModified",
"admin-management-channels__ChannelProductVariantFull",
"admin-management-channels__VariantId",
"admin-management-channels__VariantState",
"admin-management-channels__ChannelProductVariantName",
"admin-management-channels__ChannelProductVariantDescription",
"admin-management-channels__ChannelListingVariantDateCreated",
"admin-management-channels__ChannelListingVariantDateModified",
"admin-management-channels__MetaWithPartialPagination",
"admin-management-channels__pagination_Partial",
"admin-management-channels__PaginationPartialLinks"
]
},
"GET /v3/channels/{channel_id}/listings/{listing_id}": {
"operation": "listings_getChannelListing",
"method": "GET",
"path": "/v3/channels/{channel_id}/listings/{listing_id}",
"risk": "R",
"description": "Get Channel Listing. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
},
"listing_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel listing."
}
},
"required": [
"channel_id",
"listing_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "listing_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Listings_getChannelListing_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Listings_getChannelListing_Response_200",
"admin-management-channels__Listing",
"admin-management-channels__ChannelIdForListing",
"admin-management-channels__ListingId",
"admin-management-channels__ExternalId",
"admin-management-channels__ProductId",
"admin-management-channels__ListingState",
"admin-management-channels__ChannelProductName",
"admin-management-channels__ChannelProductDescription",
"admin-management-channels__ChannelListingDateCreated",
"admin-management-channels__ChannelListingDateModified",
"admin-management-channels__ChannelProductVariantFull",
"admin-management-channels__VariantId",
"admin-management-channels__VariantState",
"admin-management-channels__ChannelProductVariantName",
"admin-management-channels__ChannelProductVariantDescription",
"admin-management-channels__ChannelListingVariantDateCreated",
"admin-management-channels__ChannelListingVariantDateModified",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}/channel-menus": {
"operation": "menus_getChannelMenus",
"method": "GET",
"path": "/v3/channels/{channel_id}/channel-menus",
"risk": "R",
"description": "List Channel Menus. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Menus_getChannelMenus_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Menus_getChannelMenus_Response_200",
"admin-management-channels__ChannelsChannelIdChannelMenusGetResponsesContentApplicationJsonSchemaData",
"admin-management-channels__BigCommerceProtectedAppSections",
"admin-management-channels__BigCommerceProtectedAppSectionsItems",
"admin-management-channels__CustomAppSections",
"admin-management-channels__CustomAppSectionsItems",
"admin-management-channels__EmptyMeta"
]
},
"POST /v3/channels/{channel_id}/channel-menus": {
"operation": "menus_createChannelMenus",
"method": "POST",
"path": "/v3/channels/{channel_id}/channel-menus",
"risk": "H",
"description": "Create Channel Menus. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__channel_menus_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__channel_menus_Post",
"admin-management-channels__BigCommerceProtectedAppSections",
"admin-management-channels__BigCommerceProtectedAppSectionsItems",
"admin-management-channels__CustomAppSections",
"admin-management-channels__CustomAppSectionsItems"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Menus_createChannelMenus_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Menus_createChannelMenus_Response_200",
"admin-management-channels__ChannelsChannelIdChannelMenusPostResponsesContentApplicationJsonSchemaData",
"admin-management-channels__BigCommerceProtectedAppSections",
"admin-management-channels__BigCommerceProtectedAppSectionsItems",
"admin-management-channels__CustomAppSections",
"admin-management-channels__CustomAppSectionsItems",
"admin-management-channels__EmptyMeta"
]
},
"DELETE /v3/channels/{channel_id}/channel-menus": {
"operation": "menus_deleteChannelMenus",
"method": "DELETE",
"path": "/v3/channels/{channel_id}/channel-menus",
"risk": "D",
"description": "Delete Channel Menus. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Menus_deleteChannelMenus_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Menus_deleteChannelMenus_Response_200",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}/metafields": {
"operation": "metafields_getChannelMetafields",
"method": "GET",
"path": "/v3/channels/{channel_id}/metafields",
"risk": "R",
"description": "List Channel Metafields. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of products.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of products.\n"
},
"key": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs key.\n"
},
"namespace": {
"type": "string",
"maxLength": 262144,
"description": "Filter based on a metafieldʼs namespace."
},
"direction": {
"$ref": "#/$defs/admin-management-channels__ChannelsChannelIdMetafieldsGetParametersDirection",
"description": "Sort direction. Acceptable values are: `asc`, `desc`."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__ChannelsChannelIdMetafieldsGetParametersDirection"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "key",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "namespace",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "direction",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Metafields_getChannelMetafields_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Metafields_getChannelMetafields_Response_200",
"admin-management-channels__metafield_Base",
"admin-management-channels__MetafieldBasePermissionSet",
"admin-management-channels__MetafieldBaseResourceType",
"admin-management-channels__MetaWithFullPagination",
"admin-management-channels__pagination_Full",
"admin-management-channels__PaginationFullLinks"
]
},
"POST /v3/channels/{channel_id}/metafields": {
"operation": "metafields_createChannelMetafield",
"method": "POST",
"path": "/v3/channels/{channel_id}/metafields",
"risk": "H",
"description": "Create Channel Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__metafield_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__metafield_Post",
"admin-management-channels__MetafieldPostPermissionSet"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Metafields_createChannelMetafield_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Metafields_createChannelMetafield_Response_200",
"admin-management-channels__Metafield",
"admin-management-channels__MetafieldPermissionSet",
"admin-management-channels__MetafieldResourceType",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/channels/{channel_id}/metafields/{metafield_id}": {
"operation": "metafields_getChannelMetafield",
"method": "GET",
"path": "/v3/channels/{channel_id}/metafields/{metafield_id}",
"risk": "R",
"description": "Get Channel Metafield. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
},
"metafield_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the metafield."
}
},
"required": [
"channel_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Metafields_getChannelMetafield_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Metafields_getChannelMetafield_Response_200",
"admin-management-channels__Metafield",
"admin-management-channels__MetafieldPermissionSet",
"admin-management-channels__MetafieldResourceType",
"admin-management-channels__EmptyMeta"
]
},
"PUT /v3/channels/{channel_id}/metafields/{metafield_id}": {
"operation": "metafields_updateChannelMetafield",
"method": "PUT",
"path": "/v3/channels/{channel_id}/metafields/{metafield_id}",
"risk": "H",
"description": "Update Channel Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
},
"metafield_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the metafield."
}
},
"required": [
"channel_id",
"metafield_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__metafield_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__metafield_Put",
"admin-management-channels__MetafieldPutPermissionSet"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Metafields_updateChannelMetafield_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Metafields_updateChannelMetafield_Response_200",
"admin-management-channels__Metafield",
"admin-management-channels__MetafieldPermissionSet",
"admin-management-channels__MetafieldResourceType",
"admin-management-channels__EmptyMeta"
]
},
"DELETE /v3/channels/{channel_id}/metafields/{metafield_id}": {
"operation": "metafields_deleteChannelMetafield",
"method": "DELETE",
"path": "/v3/channels/{channel_id}/metafields/{metafield_id}",
"risk": "D",
"description": "Delete Channel Metafield. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
},
"metafield_id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the metafield."
}
},
"required": [
"channel_id",
"metafield_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "metafield_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/channels/{channel_id}/site": {
"operation": "site_getChannelSite",
"method": "GET",
"path": "/v3/channels/{channel_id}/site",
"risk": "R",
"description": "Get Channel Site. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Site_getChannelSite_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Site_getChannelSite_Response_200",
"admin-management-channels__Site",
"admin-management-channels__SiteSslStatus",
"admin-management-channels__Url",
"admin-management-channels__UrlType",
"admin-management-channels__EmptyMeta"
]
},
"POST /v3/channels/{channel_id}/site": {
"operation": "site_createChannelSite",
"method": "POST",
"path": "/v3/channels/{channel_id}/site",
"risk": "H",
"description": "Create Channel Site. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__site_Post"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__site_Post"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Site_createChannelSite_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Site_createChannelSite_Response_200",
"admin-management-channels__Site",
"admin-management-channels__SiteSslStatus",
"admin-management-channels__Url",
"admin-management-channels__UrlType",
"admin-management-channels__EmptyMeta"
]
},
"PUT /v3/channels/{channel_id}/site": {
"operation": "site_updateChannelSite",
"method": "PUT",
"path": "/v3/channels/{channel_id}/site",
"risk": "H",
"description": "Update Channel Site. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__site_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__site_Put"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Site_updateChannelSite_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Site_updateChannelSite_Response_200",
"admin-management-channels__Site",
"admin-management-channels__SiteSslStatus",
"admin-management-channels__Url",
"admin-management-channels__UrlType",
"admin-management-channels__EmptyMeta"
]
},
"DELETE /v3/channels/{channel_id}/site": {
"operation": "site_deleteChannelSite",
"method": "DELETE",
"path": "/v3/channels/{channel_id}/site",
"risk": "D",
"description": "Delete Channel Site. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Site_deleteChannelSite_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Site_deleteChannelSite_Response_200"
]
},
"PUT /v3/channels/{channel_id}/site/checkout-url": {
"operation": "siteCheckoutUrl_updateCheckoutUrl",
"method": "PUT",
"path": "/v3/channels/{channel_id}/site/checkout-url",
"risk": "H",
"description": "Upsert Siteʼs Checkout URL. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-channels__PutCheckoutUrl"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-channels__PutCheckoutUrl"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Site"
}
},
"response_definitions": [
"admin-management-channels__Site",
"admin-management-channels__SiteSslStatus",
"admin-management-channels__Url",
"admin-management-channels__UrlType"
]
},
"DELETE /v3/channels/{channel_id}/site/checkout-url": {
"operation": "siteCheckoutUrl_deleteCheckoutUrl",
"method": "DELETE",
"path": "/v3/channels/{channel_id}/site/checkout-url",
"risk": "D",
"description": "Delete Siteʼs Checkout URL. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-channels.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of a channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-channels__Site_Checkout_URL_deleteCheckoutUrl_Response_200"
}
},
"response_definitions": [
"admin-management-channels__Site_Checkout_URL_deleteCheckoutUrl_Response_200",
"admin-management-channels__ChannelsChannelIdSiteCheckoutUrlDeleteResponsesContentApplicationJsonSchemaData",
"admin-management-channels__EmptyMeta"
]
},
"GET /v3/checkouts/{checkoutId}": {
"operation": "checkout_getCheckout",
"method": "GET",
"path": "/v3/checkouts/{checkoutId}",
"risk": "R",
"description": "Get Checkout. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-checkouts__CheckoutsCheckoutIdGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "Comma-separated list of sub-resources to add to the response. The default response omits all of them.\n\n* `cart.line_items.physical_items.options` - product options on physical line items\n* `cart.line_items.digital_items.options` - product options on digital line items\n* `cart.line_items.physical_items.stock_position` - backorder and stock availability for physical items\n* `cart.line_items.digital_items.stock_position` - backorder and stock availability for digital items (backorder values are always zero because digital products cannot be backordered)\n* `consignments.available_shipping_options` - shipping options available to each consignment\n* `promotions.banners` - eligible promotion banners\n\nExample: `include=consignments.available_shipping_options,promotions.banners`"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__CheckoutsCheckoutIdGetParametersIncludeSchemaItems"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Checkout_getCheckout_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Checkout_getCheckout_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"PUT /v3/checkouts/{checkoutId}": {
"operation": "checkout_updateCheckout",
"method": "PUT",
"path": "/v3/checkouts/{checkoutId}",
"risk": "H",
"description": "Update Customer Messages. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__Checkout_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__Checkout_Put"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Checkout_updateCheckout_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Checkout_updateCheckout_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"POST /v3/checkouts/{checkoutId}/billing-address": {
"operation": "billingAddress_addCheckoutBillingAddress",
"method": "POST",
"path": "/v3/checkouts/{checkoutId}/billing-address",
"risk": "H",
"description": "Add Checkout Billing Address. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__AddressProperties"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__AddressProperties",
"admin-management-checkouts__AddressPropertiesCustomFieldsItems"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Billing_Address_addCheckoutBillingAddress_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Billing_Address_addCheckoutBillingAddress_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"PUT /v3/checkouts/{checkoutId}/billing-address/{addressId}": {
"operation": "billingAddress_updateCheckoutBillingAddress",
"method": "PUT",
"path": "/v3/checkouts/{checkoutId}/billing-address/{addressId}",
"risk": "H",
"description": "Update Checkout Billing Address. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
},
"addressId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the address."
}
},
"required": [
"checkoutId",
"addressId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__AddressProperties"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__AddressProperties",
"admin-management-checkouts__AddressPropertiesCustomFieldsItems"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "addressId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Billing_Address_updateCheckoutBillingAddress_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Billing_Address_updateCheckoutBillingAddress_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"POST /v3/checkouts/{checkoutId}/consignments": {
"operation": "consignments_addCheckoutConsignment",
"method": "POST",
"path": "/v3/checkouts/{checkoutId}/consignments",
"risk": "H",
"description": "Add Consignment to Checkout. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/admin-management-checkouts__CheckoutsCheckoutIdConsignmentsPostParametersInclude",
"description": "Include the shipping options available to this checkout."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__CreateConsignmentRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__CheckoutsCheckoutIdConsignmentsPostParametersInclude",
"admin-management-checkouts__CreateConsignmentRequest",
"admin-management-checkouts__CreateConsignmentRequestItems",
"admin-management-checkouts__CreateConsignmentRequestItemsAddress",
"admin-management-checkouts__CreateConsignmentRequestItemsAddressCustomFieldsItems",
"admin-management-checkouts__CreateConsignmentRequestItemsLineItemsItems",
"admin-management-checkouts__CreateConsignmentRequestItemsPickupOption"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Consignments_addCheckoutConsignment_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Consignments_addCheckoutConsignment_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"PUT /v3/checkouts/{checkoutId}/consignments/{consignmentId}": {
"operation": "consignments_updateCheckoutConsignment",
"method": "PUT",
"path": "/v3/checkouts/{checkoutId}/consignments/{consignmentId}",
"risk": "H",
"description": "Update Checkout Consignment. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
},
"consignmentId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the consignment."
}
},
"required": [
"checkoutId",
"consignmentId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"include": {
"$ref": "#/$defs/admin-management-checkouts__CheckoutsCheckoutIdConsignmentsConsignmentIdPutParametersInclude",
"description": "Include the shipping options available to this checkout."
}
},
"required": [],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__UpdateConsignmentRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__CheckoutsCheckoutIdConsignmentsConsignmentIdPutParametersInclude",
"admin-management-checkouts__UpdateConsignmentRequest",
"admin-management-checkouts__UpdateConsignmentRequestAddress",
"admin-management-checkouts__UpdateConsignmentRequestAddressCustomFieldsItems",
"admin-management-checkouts__UpdateConsignmentRequestLineItemsItems",
"admin-management-checkouts__UpdateConsignmentRequestPickupOption",
"admin-management-checkouts__UpdateConsignmentRequestCustomShipping"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "consignmentId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Consignments_updateCheckoutConsignment_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Consignments_updateCheckoutConsignment_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"DELETE /v3/checkouts/{checkoutId}/consignments/{consignmentId}": {
"operation": "consignments_deleteCheckoutConsignment",
"method": "DELETE",
"path": "/v3/checkouts/{checkoutId}/consignments/{consignmentId}",
"risk": "D",
"description": "Delete Checkout Consignment. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
},
"consignmentId": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the consignment."
}
},
"required": [
"checkoutId",
"consignmentId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__DeleteConsignmentRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__DeleteConsignmentRequest"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "consignmentId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Consignments_deleteCheckoutConsignment_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Consignments_deleteCheckoutConsignment_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"POST /v3/checkouts/{checkoutId}/coupons": {
"operation": "coupons_addCheckoutCoupon",
"method": "POST",
"path": "/v3/checkouts/{checkoutId}/coupons",
"risk": "H",
"description": "Add Coupon to Checkout. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__CouponCodeRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__CouponCodeRequest"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Coupons_addCheckoutCoupon_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Coupons_addCheckoutCoupon_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"DELETE /v3/checkouts/{checkoutId}/coupons/{couponCode}": {
"operation": "coupons_deleteCheckoutCoupon",
"method": "DELETE",
"path": "/v3/checkouts/{checkoutId}/coupons/{couponCode}",
"risk": "D",
"description": "Delete Checkout Coupon. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
},
"couponCode": {
"type": "string",
"maxLength": 262144,
"description": "The actual coupon code value, not the coupon ID."
}
},
"required": [
"checkoutId",
"couponCode"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__DeleteCouponCodeRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__DeleteCouponCodeRequest"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "couponCode",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Coupons_deleteCheckoutCoupon_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Coupons_deleteCheckoutCoupon_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"POST /v3/checkouts/{checkoutId}/discounts": {
"operation": "discounts_addCheckoutDiscount",
"method": "POST",
"path": "/v3/checkouts/{checkoutId}/discounts",
"risk": "H",
"description": "Add Discount to Checkout. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"type": "object",
"properties": {
"cart": {
"$ref": "#/$defs/admin-management-checkouts__CheckoutsCheckoutIdDiscountsPostRequestBodyContentApplicationJsonSchemaCart",
"description": "The complete manual-discount state to apply to the checkout."
}
},
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__CheckoutsCheckoutIdDiscountsPostRequestBodyContentApplicationJsonSchemaCart",
"admin-management-checkouts__CheckoutsCheckoutIdDiscountsPostRequestBodyContentApplicationJsonSchemaCartDiscountsItems",
"admin-management-checkouts__CheckoutsCheckoutIdDiscountsPostRequestBodyContentApplicationJsonSchemaCartLineItemsItems"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Discounts_addCheckoutDiscount_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Discounts_addCheckoutDiscount_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"POST /v3/checkouts/{checkoutId}/fees": {
"operation": "fees_CheckoutsFeesByCheckoutIdPost",
"method": "POST",
"path": "/v3/checkouts/{checkoutId}/fees",
"risk": "H",
"description": "Add Order Level Fees to Checkout. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__AddFeesRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__AddFeesRequest",
"admin-management-checkouts__BaseFee",
"admin-management-checkouts__BaseFeeType"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Fees_CheckoutsFeesByCheckoutIdPost_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Fees_CheckoutsFeesByCheckoutIdPost_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"PUT /v3/checkouts/{checkoutId}/fees": {
"operation": "fees_CheckoutsFeesByCheckoutIdPut",
"method": "PUT",
"path": "/v3/checkouts/{checkoutId}/fees",
"risk": "H",
"description": "Update Order Level Fees in Checkout. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__UpdateFeesRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__UpdateFeesRequest",
"admin-management-checkouts__FeeWithId",
"admin-management-checkouts__FeeWithIdType"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Fees_CheckoutsFeesByCheckoutIdPut_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Fees_CheckoutsFeesByCheckoutIdPut_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"DELETE /v3/checkouts/{checkoutId}/fees": {
"operation": "fees_CheckoutsFeesByCheckoutIdDelete",
"method": "DELETE",
"path": "/v3/checkouts/{checkoutId}/fees",
"risk": "D",
"description": "Delete Order Level Fees from Checkout. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__DeleteFeesRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__DeleteFeesRequest"
],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Fees_CheckoutsFeesByCheckoutIdDelete_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Fees_CheckoutsFeesByCheckoutIdDelete_Response_200",
"admin-management-checkouts__Checkout",
"admin-management-checkouts__CheckoutCart",
"admin-management-checkouts__CheckoutCartCurrency",
"admin-management-checkouts__CheckoutCartCouponsItems",
"admin-management-checkouts__CheckoutCartDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsDiscountsItemsId",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsGiftWrapping",
"admin-management-checkouts__CheckoutCartLineItemsPhysicalItemsItemsStockPosition",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItems",
"admin-management-checkouts__CheckoutCartLineItemsDigitalItemsItemsDiscountsItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItems",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsSender",
"admin-management-checkouts__CheckoutCartLineItemsGiftCertificatesItemsRecipient",
"admin-management-checkouts__CheckoutCartLineItemsCustomItemsItems",
"admin-management-checkouts__CheckoutBillingAddress",
"admin-management-checkouts__CheckoutBillingAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsShippingAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddress",
"admin-management-checkouts__CheckoutConsignmentsItemsAddressCustomFieldsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsAvailableShippingOptionsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsSelectedShippingOption",
"admin-management-checkouts__CheckoutConsignmentsItemsCouponDiscountsItems",
"admin-management-checkouts__CheckoutConsignmentsItemsDiscountsItems",
"admin-management-checkouts__PickupOption",
"admin-management-checkouts__CheckoutTaxesItems",
"admin-management-checkouts__AppliedCoupon",
"admin-management-checkouts__CheckoutFee",
"admin-management-checkouts__CheckoutFeeType",
"admin-management-checkouts__CheckoutPromotionsItems",
"admin-management-checkouts__CheckoutPromotionsItemsBannersItems",
"admin-management-checkouts__MetaOpen"
]
},
"POST /v3/checkouts/{checkoutId}/orders": {
"operation": "orders_createOrder",
"method": "POST",
"path": "/v3/checkouts/{checkoutId}/orders",
"risk": "H",
"description": "Create Order. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"checkoutId": {
"type": "string",
"maxLength": 262144,
"description": "ID of the checkout; the same as the cart ID."
}
},
"required": [
"checkoutId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "checkoutId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Orders_createOrder_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Orders_createOrder_Response_200",
"admin-management-checkouts__Order",
"admin-management-checkouts__MetaOpen"
]
},
"GET /v3/checkouts/settings": {
"operation": "settings_getCheckoutSettings",
"method": "GET",
"path": "/v3/checkouts/settings",
"risk": "R",
"description": "Get Checkout Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Settings_getCheckoutSettings_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Settings_getCheckoutSettings_Response_200",
"admin-management-checkouts__CheckoutsSettings",
"admin-management-checkouts__CheckoutsSettingsCheckoutType",
"admin-management-checkouts__CheckoutsSettingsGuestCheckoutType",
"admin-management-checkouts__CheckoutsSettingsGuestCheckoutForExistingAccounts",
"admin-management-checkouts__CheckoutsSettingsPolicyConsent",
"admin-management-checkouts__CheckoutsSettingsOrderTermsAndConditionsType",
"admin-management-checkouts__MetaOpen"
]
},
"PUT /v3/checkouts/settings": {
"operation": "settings_updateCheckoutSettings",
"method": "PUT",
"path": "/v3/checkouts/settings",
"risk": "H",
"description": "Update Checkout Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-checkouts__CheckoutsSettingsRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__CheckoutsSettingsRequest",
"admin-management-checkouts__CheckoutsSettingsRequestCheckoutType",
"admin-management-checkouts__CheckoutsSettingsRequestGuestCheckoutType",
"admin-management-checkouts__CheckoutsSettingsRequestGuestCheckoutForExistingAccounts",
"admin-management-checkouts__CheckoutsSettingsRequestPolicyConsent",
"admin-management-checkouts__CheckoutsSettingsRequestOrderTermsAndConditionsType"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Settings_updateCheckoutSettings_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Settings_updateCheckoutSettings_Response_200",
"admin-management-checkouts__CheckoutsSettings",
"admin-management-checkouts__CheckoutsSettingsCheckoutType",
"admin-management-checkouts__CheckoutsSettingsGuestCheckoutType",
"admin-management-checkouts__CheckoutsSettingsGuestCheckoutForExistingAccounts",
"admin-management-checkouts__CheckoutsSettingsPolicyConsent",
"admin-management-checkouts__CheckoutsSettingsOrderTermsAndConditionsType",
"admin-management-checkouts__MetaOpen"
]
},
"GET /v3/checkouts/settings/channels/{channelId}": {
"operation": "settings_get-channel-checkout-settings",
"method": "GET",
"path": "/v3/checkouts/settings/channels/{channelId}",
"risk": "R",
"description": "Get Channel-Specific Checkout Settings. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channelId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the channel."
}
},
"required": [
"channelId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channelId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Settings_get-channel-checkout-settings_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Settings_get-channel-checkout-settings_Response_200",
"admin-management-checkouts__ChannelCheckoutsSettings",
"admin-management-checkouts__ChannelCheckoutsSettingsCheckoutType",
"admin-management-checkouts__ChannelCheckoutsSettingsGuestCheckoutType",
"admin-management-checkouts__ChannelCheckoutsSettingsGuestCheckoutForExistingAccounts",
"admin-management-checkouts__ChannelCheckoutsSettingsPolicyConsent",
"admin-management-checkouts__ChannelCheckoutsSettingsOrderTermsAndConditionsType",
"admin-management-checkouts__MetaOpen"
]
},
"PUT /v3/checkouts/settings/channels/{channelId}": {
"operation": "settings_put-channel-checkout-settings",
"method": "PUT",
"path": "/v3/checkouts/settings/channels/{channelId}",
"risk": "H",
"description": "Update Channel-Specific Checkout Settings. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-checkouts.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channelId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the channel."
}
},
"required": [
"channelId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-checkouts__ChannelCheckoutsSettings"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-checkouts__ChannelCheckoutsSettings",
"admin-management-checkouts__ChannelCheckoutsSettingsCheckoutType",
"admin-management-checkouts__ChannelCheckoutsSettingsGuestCheckoutType",
"admin-management-checkouts__ChannelCheckoutsSettingsGuestCheckoutForExistingAccounts",
"admin-management-checkouts__ChannelCheckoutsSettingsPolicyConsent",
"admin-management-checkouts__ChannelCheckoutsSettingsOrderTermsAndConditionsType"
],
"wire": [
{
"name": "channelId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-checkouts__Settings_put-channel-checkout-settings_Response_200"
}
},
"response_definitions": [
"admin-management-checkouts__Settings_put-channel-checkout-settings_Response_200",
"admin-management-checkouts__ChannelCheckoutsSettings",
"admin-management-checkouts__ChannelCheckoutsSettingsCheckoutType",
"admin-management-checkouts__ChannelCheckoutsSettingsGuestCheckoutType",
"admin-management-checkouts__ChannelCheckoutsSettingsGuestCheckoutForExistingAccounts",
"admin-management-checkouts__ChannelCheckoutsSettingsPolicyConsent",
"admin-management-checkouts__ChannelCheckoutsSettingsOrderTermsAndConditionsType",
"admin-management-checkouts__MetaOpen"
]
},
"GET /v2/currencies/{id}": {
"operation": "currenciesSingle_getCurrency",
"method": "GET",
"path": "/v2/currencies/{id}",
"risk": "R",
"description": "Get Currency. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-currencies.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the subject currency."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-currencies__currency_Full"
}
},
"response_definitions": [
"admin-management-currencies__currency_Full"
]
},
"PUT /v2/currencies/{id}": {
"operation": "currenciesSingle_updateCurrency",
"method": "PUT",
"path": "/v2/currencies/{id}",
"risk": "H",
"description": "Update Currency. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-currencies.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the subject currency."
}
},
"required": [
"id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-currencies__currency_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-currencies__currency_Put"
],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-currencies__currency_Full"
}
},
"response_definitions": [
"admin-management-currencies__currency_Full"
]
},
"DELETE /v2/currencies/{id}": {
"operation": "currenciesSingle_deleteCurrency",
"method": "DELETE",
"path": "/v2/currencies/{id}",
"risk": "D",
"description": "Delete Currency. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-currencies.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 262144,
"description": "The ID of the subject currency."
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/currencies": {
"operation": "currenciesBulk_getCurrencies",
"method": "GET",
"path": "/v2/currencies",
"risk": "R",
"description": "List Currencies. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-currencies.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Specifies the page number in a limited (paginated) list of currencies.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Controls the number of items per page in a limited (paginated) list of currencies.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-currencies__currency_Full"
}
}
},
"response_definitions": [
"admin-management-currencies__currency_Full"
]
},
"POST /v2/currencies": {
"operation": "currenciesBulk_createCurrency",
"method": "POST",
"path": "/v2/currencies",
"risk": "H",
"description": "Create Currency. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-currencies.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-currencies__currency_Post"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-currencies__currency_Post"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-currencies__currency_Full"
}
},
"response_definitions": [
"admin-management-currencies__currency_Full"
]
},
"DELETE /v2/currencies": {
"operation": "currenciesBulk_deleteCurrencies",
"method": "DELETE",
"path": "/v2/currencies",
"risk": "D",
"description": "Delete All Currencies. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-currencies.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/segments": {
"operation": "segments_GetPaginatedSegmentsList",
"method": "GET",
"path": "/v3/segments",
"risk": "R",
"description": "List Segments. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Items count per page.\n"
},
"id:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Comma separated IDs.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentCollectionResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__SegmentCollectionResponse",
"admin-management-customer-segmentation__Segment",
"admin-management-customer-segmentation__CollectionMeta",
"admin-management-customer-segmentation__Pagination",
"admin-management-customer-segmentation__PaginationLinks"
]
},
"POST /v3/segments": {
"operation": "segments_SegmentsPostRequest",
"method": "POST",
"path": "/v3/segments",
"risk": "W",
"description": "Create Segments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsPostRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customer-segmentation__SegmentsPostRequest",
"admin-management-customer-segmentation__SegmentPost"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__SegmentsResponse",
"admin-management-customer-segmentation__Segment",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__SegmentsWithErrorsResponse",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors"
]
},
"PUT /v3/segments": {
"operation": "segments_PutSegmentObjects",
"method": "PUT",
"path": "/v3/segments",
"risk": "W",
"description": "Update Segments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsPutRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customer-segmentation__SegmentsPutRequest",
"admin-management-customer-segmentation__SegmentPut"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__SegmentsResponse",
"admin-management-customer-segmentation__Segment",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__SegmentsWithErrorsResponse",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors"
]
},
"DELETE /v3/segments": {
"operation": "segments_DeleteStoreSegment",
"method": "DELETE",
"path": "/v3/segments",
"risk": "D",
"description": "Delete Segments. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Comma separated IDs.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsRemoveResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentsRemoveWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__SegmentsRemoveResponse",
"admin-management-customer-segmentation__SegmentsRemoveResponseDataItems",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__SegmentsRemoveWithErrorsResponse",
"admin-management-customer-segmentation__SegmentsRemoveWithErrorsResponseDataItems"
]
},
"GET /v3/shopper-profiles/{shopperProfileId}/segments": {
"operation": "segmentsForAShopperProfile_GetListShopperProfile",
"method": "GET",
"path": "/v3/shopper-profiles/{shopperProfileId}/segments",
"risk": "R",
"description": "List Segments for Shopper Profile. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"shopperProfileId": {
"type": "string",
"maxLength": 262144,
"description": "The *Shopper Profile* ID."
}
},
"required": [
"shopperProfileId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Items count per page.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "shopperProfileId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__SegmentCollectionResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__SegmentCollectionResponse",
"admin-management-customer-segmentation__Segment",
"admin-management-customer-segmentation__CollectionMeta",
"admin-management-customer-segmentation__Pagination",
"admin-management-customer-segmentation__PaginationLinks"
]
},
"GET /v3/shopper-profiles": {
"operation": "shopperProfiles_GetShopperList",
"method": "GET",
"path": "/v3/shopper-profiles",
"risk": "R",
"description": "List Shopper Profiles. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Items count per page.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesCollectionResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__ShopperProfilesCollectionResponse",
"admin-management-customer-segmentation__ShopperProfile",
"admin-management-customer-segmentation__CollectionMeta",
"admin-management-customer-segmentation__Pagination",
"admin-management-customer-segmentation__PaginationLinks"
]
},
"POST /v3/shopper-profiles": {
"operation": "shopperProfiles_ShopperProfilesRequest",
"method": "POST",
"path": "/v3/shopper-profiles",
"risk": "W",
"description": "Create Shopper Profiles. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesPostRequest"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customer-segmentation__ShopperProfilesPostRequest",
"admin-management-customer-segmentation__ShopperProfilePost"
],
"wire": [],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__ShopperProfilesResponse",
"admin-management-customer-segmentation__ShopperProfile",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__ShopperProfilesWithErrorsResponse"
]
},
"DELETE /v3/shopper-profiles": {
"operation": "shopperProfiles_DeleteStoreShopperProfile",
"method": "DELETE",
"path": "/v3/shopper-profiles",
"risk": "D",
"description": "Delete Shopper Profiles. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Comma separated IDs.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesRemoveResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesRemoveWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__ShopperProfilesRemoveResponse",
"admin-management-customer-segmentation__ShopperProfilesRemoveResponseDataItems",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__ShopperProfilesRemoveWithErrorsResponse",
"admin-management-customer-segmentation__ShopperProfilesRemoveWithErrorsResponseDataItems"
]
},
"GET /v3/segments/{segmentId}/shopper-profiles": {
"operation": "shopperProfilesForASegment_GetSegmentProfiles",
"method": "GET",
"path": "/v3/segments/{segmentId}/shopper-profiles",
"risk": "R",
"description": "List Shopper Profiles in Segment. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"segmentId": {
"type": "string",
"maxLength": 262144,
"description": "The *Segment* ID."
}
},
"required": [
"segmentId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number.\n"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Items count per page.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "segmentId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesGetResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__ShopperProfilesGetResponse",
"admin-management-customer-segmentation__ShopperProfile",
"admin-management-customer-segmentation__CollectionMeta",
"admin-management-customer-segmentation__Pagination",
"admin-management-customer-segmentation__PaginationLinks"
]
},
"POST /v3/segments/{segmentId}/shopper-profiles": {
"operation": "shopperProfilesForASegment_PostShopperProfile",
"method": "POST",
"path": "/v3/segments/{segmentId}/shopper-profiles",
"risk": "W",
"description": "Add Shopper Profiles to Segment. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"segmentId": {
"type": "string",
"maxLength": 262144,
"description": "The *Segment* ID."
}
},
"required": [
"segmentId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesAddRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customer-segmentation__ShopperProfilesAddRequest"
],
"wire": [
{
"name": "segmentId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"201": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesAddResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesAddWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__ShopperProfilesAddResponse",
"admin-management-customer-segmentation__ShopperProfile",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__ShopperProfilesAddWithErrorsResponse"
]
},
"DELETE /v3/segments/{segmentId}/shopper-profiles": {
"operation": "shopperProfilesForASegment_DeleteShopperProfile",
"method": "DELETE",
"path": "/v3/segments/{segmentId}/shopper-profiles",
"risk": "D",
"description": "Remove Shopper Profiles from Segment. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customer-segmentation.json",
"partial_http": [
422
],
"error_paths": [
[
"errors"
],
[
"errors"
]
],
"failed_count_paths": [
[
"meta",
"failed"
],
[
"meta",
"failed"
]
],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"segmentId": {
"type": "string",
"maxLength": 262144,
"description": "The *Segment* ID."
}
},
"required": [
"segmentId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10,
"description": "Comma separated IDs.\n"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "segmentId",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesRemoveResponse"
},
"422": {
"$ref": "#/$defs/admin-management-customer-segmentation__ShopperProfilesRemoveWithErrorsResponse"
}
},
"response_definitions": [
"admin-management-customer-segmentation__ShopperProfilesRemoveResponse",
"admin-management-customer-segmentation__ShopperProfilesRemoveResponseDataItems",
"admin-management-customer-segmentation__ErrorResponse",
"admin-management-customer-segmentation__DetailedErrors",
"admin-management-customer-segmentation__BatchResultMeta",
"admin-management-customer-segmentation__ShopperProfilesRemoveWithErrorsResponse",
"admin-management-customer-segmentation__ShopperProfilesRemoveWithErrorsResponseDataItems"
]
},
"GET /v2/customer_groups": {
"operation": "customerGroups_getCustomerGroups",
"method": "GET",
"path": "/v2/customer_groups",
"risk": "R",
"description": "List Customer Groups. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v2.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Number of pages."
},
"limit": {
"type": "number",
"description": "Count per page."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by exact name match."
},
"name:like": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by name, using a fuzzy matching method."
},
"is_default": {
"type": "boolean",
"description": "Filter by customers who sign up are added to this group by default."
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by date_created. `date_created=2018-09-05T13:43:54`"
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by maximum date_created. `date_created:max=2018-09-10`"
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by date_created. `date_created:min=2018-09-05`"
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by date_modified. `date_modified=2018-09-05T13:45:03`"
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by minimum date_modified. `date_modified:min=2019-09-04T:00:00:00` or `date_modified:min=2019-09-04`"
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter customer groups by maximum date_modified. `date_modified:max=2018-09-05T13:45:03` or `date_modified:max=2019-09-04`"
},
"is_group_for_guests": {
"type": "boolean",
"description": "Filter whether the group is for guests. There can only be one customer group for guests at a time."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_default",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_group_for_guests",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v2__customerGroup_Full"
}
}
},
"response_definitions": [
"admin-management-customers-v2__customerGroup_Full",
"admin-management-customers-v2__categoryAccessLevel_Full",
"admin-management-customers-v2__CategoryAccessLevelFullType",
"admin-management-customers-v2__CustomerGroupFullDiscountRules",
"admin-management-customers-v2__CustomerGroupFullDiscountRules0",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules1",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules2",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules3",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules4",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsMethod"
]
},
"POST /v2/customer_groups": {
"operation": "customerGroups_createCustomerGroup",
"method": "POST",
"path": "/v2/customer_groups",
"risk": "H",
"description": "Create Customer Group. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v2.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"$ref": "#/$defs/admin-management-customers-v2__customerGroup_Post_Put"
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v2__customerGroup_Post_Put",
"admin-management-customers-v2__categoryAccessLevel_Full",
"admin-management-customers-v2__CategoryAccessLevelFullType",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules0",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf0Items",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf0ItemsType",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules1",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items0",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf0Type",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf0Method",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items1",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf1Type",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf1Method",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items2",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf2Type",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf2Method",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules2",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf2Items",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf2ItemsType",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf2ItemsMethod"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v2__customerGroup_Full"
}
},
"response_definitions": [
"admin-management-customers-v2__customerGroup_Full",
"admin-management-customers-v2__categoryAccessLevel_Full",
"admin-management-customers-v2__CategoryAccessLevelFullType",
"admin-management-customers-v2__CustomerGroupFullDiscountRules",
"admin-management-customers-v2__CustomerGroupFullDiscountRules0",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules1",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules2",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules3",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules4",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsMethod"
]
},
"GET /v2/customer_groups/{customer_group_id}": {
"operation": "customerGroups_getCustomerGroup",
"method": "GET",
"path": "/v2/customer_groups/{customer_group_id}",
"risk": "R",
"description": "Get Customer Group. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v2.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"customer_group_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the customer group."
}
},
"required": [
"customer_group_id"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Number of pages."
},
"limit": {
"type": "number",
"description": "Count per page."
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Name of the customer groups."
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_created. `date_created=2018-09-05T13:43:54`"
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date_created. `date_created:max=2018-09-10`"
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_created. `date_created:min=2018-09-05`"
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date_modified. `date_modified=2018-09-05T13:45:03`"
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date_modified. `date_modified:min=2019-09-04T:00:00:00` or `date_modified:min=2019-09-04`"
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date_modified. `date_modified:max=2018-09-05T13:45:03` or `date_modified:max=2019-09-04`"
},
"is_default": {
"type": "boolean",
"description": "Whether customers who sign up are added to this group by default."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "customer_group_id",
"location": "path",
"style": "form",
"explode": false
},
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "is_default",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v2__customerGroup_Full"
}
},
"response_definitions": [
"admin-management-customers-v2__customerGroup_Full",
"admin-management-customers-v2__categoryAccessLevel_Full",
"admin-management-customers-v2__CategoryAccessLevelFullType",
"admin-management-customers-v2__CustomerGroupFullDiscountRules",
"admin-management-customers-v2__CustomerGroupFullDiscountRules0",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules1",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules2",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules3",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules4",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsMethod"
]
},
"PUT /v2/customer_groups/{customer_group_id}": {
"operation": "customerGroups_updateCustomerGroup",
"method": "PUT",
"path": "/v2/customer_groups/{customer_group_id}",
"risk": "H",
"description": "Update Customer Group. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v2.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"customer_group_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the customer group."
}
},
"required": [
"customer_group_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-customers-v2__customerGroup_Post_Put"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v2__customerGroup_Post_Put",
"admin-management-customers-v2__categoryAccessLevel_Full",
"admin-management-customers-v2__CategoryAccessLevelFullType",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules0",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf0Items",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf0ItemsType",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules1",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items0",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf0Type",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf0Method",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items1",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf1Type",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf1Method",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1Items2",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf2Type",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf1ItemsOneOf2Method",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRules2",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf2Items",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf2ItemsType",
"admin-management-customers-v2__CustomerGroupPostPutDiscountRulesOneOf2ItemsMethod"
],
"wire": [
{
"name": "customer_group_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v2__customerGroup_Full"
}
},
"response_definitions": [
"admin-management-customers-v2__customerGroup_Full",
"admin-management-customers-v2__categoryAccessLevel_Full",
"admin-management-customers-v2__CategoryAccessLevelFullType",
"admin-management-customers-v2__CustomerGroupFullDiscountRules",
"admin-management-customers-v2__CustomerGroupFullDiscountRules0",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf0ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules1",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf1ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules2",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf2ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules3",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf3ItemsMethod",
"admin-management-customers-v2__CustomerGroupFullDiscountRules4",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4Items",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsType",
"admin-management-customers-v2__CustomerGroupFullDiscountRulesOneOf4ItemsMethod"
]
},
"DELETE /v2/customer_groups/{customer_group_id}": {
"operation": "customerGroups_deleteCustomerGroup",
"method": "DELETE",
"path": "/v2/customer_groups/{customer_group_id}",
"risk": "D",
"description": "Delete Customer Group. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v2.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"customer_group_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the customer group."
}
},
"required": [
"customer_group_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "customer_group_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v2/customer_groups/count": {
"operation": "customerGroups_getCustomerGroupsCount",
"method": "GET",
"path": "/v2/customer_groups/count",
"risk": "R",
"description": "Get Count of Customer Groups. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v2.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v2__count_Full"
}
},
"response_definitions": [
"admin-management-customers-v2__count_Full"
]
},
"GET /v3/customers": {
"operation": "customers_getCustomers",
"method": "GET",
"path": "/v3/customers",
"risk": "R",
"description": "List Customers. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number (`page` will be ignored if you provide `before` or `after` in the request). For example `page=1`."
},
"limit": {
"type": "number",
"description": "Items count per page. `limit=50`"
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter items by ID.\n`id:in=4,5,6`"
},
"company:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by company. `company:in=bigcommerce,commongood`"
},
"customer_group_id:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by customer_group_id. `customer_group_id:in=5,6`"
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date created, for example, `2024-05-14T09:34:00` or `2024-05-14`."
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns customers created before this date."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date created for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns customers created after this date."
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns customers modified after this date."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum date modified, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns customers modified before this date."
},
"email:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by email. `email:[email protected]`"
},
"name:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by first_name and last_name. `name=james moriarty`"
},
"name:like": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by substring in first_name and last_name.\n`name:like=moriarty,sherlock`\nConcatenates the first_name and last_name fields."
},
"phone:in": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by phone number. `phone:in=555-55-5555`"
},
"registration_ip_address:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter items by registration_ip_address. If the customer was created using the API, then registration address is blank.\n`registration_ip_address:in=12.345.6.789`"
},
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__CustomersGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "Indicates whether to include customer sub-resources:\n * `addresses` - customer addresses\n * `storecredit` - store credit\n * `attributes` - customer attributes and address attributes\n * `formfields` - customer and address form fields\n * `shopper_profile_id` - the ID of the shopper profile associated with the customer (Beta)\n * `segment_ids`- segments the customer belongs to (Beta)\n\n `include=addresses,storecredit,attributes,formfields,shopper_profile_id,segment_ids`"
},
"sort": {
"$ref": "#/$defs/admin-management-customers-v3__CustomersGetParametersSort",
"description": "Sort items by date_created, date_modified, or last_name:* `date_created:asc` - date created, ascending* `date_created:desc` - date created, descending* `last_name:asc` - last name, ascending* `last_name:desc` - last name, descending * `date_modified:asc` - date modified, ascending* `date_modified:desc`- date modified, descending Example: `sort=last_name:asc`"
},
"after": {
"type": "string",
"maxLength": 262144,
"description": "The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the last response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJpZCI6MjA0fQ`. "
},
"before": {
"type": "string",
"maxLength": 262144,
"description": "The cursor reference of the first entry for the next page. Use the `start_cursor` value from the last response to get the previous page (`start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `before=eyJpZCI6MjA1fQ`."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__CustomersGetParametersIncludeSchemaItems",
"admin-management-customers-v3__CustomersGetParametersSort"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "company:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "customer_group_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "email:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "phone:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "registration_ip_address:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "sort",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "after",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "before",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Customers_getCustomers_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Customers_getCustomers_Response_200",
"admin-management-customers-v3__customer_Full",
"admin-management-customers-v3__CustomerFullAuthentication",
"admin-management-customers-v3__address_Full",
"admin-management-customers-v3__AddressFullAddressType",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue",
"admin-management-customers-v3__attribute_Full",
"admin-management-customers-v3__formFieldValue_Customer",
"admin-management-customers-v3__FormFieldValueCustomerValue",
"admin-management-customers-v3__CustomerStoredCreditAmounts",
"admin-management-customers-v3__CustomerStoredCreditAmountsItems",
"admin-management-customers-v3__customerChannelIds",
"admin-management-customers-v3___metaCollectionWithCursorPagination",
"admin-management-customers-v3__Pagination",
"admin-management-customers-v3__Links",
"admin-management-customers-v3__CursorPagination"
]
},
"POST /v3/customers": {
"operation": "customers_createCustomers",
"method": "POST",
"path": "/v3/customers",
"risk": "H",
"description": "Create Customers. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__customer_Post"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__customer_Post",
"admin-management-customers-v3__customerAddresses_CustomerPost",
"admin-management-customers-v3__CustomerAddressesCustomerPostAddressType",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue",
"admin-management-customers-v3__customerAttributes_Base",
"admin-management-customers-v3__customerAuthentication_PostPut",
"admin-management-customers-v3__CustomerStoredCreditAmounts",
"admin-management-customers-v3__CustomerStoredCreditAmountsItems"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Customers_createCustomers_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Customers_createCustomers_Response_200",
"admin-management-customers-v3__customer_Full",
"admin-management-customers-v3__CustomerFullAuthentication",
"admin-management-customers-v3__address_Full",
"admin-management-customers-v3__AddressFullAddressType",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue",
"admin-management-customers-v3__attribute_Full",
"admin-management-customers-v3__formFieldValue_Customer",
"admin-management-customers-v3__FormFieldValueCustomerValue",
"admin-management-customers-v3__CustomerStoredCreditAmounts",
"admin-management-customers-v3__CustomerStoredCreditAmountsItems",
"admin-management-customers-v3__customerChannelIds",
"admin-management-customers-v3__MetaOpen"
]
},
"PUT /v3/customers": {
"operation": "customers_updateCustomers",
"method": "PUT",
"path": "/v3/customers",
"risk": "H",
"description": "Update Customers. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__customer_Put"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__customer_Put",
"admin-management-customers-v3__customerAuthentication_PostPut",
"admin-management-customers-v3__CustomerStoredCreditAmounts",
"admin-management-customers-v3__CustomerStoredCreditAmountsItems",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Customers_updateCustomers_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Customers_updateCustomers_Response_200",
"admin-management-customers-v3__customer_Full",
"admin-management-customers-v3__CustomerFullAuthentication",
"admin-management-customers-v3__address_Full",
"admin-management-customers-v3__AddressFullAddressType",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue",
"admin-management-customers-v3__attribute_Full",
"admin-management-customers-v3__formFieldValue_Customer",
"admin-management-customers-v3__FormFieldValueCustomerValue",
"admin-management-customers-v3__CustomerStoredCreditAmounts",
"admin-management-customers-v3__CustomerStoredCreditAmountsItems",
"admin-management-customers-v3__customerChannelIds",
"admin-management-customers-v3__MetaOpen"
]
},
"DELETE /v3/customers": {
"operation": "customers_deleteCustomers",
"method": "DELETE",
"path": "/v3/customers",
"risk": "D",
"description": "Delete Customers. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter items by ID.\n`id:in=4,5,6`"
}
},
"required": [
"id:in"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/customers/addresses": {
"operation": "addresses_getCustomersAddresses",
"method": "GET",
"path": "/v3/customers/addresses",
"risk": "R",
"description": "List Customer Addresses. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number. `page=1`"
},
"limit": {
"type": "number",
"description": "Items count per page. `limit=50`"
},
"company:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by company. `company:in=bigcommerce,commongood`"
},
"name:in": {
"type": "array",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 100,
"description": "Filter items by first_name and last_name. `name:in=James+Moriarty`"
},
"customer_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter by the ID of the customer. Also accepts comma-separated IDs to filter for multiple customers. `customer_id:in=23,24,55`"
},
"include": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__CustomersAddressesGetParametersIncludeSchemaItems"
},
"maxItems": 100,
"description": "Indicates whether to include customer address sub-resources:\n* `formfields` - address form fields\n`include=formfields`"
},
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter items by ID.\n`id:in=4,5,6`"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__CustomersAddressesGetParametersIncludeSchemaItems"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "company:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "customer_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "include",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Addresses_getCustomersAddresses_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Addresses_getCustomersAddresses_Response_200",
"admin-management-customers-v3__CustomersAddressesGetResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersAddressesGetResponsesContentApplicationJsonSchemaDataItemsAddressType",
"admin-management-customers-v3__formFieldValue_Address",
"admin-management-customers-v3__FormFieldValueAddressValue",
"admin-management-customers-v3___metaCollection",
"admin-management-customers-v3__Pagination",
"admin-management-customers-v3__Links"
]
},
"POST /v3/customers/addresses": {
"operation": "addresses_createCustomersAddresses",
"method": "POST",
"path": "/v3/customers/addresses",
"risk": "H",
"description": "Create Customer Address. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__address_Post"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__address_Post",
"admin-management-customers-v3__AddressPostAddressType",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Addresses_createCustomersAddresses_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Addresses_createCustomersAddresses_Response_200",
"admin-management-customers-v3__AddressesCreateCustomersAddressesResponse2000",
"admin-management-customers-v3__CustomersAddressesPostResponsesContentApplicationJsonSchemaOneOf0DataItems",
"admin-management-customers-v3__CustomersAddressesPostResponsesContentApplicationJsonSchemaOneOf0DataItemsAddressType",
"admin-management-customers-v3__formFieldValue_Full",
"admin-management-customers-v3__formFieldValue_Customer",
"admin-management-customers-v3__FormFieldValueCustomerValue",
"admin-management-customers-v3__formFieldValue_Address",
"admin-management-customers-v3__FormFieldValueAddressValue",
"admin-management-customers-v3__MetaOpen"
]
},
"PUT /v3/customers/addresses": {
"operation": "addresses_updateCustomersAddresses",
"method": "PUT",
"path": "/v3/customers/addresses",
"risk": "H",
"description": "Update Customer Address. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__address_Put"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__address_Put",
"admin-management-customers-v3__AddressPutAddressType",
"admin-management-customers-v3__formFieldValue",
"admin-management-customers-v3__FormFieldValueValue"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Addresses_updateCustomersAddresses_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Addresses_updateCustomersAddresses_Response_200",
"admin-management-customers-v3__AddressesUpdateCustomersAddressesResponse2000",
"admin-management-customers-v3__CustomersAddressesPutResponsesContentApplicationJsonSchemaOneOf0DataItems",
"admin-management-customers-v3__CustomersAddressesPutResponsesContentApplicationJsonSchemaOneOf0DataItemsAddressType",
"admin-management-customers-v3__formFieldValue_Full",
"admin-management-customers-v3__formFieldValue_Customer",
"admin-management-customers-v3__FormFieldValueCustomerValue",
"admin-management-customers-v3__formFieldValue_Address",
"admin-management-customers-v3__FormFieldValueAddressValue",
"admin-management-customers-v3__MetaOpen"
]
},
"DELETE /v3/customers/addresses": {
"operation": "addresses_deleteCustomersAddresses",
"method": "DELETE",
"path": "/v3/customers/addresses",
"risk": "D",
"description": "Delete Customer Address. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter items by ID.\n`id:in=4,5,6`"
}
},
"required": [
"id:in"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/customers/attribute-values": {
"operation": "attributeValues_getCustomersAttributeValues",
"method": "GET",
"path": "/v3/customers/attribute-values",
"risk": "R",
"description": "List Customer Attribute Values. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number. `page=1`"
},
"limit": {
"type": "number",
"description": "Items count per page. `limit=50`"
},
"customer_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter items by the customer ID. `customer_id:in=23,24,55`"
},
"attribute_id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 100,
"description": "Filter items by the attribute ID. `attribute_id:in=1,2`"
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by the attribute name. `name=age`"
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_created`, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`."
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum `date_created`, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields created before this date."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum `date_created`, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields created after this date"
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_modified`, for example, `2024-05-14T09:34:00` or `2024-05-14`."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum `date_modified`, for example, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields modified before this date."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum `date_modified`, for example, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields modified after this date."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "customer_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "attribute_id:in",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Attribute_Values_getCustomersAttributeValues_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Attribute_Values_getCustomersAttributeValues_Response_200",
"admin-management-customers-v3__CustomersAttributeValuesGetResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersAttributeValuesGetResponsesContentApplicationJsonSchemaMeta",
"admin-management-customers-v3__CustomersAttributeValuesGetResponsesContentApplicationJsonSchemaMetaPagination",
"admin-management-customers-v3__CustomersAttributeValuesGetResponsesContentApplicationJsonSchemaMetaPaginationLinks"
]
},
"PUT /v3/customers/attribute-values": {
"operation": "attributeValues_upsertCustomersAttributeValues",
"method": "PUT",
"path": "/v3/customers/attribute-values",
"risk": "H",
"description": "Upsert Customer Attribute Values. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__attributeValue_Base"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__attributeValue_Base"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Attribute_Values_upsertCustomersAttributeValues_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Attribute_Values_upsertCustomersAttributeValues_Response_200",
"admin-management-customers-v3__CustomersAttributeValuesPutResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersAttributeValuesPutResponsesContentApplicationJsonSchemaMeta",
"admin-management-customers-v3__CustomersAttributeValuesPutResponsesContentApplicationJsonSchemaMetaPagination",
"admin-management-customers-v3__CustomersAttributeValuesPutResponsesContentApplicationJsonSchemaMetaPaginationLinks"
]
},
"DELETE /v3/customers/attribute-values": {
"operation": "attributeValues_deleteCustomersAttributeValues",
"method": "DELETE",
"path": "/v3/customers/attribute-values",
"risk": "D",
"description": "Delete Customer Attribute Values. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter items by ID.\n`id:in=4,5,6`"
}
},
"required": [
"id:in"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/customers/attributes": {
"operation": "attributes_getCustomersAttributes",
"method": "GET",
"path": "/v3/customers/attributes",
"risk": "R",
"description": "List Customer Attributes. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number. `page=1`"
},
"limit": {
"type": "number",
"description": "Items count per page. `limit=50`"
},
"name": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by customer attribute name. `name=Date+Joined`"
},
"name:like": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by substring in customer attribute name. `name:like=join`"
},
"type": {
"type": "string",
"maxLength": 262144,
"description": "The type of the customer attribute."
},
"date_created": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_created`, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`."
},
"date_created:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum `date_created`, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields created before this date."
},
"date_created:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum `date_created`, for example, `2024-05-14T09:34:00`, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields created after this date."
},
"date_modified": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by `date_modified`, for example, `2024-05-14T09:34:00` or `2024-05-14`."
},
"date_modified:max": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by maximum `date_modified`, for example, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields modified before this date."
},
"date_modified:min": {
"type": "string",
"maxLength": 262144,
"description": "Filter items by minimum `date_modified`, for example, `2024-05-14T09:34:00` or `2024-05-14`. ISO 8601 full-date is required, ISO 8601 full-time is not required. UNIX timestamp also accepted. Returns metafields modified after this date."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "name:like",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_created:min",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:max",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "date_modified:min",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Attributes_getCustomersAttributes_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Attributes_getCustomersAttributes_Response_200",
"admin-management-customers-v3__CustomersAttributesGetResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersAttributesGetResponsesContentApplicationJsonSchemaDataItemsType",
"admin-management-customers-v3__MetaOpen"
]
},
"POST /v3/customers/attributes": {
"operation": "attributes_createCustomersAttributes",
"method": "POST",
"path": "/v3/customers/attributes",
"risk": "H",
"description": "Create Customer Attribute. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__attribute_Post"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__attribute_Post",
"admin-management-customers-v3__AttributePostType"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Attributes_createCustomersAttributes_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Attributes_createCustomersAttributes_Response_200",
"admin-management-customers-v3__CustomersAttributesPostResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersAttributesPostResponsesContentApplicationJsonSchemaDataItemsType",
"admin-management-customers-v3__MetaOpen"
]
},
"PUT /v3/customers/attributes": {
"operation": "attributes_updateCustomersAttributes",
"method": "PUT",
"path": "/v3/customers/attributes",
"risk": "H",
"description": "Update Customer Attribute. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "array",
"items": {
"$ref": "#/$defs/admin-management-customers-v3__attribute_Put"
},
"maxItems": 10
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__attribute_Put"
],
"wire": [],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Attributes_updateCustomersAttributes_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Attributes_updateCustomersAttributes_Response_200",
"admin-management-customers-v3__CustomersAttributesPutResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersAttributesPutResponsesContentApplicationJsonSchemaDataItemsType",
"admin-management-customers-v3__MetaOpen"
]
},
"DELETE /v3/customers/attributes": {
"operation": "attributes_deleteCustomersAttributes",
"method": "DELETE",
"path": "/v3/customers/attributes",
"risk": "D",
"description": "Delete Customer Attributes. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"id:in": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxItems": 10,
"description": "Filter items by ID."
}
},
"required": [
"id:in"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "id:in",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"204": null
},
"response_definitions": []
},
"GET /v3/customers/settings/channels/{channel_id}": {
"operation": "channelSettings_getCustomersSettingsChannel",
"method": "GET",
"path": "/v3/customers/settings/channels/{channel_id}",
"risk": "R",
"description": "Get Customer Settings per Channel. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Channel_Settings_getCustomersSettingsChannel_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Channel_Settings_getCustomersSettingsChannel_Response_200",
"admin-management-customers-v3__CustomerChannelSettingsObject",
"admin-management-customers-v3__CustomerChannelSettingsObjectPrivacySettings",
"admin-management-customers-v3__CustomerChannelSettingsObjectCustomerGroupSettings",
"admin-management-customers-v3__CustomersSettingsChannelsChannelIdGetResponsesContentApplicationJsonSchemaMeta"
]
},
"PUT /v3/customers/settings/channels/{channel_id}": {
"operation": "channelSettings_updateCustomersSettingsChannel",
"method": "PUT",
"path": "/v3/customers/settings/channels/{channel_id}",
"risk": "H",
"description": "Update Customer Settings per Channel. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"channel_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the channel."
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-customers-v3__CustomerChannelSettingsObject"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__CustomerChannelSettingsObject",
"admin-management-customers-v3__CustomerChannelSettingsObjectPrivacySettings",
"admin-management-customers-v3__CustomerChannelSettingsObjectCustomerGroupSettings"
],
"wire": [
{
"name": "channel_id",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Channel_Settings_updateCustomersSettingsChannel_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Channel_Settings_updateCustomersSettingsChannel_Response_200",
"admin-management-customers-v3__CustomerSettingsObject",
"admin-management-customers-v3__CustomerSettingsObjectPrivacySettings",
"admin-management-customers-v3__CustomerSettingsObjectCustomerGroupSettings",
"admin-management-customers-v3__CustomersSettingsChannelsChannelIdPutResponsesContentApplicationJsonSchemaMeta"
]
},
"GET /v3/customers/{customerId}/consent": {
"operation": "consent_getCustomerConsent",
"method": "GET",
"path": "/v3/customers/{customerId}/consent",
"risk": "R",
"description": "Get Customer Consent. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the customer."
}
},
"required": [
"customerId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [],
"wire": [
{
"name": "customerId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__consent_Full"
}
},
"response_definitions": [
"admin-management-customers-v3__consent_Full",
"admin-management-customers-v3__consentAllow",
"admin-management-customers-v3__ConsentAllowItems",
"admin-management-customers-v3__Deny",
"admin-management-customers-v3__DenyItems"
]
},
"PUT /v3/customers/{customerId}/consent": {
"operation": "consent_updateCustomerConsent",
"method": "PUT",
"path": "/v3/customers/{customerId}/consent",
"risk": "H",
"description": "Update Customer Consent. Provider acknowledgement only; inspect resource state before retrying an uncertain write. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "The ID of the customer."
}
},
"required": [
"customerId"
],
"additionalProperties": false
},
"body": {
"$ref": "#/$defs/admin-management-customers-v3__DeclareCustomerConsentRequest"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__DeclareCustomerConsentRequest",
"admin-management-customers-v3__consentAllow",
"admin-management-customers-v3__ConsentAllowItems",
"admin-management-customers-v3__Deny",
"admin-management-customers-v3__DenyItems"
],
"wire": [
{
"name": "customerId",
"location": "path",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__consent_Full"
}
},
"response_definitions": [
"admin-management-customers-v3__consent_Full",
"admin-management-customers-v3__consentAllow",
"admin-management-customers-v3__ConsentAllowItems",
"admin-management-customers-v3__Deny",
"admin-management-customers-v3__DenyItems"
]
},
"GET /v3/customers/form-field-values": {
"operation": "formFieldValues_getCustomersFormFieldValues",
"method": "GET",
"path": "/v3/customers/form-field-values",
"risk": "R",
"description": "List Customer Form Field Values. One explicit page; no automatic pagination. https://docs.bigcommerce.com/openapi/admin-management-customers-v3.json",
"partial_http": [],
"error_paths": [],
"failed_count_paths": [],
"failed_status_paths": [],
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Page number (`page` will be ignored if you provide `before` or `after` in the request). For example `page=1`."
},
"limit": {
"type": "number",
"description": "Items count per page. `limit=50`"
},
"customer_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter by the customer ID."
},
"address_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Filter by the ID of the customer address."
},
"field_name": {
"type": "string",
"maxLength": 262144,
"description": "Filter by the field name."
},
"field_type": {
"$ref": "#/$defs/admin-management-customers-v3__CustomersFormFieldValuesGetParametersFieldType",
"description": "Filter by the field type.\n * `checkboxes` - checkboxes field\n * `date` - date field\n * `multiline` - multiline text field\n * `numbers` - numbers only field\n * `password` - password field\n * `radiobuttons` - radio buttons field\n * `text` - text field\n * `picklist` - pick list field"
},
"after": {
"type": "string",
"maxLength": 262144,
"description": "The cursor reference of the last entry for the previous page. Use the `end_cursor` value from the last response to get the next page (`end_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `after=eyJzZXNzaW9uSWQiOjM4LCJmaWVsZElkIjo0MH0`. "
},
"before": {
"type": "string",
"maxLength": 262144,
"description": "The cursor reference of the first entry for the next page. Use the `start_cursor` value from the last response to get the previous page (`start_cursor` is only returned on the first page or when the request contains query parameter `before` or `after`). For example `before=eyJzZXNzaW9uSWQiOjgsImZpZWxkSWQiOjMxfQ`."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"input_definitions": [
"admin-management-customers-v3__CustomersFormFieldValuesGetParametersFieldType"
],
"wire": [
{
"name": "page",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "limit",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "customer_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "address_id",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "field_name",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "field_type",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "after",
"location": "query",
"style": "form",
"explode": false
},
{
"name": "before",
"location": "query",
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"$ref": "#/$defs/admin-management-customers-v3__Form_Field_Values_getCustomersFormFieldValues_Response_200"
}
},
"response_definitions": [
"admin-management-customers-v3__Form_Field_Values_getCustomersFormFieldValues_Response_200",
"admin-management-customers-v3__CustomersFormFieldValuesGetResponsesContentApplicationJsonSchemaDataItems",
"admin-management-customers-v3__CustomersFormFieldValuesGetResponsesContentApplicationJsonSchemaDataItems0",
"admin-management-customers-v3__CustomersFormFieldValuesGetResponsesContentApplicationJsonSchemaDataItemsOneOf0Value",
"admin-management-customers-v3__CustomersFormFieldValuesGetResponsesContentApplicationJsonSchemaDataItems1",
"admin-management-customers-v3__CustomersFormFieldValuesGetResponsesContentApplicationJsonSchemaDataItemsOneOf1Value",
"admin-management-customers-v3___metaCollectionWithCursorPagination",
"admin-management-customers-v3__Pagination",
"admin-management-customers-v3__Links",
"admin-management-customers-v3__CursorPagination"
]
},
"GET /v3/customers/settings": {
"operation": "globalSettings_getCustomersSettings",
"method": "GET",
"path": "/v3/customers/settings",
"risk": "R",
"description": "Get Customer Settings. One explicFile truncated at 1 MB.