Get Subcategory Status

Get the subcategory status for the specified seller account. Subcategory is either enabled or not enabled for a seller.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sellermgmt/seller/subcategory?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/sellermgmt/seller/subcategory?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/sellermgmt/seller/subcategory?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

Schema:  GetSubcatetoryRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetSellerSubcategoryRequest</OperationType>
    <RequestBody>
        <GetItemSubcategory>
            <SubcategoryIDList>
                <SubcategoryID>397</SubcategoryID>
            </SubcategoryIDList>
            <IndustryCodeList>
                <IndustryCode>CH</IndustryCode>
            </IndustryCodeList>
            <Enabled>1</Enabled>
        </GetItemSubcategory>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetSellerSubcategoryRequest",
    "RequestBody": {
        "GetItemSubcategory": {
            "SubcategoryIDList": {
                "SubcategoryID": "397"
            },
            "IndustryCodeList": {
                "IndustryCode": "CH"
            },
            "Enabled": "1"
        }
    }
}

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

Schema: GetSubcatetoryResponse.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>AP</IndustryCode>
                <IndustryName>Apparel</IndustryName>
                <SubcategoryID>1508</SubcategoryID>
                <SubcategoryName>
                    <![CDATA[Belts & Suspenders]]>
                </SubcategoryName>
                <Enabled>1</Enabled>
            </Subcategory>
            <Subcategory>
                <IndustryCode>AP</IndustryCode>
                <IndustryName>Apparel</IndustryName>
                <SubcategoryID>153</SubcategoryID>
                <SubcategoryName>
                    <![CDATA[Buckles]]>
                </SubcategoryName>
                <Enabled>0</Enabled>
            </Subcategory>
        </SubcategoryList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "GetSellerSubcategoryResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "SubcategoryList": [
            {
                "IndustryCode": "AP",
                "IndustryName": "Apparel",
                "SubcategoryID": "1508",
                "SubcategoryName": "Belts & Suspenders",
                "Enabled": "1"
            },
            {
                "IndustryCode": "AP",
                "IndustryName": "Apparel",
                "SubcategoryID": "153",
                "SubcategoryName": "Buckles",
                "Enabled": "0"
            }
        ]
    }
}

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: October 15, 2018