kinlane
8/12/2018 - 5:39 AM
bigcommerce openapi
bigcommerce openapi
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "BigCommerce API V3",
"description": "Collection of requests for interacting with BigCommerce's V3 API"
},
"host": "api.bigcommerce.com",
"basePath": "/stores",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/{store-hash}/v3/catalog/products/{id}/images": {
"get": {
"description": "GET request for retrieving images associated with a product ",
"summary": "Retrieve images for a single product",
"tags": [
"Product Images"
],
"operationId": "V3CatalogProductsImagesByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Adds a new product image from a publicly accessible URL. May fail if the hosting website is forcing HTTPS connections with TLS 1.0 (as this has been deprecated). ",
"summary": "Upload a new product image to a single product",
"tags": [
"Product Images"
],
"operationId": "V3CatalogProductsImagesByStoreHashAndIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UploadANewProductImageToASingleProductrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store-hash}/v3/catalog/products/{id}": {
"get": {
"description": "Request a single product with expanded variant information",
"summary": "Retrieve a single product with expanded sub-resources",
"tags": [
"Products"
],
"operationId": "V3CatalogProductsByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "include",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Updates a single product's information in the catalog",
"summary": "Update a product in the catalog",
"tags": [
"Products"
],
"operationId": "V3CatalogProductsByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductInTheCatalogrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Deleting a single product from the catalog by product ID",
"summary": "Delete a single product by ID",
"tags": [
"Products"
],
"operationId": "V3CatalogProductsByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/videos/{id}": {
"get": {
"description": "",
"summary": "Retrieve a video on a product",
"tags": [
"Product Videos"
],
"operationId": "V3CatalogProductsVideosIdByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Updates an video on a product",
"tags": [
"Product Videos"
],
"operationId": "V3CatalogProductsVideosIdByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdatesAnVideoOnAProductrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a video on a product",
"tags": [
"Product Videos"
],
"operationId": "V3CatalogProductsVideosIdByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/variants": {
"get": {
"description": "Returns a `Variant` object list from the BigCommerce Catalog.\n",
"summary": "Retrieve variant with parameters",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "sku",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/videos": {
"get": {
"description": "",
"summary": "Retrieve all videos for a single product",
"tags": [
"Product Videos"
],
"operationId": "V3CatalogProductsVideosByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates an video on a product using a video ID from Youtube\n",
"summary": "Add a video to a product using a video ID from Youtube",
"tags": [
"Product Videos"
],
"operationId": "V3CatalogProductsVideosByStoreHashAndIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AddAVideoToAProductUsingAVideoIdFromYoutuberequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/categories/{id}": {
"get": {
"description": "",
"summary": "Retrieve a single category",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Update a `Category` in the BigCommerce Catalog\n",
"summary": "Update a category",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateACategoryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a single category",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/brands/{id}/image": {
"post": {
"description": "",
"summary": "Upload an image for a brand",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsImageByStoreHashAndIdPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "image_file",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a `Brand` image the BigCommerce Catalog\n",
"summary": "Delete a brand image",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsImageByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store-hash}/v3/catalog/products": {
"get": {
"description": "Shows full product data with a single GET request",
"summary": "Retrieve all products with expanded sub-resources",
"tags": [
"Products"
],
"operationId": "V3CatalogProductsByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "include",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Sample request for creating a new product with variants through V3 Catalog API",
"summary": "Create a new product with variants",
"tags": [
"Products"
],
"operationId": "V3CatalogProductsByStoreHashPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewProductWithVariantsrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Deletes products that aren't marked as visible using a filter parameter",
"summary": "Delete multiple products",
"tags": [
"Products"
],
"operationId": "V3CatalogProductsByStoreHashDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "is_visible",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/summary": {
"get": {
"description": "Returns a lightweight inventory summary from the BigCommerce Catalog.\n",
"summary": "Returns a lightweight inventory summary",
"tags": [
"Catalog"
],
"operationId": "V3CatalogSummaryByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/options": {
"get": {
"description": "",
"summary": "Retrieve an array of product options",
"tags": [
"Product Options"
],
"operationId": "V3CatalogProductsOptionsByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a product option",
"tags": [
"Product Options"
],
"operationId": "V3CatalogProductsOptionsByStoreHashAndIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAProductOptionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/categories/{id}/image": {
"post": {
"description": "",
"summary": "Create an image for a category",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesImageByStoreHashAndIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAnImageForACategoryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a category image",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesImageByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/modifiers": {
"get": {
"description": "",
"summary": "Retrieve an array of product modifiers",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a product modifier",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersByStoreHashAndIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAProductModifierrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store-hash}/v3/catalog/products/{id}/images/{id}": {
"get": {
"description": "GET request for a specific product image by ID",
"summary": "Retrieve a single product image's data",
"tags": [
"Product Images"
],
"operationId": "V3CatalogProductsImagesIdByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "This is used to update the information for an existing product image",
"summary": "Update product image information",
"tags": [
"Product Images"
],
"operationId": "V3CatalogProductsImagesIdByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateProductImageInformationrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a product image and it's description",
"summary": "Delete a single product image",
"tags": [
"Product Images"
],
"operationId": "V3CatalogProductsImagesIdByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store-hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/brands": {
"get": {
"description": "",
"summary": "Retrieve brands",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "limit",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new brand",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsByStoreHashPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewBrandrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete one or more `Brand` objects from the BigCommerce Catalog\n",
"summary": "Delete a brand or brands",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsByStoreHashDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page_title",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/customers/subscribers": {
"get": {
"description": "Returns a paginated Subscribers collection.\n",
"summary": "Returns all newsletter subscribers",
"tags": [
"Newsletter Subscribers"
],
"operationId": "V3CustomersSubscribersByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new subscriber",
"tags": [
"Newsletter Subscribers"
],
"operationId": "V3CustomersSubscribersByStoreHashPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewSubscriberrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "\n",
"summary": "Delete a group of subscribers by parameter",
"tags": [
"Newsletter Subscribers"
],
"operationId": "V3CustomersSubscribersByStoreHashDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_created",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/categories": {
"get": {
"description": "Returns a paginated categories collection from the BigCommerce Catalog\n",
"summary": "Retrieve categories",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "is_visible",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a new category",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesByStoreHashPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateANewCategoryrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "\n",
"summary": "Delete a category or categories",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesByStoreHashDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "is_visible",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/categories/tree": {
"get": {
"description": "",
"summary": "Retrieve category structure/tree",
"tags": [
"Categories"
],
"operationId": "V3CatalogCategoriesTreeByStoreHashGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/variants/{id}": {
"get": {
"description": "Get a `Variant` object.",
"summary": "Retrieve a single variant",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsIdByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Update a `Variant` object.",
"summary": "Update a variant",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsIdByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAVariantrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete a `Variant`\n",
"summary": "Delete a variant",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsIdByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/modifiers/{id}": {
"get": {
"description": "",
"summary": "Retrieve a product modifier",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersIdByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a product modifier",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersIdByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductModifierrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "\n",
"summary": "Delete a product's modifier",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersIdByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/customers/subscribers/{id}": {
"get": {
"description": "",
"summary": "Return a single subscriber by ID",
"tags": [
"Newsletter Subscribers"
],
"operationId": "V3CustomersSubscribersByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a single subscriber",
"tags": [
"Newsletter Subscribers"
],
"operationId": "V3CustomersSubscribersByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateASingleSubscriberrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a single subscriber by ID",
"tags": [
"Newsletter Subscribers"
],
"operationId": "V3CustomersSubscribersByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_id}/v3/catalog/products/{id}/options/{id}": {
"put": {
"description": "",
"summary": "Update a product option",
"tags": [
"Product Options"
],
"operationId": "V3CatalogProductsOptionsIdByStoreIdAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateAProductOptionrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_id",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/brands/{id}": {
"get": {
"description": "",
"summary": "Retrieve a brand",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update a brand",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsByStoreHashAndIdPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateABrandrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a brand",
"tags": [
"Brands"
],
"operationId": "V3CatalogBrandsByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/options/{id}": {
"get": {
"description": "Gets `Option` object by product id and option id.",
"summary": "Retrieve a product option",
"tags": [
"Product Options"
],
"operationId": "V3CatalogProductsOptionsIdByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete a product option",
"tags": [
"Product Options"
],
"operationId": "V3CatalogProductsOptionsIdByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/modifiers/{id}/values/{id}/image": {
"post": {
"description": "Add an image to a modifier value that will show on the storefront when it’s selected",
"summary": "Add an image to a modifier value",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersIdValuesIdImageByStoreHashAndIdPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "image_file",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Delete the image applied to show when the modifier value is selected",
"summary": "Delete the image associated with a modifier",
"tags": [
"Product Modifiers"
],
"operationId": "V3CatalogProductsModifiersIdValuesIdImageByStoreHashAndIdDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/variants/{id}/image": {
"post": {
"description": "",
"summary": "Upload a variant image",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsIdImageByStoreHashAndIdPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "image_file",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{store_hash}/v3/catalog/products/{id}/variants": {
"get": {
"description": "Returns a `Variant` object list from the BigCommerce Catalog.\n",
"summary": "Retrieve a list of variants",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsByStoreHashAndIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create a variant",
"tags": [
"Product Variants"
],
"operationId": "V3CatalogProductsVariantsByStoreHashAndIdPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateAVariantrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "store_hash",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"UpdateAProductInTheCatalogrequest": {
"title": "Update a product in the catalogRequest",
"example": {
"price": 10.25,
"description": "<h4>Great T-shirt</h4>The best t-shirt ever.",
"weight": 1.2
},
"type": "object",
"properties": {
"price": {
"description": "",
"example": 10.25,
"type": "number",
"format": "double"
},
"description": {
"description": "",
"example": "<h4>Great T-shirt</h4>The best t-shirt ever.",
"type": "string"
},
"weight": {
"description": "",
"example": 1.2,
"type": "number",
"format": "double"
}
},
"required": [
"price",
"description",
"weight"
]
},
"UpdateProductImageInformationrequest": {
"title": "Update product image informationRequest",
"example": {
"description": "This is a picture of a tiny puppy in a car."
},
"type": "object",
"properties": {
"description": {
"description": "",
"example": "This is a picture of a tiny puppy in a car.",
"type": "string"
}
},
"required": [
"description"
]
},
"CreateAProductOptionrequest": {
"title": "Create a product optionRequest",
"example": {
"name": "Shirt Sizes",
"display_name": "Sizes",
"type": "RT",
"config": [
{
"option_values": [
{
"is_default": "true",
"label": "large"
},
{
"label": "medium"
}
]
}
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Shirt Sizes",
"type": "string"
},
"display_name": {
"description": "",
"example": "Sizes",
"type": "string"
},
"type": {
"description": "",
"example": "RT",
"type": "string"
},
"config": {
"description": "",
"example": [
{
"option_values": [
{
"is_default": "true",
"label": "large"
},
{
"label": "medium"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Config"
}
}
},
"required": [
"name",
"display_name",
"type",
"config"
]
},
"Config": {
"title": "Config",
"example": {
"option_values": [
{
"is_default": "true",
"label": "large"
},
{
"label": "medium"
}
]
},
"type": "object",
"properties": {
"option_values": {
"description": "",
"example": [
{
"is_default": "true",
"label": "large"
},
{
"label": "medium"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/OptionValue"
}
}
},
"required": [
"option_values"
]
},
"OptionValue": {
"title": "OptionValue",
"example": {
"is_default": "true",
"label": "large"
},
"type": "object",
"properties": {
"label": {
"description": "",
"example": "large",
"type": "string"
},
"is_default": {
"description": "",
"example": "true",
"type": "string"
}
},
"required": [
"label"
]
},
"CreateANewBrandrequest": {
"title": "Create a new brandRequest",
"example": {
"name": "BigCommerce",
"page_title": "ecommerce platform",
"keywords": "ecommerce"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "BigCommerce",
"type": "string"
},
"page_title": {
"description": "",
"example": "ecommerce platform",
"type": "string"
},
"keywords": {
"description": "",
"example": "ecommerce",
"type": "string"
}
},
"required": [
"name",
"page_title",
"keywords"
]
},
"UpdateAProductOptionrequest": {
"title": "Update a product optionRequest",
"example": {
"display_name": "Women's Sizes",
"config": [
{
"option_values": [
{
"label": "small"
}
]
}
]
},
"type": "object",
"properties": {
"display_name": {
"description": "",
"example": "Women's Sizes",
"type": "string"
},
"config": {
"description": "",
"example": [
{
"option_values": [
{
"label": "small"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Config7"
}
}
},
"required": [
"display_name",
"config"
]
},
"Config7": {
"title": "Config7",
"example": {
"option_values": [
{
"label": "small"
}
]
},
"type": "object",
"properties": {
"option_values": {
"description": "",
"example": [
{
"label": "small"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/OptionValue8"
}
}
},
"required": [
"option_values"
]
},
"OptionValue8": {
"title": "OptionValue8",
"example": {
"label": "small"
},
"type": "object",
"properties": {
"label": {
"description": "",
"example": "small",
"type": "string"
}
},
"required": [
"label"
]
},
"CreateAnImageForACategoryrequest": {
"title": "Create an image for a categoryRequest",
"example": {
"image_url": "http://i.imgur.com/pwsKT2G.jpg"
},
"type": "object",
"properties": {
"image_url": {
"description": "",
"example": "http://i.imgur.com/pwsKT2G.jpg",
"type": "string"
}
},
"required": [
"image_url"
]
},
"CreateAProductModifierrequest": {
"title": "Create a product modifierRequest",
"example": {
"name": "T-Shirt Sizes",
"type": "dropdown",
"required": "true"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "T-Shirt Sizes",
"type": "string"
},
"type": {
"description": "",
"example": "dropdown",
"type": "string"
},
"required": {
"description": "",
"example": "true",
"type": "string"
}
},
"required": [
"name",
"type",
"required"
]
},
"CreateANewCategoryrequest": {
"title": "Create a new categoryRequest",
"example": {
"name": "Apparel",
"description": "A category for clothing",
"sort_order": "1",
"is_visible": "true",
"default_product_sort": "avg_customer_reviews"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Apparel",
"type": "string"
},
"description": {
"description": "",
"example": "A category for clothing",
"type": "string"
},
"sort_order": {
"description": "",
"example": "1",
"type": "string"
},
"is_visible": {
"description": "",
"example": "true",
"type": "string"
},
"default_product_sort": {
"description": "",
"example": "avg_customer_reviews",
"type": "string"
}
},
"required": [
"name",
"description",
"sort_order",
"is_visible",
"default_product_sort"
]
},
"UpdateASingleSubscriberrequest": {
"title": "Update a single subscriberRequest",
"example": {
"first_name": "Jane"
},
"type": "object",
"properties": {
"first_name": {
"description": "",
"example": "Jane",
"type": "string"
}
},
"required": [
"first_name"
]
},
"UpdateAVariantrequest": {
"title": "Update a variantRequest",
"example": {
"price": "12.00",
"inventory_level": "4"
},
"type": "object",
"properties": {
"price": {
"description": "",
"example": "12.00",
"type": "string"
},
"inventory_level": {
"description": "",
"example": "4",
"type": "string"
}
},
"required": [
"price",
"inventory_level"
]
},
"UpdateAProductModifierrequest": {
"title": "Update a product modifierRequest",
"example": {
"name": "T-Shirt Sizes",
"type": "rectangles",
"required": "true"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "T-Shirt Sizes",
"type": "string"
},
"type": {
"description": "",
"example": "rectangles",
"type": "string"
},
"required": {
"description": "",
"example": "true",
"type": "string"
}
},
"required": [
"name",
"type",
"required"
]
},
"UpdateACategoryrequest": {
"title": "Update a categoryRequest",
"example": {
"search_keywords": "tshirt, shirt, top"
},
"type": "object",
"properties": {
"search_keywords": {
"description": "",
"example": "tshirt, shirt, top",
"type": "string"
}
},
"required": [
"search_keywords"
]
},
"UploadANewProductImageToASingleProductrequest": {
"title": "Upload a new product image to a single productRequest",
"example": {
"image_file": "http://i.imgur.com/pwsKT2G.jpg"
},
"type": "object",
"properties": {
"image_file": {
"description": "",
"example": "http://i.imgur.com/pwsKT2G.jpg",
"type": "string"
}
},
"required": [
"image_file"
]
},
"CreateANewProductWithVariantsrequest": {
"title": "Create a new product with variantsRequest",
"example": {
"name": "T-shirt",
"type": "physical",
"price": 10.25,
"description": "<h4>Great T-shirt</h4>The best t-shirt ever.",
"weight": 1.2,
"categories": [
18
],
"variants": [
{
"sku": "SKU-R-SM",
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Small"
}
]
},
{
"sku": "SKU-B-SM",
"option_values": [
{
"option_display_name": "Color",
"label": "Blue"
},
{
"option_display_name": "Size",
"label": "Small"
}
]
},
{
"sku": "SKU-R-MD",
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Medium"
}
]
},
{
"sku": "SKU-B-MD",
"option_values": [
{
"option_display_name": "Color",
"label": "Blue"
},
{
"option_display_name": "Size",
"label": "Medium"
}
]
},
{
"sku": "SKU-R-LG",
"price": 10.5,
"weight": 1.25,
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Large"
}
]
},
{
"sku": "SKU-B-LG",
"price": 10.5,
"weight": 1.25,
"option_values": [
{
"option_display_name": "Color",
"label": "Blue"
},
{
"option_display_name": "Size",
"label": "Large"
}
]
}
]
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "T-shirt",
"type": "string"
},
"type": {
"description": "",
"example": "physical",
"type": "string"
},
"price": {
"description": "",
"example": 10.25,
"type": "number",
"format": "double"
},
"description": {
"description": "",
"example": "<h4>Great T-shirt</h4>The best t-shirt ever.",
"type": "string"
},
"weight": {
"description": "",
"example": 1.2,
"type": "number",
"format": "double"
},
"categories": {
"description": "",
"example": [
18
],
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"variants": {
"description": "",
"example": [
{
"sku": "SKU-R-SM",
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Small"
}
]
},
{
"sku": "SKU-B-SM",
"option_values": [
{
"option_display_name": "Color",
"label": "Blue"
},
{
"option_display_name": "Size",
"label": "Small"
}
]
},
{
"sku": "SKU-R-MD",
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Medium"
}
]
},
{
"sku": "SKU-B-MD",
"option_values": [
{
"option_display_name": "Color",
"label": "Blue"
},
{
"option_display_name": "Size",
"label": "Medium"
}
]
},
{
"sku": "SKU-R-LG",
"price": 10.5,
"weight": 1.25,
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Large"
}
]
},
{
"sku": "SKU-B-LG",
"price": 10.5,
"weight": 1.25,
"option_values": [
{
"option_display_name": "Color",
"label": "Blue"
},
{
"option_display_name": "Size",
"label": "Large"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Variant"
}
}
},
"required": [
"name",
"type",
"price",
"description",
"weight",
"categories",
"variants"
]
},
"Variant": {
"title": "Variant",
"example": {
"sku": "SKU-R-SM",
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Small"
}
]
},
"type": "object",
"properties": {
"sku": {
"description": "",
"example": "SKU-R-SM",
"type": "string"
},
"option_values": {
"description": "",
"example": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Small"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/OptionValue19"
}
},
"price": {
"description": "",
"example": 10.5,
"type": "number",
"format": "double"
},
"weight": {
"description": "",
"example": 1.25,
"type": "number",
"format": "double"
}
},
"required": [
"sku",
"option_values"
]
},
"OptionValue19": {
"title": "OptionValue19",
"example": {
"option_display_name": "Color",
"label": "Red"
},
"type": "object",
"properties": {
"option_display_name": {
"description": "",
"example": "Color",
"type": "string"
},
"label": {
"description": "",
"example": "Red",
"type": "string"
}
},
"required": [
"option_display_name",
"label"
]
},
"AddAVideoToAProductUsingAVideoIdFromYoutuberequest": {
"title": "Add a video to a product using a video ID from YoutubeRequest",
"example": {
"id": "puu6ujo0MDg"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": "puu6ujo0MDg",
"type": "string"
}
},
"required": [
"id"
]
},
"CreateAVariantrequest": {
"title": "Create a variantRequest",
"example": {
"sku": "SKU-R-SM",
"price": "10.00",
"inventory_level": "5",
"option_values": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Small"
}
]
},
"type": "object",
"properties": {
"sku": {
"description": "",
"example": "SKU-R-SM",
"type": "string"
},
"price": {
"description": "",
"example": "10.00",
"type": "string"
},
"inventory_level": {
"description": "",
"example": "5",
"type": "string"
},
"option_values": {
"description": "",
"example": [
{
"option_display_name": "Color",
"label": "Red"
},
{
"option_display_name": "Size",
"label": "Small"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/OptionValue19"
}
}
},
"required": [
"sku",
"price",
"inventory_level",
"option_values"
]
},
"UpdateABrandrequest": {
"title": "Update a brandRequest",
"example": {
"name": "Gucci",
"page_title": "Luxury products by Gucci"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "Gucci",
"type": "string"
},
"page_title": {
"description": "",
"example": "Luxury products by Gucci",
"type": "string"
}
},
"required": [
"name",
"page_title"
]
},
"CreateANewSubscriberrequest": {
"title": "Create a new subscriberRequest",
"example": {
"email": "someone@email.com",
"first_name": "John",
"last_name": "Doe"
},
"type": "object",
"properties": {
"email": {
"description": "",
"example": "someone@email.com",
"type": "string"
},
"first_name": {
"description": "",
"example": "John",
"type": "string"
},
"last_name": {
"description": "",
"example": "Doe",
"type": "string"
}
},
"required": [
"email",
"first_name",
"last_name"
]
},
"UpdatesAnVideoOnAProductrequest": {
"title": "Updates an video on a productRequest",
"example": {
"title": "How To Sell Online"
},
"type": "object",
"properties": {
"title": {
"description": "",
"example": "How To Sell Online",
"type": "string"
}
},
"required": [
"title"
]
}
}
}