POST v1/api/Standard/ProductCatalog

Processes Product Catalog upload requests from a Brand to EShopWorld.

Request Information

URI Parameters

None.

Body Parameters

A object containing Product Catalog upload request details.

esw.Common.Model.Published.Catalog.ProductCatalogRequest

Name	Description	Type	Additional information
Header	A object detailing the catalog request header details. Required: Yes	esw.Common.Model.Published.Catalog.ProductCatalogHeader	None.
Products	A list of objects detailing the Catalog Products to upload. Required: Yes	Collection of esw.Common.Model.Published.Catalog.ProductCatalogProduct	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "BrandCode": "sample string 1",
    "CatalogRevision": "sample string 2",
    "CatalogRevisionStartTime": "2024-09-29T02:24:04.8099194+00:00"
  },
  "Products": [
    {
      "GlobalProductId": "a7b6cd39-7269-4155-b1d6-c3cd94f4d8ee",
      "MaterialNumber": "sample string 1",
      "ImageUrl": "sample string 2",
      "IsCustomized": true,
      "Category": 0,
      "Description": "sample string 4",
      "Description2": "sample string 5",
      "Hazardous": true,
      "ExcludedCountries": [
        "sample string 1",
        "sample string 2"
      ],
      "CountryOfOriginHsCodeMappings": [
        {
          "CountryOfOrigin": "sample string 1",
          "TargetHsCodeCountryCode": "sample string 2",
          "DescriptionForCustoms": "sample string 3",
          "SizesToHsCodeMappings": [
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            },
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            }
          ],
          "MaterialContents": [
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            },
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            }
          ]
        },
        {
          "CountryOfOrigin": "sample string 1",
          "TargetHsCodeCountryCode": "sample string 2",
          "DescriptionForCustoms": "sample string 3",
          "SizesToHsCodeMappings": [
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            },
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            }
          ],
          "MaterialContents": [
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            },
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            }
          ]
        }
      ],
      "CountryPriceMappings": [
        {
          "CountryCode": "sample string 1",
          "CurrencyCode": "sample string 2",
          "SizeToPriceMappings": [
            {
              "Size": "sample string 1",
              "Price": 2.0
            },
            {
              "Size": "sample string 1",
              "Price": 2.0
            }
          ],
          "IsLocalizedPrice": true
        },
        {
          "CountryCode": "sample string 1",
          "CurrencyCode": "sample string 2",
          "SizeToPriceMappings": [
            {
              "Size": "sample string 1",
              "Price": 2.0
            },
            {
              "Size": "sample string 1",
              "Price": 2.0
            }
          ],
          "IsLocalizedPrice": true
        }
      ],
      "Gender": 0,
      "ShippingPackageDimensionUnit": 1,
      "ShippingPackageVolumetricWeightUnit": 1,
      "WeightUnit": 1,
      "Marketplaces": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "GlobalProductId": "a7b6cd39-7269-4155-b1d6-c3cd94f4d8ee",
      "MaterialNumber": "sample string 1",
      "ImageUrl": "sample string 2",
      "IsCustomized": true,
      "Category": 0,
      "Description": "sample string 4",
      "Description2": "sample string 5",
      "Hazardous": true,
      "ExcludedCountries": [
        "sample string 1",
        "sample string 2"
      ],
      "CountryOfOriginHsCodeMappings": [
        {
          "CountryOfOrigin": "sample string 1",
          "TargetHsCodeCountryCode": "sample string 2",
          "DescriptionForCustoms": "sample string 3",
          "SizesToHsCodeMappings": [
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            },
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            }
          ],
          "MaterialContents": [
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            },
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            }
          ]
        },
        {
          "CountryOfOrigin": "sample string 1",
          "TargetHsCodeCountryCode": "sample string 2",
          "DescriptionForCustoms": "sample string 3",
          "SizesToHsCodeMappings": [
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            },
            {
              "ProductCode": "sample string 1",
              "Size": "sample string 2",
              "HsCode": "sample string 3",
              "Weight": 4.1,
              "VolumetricWeight": 5.1,
              "ShippingPackageLength": 6.1,
              "ShippingPackageWidth": 7.1,
              "ShippingPackageHeight": 8.1
            }
          ],
          "MaterialContents": [
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            },
            {
              "Name": "sample string 1",
              "Description": "sample string 2",
              "Value": "sample string 3"
            }
          ]
        }
      ],
      "CountryPriceMappings": [
        {
          "CountryCode": "sample string 1",
          "CurrencyCode": "sample string 2",
          "SizeToPriceMappings": [
            {
              "Size": "sample string 1",
              "Price": 2.0
            },
            {
              "Size": "sample string 1",
              "Price": 2.0
            }
          ],
          "IsLocalizedPrice": true
        },
        {
          "CountryCode": "sample string 1",
          "CurrencyCode": "sample string 2",
          "SizeToPriceMappings": [
            {
              "Size": "sample string 1",
              "Price": 2.0
            },
            {
              "Size": "sample string 1",
              "Price": 2.0
            }
          ],
          "IsLocalizedPrice": true
        }
      ],
      "Gender": 0,
      "ShippingPackageDimensionUnit": 1,
      "ShippingPackageVolumetricWeightUnit": 1,
      "WeightUnit": 1,
      "Marketplaces": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<eShopWorldProductCatalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <Header>
    <BrandCode>sample string 1</BrandCode>
    <CatalogRevision>sample string 2</CatalogRevision>
    <CatalogRevisionStartTime>2024-09-29T02:24:04.8099194+00:00</CatalogRevisionStartTime>
  </Header>
  <Products>
    <CatalogProduct>
      <Category>NotApplicable</Category>
      <CountryOfOriginHsCodeMappings>
        <CountryOfOriginHsCodeMapping>
          <CountryOfOrigin>sample string 1</CountryOfOrigin>
          <DescriptionForCustoms>sample string 3</DescriptionForCustoms>
          <MaterialContents>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
          </MaterialContents>
          <SizesToHsCodeMappings>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
          </SizesToHsCodeMappings>
          <TargetHsCodeCountryCode>sample string 2</TargetHsCodeCountryCode>
        </CountryOfOriginHsCodeMapping>
        <CountryOfOriginHsCodeMapping>
          <CountryOfOrigin>sample string 1</CountryOfOrigin>
          <DescriptionForCustoms>sample string 3</DescriptionForCustoms>
          <MaterialContents>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
          </MaterialContents>
          <SizesToHsCodeMappings>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
          </SizesToHsCodeMappings>
          <TargetHsCodeCountryCode>sample string 2</TargetHsCodeCountryCode>
        </CountryOfOriginHsCodeMapping>
      </CountryOfOriginHsCodeMappings>
      <CountryPriceMappings>
        <CountryPriceMapping>
          <CountryCode>sample string 1</CountryCode>
          <CurrencyCode>sample string 2</CurrencyCode>
          <IsLocalizedPrice>true</IsLocalizedPrice>
          <SizeToPriceMappings>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
          </SizeToPriceMappings>
        </CountryPriceMapping>
        <CountryPriceMapping>
          <CountryCode>sample string 1</CountryCode>
          <CurrencyCode>sample string 2</CurrencyCode>
          <IsLocalizedPrice>true</IsLocalizedPrice>
          <SizeToPriceMappings>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
          </SizeToPriceMappings>
        </CountryPriceMapping>
      </CountryPriceMappings>
      <Description>sample string 4</Description>
      <Description2>sample string 5</Description2>
      <ExcludedCountries xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ExcludedCountries>
      <Gender>Unused</Gender>
      <GlobalProductId>a7b6cd39-7269-4155-b1d6-c3cd94f4d8ee</GlobalProductId>
      <Hazardous>true</Hazardous>
      <ImageUrl>sample string 2</ImageUrl>
      <IsCustomized>true</IsCustomized>
      <Marketplaces xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Marketplaces>
      <MaterialNumber>sample string 1</MaterialNumber>
      <ShippingPackageDimensionUnit>M</ShippingPackageDimensionUnit>
      <ShippingPackageVolumetricWeightUnit>Lb</ShippingPackageVolumetricWeightUnit>
      <WeightUnit>Lb</WeightUnit>
    </CatalogProduct>
    <CatalogProduct>
      <Category>NotApplicable</Category>
      <CountryOfOriginHsCodeMappings>
        <CountryOfOriginHsCodeMapping>
          <CountryOfOrigin>sample string 1</CountryOfOrigin>
          <DescriptionForCustoms>sample string 3</DescriptionForCustoms>
          <MaterialContents>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
          </MaterialContents>
          <SizesToHsCodeMappings>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
          </SizesToHsCodeMappings>
          <TargetHsCodeCountryCode>sample string 2</TargetHsCodeCountryCode>
        </CountryOfOriginHsCodeMapping>
        <CountryOfOriginHsCodeMapping>
          <CountryOfOrigin>sample string 1</CountryOfOrigin>
          <DescriptionForCustoms>sample string 3</DescriptionForCustoms>
          <MaterialContents>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
            <MaterialContent>
              <Description>sample string 2</Description>
              <Name>sample string 1</Name>
              <Value>sample string 3</Value>
            </MaterialContent>
          </MaterialContents>
          <SizesToHsCodeMappings>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
            <SizeToHsCodeMapping>
              <HsCode>sample string 3</HsCode>
              <ProductCode>sample string 1</ProductCode>
              <ShippingPackageHeight>8.1</ShippingPackageHeight>
              <ShippingPackageLength>6.1</ShippingPackageLength>
              <ShippingPackageWidth>7.1</ShippingPackageWidth>
              <Size>sample string 2</Size>
              <VolumetricWeight>5.1</VolumetricWeight>
              <Weight>4.1</Weight>
            </SizeToHsCodeMapping>
          </SizesToHsCodeMappings>
          <TargetHsCodeCountryCode>sample string 2</TargetHsCodeCountryCode>
        </CountryOfOriginHsCodeMapping>
      </CountryOfOriginHsCodeMappings>
      <CountryPriceMappings>
        <CountryPriceMapping>
          <CountryCode>sample string 1</CountryCode>
          <CurrencyCode>sample string 2</CurrencyCode>
          <IsLocalizedPrice>true</IsLocalizedPrice>
          <SizeToPriceMappings>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
          </SizeToPriceMappings>
        </CountryPriceMapping>
        <CountryPriceMapping>
          <CountryCode>sample string 1</CountryCode>
          <CurrencyCode>sample string 2</CurrencyCode>
          <IsLocalizedPrice>true</IsLocalizedPrice>
          <SizeToPriceMappings>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
            <SizeToPriceMapping>
              <Price>2</Price>
              <Size>sample string 1</Size>
            </SizeToPriceMapping>
          </SizeToPriceMappings>
        </CountryPriceMapping>
      </CountryPriceMappings>
      <Description>sample string 4</Description>
      <Description2>sample string 5</Description2>
      <ExcludedCountries xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ExcludedCountries>
      <Gender>Unused</Gender>
      <GlobalProductId>a7b6cd39-7269-4155-b1d6-c3cd94f4d8ee</GlobalProductId>
      <Hazardous>true</Hazardous>
      <ImageUrl>sample string 2</ImageUrl>
      <IsCustomized>true</IsCustomized>
      <Marketplaces xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Marketplaces>
      <MaterialNumber>sample string 1</MaterialNumber>
      <ShippingPackageDimensionUnit>M</ShippingPackageDimensionUnit>
      <ShippingPackageVolumetricWeightUnit>Lb</ShippingPackageVolumetricWeightUnit>
      <WeightUnit>Lb</WeightUnit>
    </CatalogProduct>
  </Products>
