{ "openapi": "3.0.1", "info": { "title": "Developer API", "version": "1.0.0" }, "paths": { "/api/v1/ad-spy/search": { "post": { "tags": [ "AdSpy" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/ad-spy/{SearchTermValue}/brands": { "get": { "tags": [ "AdSpy" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SearchTermValue", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/ad-spy/sponsored-products": { "get": { "tags": [ "AdSpy" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "searchTermValue", "in": "query", "schema": { "type": "string" } }, { "name": "brandName", "in": "query", "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/brands/search": { "post": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/market-share": { "get": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/sellers": { "get": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/ad-spy": { "get": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/history/sales": { "post": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/history/sales-by-subcategories": { "post": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/history/top-products/sales": { "post": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/brands/{BrandName}/history/top-products/sales-rank": { "post": { "tags": [ "Brands" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "BrandName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v2/brands/search": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsV2Request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsV2Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsV2Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchBrandsV2Request" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/market-share": { "get": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "brandName", "in": "query", "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/sellers": { "get": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "brandName", "in": "query", "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/ad-spy": { "get": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "brandName", "in": "query", "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/history/sales": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryV2Request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryV2Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryV2Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryV2Request" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v2/brands/history/sales-by-subcategories": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesV2Request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesV2Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesV2Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandSalesHistoryBySubcategoriesV2Request" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v2/brands/history/top-products/sales": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryV2Request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryV2Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryV2Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesHistoryV2Request" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v2/brands/history/top-products/sales-rank": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryV2Request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryV2Request" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryV2Request" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandTopProductsSalesRankHistoryV2Request" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v2/brands/history/scope": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/history/scope/by-subcategories": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeBySubcategoriesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeBySubcategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeBySubcategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeBySubcategoriesRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScopeBySubcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScopeBySubcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScopeBySubcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/history/scope/top-products": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeTopProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeTopProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeTopProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandScopeTopProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v2/brands/history/scope/by-sellers": { "post": { "tags": [ "BrandsV2" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageByBrandHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageByBrandHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageByBrandHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageByBrandHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageBySellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageBySellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageBySellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/custom-segments/search": { "post": { "tags": [ "CustomSegments" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchCustomSegmentsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchCustomSegmentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchCustomSegmentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchCustomSegmentsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.CustomSegment, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.CustomSegment, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.CustomSegment, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/geobuybox/request": { "post": { "tags": [ "GeoBuyBox" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.RequestGeoBuyBoxResponse" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/geobuybox": { "get": { "tags": [ "GeoBuyBox" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "requestId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetGeoBuyBoxResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetGeoBuyBoxResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetGeoBuyBoxResult" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/products/search": { "post": { "tags": [ "Products" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Product, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Product, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Product, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/products/{Asin}/history": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/products/{Asin}/history/scope": { "post": { "tags": [ "Products" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetProductHistoryScopeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetProductHistoryScopeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetProductHistoryScopeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetProductHistoryScopeRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ScopeHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ScopeHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ScopeHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/products/{Asin}/offers": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/products/{Asin}/history/offers": { "get": { "tags": [ "Products" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOfferHistoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOfferHistoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOfferHistoryResponse" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/sales/estimate": { "get": { "tags": [ "Sales" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "categoryNode", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "salesRank", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SalesEstimate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SalesEstimate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SalesEstimate" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/search-terms/search": { "post": { "tags": [ "SearchTerms" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSearchTermsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/search-terms/organic-ranks": { "post": { "tags": [ "SearchTerms" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOrganicRanksRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOrganicRanksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOrganicRanksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetOrganicRanksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProductRank, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProductRank, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProductRank, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/search-terms/relevant-products/{Asin}": { "post": { "tags": [ "SearchTerms" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/search-terms/relevant-search-terms/{Asin}": { "post": { "tags": [ "SearchTerms" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "Asin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantSearchTermsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantSearchTermsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantSearchTermsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetRelevantSearchTermsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/search-terms/history": { "post": { "tags": [ "SearchTerms" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSearchTermHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSearchTermHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSearchTermHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSearchTermHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/sellers/search": { "post": { "tags": [ "Sellers" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSellersRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSellersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSellersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSellersRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Seller, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Seller, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Seller, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/sellers/{AmazonSellerId}/offers": { "get": { "tags": [ "Sellers" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "AmazonSellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/sellers/{AmazonSellerId}/brands": { "get": { "tags": [ "Sellers" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "AmazonSellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/sellers/{AmazonSellerId}/history/scope/by-brands": { "post": { "tags": [ "Sellers" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "AmazonSellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageBySellerHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageBySellerHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageBySellerHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetBrandCoverageBySellerHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageByBrandHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageByBrandHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageByBrandHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/sellers/{AmazonSellerId}/history": { "get": { "tags": [ "Sellers" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "AmazonSellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/subcategories/search": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSubcategoriesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSubcategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSubcategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchSubcategoriesRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/subcategories/{SubcategoryId}/brands": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryBrandsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryBrandsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryBrandsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryBrandsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/subcategories/{SubcategoryId}/history/sales": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/subcategories/{SubcategoryId}/history/sales-by-brands": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryByBrandsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryByBrandsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryByBrandsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategorySalesHistoryByBrandsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/subcategories/{SubcategoryId}/history/top-products/sales": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/subcategories/{SubcategoryId}/history/top-products/sales-rank": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesRankHistoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesRankHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesRankHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryTopProductsSalesRankHistoryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true } }, "/api/v1/subcategories/{SubcategoryId}/history/scope": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/subcategories/{SubcategoryId}/history/scope/by-brands": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeByBrandsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeByBrandsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeByBrandsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeByBrandsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScopeByBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScopeByBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScopeByBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/subcategories/{SubcategoryId}/history/scope/top-products": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeTopProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeTopProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeTopProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetSubcategoryScopeTopProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/subcategories/{SubcategoryId}/hierarchy": { "post": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } }, "deprecated": true }, "get": { "tags": [ "Subcategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "marketplace", "in": "query", "required": true, "schema": { "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ] } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: marketplace_required, invalid_marketplace, invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-categories/search": { "post": { "tags": [ "TiktokCategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokCategoriesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokCategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokCategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokCategoriesRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-categories/{SubcategoryId}/products": { "post": { "tags": [ "TiktokCategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-categories/{SubcategoryId}/shops": { "post": { "tags": [ "TiktokCategories" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "SubcategoryId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryShopsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryShopsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryShopsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokSubcategoryShopsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-products/search": { "post": { "tags": [ "TiktokProducts" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-products/variants/search": { "post": { "tags": [ "TiktokProducts" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokVariantsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokVariantsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokVariantsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokVariantsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-products/{ProductId}/variants": { "post": { "tags": [ "TiktokProducts" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "ProductId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokProductVariantsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokProductVariantsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokProductVariantsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokProductVariantsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-shops/search": { "post": { "tags": [ "TiktokShops" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokShopsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokShopsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokShopsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.SearchTiktokShopsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-shops/{ShopId}/products": { "post": { "tags": [ "TiktokShops" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "ShopId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopProductsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } }, "/api/v1/tiktok-shops/{ShopId}/categories": { "post": { "tags": [ "TiktokShops" ], "parameters": [ { "name": "X-Api-Key", "in": "header", "required": true }, { "name": "ShopId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page[id]", "in": "query" }, { "name": "page[size]", "in": "query" }, { "name": "sort[by]", "in": "query" }, { "name": "sort[order]", "in": "query", "schema": { "enum": [ "asc", "desc" ] } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopCategoriesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopCategoriesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopCategoriesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.GetTiktokShopCategoriesRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Invalid request (RFC 9457 problem details). 'errors' is keyed by the error code for a query parameter, or by the field name for a request body that failed to bind; 'traceId' identifies the request. Query parameter codes: invalid_page_size, invalid_page_id, invalid_sort_by, invalid_sort_order.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails" } } } } } } } }, "components": { "schemas": { "Bb.BuyBoxMapUsageModel": { "title": "BuyBoxMapUsageModel", "type": "object", "properties": { "totalCredits": { "type": "integer", "format": "int32" }, "remainingCredits": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bb.CollectionRootDataTypeId": { "title": "CollectionRootDataTypeId", "enum": [ "Products", "Brands", "Subcategories", "Sellers", "SearchTerms" ], "type": "string" }, "Bb.Core.Condition": { "title": "Condition", "type": "object", "properties": { "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Core.DateFilter": { "title": "DateFilter", "type": "object", "properties": { "operator": { "type": "string", "nullable": true }, "condition1": { "$ref": "#/components/schemas/Bb.Core.Condition" }, "condition2": { "$ref": "#/components/schemas/Bb.Core.Condition" }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Core.ListFilter`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "title": "ListFilter`1", "type": "object", "properties": { "filter": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "title": "ListFilter`1", "type": "object", "properties": { "filter": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Bb.Core.RangeDecimal": { "title": "RangeDecimal", "type": "object", "properties": { "min": { "type": "number", "format": "double", "nullable": true }, "max": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Core.RangeFilter": { "title": "RangeFilter", "type": "object", "properties": { "min": { "type": "number", "format": "double", "nullable": true }, "max": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Core.RangeInt": { "title": "RangeInt", "type": "object", "properties": { "min": { "type": "integer", "format": "int32", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Core.TextFilter": { "title": "TextFilter", "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "filter": { "type": "string", "nullable": true }, "operator": { "type": "string", "nullable": true }, "condition1": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "condition2": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "isCombined": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Bb.Pub.Brand": { "title": "Brand", "type": "object", "properties": { "amazonIsr": { "type": "number", "format": "double", "nullable": true }, "avgFbaSellers": { "type": "number", "format": "double", "nullable": true }, "avgSellers": { "type": "number", "format": "double", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "avgVolume": { "type": "number", "format": "double", "nullable": true }, "reviewRating": { "type": "number", "format": "double", "nullable": true }, "totalProducts": { "type": "integer", "format": "int32", "nullable": true }, "totalReviews": { "type": "integer", "format": "int32", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "monthlyUnitsSold": { "type": "integer", "format": "int32", "nullable": true }, "brandScore": { "type": "number", "format": "double", "nullable": true }, "hasStorefront": { "type": "boolean" }, "storefrontUrl": { "type": "string", "nullable": true }, "dominantSellerProfileId": { "type": "integer", "format": "int32", "nullable": true }, "dominantSellerBrandCoverage": { "type": "number", "format": "double", "nullable": true }, "brandName": { "type": "string", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "subcategoryName": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "monthGrowth": { "type": "number", "format": "double", "nullable": true }, "monthGrowth12": { "type": "number", "format": "double", "nullable": true }, "trailing12Months": { "type": "number", "format": "double", "nullable": true }, "outOfStockCount": { "type": "integer", "format": "int32", "nullable": true }, "domain": { "type": "string", "nullable": true }, "hasSingleSeller": { "type": "boolean" } }, "additionalProperties": false }, "Bb.Pub.BrandCoverage": { "title": "BrandCoverage", "type": "object", "properties": { "numberOffers": { "type": "integer", "format": "int32", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "estimateBrandPercentage": { "type": "number", "format": "double", "nullable": true }, "amazonSellerId": { "type": "string", "nullable": true }, "brandName": { "type": "string", "nullable": true }, "monthOverMonthChange": { "type": "number", "format": "double", "nullable": true, "deprecated": true }, "moMBrandShareChange": { "type": "number", "format": "double", "nullable": true }, "sellerName": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "moMRevenueChange": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Bb.Pub.BrandCoverageByBrandHistory": { "title": "BrandCoverageByBrandHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "brandName": { "type": "string", "nullable": true }, "coverage": { "type": "number", "format": "double", "nullable": true }, "estimateRevenue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.BrandCoverageBySellerHistory": { "title": "BrandCoverageBySellerHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "amazonSellerId": { "type": "string", "nullable": true }, "coverage": { "type": "number", "format": "double", "nullable": true }, "estimateRevenue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.BrandSalesHistory": { "title": "BrandSalesHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "brand": { "type": "string", "nullable": true }, "sales": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.BrandScope": { "title": "BrandScope", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "revenue": { "type": "number", "format": "double", "nullable": true }, "unitSales": { "type": "integer", "format": "int32", "nullable": true }, "sellingPrice": { "type": "number", "format": "double", "nullable": true }, "asins": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bb.Pub.BrandScopeBySubcategory": { "title": "BrandScopeBySubcategory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "subcategoryId": { "type": "integer", "format": "int64" }, "revenue": { "type": "number", "format": "double", "nullable": true }, "unitSales": { "type": "integer", "format": "int32", "nullable": true }, "sellingPrice": { "type": "number", "format": "double", "nullable": true }, "asins": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bb.Pub.BrandSearchTerm": { "title": "BrandSearchTerm", "type": "object", "properties": { "sponsoredProducts": { "type": "integer", "format": "int32" }, "sponsoredBrandWinRate": { "type": "number", "format": "double", "nullable": true }, "sponsoredVideoWinRate": { "type": "number", "format": "double", "nullable": true }, "topGroupWinRate": { "type": "number", "format": "double", "nullable": true }, "topSpotWinRate": { "type": "number", "format": "double", "nullable": true }, "sponsoredBrandSpend": { "type": "number", "format": "double", "nullable": true }, "sponsoredVideoSpend": { "type": "number", "format": "double", "nullable": true }, "topSpotSpend": { "type": "number", "format": "double", "nullable": true }, "topGroupSpend": { "type": "number", "format": "double", "nullable": true }, "totalAdSpend": { "type": "number", "format": "double", "nullable": true }, "searchTermValue": { "type": "string", "nullable": true }, "estimateSearches": { "type": "integer", "format": "int32" }, "estimatedCpc": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.CustomSegment": { "title": "CustomSegment", "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "dataType": { "$ref": "#/components/schemas/Bb.CollectionRootDataTypeId" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Bb.Pub.DailyRank": { "title": "DailyRank", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "avgRank": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.EstimatedUnitSalesHistory": { "title": "EstimatedUnitSalesHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "sales": { "type": "number", "format": "float", "nullable": true }, "coverage": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GeoBuyBoxModel": { "title": "GeoBuyBoxModel", "type": "object", "properties": { "state": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "isPrime": { "type": "boolean", "nullable": true }, "freeShippingDays": { "type": "integer", "format": "int32", "nullable": true }, "fastestShippingDays": { "type": "integer", "format": "int32", "nullable": true }, "amazonSellerId": { "type": "string", "nullable": true }, "sellerName": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GeoBuyBoxProductModel": { "title": "GeoBuyBoxProductModel", "type": "object", "properties": { "asin": { "type": "string", "nullable": true }, "buyBoxes": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.GeoBuyBoxModel" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandCoverageByBrandHistoryRequest": { "title": "GetBrandCoverageByBrandHistoryRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandCoverageBySellerHistoryRequest": { "title": "GetBrandCoverageBySellerHistoryRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandSalesHistoryBySubcategoriesRequest": { "title": "GetBrandSalesHistoryBySubcategoriesRequest", "type": "object", "properties": { "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandSalesHistoryBySubcategoriesV2Request": { "title": "GetBrandSalesHistoryBySubcategoriesV2Request", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandSalesHistoryRequest": { "title": "GetBrandSalesHistoryRequest", "type": "object", "properties": { "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandSalesHistoryV2Request": { "title": "GetBrandSalesHistoryV2Request", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandScopeBySubcategoriesRequest": { "title": "GetBrandScopeBySubcategoriesRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandScopeRequest": { "title": "GetBrandScopeRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandScopeTopProductsRequest": { "title": "GetBrandScopeTopProductsRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "topBy": { "type": "string", "nullable": true }, "top": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandTopProductsSalesHistoryRequest": { "title": "GetBrandTopProductsSalesHistoryRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandTopProductsSalesHistoryV2Request": { "title": "GetBrandTopProductsSalesHistoryV2Request", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandTopProductsSalesRankHistoryRequest": { "title": "GetBrandTopProductsSalesRankHistoryRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetBrandTopProductsSalesRankHistoryV2Request": { "title": "GetBrandTopProductsSalesRankHistoryV2Request", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetGeoBuyBoxResult": { "title": "GetGeoBuyBoxResult", "type": "object", "properties": { "asinCount": { "type": "integer", "format": "int32" }, "processedAsins": { "type": "integer", "format": "int32" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.GeoBuyBoxProductModel" }, "nullable": true }, "error": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetOfferHistoryResponse": { "title": "GetOfferHistoryResponse", "type": "object", "properties": { "weeklyOfferHistories": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.WeeklyOfferHistory" }, "nullable": true }, "sellerNames": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetOrganicRanksRequest": { "title": "GetOrganicRanksRequest", "type": "object", "properties": { "asin": { "type": "string", "nullable": true }, "excludeVariants": { "type": "boolean" }, "includeRankHistory": { "type": "boolean" }, "intent": { "type": "string", "nullable": true }, "searchTerm": { "type": "string", "nullable": true }, "avgRank": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "latestRank": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "rankScore": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "smartScore": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "estimateSearches": { "$ref": "#/components/schemas/Bb.Core.RangeInt" } }, "additionalProperties": false }, "Bb.Pub.GetProductHistoryScopeRequest": { "title": "GetProductHistoryScopeRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetRelevantProductsRequest": { "title": "GetRelevantProductsRequest", "type": "object", "properties": { "parentAsin": { "type": "string", "nullable": true }, "relevancyScore": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "commonSearchTerms": { "$ref": "#/components/schemas/Bb.Core.RangeInt" } }, "additionalProperties": false }, "Bb.Pub.GetRelevantSearchTermsRequest": { "title": "GetRelevantSearchTermsRequest", "type": "object", "properties": { "parentAsin": { "type": "string", "nullable": true, "readOnly": true }, "searchTerm": { "type": "string", "nullable": true }, "intent": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "relevancy": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "estimatedSearches": { "$ref": "#/components/schemas/Bb.Core.RangeInt" } }, "additionalProperties": false }, "Bb.Pub.GetSearchTermHistoryRequest": { "title": "GetSearchTermHistoryRequest", "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategoryBrandsRequest": { "title": "GetSubcategoryBrandsRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategorySalesHistoryByBrandsRequest": { "title": "GetSubcategorySalesHistoryByBrandsRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategorySalesHistoryRequest": { "title": "GetSubcategorySalesHistoryRequest", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategoryScopeByBrandsRequest": { "title": "GetSubcategoryScopeByBrandsRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategoryScopeRequest": { "title": "GetSubcategoryScopeRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategoryScopeTopProductsRequest": { "title": "GetSubcategoryScopeTopProductsRequest", "type": "object", "properties": { "topBy": { "type": "string", "nullable": true }, "top": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategoryTopProductsSalesHistoryRequest": { "title": "GetSubcategoryTopProductsSalesHistoryRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetSubcategoryTopProductsSalesRankHistoryRequest": { "title": "GetSubcategoryTopProductsSalesRankHistoryRequest", "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetTiktokProductVariantsRequest": { "title": "GetTiktokProductVariantsRequest", "type": "object", "properties": { "ids": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "variant": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "badges": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "price": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "lifetimeRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "quantityAvailable": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "freeShipping": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.GetTiktokShopCategoriesRequest": { "title": "GetTiktokShopCategoriesRequest", "type": "object", "additionalProperties": false }, "Bb.Pub.GetTiktokShopProductsRequest": { "title": "GetTiktokShopProductsRequest", "type": "object", "properties": { "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int32", "nullable": true }, "amzSubcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "productName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productDescription": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "categoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "reviewCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "lifeTimeUnitSales": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyUnitSales": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "variantCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "avgRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" } }, "additionalProperties": false }, "Bb.Pub.GetTiktokSubcategoryProductsRequest": { "title": "GetTiktokSubcategoryProductsRequest", "type": "object", "properties": { "shopId": { "type": "integer", "format": "int64", "nullable": true }, "amzSubcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "shopName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productDescription": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "reviewCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "lifeTimeUnitSales": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyUnitSales": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "variantCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "avgRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" } }, "additionalProperties": false }, "Bb.Pub.GetTiktokSubcategoryShopsRequest": { "title": "GetTiktokSubcategoryShopsRequest", "type": "object", "properties": { "name": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "country": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "lifetimeRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyGrowthRate": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "numberOfProducts": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "primarySubcategoryShare": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Brand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[Brand]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.Brand" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverage, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandCoverage]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandCoverage" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageByBrandHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandCoverageByBrandHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandCoverageByBrandHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandCoverageBySellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandCoverageBySellerHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandCoverageBySellerHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandSalesHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandSalesHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandScope]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandScope" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandScopeBySubcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandScopeBySubcategory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandScopeBySubcategory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.BrandSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[BrandSearchTerm]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.BrandSearchTerm" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.CustomSegment, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[CustomSegment]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.CustomSegment" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.EstimatedUnitSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[EstimatedUnitSalesHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.EstimatedUnitSalesHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Product, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[Product]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.Product" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[ProductHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.ProductHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[ProductOffer]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.ProductOffer" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[ProductSalesHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.ProductSalesHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ProductSalesRankHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[ProductSalesRankHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.ProductSalesRankHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[RelevantProduct]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.RelevantProduct" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.RelevantSearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[RelevantSearchTerm]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.RelevantSearchTerm" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.ScopeHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[ScopeHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.ScopeHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTerm, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SearchTerm]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SearchTerm" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SearchTermBrand]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SearchTermBrand" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SearchTermHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SearchTermHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SearchTermProduct]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SearchTermProduct" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SearchTermProductRank, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SearchTermProductRank]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SearchTermProductRank" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Seller, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[Seller]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.Seller" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SellerHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SellerHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SellerOffer, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SellerOffer]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SellerOffer" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.Subcategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[Subcategory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.Subcategory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SubcategoryBrand]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SubcategoryBrand" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategorySalesHistory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SubcategorySalesHistory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SubcategorySalesHistory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SubcategoryScope]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SubcategoryScope" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.SubcategoryScopeByBrand, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[SubcategoryScopeByBrand]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.SubcategoryScopeByBrand" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokCategory, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[TiktokCategory]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.TiktokCategory" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokProduct, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[TiktokProduct]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.TiktokProduct" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokShop, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[TiktokShop]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.TiktokShop" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TiktokVariant, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[TiktokVariant]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.TiktokVariant" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.PagedSearchResponse`1[[Bb.Pub.TopProductScope, Bb.Pub.App.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "PagedSearchResponse[TopProductScope]", "type": "object", "properties": { "dataCount": { "type": "integer", "format": "int32" }, "paging": { "$ref": "#/components/schemas/Bb.Pub.Paging" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.TopProductScope" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.Paging": { "title": "Paging", "type": "object", "properties": { "nextPageId": { "type": "string", "nullable": true }, "hasMoreRecords": { "type": "boolean" } }, "additionalProperties": false }, "Bb.Pub.Product": { "title": "Product", "type": "object", "properties": { "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "asin": { "type": "string", "nullable": true }, "rank": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryRank": { "type": "integer", "format": "int32", "nullable": true }, "numberOfSellers": { "type": "integer", "format": "int32", "nullable": true }, "buyBoxPrice": { "type": "number", "format": "double", "nullable": true }, "averageBuyBoxPrice": { "type": "number", "format": "double", "nullable": true }, "reviewCount": { "type": "integer", "format": "int32", "nullable": true }, "reviewRating": { "type": "number", "format": "double", "nullable": true }, "numberFbaSellers": { "type": "integer", "format": "int32", "nullable": true }, "amazonIsr": { "type": "number", "format": "double", "nullable": true }, "monthlyRevenueEstimate": { "type": "number", "format": "double", "nullable": true }, "monthlyUnitsSold": { "type": "integer", "format": "int32", "nullable": true }, "outOfStockNow": { "type": "boolean" }, "productPageScore": { "type": "number", "format": "double", "nullable": true }, "isVariation": { "type": "boolean" }, "parentAsin": { "type": "string", "nullable": true }, "imageCount": { "type": "integer", "format": "int32", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "buyBoxEquity": { "type": "number", "format": "double", "nullable": true }, "revenueEquity": { "type": "number", "format": "double", "nullable": true }, "marginEquity": { "type": "number", "format": "double", "nullable": true }, "partNumber": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true }, "upc": { "type": "string", "nullable": true }, "manufacturer": { "type": "string", "nullable": true }, "numberOfItems": { "type": "integer", "format": "int32", "nullable": true }, "totalRatings": { "type": "integer", "format": "int32", "nullable": true }, "packageQuantity": { "type": "integer", "format": "int32", "nullable": true }, "size": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "length": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "listedSince": { "type": "string", "format": "date-time", "nullable": true }, "subcategoryName": { "type": "string", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "brandName": { "type": "string", "nullable": true }, "ttmRevenue": { "type": "number", "format": "double", "nullable": true }, "boughtInPastMonth": { "type": "integer", "format": "int32", "nullable": true }, "twelveTwentyFourMonthRevenue": { "type": "number", "format": "double", "nullable": true }, "oneMonthGrowth": { "type": "number", "format": "double", "nullable": true }, "twelveMonthGrowth": { "type": "number", "format": "double", "nullable": true }, "buyBoxSuppression": { "type": "number", "format": "double", "nullable": true }, "lastRefreshed": { "type": "string", "format": "date-time", "nullable": true }, "ttmStartDate": { "type": "string", "format": "date-time", "nullable": true }, "ttmEndDate": { "type": "string", "format": "date-time", "nullable": true }, "ttmRevenueChange": { "type": "number", "format": "double", "nullable": true }, "ttmUnitsSold": { "type": "number", "format": "double", "nullable": true }, "hasAPlusContent": { "type": "boolean" }, "hasVideos": { "type": "boolean" }, "inStockRate90Day": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.ProductHistory": { "title": "ProductHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "newFbmPrice": { "type": "number", "format": "double", "nullable": true }, "newFbaPrice": { "type": "number", "format": "double", "nullable": true }, "salesRank": { "type": "number", "format": "double", "nullable": true }, "buyBoxPrice": { "type": "number", "format": "double", "nullable": true }, "reviewsCount": { "type": "number", "format": "double", "nullable": true }, "newOfferCount": { "type": "number", "format": "double", "nullable": true }, "amazonPrice": { "type": "number", "format": "double", "nullable": true }, "rankScore": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.ProductOffer": { "title": "ProductOffer", "type": "object", "properties": { "sellerId": { "type": "string", "nullable": true }, "sellerName": { "type": "string", "nullable": true }, "buyBoxPercentage": { "type": "number", "format": "double", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.ProductSalesHistory": { "title": "ProductSalesHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "asin": { "type": "string", "nullable": true }, "sales": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.ProductSalesRankHistory": { "title": "ProductSalesRankHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "asin": { "type": "string", "nullable": true }, "salesRank": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.RelevantProduct": { "title": "RelevantProduct", "type": "object", "properties": { "asin": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "commonSearchTerms": { "type": "integer", "format": "int32" }, "relevancyScore": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Bb.Pub.RelevantSearchTerm": { "title": "RelevantSearchTerm", "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "estimateSearches": { "type": "integer", "format": "int32" }, "relevancy": { "type": "number", "format": "double" }, "intent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.RequestGeoBuyBoxRequest": { "title": "RequestGeoBuyBoxRequest", "type": "object", "properties": { "asins": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.RequestGeoBuyBoxResponse": { "title": "RequestGeoBuyBoxResponse", "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "usage": { "$ref": "#/components/schemas/Bb.BuyBoxMapUsageModel" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SalesEstimate": { "title": "SalesEstimate", "type": "object", "properties": { "estimated30DaySalesVelocity": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.ScopeHistory": { "title": "ScopeHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "buyBoxPrice": { "type": "number", "format": "float", "nullable": true }, "sales": { "type": "number", "format": "float", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "numberOfSellers": { "type": "integer", "format": "int32", "nullable": true }, "salesRank": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryRank": { "type": "integer", "format": "int32", "nullable": true }, "rating": { "type": "number", "format": "float", "nullable": true }, "reviews": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchBrandsRequest": { "title": "SearchBrandsRequest", "type": "object", "properties": { "customSegmentId": { "type": "string", "nullable": true }, "brandNames": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "brandName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "amazonIsr": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgSellers": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgVolume": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "reviewRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "totalReviews": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "totalProducts": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "avgFbaSellers": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "brandScore": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "note": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "category": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "categoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryContextName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "hasStorefront": { "type": "boolean", "nullable": true }, "searchTerms": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "sponsoredProducts": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "sponsoredBrandWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "sponsoredVideoWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "topSpotWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "topGroupWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "monthGrowth": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "monthGrowth12": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "trailing12Months": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" } }, "additionalProperties": false }, "Bb.Pub.SearchBrandsV2Request": { "title": "SearchBrandsV2Request", "type": "object", "properties": { "customSegmentId": { "type": "string", "nullable": true }, "brandNames": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "brandName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "amazonIsr": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgSellers": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgVolume": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "reviewRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "totalReviews": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "totalProducts": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "avgFbaSellers": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "brandScore": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "note": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "category": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "categoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryContextName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "hasStorefront": { "type": "boolean", "nullable": true }, "searchTerms": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "sponsoredProducts": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "sponsoredBrandWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "sponsoredVideoWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "topSpotWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "topGroupWinRate": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "monthGrowth": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "monthGrowth12": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "trailing12Months": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" } }, "additionalProperties": false }, "Bb.Pub.SearchCustomSegmentsRequest": { "title": "SearchCustomSegmentsRequest", "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "createdDate": { "$ref": "#/components/schemas/Bb.Core.DateFilter" } }, "additionalProperties": false }, "Bb.Pub.SearchProductsRequest": { "title": "SearchProductsRequest", "type": "object", "properties": { "customSegmentId": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "brandName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "categoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryContextName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "rank": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyRevenueEstimate": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "amazonIsr": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "numberOfSellers": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "numberFbaSellers": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "reviewCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "reviewRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "buyBoxPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "productPageScore": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "outOfStockNow": { "type": "boolean", "nullable": true }, "isVariation": { "type": "boolean", "nullable": true }, "asins": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "asin": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "parentAsin": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "title": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "note": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "upcs": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "upc": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "buyBoxEquity": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "numberOfItems": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "totalRatings": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "listedSince": { "$ref": "#/components/schemas/Bb.Core.DateFilter" }, "lastRefreshed": { "$ref": "#/components/schemas/Bb.Core.DateFilter" } }, "additionalProperties": false }, "Bb.Pub.SearchSearchTermsRequest": { "title": "SearchSearchTermsRequest", "type": "object", "properties": { "customSegmentId": { "type": "string", "nullable": true }, "searchTermValue": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "estimateSearches": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "brands": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "products": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "estimatedCpc": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "superCharge": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchSellersRequest": { "title": "SearchSellersRequest", "type": "object", "properties": { "customSegmentId": { "type": "string", "nullable": true }, "categoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "amazonSellerId": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "amazonSellerIds": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "sellerNames": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "businessNames": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.String, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "includeProducts": { "type": "boolean", "nullable": true }, "estimateSales": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "sellerName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "percentFba": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "numberWinningBrands": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "numberAsins": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "numberTopAsins": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "numBrands1000": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "moMGrowth": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "threeMonthGrowth": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "sixMonthGrowth": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "yearGrowth": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "moMGrowthCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "sixMonthGrowthCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "street": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "city": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "state": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "country": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "zipCode": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "businessName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "numberReviewsLifetime": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "numberReviews30Days": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "isSuspended": { "type": "boolean", "nullable": true }, "lastSuspendedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchSubcategoriesRequest": { "title": "SearchSubcategoriesRequest", "type": "object", "properties": { "customSegmentId": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int64", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "parentId": { "type": "integer", "format": "int64", "nullable": true }, "totalMonthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "totalBrands": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "totalAsins": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "avgReviews": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "avgRating": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "azRevenuePct": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "sellerRevenuePct": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "avgNumberSellers": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "avgPageScore": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "avgVolume": { "$ref": "#/components/schemas/Bb.Core.RangeDecimal" }, "totalNumberUnitsSold": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "totalReviews": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "subcategoryContextName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" } }, "additionalProperties": false }, "Bb.Pub.SearchTerm": { "title": "SearchTerm", "type": "object", "properties": { "searchTermValue": { "type": "string", "nullable": true }, "estimateSearches": { "type": "integer", "format": "int32", "nullable": true }, "superCharge": { "type": "boolean" }, "superChargeDate": { "type": "string", "format": "date-time", "nullable": true }, "brands": { "type": "integer", "format": "int32", "nullable": true }, "products": { "type": "integer", "format": "int32", "nullable": true }, "estimatedCpc": { "type": "number", "format": "double", "nullable": true }, "cpcRangeStart": { "type": "number", "format": "double", "nullable": true }, "cpcRangeEnd": { "type": "number", "format": "double", "nullable": true }, "conversionShareTop3Total": { "type": "number", "format": "double", "nullable": true }, "clickShare1": { "type": "number", "format": "double", "nullable": true }, "clickShare2": { "type": "number", "format": "double", "nullable": true }, "clickShare3": { "type": "number", "format": "double", "nullable": true }, "rankingProducts": { "type": "integer", "format": "int32", "nullable": true }, "rankingBrands": { "type": "integer", "format": "int32", "nullable": true }, "titleDensityCount": { "type": "integer", "format": "int32", "nullable": true }, "searchResultsCount": { "type": "integer", "format": "int32", "nullable": true }, "opportunityScore": { "type": "integer", "format": "int32", "nullable": true }, "launchVelocity": { "type": "integer", "format": "int32", "nullable": true }, "totalKeywordSales": { "type": "integer", "format": "int64", "nullable": true }, "estimateSearchesGrowth1Month": { "type": "integer", "format": "int32", "nullable": true }, "estimateSearchesGrowth3Months": { "type": "integer", "format": "int32", "nullable": true }, "estimateSearchesGrowth6Months": { "type": "integer", "format": "int32", "nullable": true }, "estimateSearchesGrowth12Months": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchTermBrand": { "title": "SearchTermBrand", "type": "object", "properties": { "sponsoredProducts": { "type": "integer", "format": "int32" }, "sponsoredBrandWinRate": { "type": "number", "format": "double", "nullable": true }, "sponsoredVideoWinRate": { "type": "number", "format": "double", "nullable": true }, "topGroupWinRate": { "type": "number", "format": "double", "nullable": true }, "topSpotWinRate": { "type": "number", "format": "double", "nullable": true }, "sponsoredBrandSpend": { "type": "number", "format": "double", "nullable": true }, "sponsoredVideoSpend": { "type": "number", "format": "double", "nullable": true }, "topSpotSpend": { "type": "number", "format": "double", "nullable": true }, "topGroupSpend": { "type": "number", "format": "double", "nullable": true }, "totalAdSpend": { "type": "number", "format": "double", "nullable": true }, "brandName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchTermHistory": { "title": "SearchTermHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "estimateSearches": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchTermProduct": { "title": "SearchTermProduct", "type": "object", "properties": { "sponsoredBrandWinRate": { "type": "number", "format": "double" }, "sponsoredVideoWinRate": { "type": "number", "format": "double" }, "topGroupWinRate": { "type": "number", "format": "double" }, "topSpotWinRate": { "type": "number", "format": "double" }, "asin": { "type": "string", "nullable": true }, "productTitle": { "type": "string", "nullable": true }, "brandName": { "type": "string", "nullable": true }, "searchTermValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchTermProductRank": { "title": "SearchTermProductRank", "type": "object", "properties": { "avgRank": { "type": "number", "format": "double" }, "latestRank": { "type": "integer", "format": "int32", "nullable": true }, "keywordSales": { "type": "integer", "format": "int32", "nullable": true }, "asin": { "type": "string", "nullable": true }, "searchTerm": { "type": "string", "nullable": true }, "estimateSearches": { "type": "integer", "format": "int32", "nullable": true }, "intent": { "type": "string", "nullable": true }, "rankScore": { "type": "integer", "format": "int32", "nullable": true }, "rankHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Bb.Pub.DailyRank" }, "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchTiktokCategoriesRequest": { "title": "SearchTiktokCategoriesRequest", "type": "object", "properties": { "parentId": { "type": "integer", "format": "int32", "nullable": true }, "leafNodesOnly": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SearchTiktokProductsRequest": { "title": "SearchTiktokProductsRequest", "type": "object", "properties": { "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "shopId": { "type": "integer", "format": "int64", "nullable": true }, "amzSubcategoryId": { "type": "integer", "format": "int64", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int32", "nullable": true }, "shopName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productDescription": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "categoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "subcategoryName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "reviewCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "lifeTimeUnitSales": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyUnitSales": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "variantCount": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "avgRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" } }, "additionalProperties": false }, "Bb.Pub.SearchTiktokShopsRequest": { "title": "SearchTiktokShopsRequest", "type": "object", "properties": { "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "country": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "lifetimeRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyGrowthRate": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "numberOfProducts": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "primarySubcategoryShare": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgRating": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" } }, "additionalProperties": false }, "Bb.Pub.SearchTiktokVariantsRequest": { "title": "SearchTiktokVariantsRequest", "type": "object", "properties": { "ids": { "$ref": "#/components/schemas/Bb.Core.ListFilter`1[[System.Int64, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "variant": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "badges": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "price": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "avgPrice": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "monthlyRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "lifetimeRevenue": { "$ref": "#/components/schemas/Bb.Core.RangeFilter" }, "quantityAvailable": { "$ref": "#/components/schemas/Bb.Core.RangeInt" }, "freeShipping": { "type": "boolean", "nullable": true }, "productId": { "type": "integer", "format": "int64", "nullable": true }, "shopId": { "type": "integer", "format": "int64", "nullable": true }, "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int32", "nullable": true }, "shopName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productName": { "$ref": "#/components/schemas/Bb.Core.TextFilter" }, "productDescription": { "$ref": "#/components/schemas/Bb.Core.TextFilter" } }, "additionalProperties": false }, "Bb.Pub.Seller": { "title": "Seller", "type": "object", "properties": { "businessName": { "type": "string", "nullable": true }, "amazonSellerId": { "type": "string", "nullable": true }, "estimateSales": { "type": "number", "format": "double", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "percentFba": { "type": "number", "format": "double", "nullable": true }, "numberReviewsLifetime": { "type": "integer", "format": "int32", "nullable": true }, "numberReviews30Days": { "type": "integer", "format": "int32", "nullable": true }, "numberWinningBrands": { "type": "integer", "format": "int32", "nullable": true }, "numberAsins": { "type": "integer", "format": "int32", "nullable": true }, "numberTopAsins": { "type": "integer", "format": "int32", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "numBrands1000": { "type": "integer", "format": "int32", "nullable": true }, "moMGrowth": { "type": "number", "format": "double", "nullable": true }, "threeMonthGrowth": { "type": "number", "format": "double", "nullable": true }, "sixMonthGrowth": { "type": "number", "format": "double", "nullable": true }, "yearGrowth": { "type": "number", "format": "double", "nullable": true }, "moMGrowthCount": { "type": "integer", "format": "int32", "nullable": true }, "sixMonthGrowthCount": { "type": "integer", "format": "int32", "nullable": true }, "ttm": { "type": "number", "format": "double", "nullable": true }, "ttmPrev": { "type": "number", "format": "double", "nullable": true }, "ttmGrowth": { "type": "number", "format": "double", "nullable": true }, "isSuspended": { "type": "boolean" }, "lastSuspendedDate": { "type": "string", "format": "date-time", "nullable": true }, "startedSellingDate": { "type": "string", "format": "date-time", "nullable": true }, "sellerName": { "type": "string", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "subcategoryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SellerHistory": { "title": "SellerHistory", "type": "object", "properties": { "historyDate": { "type": "string", "format": "date-time" }, "reviews": { "type": "integer", "format": "int32", "nullable": true }, "reviewScore": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SellerOffer": { "title": "SellerOffer", "type": "object", "properties": { "asin": { "type": "string", "nullable": true }, "brandName": { "type": "string", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "buyBoxPercentage": { "type": "number", "format": "double", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.Subcategory": { "title": "Subcategory", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "subcategoryName": { "type": "string", "nullable": true }, "totalMonthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "totalBrands": { "type": "integer", "format": "int32", "nullable": true }, "totalAsins": { "type": "integer", "format": "int32", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "avgReviews": { "type": "number", "format": "double", "nullable": true }, "avgRating": { "type": "number", "format": "double", "nullable": true }, "avgNumberSellers": { "type": "number", "format": "double", "nullable": true }, "avgPageScore": { "type": "number", "format": "double", "nullable": true }, "avgVolume": { "type": "number", "format": "double", "nullable": true }, "totalNumberUnitsSold": { "type": "integer", "format": "int64", "nullable": true }, "totalReviews": { "type": "integer", "format": "int64", "nullable": true }, "subcategoryContextName": { "type": "string", "nullable": true }, "sellerRevenuePct": { "type": "number", "format": "double", "nullable": true }, "azRevenuePct": { "type": "number", "format": "double", "nullable": true }, "avgListedSinceDays": { "type": "integer", "format": "int32", "nullable": true }, "ttm": { "type": "number", "format": "double", "nullable": true }, "isParent": { "type": "boolean", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "isLeafNode": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "monthGrowth": { "type": "number", "format": "double", "nullable": true }, "monthGrowth12": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SubcategoryBrand": { "title": "SubcategoryBrand", "type": "object", "properties": { "brandName": { "type": "string", "nullable": true }, "subcategoryName": { "type": "string", "nullable": true }, "subcategoryContext": { "type": "string", "nullable": true }, "numberASINs": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "totalReviews": { "type": "integer", "format": "int32", "nullable": true }, "reviewRating": { "type": "number", "format": "double", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "avgNumberSellers": { "type": "number", "format": "double", "nullable": true }, "avgPageScore": { "type": "number", "format": "double", "nullable": true }, "avgVolume": { "type": "number", "format": "double", "nullable": true }, "avgReviews": { "type": "number", "format": "double", "nullable": true }, "totalNumberUnitsSold": { "type": "integer", "format": "int32", "nullable": true }, "marketshare": { "type": "number", "format": "double", "nullable": true }, "moMMktShareChange": { "type": "number", "format": "double", "nullable": true }, "moMMonthlyUnitsChange": { "type": "integer", "format": "int32", "nullable": true }, "moMMonthlyRevChange": { "type": "number", "format": "double", "nullable": true }, "adSpendShare": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SubcategorySalesHistory": { "title": "SubcategorySalesHistory", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "subcategoryId": { "type": "integer", "format": "int64" }, "sales": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.SubcategoryScope": { "title": "SubcategoryScope", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "revenue": { "type": "number", "format": "double", "nullable": true }, "unitSales": { "type": "integer", "format": "int32", "nullable": true }, "sellingPrice": { "type": "number", "format": "double", "nullable": true }, "asins": { "type": "integer", "format": "int32" }, "brands": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bb.Pub.SubcategoryScopeByBrand": { "title": "SubcategoryScopeByBrand", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "brandName": { "type": "string", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "unitSales": { "type": "integer", "format": "int32", "nullable": true }, "sellingPrice": { "type": "number", "format": "double", "nullable": true }, "asins": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Bb.Pub.TiktokCategory": { "title": "TiktokCategory", "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "level": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "isLeafNode": { "type": "boolean" }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "monthlyUnits": { "type": "integer", "format": "int32", "nullable": true }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "annualUnits": { "type": "integer", "format": "int32", "nullable": true }, "monthlyGrowthRate": { "type": "number", "format": "double", "nullable": true }, "annualGrowthRate": { "type": "number", "format": "double", "nullable": true }, "numberOfShops": { "type": "integer", "format": "int32", "nullable": true }, "numberOfProducts": { "type": "integer", "format": "int32", "nullable": true }, "revenuePerShop": { "type": "number", "format": "double", "nullable": true }, "lifetimeRevenue": { "type": "number", "format": "double", "nullable": true }, "avgRating": { "type": "number", "format": "double", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "storeRevenueShare": { "type": "number", "format": "double", "nullable": true }, "retailerRevenueShare": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.TiktokProduct": { "title": "TiktokProduct", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "shopId": { "type": "integer", "format": "int64", "nullable": true }, "shopName": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "categoryName": { "type": "string", "nullable": true }, "productDescription": { "type": "string", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryName": { "type": "string", "nullable": true }, "reviewCount": { "type": "integer", "format": "int32", "nullable": true }, "variantCount": { "type": "integer", "format": "int32", "nullable": true }, "lifeTimeUnitSales": { "type": "integer", "format": "int32", "nullable": true }, "monthlyUnitSales": { "type": "integer", "format": "int32", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "avgRating": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.TiktokShop": { "title": "TiktokShop", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "lifetimeRevenue": { "type": "number", "format": "double", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "monthlyUnitSales": { "type": "integer", "format": "int32", "nullable": true }, "lifetimeUnitSales": { "type": "integer", "format": "int64", "nullable": true }, "monthlyGrowthRate": { "type": "number", "format": "double", "nullable": true }, "numberOfProducts": { "type": "integer", "format": "int32", "nullable": true }, "primarySubcategoryShare": { "type": "number", "format": "double", "nullable": true }, "avgRating": { "type": "number", "format": "double", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "subcategoryId": { "type": "integer", "format": "int32", "nullable": true }, "primaryCategory": { "type": "string", "nullable": true }, "storeUrl": { "type": "string", "nullable": true }, "shopTier": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "isBrandShop": { "type": "boolean" } }, "additionalProperties": false }, "Bb.Pub.TiktokVariant": { "title": "TiktokVariant", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "productId": { "type": "integer", "format": "int64" }, "variant": { "type": "string", "nullable": true }, "variantType": { "type": "string", "nullable": true }, "mainImageUrl": { "type": "string", "nullable": true }, "lastUpdated": { "type": "string", "format": "date-time", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "shipping": { "type": "number", "format": "double", "nullable": true }, "quantityAvailable": { "type": "integer", "format": "int32", "nullable": true }, "freeShipping": { "type": "boolean", "nullable": true }, "discountPromo": { "type": "number", "format": "double", "nullable": true }, "badge1": { "type": "integer", "format": "int32", "nullable": true }, "badge2": { "type": "integer", "format": "int32", "nullable": true }, "badge3": { "type": "integer", "format": "int32", "nullable": true }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "lifetimeRevenue": { "type": "number", "format": "double", "nullable": true }, "monthlyRevenue": { "type": "number", "format": "double", "nullable": true }, "monthlyUnitSales": { "type": "number", "format": "double", "nullable": true }, "liveRevenue": { "type": "number", "format": "double", "nullable": true }, "productShopId": { "type": "integer", "format": "int64", "nullable": true }, "productShopName": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "productImageUrl": { "type": "string", "nullable": true }, "productCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "productCategoryName": { "type": "string", "nullable": true }, "productDescription": { "type": "string", "nullable": true }, "productSubcategoryId": { "type": "integer", "format": "int32", "nullable": true }, "productSubcategoryName": { "type": "string", "nullable": true }, "productReviewCount": { "type": "integer", "format": "int32", "nullable": true }, "productVariantCount": { "type": "integer", "format": "int32", "nullable": true }, "productLifeTimeUnitSales": { "type": "integer", "format": "int32", "nullable": true }, "productMonthlyUnitSales": { "type": "integer", "format": "int32", "nullable": true }, "productAvgRating": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Bb.Pub.TopProductScope": { "title": "TopProductScope", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "asin": { "type": "string", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "unitSales": { "type": "integer", "format": "int32", "nullable": true }, "sellingPrice": { "type": "number", "format": "double", "nullable": true }, "salesRank": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Bb.Shared.MarketplaceId": { "title": "MarketplaceId", "enum": [ "NotSet", "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ], "type": "string" }, "Bb.WeeklyOfferHistory": { "title": "WeeklyOfferHistory", "type": "object", "properties": { "endOfWeek": { "type": "string", "format": "date-time" }, "sellerId": { "type": "string", "nullable": true }, "isFba": { "type": "boolean" }, "avgPrice": { "type": "number", "format": "double", "nullable": true }, "buyBoxControlPct": { "type": "number", "format": "double" }, "salesControlPct": { "type": "number", "format": "double" }, "sales": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Microsoft.AspNetCore.Mvc.ValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } } } } }