Get Subcategory Status v1.1

The “Get Subcategory Status v1.1” is based on the “Get Subcategory Status” API, adding search for category id and catalog name of the website.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sellermgmt/seller/subcategory/v1.1?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/sellermgmt/seller/subcategory/v1.1?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/sellermgmt/seller/subcategory/v1.1?sellerid={sellerid}

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.

Parameters

Name	Required?	Description
sellerid	Yes	Your seller ID on Newegg Marketplace

Resource Information

HTTP Method	Authentication?	Request Formats	Response Formats	Rate Limited?
PUT	Required	XML, Json	XML, Json	100 request per hour

Request Body

Attribute	Required?	Format	Description
OperationType	Yes	String	Fixed values: GetSellerSubcategoryRequest
SubcategoryID	No	Integer	Newegg Subcategory ID If this value is provided, then response will only contain information of the specified subcategory ID.
IndustryCode	No	String	Newegg industry code
Enabled	No	Integer	Condition filter to specify the request by sub-category current status. Available values: 0: Not Enabled 1: Enabled If left blank, the response will return both Not Enabled and Enabled subcategories
WebSiteCategoryID	No	Integer	Newegg Website Category ID If this value is provided, then response will only contain information of the specified website category ID.
WebSiteCatalogName	No	String	Newegg Website Catalog Name This value allows keywords. If this value is provided, then response will only contain information of the specified website catalog name.

Schema: GetSubcatetoryRequestV1.1.xsd

Example: XML, Request

PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategory/v1.1?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>GetSellerSubcategoryRequest</OperationType>
    <RequestBody>
        <GetItemSubcategory>
            <WebSiteCategoryIDList>
                <WebSiteCategoryID>402</WebSiteCategoryID>
                <WebSiteCategoryID>134</WebSiteCategoryID>
            </WebSiteCategoryIDList>
            <WebSiteCatalogName>CH</WebSiteCatalogName>
        </GetItemSubcategory>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategory/v1.1?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "GetSellerSubcategoryRequest",
    "RequestBody": {
        "GetItemSubcategory": {
            "GetItemSubcategory": {
            "WebSiteCategoryIDList": [
                402,
                134
            ],
            "WebSiteCatalogName": "CH"
        }
    }
}

Response Body

Attribute	Format	Description
IsSuccess	String	Get feed status operation: True: Successful False: Not successful
OperationType	String	Fixed value: GetSellerSubcategoryResponse
SellerID	String	Your seller ID
IndustryCode	String	Newegg industry code
IndustryName	String	Newegg industry name
SubcategoryID	Integer	Newegg subcategory ID
SubcategoryName	String	Newegg subcategory name
Enabled	Integer	The subcategory is enabled or not for this seller Available values: 0: Not Enabled 1: Enabled
WebSiteCategoryID	Integer	Newegg website category id
WebSiteCatalogName	String	Newegg website catalog name

Schema: GetSubcatetoryResponseV1.1.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetSellerSubcategoryResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <SubcategoryList>
            <Subcategory>
                <IndustryCode>CE</IndustryCode>
                <IndustryName>
                    <![CDATA[Consumer Electronics]]>
                </IndustryName>
                <SubcategoryID>134</SubcategoryID>
                <SubcategoryName>
                    <![CDATA[Standard Batteries & Chargers]]>
                </SubcategoryName>
                <Enabled>1</Enabled>
                <WebSiteCategoryID>134</WebSiteCategoryID>
                <WebSiteCatalogName>
                    <![CDATA[Standard Batteries & Chargers]]>
                </WebSiteCatalogName>
            </Subcategory>
            <Subcategory>
                <IndustryCode>CE</IndustryCode>
                <IndustryName>
                    <![CDATA[Consumer Electronics]]>
                </IndustryName>
                <SubcategoryID>402</SubcategoryID>
                <SubcategoryName>
                    <![CDATA[Camcorder Batteries & Chargers]]>
                </SubcategoryName>
                <Enabled>1</Enabled>
                <WebSiteCategoryID>402</WebSiteCategoryID>
                <WebSiteCatalogName>
                    <![CDATA[Camcorder Batteries & Chargers]]>
               </WebSiteCatalogName>
            </Subcategory>
        </SubcategoryList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "GetSellerSubcategoryResponse",
    "SellerID": "A006",
    "ResponseBody": {
       "SubcategoryList": [
            {
                "IndustryCode": "CE",
                "IndustryName": "Consumer Electronics",
                "SubcategoryID": 134,
                "SubcategoryName": "Standard Batteries & Chargers",
                "Enabled": 1,
                "WebSiteCategoryID": 134,
                "WebSiteCatalogName": "Standard Batteries & Chargers"
            },
            {
               "IndustryCode": "CE",
                "IndustryName": "Consumer Electronics",
                "SubcategoryID": 402,
                "SubcategoryName": "Camcorder Batteries & Chargers",
                "Enabled": 1,
                "WebSiteCategoryID": 402,
                "WebSiteCatalogName": "Camcorder Batteries & Chargers"
            }
        ]
    }
}

Request Failure Errors

For common HTTP error responses, please refer to Failed Response Error Code List.

Error Code	Description
DF008	Invalid industry code [{0}].

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>DF008</Code>
        <Message>Invalid industry code ABC</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "DF008",
        "Message": "Invalid industry code ABC"
    }
]

Last updated: September 29, 2021