</eShopWorldProductCatalog>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'esw.Common.Model.Published.Catalog.ProductCatalogRequest'.

Response Information

Resource Description

An object containing the response object.

esw.Common.Model.Published.Catalog.ProductCatalogResponse

Name	Description	Type	Additional information
UploadStatus	Response status for the catalog submission.	esw.Common.Model.Published.ProductCatalogUploadStatus	None.
CatalogRequestErrors	List of errors encountered when processing the catalog upload request. Note: Only populated if the UploadStatus = Error	Collection of esw.Common.Model.Published.Catalog.ProductCatalogError	None.
ProductErrors	A list of objects detailing any errors encountered with uploading individual products within the catalog. Note: Only populated if the UploadStatus = InComplete.	Collection of esw.Common.Model.Published.Catalog.ProductCatalogProductError	None.

Response Formats

application/json, text/json

Sample:

{
  "UploadStatus": 0,
  "CatalogRequestErrors": [
    {
      "ErrorCode": 100,
      "ErrorDescription": "sample string 1"
    },
    {
      "ErrorCode": 100,
      "ErrorDescription": "sample string 1"
    }
  ],
  "ProductErrors": [
    {
      "MaterialNumber": "sample string 1",
      "ErrorCode": 200,
      "ErrorDescription": "sample string 2"
    },
    {
      "MaterialNumber": "sample string 1",
      "ErrorCode": 200,
      "ErrorDescription": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<eShopWorldProductCatalogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <CatalogRequestErrors>
    <ProductCatalogError>
      <ErrorCode>MissingRequest</ErrorCode>
      <ErrorDescription>sample string 1</ErrorDescription>
    </ProductCatalogError>
    <ProductCatalogError>
      <ErrorCode>MissingRequest</ErrorCode>
      <ErrorDescription>sample string 1</ErrorDescription>
    </ProductCatalogError>
  </CatalogRequestErrors>
  <ProductErrors>
    <ProductCatalogProductError>
      <ErrorCode>MissingProductCode</ErrorCode>
      <ErrorDescription>sample string 2</ErrorDescription>
      <MaterialNumber>sample string 1</MaterialNumber>
    </ProductCatalogProductError>
    <ProductCatalogProductError>
      <ErrorCode>MissingProductCode</ErrorCode>
      <ErrorDescription>sample string 2</ErrorDescription>
      <MaterialNumber>sample string 1</MaterialNumber>
    </ProductCatalogProductError>
  </ProductErrors>
  <UploadStatus>Complete</UploadStatus>
</eShopWorldProductCatalogResponse>