> For the complete documentation index, see [llms.txt](https://developer.esw.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.esw.com/customs-catalog-api/resources/first-successful-requests/catalog-exception-analyst.md).
# Catalog Exception Analyst
Represented by the `InvalidProducts`, `Home`, and `Logs` tags. The API includes invalid-product search, delete, reprocess by brand or tenant, error-file generation and download, dashboard counts for invalid/default products, and log search.
### Best first request
Use `POST /api/v2/InvalidProducts/Invalid`. Requires `pageNumber` and `pageSize`, and optionally accepts `brandCode`, `tenantCode`, `requestType`, `searchType`, and `continuationToken`.
### What success looks like
A `200 OK` returns a continued/paged invalid product response. Even if the result set is empty, it still proves the exception analyst can query the invalid-products stream successfully.
```json
curl -X POST "https://logistics-customscatalog-api.sandbox.eshopworld.com/api/v2/InvalidProducts/Invalid" \
-H "Authorization: Bearer " \
-H "Content-Type: application/json" \
-d '{
"pageNumber": 1,
"pageSize": 20,
"tenantCode": "TENANT_01"
}'
```
### What success looks like
A `200 OK` returns a continued/paged invalid product response. Even if the result set is empty, it still proves the exception analyst can query the invalid-products stream successfully.
{% tabs %}
{% tab title="Try it" %}
{% @code-walkthrough/try-it specLoaded="" specEps="" method="POST" path="/api/v2/InvalidProducts/Invalid" baseUrl="" title="Returns a list of invalid products for display on the UI." defaults="{"path":{},"query":{},"headers":{"Content-Type":"application/json"},"body":{"pageNumber":0,"pageSize":0,"orderByField":"string","isOrderByAsc":true,"brandCode":"string","tenantCode":"string","requestType":"ValidProducts","searchType":"InvalidProducts","continuationToken":"string"}}" mode="closed" %}
{% endtab %}
{% endtabs %}
Request Construction
{% @code-walkthrough/body-builder specIndex="{"defs":{"Customs.Catalog.Common.Pkg.Enums.Status":{"enum":\["Queued","UploadInProgress","UploadComplete","Error"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.AgeGroup":{"enum":\["Newborn","Infant","Toddler","Kids","Adult","OlderKids","Teen"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.Category":{"enum":\["AnimalsPetSupplies","ApparelAccessories","ArtsEntertainment","BabyToddler","BusinessIndustrial","CamerasOptics","Electronics","FoodBeveragesTobacco","Furniture","Hardware","HealthBeauty","HomeGarden","LuggageBags","Mature","Media","OfficeSupplies","ReligiousCeremonial","Software","SportingGoods","ToysGames","VehiclesParts","PerfumeryCosmeticToiletPreparations","SoapPolishCandlesEtc","AlbuminoidalSubstances","ExplosivesEtc","PhotographicCinematographicGoods","MiscellaneousChemicalProducts","Plastics","Rubber","RawHidesAndSkins","ArticlesOfLeather","FurskinsAndArtificialFur","Wood","Cork","ManufacturesOfStrawBasketwareAndWickerwork","PulpOfWoodScrapPaperPaperboard","PaperAndPaperboard","PrintedBooksNewspapers","Silk","WoolAndAnimalHair","Cotton","OtherVegetableTextileFibres","ManMadeFilaments","ManMadeStapleFibres","WaddingSpecialYarnsTwine","CarpetsAndFloorCoverings","SpecialWovenFabrics","IndustrialTextileFabricsAndTextileArticles","KnittedCrochetedFabrics","ApparelClothingKnitted","ApparelClothingNotKnitted","OtherMadeupWornTextileArticles","Footwear","Headgear","UmbrellasAndWalkingSticks","FeathersAndDownArticlesAndArtificialFlowers","ArticlesOfStone","CeramicProducts","GlassAndGlassware","PreciousStonesMetalsAndJewelry","IronAndSteel","ArticlesOfIronSteel","CopperAndArticlesThereof","NickelAndArticlesThereof","AluminumAndArticlesThereof","LeadAndArticlesThereof","ZincAndArticlesThereof","TinAndArticlesThereof","OtherBaseMetalsAndArticlesThereof","ToolsImplementsCutlery","MiscellaneousArticlesOfBaseMetal","NuclearReactorsBoilersMachinery","ElectricalMachinerySoundAndTv","RailwayTramwayLocomotivesRollingStock","VehiclesOtherThanRailwayTramwayRollingStock","AircraftSpacecraft","ShipsBoatsAndFloatingStructures","OpticalPhotographicCinematographicMeasuringMedicalInstruments","ClocksAndWatches","MusicalInstruments","ArmsAndAmmunition","FurnitureAndFurnishings","ToysGamesAndSports","MiscellaneousManufacturedArticles","WorksOfArtAndAntiques","CompleteIndustrialPlant","SpecialCombinedNomenclatureCodes","Digital","ReturnsLabels"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.CountryIso":{"enum":\["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","TP"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.CurrencyIso":{"enum":\["ARS","AUD","AZN","BHD","BDT","BBD","BYR","BYN","BZD","BMD","BOB","BRL","BGN","KHR","CAD","CLP","CNY","COP","CRC","HRK","CZK","DKK","DOP","EGP","EUR","GIP","GTQ","HNL","HKD","HUF","INR","IDR","ILS","JMD","JPY","JOD","KZT","KWD","LVL","LTL","MYR","MVR","MXN","MDL","TWD","NZD","NIO","NOK","OMR","PKR","PAB","PYG","PEN","PHP","PLN","GBP","QAR","ROL","RON","RUB","SAR","SGD","ZAR","KRW","LKR","SEK","CHF","THB","TRY","UAH","AED","USD","VEF","VND","RSD","DZD","MOP","NGN","KES","MKD","BAM","ISK","AMD","ALL","GEL"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.Gender":{"enum":\["Male","Female","Unisex"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.Region":{"enum":\["AD","AE","AL","AM","AU","AZ","BA","BY","BH","CA","CH","CL","CN","CO","EG","EU","GE","GI","HK","ID","IS","IL","IN","JP","KR","KW","KZ","LI","MA","MD","ME","MK","MX","MY","NO","NZ","PH","PR","QA","RS","RU","SA","SG","SM","TH","TL","TR","TW","UA","US","VN","XROW","ZA","XK","BR","MM","MO","PY","SK","AR","PE","DO","JO","KG","OM","BO","AF","AG","AI","AN","AO","AS","AW","BB","BD","BM","BZ","CR","CS","DZ","EC","ET","IO","IQ","FJ","JM","KE","KH","LA","LK","LR","LS","LY","MF","ML","MN","MQ","MR","MS","MV","MW","MZ","NA","NF","NG","NI","NP","NR","NU","PA","PK","PS","RW","SN","SO","SR","SS","SV","SX","TG","TT","TZ","UG","UY","UZ","VE","VU","WF","WS","YE","ZM","ZW","GB","TP","GW","JE","GT","KY","BN","TC","GP","GF","DM","GD","RE","LC","HN","KN","BF","BJ","BS","BW","CF","CG","CK","CM","CW","DJ","GA","GG","GH","GL","HT","LB","MU","NC","PG","SC","VC","VG","YT","CV","KM","SZ","VI","GY","BG","BI","CI","CU","EE","GM","HR","HU","LT","LV","MG","MT","NE","PL","SB","SI","SL","TD","TJ","TN","TO","CD","GN","VA","FK","MC","ST","AQ","AX","BL","BQ","BT","BV","CC","CX","EH","ER","FM","FO","GQ","GS","GU","HM","IM","IR","KI","KP","MH","MP","PF","PM","PN","PW","SH","SJ","SY","TF","TK","TM","TV","UM","IC"],"type":"string"},"Customs.Catalog.Common.Pkg.Product.WeightUnit":{"enum":\["Lb","Kg"],"type":"string"},"Customs.Catalog.Domain.Pkg.Models.DTO.AdditionalDutyDto":{"type":"object","properties":{"country":{"type":"string","description":"Country to ship to","nullable":true},"hsCode":{"type":"string","description":"HsCode","nullable":true},"countryOfOrigin":{"type":"array","items":{"type":"string"},"description":"Country of Origin","nullable":true}},"description":"AdditionalDuty"},"Customs.Catalog.Domain.Pkg.Models.DTO.BrandConfigDto":{"type":"object","properties":{"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand.","nullable":true},"brandName":{"type":"string","description":"Brand name.","nullable":true},"tenantCode":{"type":"string","description":"Tenant code.","nullable":true},"delimiter":{"type":"string","description":"Delimiter","nullable":true},"trimProductCodeWhiteSpaces":{"type":"boolean","description":"Indicates if the ProductCode whitespaces should be trimmed or not."},"rawCatalogMappings":{"type":"object","additionalProperties":{"type":"string"},"description":"RawCatalogMappings","nullable":true},"regions":{"type":"array","items":{"type":"string"},"description":"Regions","nullable":true},"currencyUnitDefault":{"type":"string","description":"CurrencyUnitDefault","nullable":true},"weightUnitDefault":{"type":"string","description":"WeightUnitDefault","nullable":true},"processRawCatalogs":{"type":"boolean","description":"ProcessRawCatalogs"},"generateMasterFile":{"type":"boolean","description":"GenerateMasterFile","nullable":true},"hsCodeLimit":{"type":"string","description":"Gets or sets classification code restriction","nullable":true},"defaultClassificationId":{"type":"string","description":"Gets or sets the default classification","nullable":true},"avalaraEnabled":{"type":"boolean","description":"Is Avalara enabled"},"enableCatalogRawMappings":{"type":"boolean","description":"EnableCatalogRawMappings"},"allowDefaultProducts":{"type":"boolean","description":"Indicates if Brand Allows Default Products","nullable":true},"defaultClassificationOverrides":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.DefaultClassificationOverrideDto"},"description":"DefaultClassificationOverrides","nullable":true},"classificationCodeOverride":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationCodeOverridesDto"},"description":"DefaultClassificationOverrides","nullable":true,"readOnly":true},"classificationProvider":{"type":"string","description":"ClassificationProvider","nullable":true},"digitalDefaultClassificationId":{"type":"string","description":"Gets or sets the digital default classification identifier.","nullable":true},"enableMultipleVats":{"type":"boolean","description":"Allows retailers to use more than one VAT rate."}},"description":"Represents brand config data transfer object."},"Customs.Catalog.Domain.Pkg.Models.DTO.CatalogLogDto":{"type":"object","properties":{"status":{"type":"string","description":"Status","nullable":true},"message":{"type":"string","description":"Message","nullable":true},"dateReceived":{"type":"string","description":"DateReceived","format":"date-time"},"brandCode":{"type":"string","description":"BrandCode","nullable":true},"dataSource":{"type":"string","description":"DataSource","nullable":true},"dataSourceAdditionalInfo":{"type":"string","description":"DataSourceAdditionalInfo","nullable":true},"userName":{"type":"string","description":"UserName","nullable":true},"lastModifiedUserName":{"type":"string","description":"LastModifiedUserName","nullable":true},"lastModifiedDateTime":{"type":"string","description":"LastModifiedDateTime","format":"date-time"},"catalogInputInfoReferenceId":{"type":"string","description":"Holds input data information reference id","nullable":true},"queuePosition":{"type":"integer","description":"QueuePosition","format":"int32","nullable":true}},"description":"CatalogLogDto"},"Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationCodeOverridesDto":{"type":"object","properties":{"countryCode":{"type":"string","description":"CountryCode","nullable":true}},"description":"ClassificationCodeOverride"},"Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationDto":{"type":"object","properties":{"classificationId":{"type":"string","description":"Classification Id","nullable":true},"classificationCode":{"type":"string","description":"ClassificationCode","nullable":true},"classificationDesc":{"type":"string","description":"ClassificationDesc holds the description of Chapter+Section+SubSection","nullable":true}},"description":"Classification Dto"},"Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationRegion":{"type":"object","properties":{"classificationCode":{"type":"string","description":"Classification Code","nullable":true},"previousClassificationCode":{"type":"string","description":"PreviousClassification Code","nullable":true},"regionCode":{"type":"string","description":"Region Code","nullable":true},"mfnDuty":{"type":"number","description":"MFN Duty","format":"double"},"generalDuty":{"type":"number","description":"General duty","format":"double"},"additionalDuty":{"type":"number","description":"Additional duty","format":"double"},"classificationId":{"type":"string","description":"ClassificationId","nullable":true},"vatBandId":{"type":"integer","description":"Vat Band Id","format":"int32"},"vatPercentageRate":{"type":"number","description":"VatPercentageRate","format":"double"},"id":{"type":"string","description":"id - cosmos internal id","nullable":true},"lastModifiedBy":{"type":"string","description":"LastModifiedBy","nullable":true}},"description":"Classification HsCode Region"},"Customs.Catalog.Domain.Pkg.Models.DTO.CreateProductRequest":{"required":\["countryOfOrigin","description","material","name","productCode"],"type":"object","properties":{"productCode":{"minLength":1,"type":"string","description":"(Required) The brand's unique master identifier or SKU (Stock Keeping Unit)."},"name":{"minLength":1,"type":"string","description":"(Required) The name of the product."},"description":{"minLength":1,"type":"string","description":"(Required) The short description of the product."},"material":{"minLength":1,"type":"string","description":"(Required) A description of the material that the product is made of."},"countryOfOrigin":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.CountryIso"},"hsCode":{"type":"string","description":"The brand’s HSCode of the product.This should be a minimum of 6 digits.","nullable":true},"hsCodeRegion":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.Region"},"parentProductCode":{"type":"string","description":"SKU for a group of products that come in different versions (variants).","nullable":true},"category":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.Category"},"categoryDesc":{"type":"string","description":"eShopWorld category description for the product.","nullable":true,"readOnly":true},"gender":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.Gender"},"ageGroup":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.AgeGroup"},"size":{"type":"string","description":"(Optional) The size of the product.","nullable":true},"weight":{"type":"number","description":"(Optional\*) The weight of the product in the associated WeightUnit.\n*This field is mandatory if you specify a weight unit.","format":"double","nullable":true},"weightUnit":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.WeightUnit"},"url":{"type":"string","description":"(Optional*) The product’s landing page.\n*This field is mandatory when Shipping to Russia and Japan.","nullable":true},"imageUrl":{"type":"string","description":"(Optional) The URL of the product’s main image thumbnail.","nullable":true},"unitPrice":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RetailerPrice"},"dangerousGoods":{"type":"boolean","description":"(Optional) Indicates if the product is classified a DangerousGood or Hazardous Material (HazMat).","nullable":true},"isCustomized":{"type":"boolean","description":"(Optional) Indicates if the product has been customized in any way from its Original Design.","nullable":true},"additionalProductCode":{"type":"string","description":"(Optional) An additional product code, or unique identifier,\nsuch as the manufacturer’s product code or SKU (Stock Keeping Unit),\nthat may be on or attached to the product.","nullable":true},"variantProductCode":{"type":"string","description":"(Optional) Another version of the brand's unique master identifier or SKU (Stock Keeping Unit).","nullable":true},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RestrictionDto"},"description":"(Optional) Identifies when a product should be Restricted from Sale in Certain Countries.","nullable":true},"isRestricted":{"type":"boolean","description":"(Optional) Identifies restriction on a product regardless of what country it's being sold to or any other product attributes.","nullable":true},"mid":{"type":"string","description":"(Optional) Identifies the Manufacturer ID.","nullable":true},"midAddressZip":{"type":"string","description":"(Optional) Identifies the Manufacturer's ZipCode","nullable":true},"additionalInformation":{"type":"string","description":"(Optional) Any other additional information about the product.","nullable":true},"categoryInformation":{"type":"string","description":"(Optional) Any other additional information about the product category.","nullable":true},"isSubscription":{"type":"boolean","description":"(Optional) Identifies if the product is a Subscription based product.","nullable":true},"eccn":{"type":"string","description":"ECCN","nullable":true},"deliveryCountry":{"type":"string","description":"The 2-letter ISO code of the country where the product is to be delivered.","nullable":true},"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand","nullable":true}},"description":"Create Product Request Object"},"Customs.Catalog.Domain.Pkg.Models.DTO.DefaultClassificationOverrideDto":{"type":"object","properties":{"countryCode":{"type":"string","description":"CountryCode","nullable":true},"classificationId":{"type":"string","description":"ClassificationId","nullable":true}},"description":"DefaultClassificationOverride"},"Customs.Catalog.Domain.Pkg.Models.DTO.DefaultProductDashboardResponse":{"type":"object","properties":{"totalDefaultClassifiedProductCount":{"type":"integer","description":"TotalDefaultClassifiedProductCount","format":"int64"},"defaultClassifiedProductCountByBrand":{"type":"array","items":{"$ref":"#/components/schemas/System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Int64, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"},"description":"DefaultClassifiedProductCountByBrand","nullable":true}},"description":"DefaultProductDashboardResponse"},"Customs.Catalog.Domain.Pkg.Models.DTO.DutyRateTypeDto":{"type":"object","properties":{"country":{"type":"string","description":"Country to ship to","nullable":true},"tenantCode":{"type":"string","description":"Brand code","nullable":true},"rate":{"type":"string","description":"Type of Rate","nullable":true}},"description":"DutyRateType"},"Customs.Catalog.Domain.Pkg.Models.DTO.DutyRuleDto":{"type":"object","properties":{"ruleType":{"type":"string","description":"Type of Rule","nullable":true},"rateType":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.DutyRateTypeDto"},"additionalDuty":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.AdditionalDutyDto"},"id":{"type":"string","description":"Id","nullable":true}},"description":"DutyRuleDto"},"Customs.Catalog.Domain.Pkg.Models.DTO.DutyRuleSearchResponse":{"type":"object","properties":{"ruleType":{"type":"string","description":"RuleType","nullable":true},"rateType":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Domain.DutyRateType"},"additionalDuty":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Domain.AdditionalDuty"},"id":{"type":"string","description":"Id of rule","nullable":true}},"description":"DutyRuleSearchResponse"},"Customs.Catalog.Domain.Pkg.Models.DTO.Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message","nullable":true},"code":{"type":"integer","description":"Error code","format":"int32"}},"description":"Error information."},"Customs.Catalog.Domain.Pkg.Models.DTO.FileImportResponse":{"type":"object","properties":{"numberOfRowsProcessed":{"type":"integer","description":"Gets or sets the number of rows processed.","format":"int32"},"messages":{"type":"array","items":{"type":"string"},"description":"Messages","nullable":true},"errors":{"type":"array","items":{"type":"string"},"description":"Errors","nullable":true},"fileName":{"type":"string","description":"Gets or sets the name of the file.","nullable":true},"success":{"type":"boolean","description":"Gets or sets the Success of the file import processing."}},"description":"The model to respond the import requests with"},"Customs.Catalog.Domain.Pkg.Models.DTO.FileSearchRequest":{"type":"object","properties":{"tenantCode":{"type":"string","description":"Unique retailer’s TenantCode","nullable":true},"status":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Enums.Status"},"description":"Status","nullable":true},"takeCount":{"type":"integer","description":"Gets or sets value indicating whether number of items to be retrieved.","format":"int32"},"continuationToken":{"type":"string","description":"Gets or sets search continuation token.","nullable":true}},"description":"LogSearchRequest"},"Customs.Catalog.Domain.Pkg.Models.DTO.GetClassificationsRequest":{"type":"object","properties":{"regionCode":{"type":"string","description":"Gets or sets region code.","nullable":true},"chapterCode":{"type":"string","description":"Gets or sets chapter code.","nullable":true},"sectionCode":{"type":"string","description":"Gets or sets section code.","nullable":true},"subSectionCode":{"type":"string","description":"Gets or sets sub section code.","nullable":true},"classificationCode":{"type":"string","description":"Gets or sets classification code.","nullable":true},"takeCount":{"type":"integer","description":"Gets or sets value indicating whether number of items to be retreived.","format":"int32"},"continuationToken":{"type":"string","description":"Gets or sets search continuatino token.","nullable":true}},"description":"Represents classification get request model."},"Customs.Catalog.Domain.Pkg.Models.DTO.GetDefaultProductsRequest":{"type":"object","properties":{"tenantCode":{"type":"string","description":"Gets or sets tenant code.","nullable":true},"takeCount":{"type":"integer","description":"Gets or sets value indicating whether number of items to be retreived.","format":"int32"},"continuationToken":{"type":"string","description":"Gets or sets search continuatino token.","nullable":true}},"description":"Represents dto for getting default products request."},"Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductDashboardResponse":{"type":"object","properties":{"totalInvalidProductCount":{"type":"integer","description":"InvalidProductCount","format":"int64"},"invalidProductCountByBrand":{"type":"array","items":{"$ref":"#/components/schemas/System.Collections.Generic.KeyValuePair`2\[\[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],\[System.Int64, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"},"description":"InvalidProductCountByBrand","nullable":true}},"description":"InvalidProductDashboardResponse"},"Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Domain.BaseCatalog"},"description":"List of results","nullable":true},"pagination":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Paging.Pagination"}},"description":"InvalidProductResponse"},"Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductSearchRequest":{"required":\["pageNumber","pageSize"],"type":"object","properties":{"pageNumber":{"type":"integer","description":"The page number to display.","format":"int32"},"pageSize":{"type":"integer","description":"The size of the page to display.","format":"int32"},"orderByField":{"type":"string","description":"The field to be used to order the results","nullable":true},"isOrderByAsc":{"type":"boolean","description":"The field to be used to sort the results"},"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand","nullable":true},"tenantCode":{"type":"string","description":"Tenant Code","nullable":true},"requestType":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Enums.SearchRequestType"},"searchType":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Enums.ErrorSearchType"},"continuationToken":{"type":"string","description":"Gets or sets search continuatino token.","nullable":true}},"description":"InvalidProductSearchRequest"},"Customs.Catalog.Domain.Pkg.Models.DTO.MasterCatalogRequest":{"type":"object","properties":{"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand","nullable":true},"tenantCode":{"type":"string","description":"Tenant Code","nullable":true}},"description":"Master Catalog Request DTO"},"Customs.Catalog.Domain.Pkg.Models.DTO.Price":{"type":"object","properties":{"amount":{"type":"number","description":"Amount","format":"double","nullable":true},"currency":{"type":"string","description":"Currency","nullable":true}},"description":"Price"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductCatalogDto":{"type":"object","properties":{"productCode":{"type":"string","description":"The brand's unique identifier SKU (Stock Keeping Unit)","nullable":true},"name":{"type":"string","description":"The Product’s Name","nullable":true},"description":{"type":"string","description":"The Product’s Description","nullable":true},"material":{"type":"string","description":"A description of the product that will be used for customs declaration purposes","nullable":true},"countryOfOrigin":{"type":"string","description":"Country ISO where the product is manufactured.","nullable":true},"hsCode":{"type":"string","description":"The Brand’s HSCode of the product. This should be a minimum of 6 digits.","nullable":true},"hsCodeRegion":{"type":"string","description":"The eShopWorld Region relating to the HSCode","nullable":true},"parentProductCode":{"type":"string","description":"SKU for a group of products that come in different versions (variants)","nullable":true},"category":{"type":"string","description":"The eShopWorld Category ID to which the product should be mapped","nullable":true},"categoryDesc":{"type":"string","description":"Category Desc","nullable":true},"gender":{"type":"string","description":"The Gender value for which the product is intended","nullable":true},"ageGroup":{"type":"string","description":"The Age Group value for which the product is intended\nThe demographic for which the product is intended","nullable":true},"size":{"type":"string","description":"The size of the product","nullable":true},"weight":{"type":"number","description":"The weight of the product in the associated WeightUnit","format":"double","nullable":true},"weightUnit":{"type":"string","description":"The WeightUnit value of the product for the associated weight","nullable":true},"url":{"type":"string","description":"The Product’s landing page","nullable":true},"imageUrl":{"type":"string","description":"The URL of your product’s main image thumbnail","nullable":true},"unitPrice":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.Price"},"dangerousGoods":{"type":"boolean","description":"If the Product is classified a DangerousGood or Hazardous Material (HazMat)","nullable":true},"isCustomized":{"type":"boolean","description":"Gets or sets value indicating whether product is customized.","nullable":true},"additionalProductCode":{"type":"string","description":"(Optional) An additional product code, or unique identifier,\nsuch as the manufacturer’s product code or SKU (Stock Keeping Unit),\nthat may be on or attached to the product.","nullable":true},"variantProductCode":{"type":"string","description":"(Optional) Another version of the brand's unique master identifier or SKU (Stock Keeping Unit).","nullable":true},"avataxCode":{"type":"string","description":"The Avatax code","nullable":true},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RestrictionDto"},"description":"Product restrictions.","nullable":true},"isRestricted":{"type":"boolean","description":"Gets or sets value indicating whether product is customized."},"mid":{"type":"string","description":"(Optional) Identifies the Manufacturer ID.","nullable":true},"midAddressZip":{"type":"string","description":"(Optional) Identifies the Manufacturer's ZipCode","nullable":true},"additionalInformation":{"type":"string","description":"(Optional) Any other additional information about the product.","nullable":true},"categoryInformation":{"type":"string","description":"(Optional) Any other additional information about the product category.","nullable":true},"isSubscription":{"type":"boolean","description":"(Optional) Identifies if the product is a Subscription based product.","nullable":true},"classificationCode":{"type":"string","description":"Classification code associated with the product.","nullable":true},"classifications":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ProductClassificationDto"},"description":"List of region classifications for the product.","nullable":true},"eccn":{"type":"string","description":"ECCN","nullable":true}},"description":"ProductCatalogDto"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductCatalogUiDto":{"type":"object","properties":{"id":{"type":"string","description":"Cosmos document id","nullable":true},"productCode":{"type":"string","description":"The brand's unique identifier SKU (Stock Keeping Unit)","nullable":true},"name":{"type":"string","description":"The Product’s Name","nullable":true},"description":{"type":"string","description":"The Product’s Description","nullable":true},"material":{"type":"string","description":"A description of the product that will be used for customs declaration purposes","nullable":true},"countryOfOrigin":{"type":"string","description":"The 2-letter County ISO where the product is manufactured.","nullable":true},"hsCode":{"type":"string","description":"The Brand’s HSCode of the product. This should be a minimum of 6 digits.","nullable":true},"hsCodeRegion":{"type":"string","description":"The eShopWorld Region relating to the HSCode","nullable":true},"parentProductCode":{"type":"string","description":"SKU for a group of products that come in different versions (variants)","nullable":true},"category":{"type":"string","description":"The eShopWorld Category ID to which the product should be mapped","nullable":true},"categoryDesc":{"type":"string","description":"Category Desc","nullable":true},"gender":{"type":"string","description":"The Gender value for which the product is intended","nullable":true},"size":{"type":"string","description":"The size of the product","nullable":true},"dangerousGoods":{"type":"boolean","description":"If the Product is classified a DangerousGood or Hazardous Material (HazMat)","nullable":true},"isCustomized":{"type":"boolean","description":"Gets or sets value indicating whether product is customized.","nullable":true},"defaultClassification":{"type":"boolean","description":"DefaultClassification"},"classificationId":{"type":"string","description":"ClassificationId","nullable":true},"classificationCode":{"type":"string","description":"ClassificationCode","nullable":true},"creationDate":{"type":"string","description":"Date when default classified product was created in DB.","format":"date-time"},"brandCode":{"type":"string","description":"Gets or sets the brand code.","nullable":true}},"description":"ProductCatalogUiDto"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductClassificationDto":{"type":"object","properties":{"regionCode":{"type":"string","description":"Region HS code for the classification.","nullable":true},"region":{"type":"string","description":"Region ISO for the classification.","nullable":true},"duty":{"type":"number","description":"Duty Rate for the classification","format":"double"},"dutyRateType":{"type":"string","description":"Duty Rate Type","nullable":true},"additionalDuty":{"type":"boolean","description":"Additional duty"},"vat":{"type":"number","description":"Vat rate for the classification","format":"double"},"vatRateType":{"type":"string","description":"VatRateType","nullable":true},"countries":{"type":"array","items":{"type":"string"},"description":"Countries mapped to the region","nullable":true},"countryVat":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Domain.CountryVat"},"description":"Gets or sets country-vat pairs","nullable":true}},"description":"ProductClassificationDto for exposing Classifications for Products"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductClassificationRequest":{"type":"object","properties":{"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand","nullable":true},"productCatalogIdList":{"type":"array","items":{"type":"string"},"description":"Product SKU list that need to update DefaultClassification flag","nullable":true},"defaultClassification":{"type":"boolean","description":"DefaultClassification"},"userName":{"type":"string","description":"Holds login user name","nullable":true},"tenantCode":{"type":"string","description":"Tenant Code","nullable":true}},"description":"ProductClassificationRequest"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductUiSearchResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ProductCatalogUiDto"},"description":"List of results","nullable":true},"pagination":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Paging.Pagination"}},"description":"ProductUiSearchResponse"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductVariantMap":{"type":"object","properties":{"variantProductCode":{"type":"string","description":"The brand's variant product code","nullable":true},"productCode":{"type":"string","description":"The brand's unique identifier SKU (Stock Keeping Unit)","nullable":true}},"description":"ProductVariantMap"},"Customs.Catalog.Domain.Pkg.Models.DTO.ProductVariantSearchRequest":{"type":"object","properties":{"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand","nullable":true},"variantProductCodes":{"type":"array","items":{"type":"string"},"description":"The brand's variant product code","nullable":true},"tenantCode":{"type":"string","description":"Tenant Code","nullable":true}},"description":"ProductSearchRequest"},"Customs.Catalog.Domain.Pkg.Models.DTO.RestrictionDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of restriction.","nullable":true,"example":"\n hsCodeRestricted,\n retailerRestricted\n "},"criteria":{"type":"string","description":"Criteria.","nullable":true,"example":"\n exclude,\n include\n "},"countries":{"type":"array","items":{"type":"string"},"description":"List of countries or "ALL" marker restriction to be applied. For example: \["ALL"], \["AU", "CH"]","nullable":true}},"description":"(Optional) Identifies when a product should be Restricted from Sale in Certain Countries."},"Customs.Catalog.Domain.Pkg.Models.DTO.RetailerCatalogProduct":{"required":\["countryOfOrigin","description","material","name","productCode"],"type":"object","properties":{"productCode":{"minLength":1,"type":"string","description":"(Required) The brand's unique master identifier or SKU (Stock Keeping Unit)."},"name":{"minLength":1,"type":"string","description":"(Required) The name of the product."},"description":{"minLength":1,"type":"string","description":"(Required) The short description of the product."},"material":{"minLength":1,"type":"string","description":"(Required) A description of the material that the product is made of."},"countryOfOrigin":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.CountryIso"},"hsCode":{"type":"string","description":"The brand’s HSCode of the product.This should be a minimum of 6 digits.","nullable":true},"hsCodeRegion":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.Region"},"parentProductCode":{"type":"string","description":"SKU for a group of products that come in different versions (variants).","nullable":true},"category":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.Category"},"categoryDesc":{"type":"string","description":"eShopWorld category description for the product.","nullable":true,"readOnly":true},"gender":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.Gender"},"ageGroup":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.AgeGroup"},"size":{"type":"string","description":"(Optional) The size of the product.","nullable":true},"weight":{"type":"number","description":"(Optional*) The weight of the product in the associated WeightUnit.\n*This field is mandatory if you specify a weight unit.","format":"double","nullable":true},"weightUnit":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.WeightUnit"},"url":{"type":"string","description":"(Optional*) The product’s landing page.\n\*This field is mandatory when Shipping to Russia and Japan.","nullable":true},"imageUrl":{"type":"string","description":"(Optional) The URL of the product’s main image thumbnail.","nullable":true},"unitPrice":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RetailerPrice"},"dangerousGoods":{"type":"boolean","description":"(Optional) Indicates if the product is classified a DangerousGood or Hazardous Material (HazMat).","nullable":true},"isCustomized":{"type":"boolean","description":"(Optional) Indicates if the product has been customized in any way from its Original Design.","nullable":true},"additionalProductCode":{"type":"string","description":"(Optional) An additional product code, or unique identifier,\nsuch as the manufacturer’s product code or SKU (Stock Keeping Unit),\nthat may be on or attached to the product.","nullable":true},"variantProductCode":{"type":"string","description":"(Optional) Another version of the brand's unique master identifier or SKU (Stock Keeping Unit).","nullable":true},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RestrictionDto"},"description":"(Optional) Identifies when a product should be Restricted from Sale in Certain Countries.","nullable":true},"isRestricted":{"type":"boolean","description":"(Optional) Identifies restriction on a product regardless of what country it's being sold to or any other product attributes.","nullable":true},"mid":{"type":"string","description":"(Optional) Identifies the Manufacturer ID.","nullable":true},"midAddressZip":{"type":"string","description":"(Optional) Identifies the Manufacturer's ZipCode","nullable":true},"additionalInformation":{"type":"string","description":"(Optional) Any other additional information about the product.","nullable":true},"categoryInformation":{"type":"string","description":"(Optional) Any other additional information about the product category.","nullable":true},"isSubscription":{"type":"boolean","description":"(Optional) Identifies if the product is a Subscription based product.","nullable":true},"eccn":{"type":"string","description":"ECCN","nullable":true}},"description":"Retailer Product Object"},"Customs.Catalog.Domain.Pkg.Models.DTO.RetailerPrice":{"type":"object","properties":{"amount":{"type":"number","description":"Amount","format":"double","nullable":true},"currency":{"$ref":"#/components/schemas/Customs.Catalog.Common.Pkg.Product.CurrencyIso"}},"description":"(Optional *) Price of the product.\n*This field is mandatory if you specify a unitPriceCurrencyIso."},"Customs.Catalog.Domain.Pkg.Models.DTO.VatBandConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"\nGets or sets the identifier.","nullable":true},"countryCode":{"type":"string","description":"Country Code","nullable":true},"subRegion":{"type":"string","description":"SubRegion","nullable":true},"rule":{"type":"string","description":"VAT Rule","nullable":true},"priority":{"type":"integer","description":"Priority","format":"int32"},"value":{"type":"string","description":"Value","nullable":true},"vatBandId":{"type":"integer","description":"VAT Band Id","format":"int32"}},"description":"Represents vat band config data trasfer object"},"Customs.Catalog.Domain.Pkg.Models.DTO.VatRateDto":{"type":"object","properties":{"id":{"type":"string","description":"\nGets or sets the identifier.","nullable":true},"vatBandId":{"type":"integer","description":"\nGets or sets the vat band identifier.","format":"int32","nullable":true},"regionCode":{"type":"string","description":"Gets or sets the region code.","nullable":true},"countryIso":{"type":"string","description":"Gets or sets the country iso.","nullable":true},"subRegion":{"type":"string","description":"Gets or sets the sub region.","nullable":true},"vatPercentageRate":{"type":"number","description":"Gets or sets the vat percentage rate.","format":"double","nullable":true},"description":{"type":"string","description":"Gets or sets the description.","nullable":true},"rateType":{"type":"integer","description":"Gets or sets the type of the rate.","format":"int32","nullable":true}},"description":"Represents vat rate data trasfer object"},"Customs.Catalog.Domain.Pkg.Models.Domain.AdditionalDuty":{"type":"object","properties":{"country":{"type":"string","description":"Country to ship to","nullable":true},"hsCode":{"type":"string","description":"HsCode","nullable":true},"countryOfOrigin":{"type":"array","items":{"type":"string"},"description":"Country of Origin","nullable":true}},"description":"AdditionalDuty"},"Customs.Catalog.Domain.Pkg.Models.Domain.BaseCatalog":{"type":"object","properties":{"id":{"type":"string","description":"Internal Cosmos ID","nullable":true},"timestamp":{"type":"string","description":"Internal Cosmos timestamp.","format":"date-time","readOnly":true},"eTag":{"type":"string","description":"Internal Cosmos ETag","nullable":true,"readOnly":true},"lastModifiedDateTime":{"type":"string","description":"LastModifiedDate of the record. Will serialize the Timestamp field to a DateTime across the API.","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","description":"Modified By","nullable":true},"correlationId":{"type":"string","description":"Correlation Id","nullable":true},"traceContext":{"type":"string","description":"TraceContext","nullable":true},"brandCode":{"type":"string","description":"Unique three-letter identifier for the retailer’s brand","nullable":true},"dataSource":{"type":"string","description":"The datasource of the object i.e. File/Api","nullable":true},"dataSourceAdditionalInfo":{"type":"string","description":"Additional info on the datasource e.g. filename or blobname","nullable":true},"userName":{"type":"string","description":"Holds input data request username","nullable":true},"lastModifiedUserName":{"type":"string","description":"Holds last updated username","nullable":true},"catalogInputInfoReferenceId":{"type":"string","description":"Holds input data information reference id","nullable":true},"status":{"type":"string","description":"Holds status","nullable":true}},"description":"Base Catalog"},"Customs.Catalog.Domain.Pkg.Models.Domain.Chapter":{"type":"object","properties":{"id":{"type":"string","description":"Internal Cosmos ID","nullable":true},"timestamp":{"type":"string","description":"Internal Cosmos timestamp.","format":"date-time","readOnly":true},"eTag":{"type":"string","description":"Internal Cosmos ETag","nullable":true,"readOnly":true},"lastModifiedDateTime":{"type":"string","description":"LastModifiedDate of the record. Will serialize the Timestamp field to a DateTime across the API.","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","description":"Modified By","nullable":true},"correlationId":{"type":"string","description":"Correlation Id","nullable":true},"traceContext":{"type":"string","description":"TraceContext","nullable":true},"name":{"type":"string","description":"Chapter name","nullable":true},"code":{"type":"string","description":"Chapter code","nullable":true}},"description":"Chapter mapping"},"Customs.Catalog.Domain.Pkg.Models.Domain.CountryVat":{"type":"object","properties":{"country":{"type":"string","description":"The Country ISO code","nullable":true},"vat":{"type":"number","description":"The Vat value","format":"double"},"vatRateType":{"type":"string","description":"VatRateType","nullable":true},"subRegions":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.Domain.SubRegionVat"},"description":"Collection of SubRegionVat object","nullable":true}},"description":"Represents Country-Vat pair"},"Customs.Catalog.Domain.Pkg.Models.Domain.DutyRateType":{"type":"object","properties":{"brandCode":{"type":"string","description":"Brand Code","nullable":true},"country":{"type":"string","description":"Country to ship to","nullable":true},"countryOfOrigin":{"type":"array","items":{"type":"string"},"description":"Country of Origin","nullable":true},"rate":{"type":"string","description":"Type of Rate","nullable":true}},"description":"DutyRateType"},"Customs.Catalog.Domain.Pkg.Models.Domain.MasterCatalogQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal Cosmos ID","nullable":true},"timestamp":{"type":"string","description":"Internal Cosmos timestamp.","format":"date-time","readOnly":true},"eTag":{"type":"string","description":"Internal Cosmos ETag","nullable":true,"readOnly":true},"lastModifiedDateTime":{"type":"string","description":"LastModifiedDate of the record. Will serialize the Timestamp field to a DateTime across the API.","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","description":"Modified By","nullable":true},"correlationId":{"type":"string","description":"Correlation Id","nullable":true},"traceContext":{"type":"string","description":"TraceContext","nullable":true},"brandCode":{"type":"string","description":"The brand code","nullable":true},"requestEmailAddress":{"type":"string","description":"Email Address of the user that made the request","nullable":true},"requestDate":{"type":"string","description":"The RequestDate","format":"date-time"}},"description":"MasterCatalogQueue"},"Customs.Catalog.Domain.Pkg.Models.Domain.Section":{"type":"object","properties":{"id":{"type":"string","description":"Internal Cosmos ID","nullable":true},"timestamp":{"type":"string","description":"Internal Cosmos timestamp.","format":"date-time","readOnly":true},"eTag":{"type":"string","description":"Internal Cosmos ETag","nullable":true,"readOnly":true},"lastModifiedDateTime":{"type":"string","description":"LastModifiedDate of the record. Will serialize the Timestamp field to a DateTime across the API.","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","description":"Modified By","nullable":true},"correlationId":{"type":"string","description":"Correlation Id","nullable":true},"traceContext":{"type":"string","description":"TraceContext","nullable":true},"chapterCode":{"type":"string","description":"Chapter code","nullable":true},"name":{"type":"string","description":"SubMenuOne name","nullable":true},"code":{"type":"string","description":"SubMenuOne code","nullable":true}},"description":"Section mapping"},"Customs.Catalog.Domain.Pkg.Models.Domain.SubRegionVat":{"type":"object","properties":{"code":{"type":"string","description":"Country ISO code","nullable":true},"vat":{"type":"number","description":"Vat percentage rate","format":"double"},"vatRateType":{"type":"string","description":"VatRateType","nullable":true}},"description":"SubRegionVat"},"Customs.Catalog.Domain.Pkg.Models.Domain.SubSection":{"type":"object","properties":{"id":{"type":"string","description":"Internal Cosmos ID","nullable":true},"timestamp":{"type":"string","description":"Internal Cosmos timestamp.","format":"date-time","readOnly":true},"eTag":{"type":"string","description":"Internal Cosmos ETag","nullable":true,"readOnly":true},"lastModifiedDateTime":{"type":"string","description":"LastModifiedDate of the record. Will serialize the Timestamp field to a DateTime across the API.","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","description":"Modified By","nullable":true},"correlationId":{"type":"string","description":"Correlation Id","nullable":true},"traceContext":{"type":"string","description":"TraceContext","nullable":true},"parentCode":{"type":"string","description":"Parent code holds ChapterCode + SectionCode","nullable":true,"readOnly":true},"chapterCode":{"type":"string","description":"Chapter Id","nullable":true},"sectionCode":{"type":"string","description":"Section Id","nullable":true},"name":{"type":"string","description":"SubSection name","nullable":true},"code":{"type":"string","description":"SubSection code","nullable":true}},"description":"SubSection mapping"},"Customs.Catalog.Domain.Pkg.Models.Enums.ErrorSearchType":{"enum":\["InvalidProducts","DefaultClassifiedProducts","IncompleteRatings","FailedFilesAndApiRequests","AwaitingClassification"],"type":"string","description":"ErrorSearchType"},"Customs.Catalog.Domain.Pkg.Models.Enums.SearchRequestType":{"enum":\["ValidProducts","InvalidProducts","DefaultClassification","InvalidLogs"],"type":"string","description":"The type of searches that can be called from the UI"},"Customs.Catalog.Domain.Pkg.Models.Paging.ContinuedResult`1[[Customs.Catalog.Domain.Pkg.Models.DTO.CatalogLogDto, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.CatalogLogDto"},"description":"Gets items.","nullable":true},"hasMoreResults":{"type":"boolean","description":"Gets or sets value indicating whether source has more results."},"continuationToken":{"type":"string","description":"Gets continuation token.","nullable":true}},"description":"Represents continued result model."},"Customs.Catalog.Domain.Pkg.Models.Paging.ContinuedResult`1\[\[Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationDto, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationDto"},"description":"Gets items.","nullable":true},"hasMoreResults":{"type":"boolean","description":"Gets or sets value indicating whether source has more results."},"continuationToken":{"type":"string","description":"Gets continuation token.","nullable":true}},"description":"Represents continued result model."},"Customs.Catalog.Domain.Pkg.Models.Paging.ContinuedResult`1[[Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductResponse, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductResponse"},"description":"Gets items.","nullable":true},"hasMoreResults":{"type":"boolean","description":"Gets or sets value indicating whether source has more results."},"continuationToken":{"type":"string","description":"Gets continuation token.","nullable":true}},"description":"Represents continued result model."},"Customs.Catalog.Domain.Pkg.Models.Paging.ContinuedResult`1\[\[Customs.Catalog.Domain.Pkg.Models.DTO.ProductCatalogUiDto, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ProductCatalogUiDto"},"description":"Gets items.","nullable":true},"hasMoreResults":{"type":"boolean","description":"Gets or sets value indicating whether source has more results."},"continuationToken":{"type":"string","description":"Gets continuation token.","nullable":true}},"description":"Represents continued result model."},"Customs.Catalog.Domain.Pkg.Models.Paging.PagedResult`1[[Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationDto, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Gets or sets the current page.","format":"int32"},"pageCount":{"type":"integer","description":"Gets or sets the page count.","format":"int32"},"pageSize":{"type":"integer","description":"Gets or sets the size of the page.","format":"int32"},"rowCount":{"type":"integer","description":"Gets or sets the row count.","format":"int32"},"firstRowOnPage":{"type":"integer","description":"Gets the first row on page.","format":"int32","readOnly":true},"lastRowOnPage":{"type":"integer","description":"Gets the last row on page.","format":"int32","readOnly":true},"orderByField":{"type":"string","description":"Gets or sets the order by field.","nullable":true},"isOrderByAsc":{"type":"boolean","description":"Gets or sets a value indicating whether this instance is order by asc."},"results":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationDto"},"description":"Gets or sets the results.","nullable":true}},"description":""},"Customs.Catalog.Domain.Pkg.Models.Paging.PagedResult`1\[\[Customs.Catalog.Domain.Pkg.Models.DTO.VatBandConfigDto, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Gets or sets the current page.","format":"int32"},"pageCount":{"type":"integer","description":"Gets or sets the page count.","format":"int32"},"pageSize":{"type":"integer","description":"Gets or sets the size of the page.","format":"int32"},"rowCount":{"type":"integer","description":"Gets or sets the row count.","format":"int32"},"firstRowOnPage":{"type":"integer","description":"Gets the first row on page.","format":"int32","readOnly":true},"lastRowOnPage":{"type":"integer","description":"Gets the last row on page.","format":"int32","readOnly":true},"orderByField":{"type":"string","description":"Gets or sets the order by field.","nullable":true},"isOrderByAsc":{"type":"boolean","description":"Gets or sets a value indicating whether this instance is order by asc."},"results":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.VatBandConfigDto"},"description":"Gets or sets the results.","nullable":true}},"description":""},"Customs.Catalog.Domain.Pkg.Models.Paging.PagedResult`1[[Customs.Catalog.Domain.Pkg.Models.DTO.VatRateDto, Customs.Catalog.Domain.Pkg, Version=2.1.0.1262, Culture=neutral, PublicKeyToken=null]]":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Gets or sets the current page.","format":"int32"},"pageCount":{"type":"integer","description":"Gets or sets the page count.","format":"int32"},"pageSize":{"type":"integer","description":"Gets or sets the size of the page.","format":"int32"},"rowCount":{"type":"integer","description":"Gets or sets the row count.","format":"int32"},"firstRowOnPage":{"type":"integer","description":"Gets the first row on page.","format":"int32","readOnly":true},"lastRowOnPage":{"type":"integer","description":"Gets the last row on page.","format":"int32","readOnly":true},"orderByField":{"type":"string","description":"Gets or sets the order by field.","nullable":true},"isOrderByAsc":{"type":"boolean","description":"Gets or sets a value indicating whether this instance is order by asc."},"results":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.VatRateDto"},"description":"Gets or sets the results.","nullable":true}},"description":""},"Customs.Catalog.Domain.Pkg.Models.Paging.Pagination":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Gets or sets the current page.","format":"int32"},"pageCount":{"type":"integer","description":"Gets or sets the page count.","format":"int32"},"pageSize":{"type":"integer","description":"Gets or sets the size of the page.","format":"int32"},"rowCount":{"type":"integer","description":"Gets or sets the row count.","format":"int32"},"firstRowOnPage":{"type":"integer","description":"Gets the first row on page.","format":"int32","readOnly":true},"lastRowOnPage":{"type":"integer","description":"Gets the last row on page.","format":"int32","readOnly":true},"orderByField":{"type":"string","description":"Gets or sets the order by field.","nullable":true},"isOrderByAsc":{"type":"boolean","description":"Gets or sets a value indicating whether this instance is order by asc."}},"description":""},"System.Collections.Generic.KeyValuePair`2\[\[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],\[System.Int64, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"integer","format":"int64"}}}},"endpoints":\[{"method":"POST","path":"/api/v2/Classifications","summary":"Returns a list of products","pathParams":\[],"bodySchema":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationRegion"}}},{"method":"POST","path":"/api/v2/Classifications/regions/save","summary":"Saves a classifications regions","pathParams":\[],"bodySchema":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ClassificationRegion"}}},{"method":"POST","path":"/api/v2/Classifications/LoadChapterClassifications","summary":"Returns a list of Classifications","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.GetClassificationsRequest"}},{"method":"POST","path":"/api/v2/DefaultClassifiedProduct/load","summary":"Loads default products","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.GetDefaultProductsRequest"}},{"method":"POST","path":"/api/v2/DutyRule","summary":"Upsert a list of duty rules","pathParams":\[],"bodySchema":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.DutyRuleDto"}}},{"method":"POST","path":"/api/v2/InvalidProducts/Invalid","summary":"Returns a list of invalid products for display on the UI.","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductSearchRequest"}},{"method":"POST","path":"/api/v2/InvalidProducts/Delete","summary":"Deletes invalid products for brand.","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.InvalidProductSearchRequest"}},{"method":"POST","path":"/api/v2/Logs/GetFiles","summary":"Returns a list of logs for display on the UI.","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.FileSearchRequest"}},{"method":"POST","path":"/api/v2/MasterCatalog/Reload","summary":"Allows a retailer to reload a catalog that will be subject t","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.MasterCatalogRequest"}},{"method":"PUT","path":"/api/v2/Products/DefaultClassification","summary":"Update default classification for the selected products","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ProductClassificationRequest"}},{"method":"POST","path":"/api/v2/Products","summary":"Creates new products and returns the product information inc","pathParams":\[],"bodySchema":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.CreateProductRequest"}}},{"method":"POST","path":"/api/v2/Products/Variants","summary":"Returns a list of product codes mapped by variant product co","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.ProductVariantSearchRequest"}},{"method":"POST","path":"/api/v2/RetailerCatalog","summary":"Allows a retailer to upload a catalog that will be subject t","pathParams":\[],"bodySchema":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RetailerCatalogProduct"}}},{"method":"POST","path":"/api/v2/RetailerCatalog/TenantCode/{tenantCode}","summary":"Allows a retailer to upload a catalog for a tenant that will","pathParams":\[{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"type":"array","items":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.RetailerCatalogProduct"}}},{"method":"POST","path":"/api/v2/Vat","summary":"Add new Vat rate","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.VatRateDto"}},{"method":"PUT","path":"/api/v2/Vat/{id}","summary":"Updates a vat rate.","pathParams":\[{"name":"id","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.VatRateDto"}},{"method":"POST","path":"/api/v2/VatBandConfig","summary":"Add new VatBandConfig.","pathParams":\[],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.VatBandConfigDto"}},{"method":"PUT","path":"/api/v2/VatBandConfig/{id}","summary":"Updates a VatBandConfig.","pathParams":\[{"name":"id","required":true,"description":"The identifier."}],"bodySchema":{"$ref":"#/components/schemas/Customs.Catalog.Domain.Pkg.Models.DTO.VatBandConfigDto"}}]}" specUrl="" epIdx="5" method="POST" path="/api/v2/InvalidProducts/Invalid" title="Returns a list of invalid products for display on the UI." %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://developer.esw.com/customs-catalog-api/resources/first-successful-requests/catalog-exception-analyst.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.