Get Subcategory Properties 

Get the subcategory properties for the specified subcategory.

Resource URL

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

Request Body

Attribute Required? Format Description
OperationType Yes String Fixed values: GetSellerSubcategoryPropertyRequest
SubcategoryID Yes Integer Newegg Subcategory ID

Note: Obtained using the Get Subcategory Status request

Schema:  GetSubcatetoryPropertiesRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetSellerSubcategoryPropertyRequest</OperationType>
    <RequestBody>
        <SubcategoryID>1045</SubcategoryID>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetSellerSubcategoryPropertyRequest",
    "RequestBody": {
        "SubcategoryID": "1045"
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: GetSellerSubcategoryPropertyResponse
SellerID String Your seller ID
SubcategoryID Integer Newegg subcategory ID
SubcategoryName String Newegg subcategory name
PropertyName String Property name of specified Newegg subcategory
IsAdvancedSearch Integer Will this property be showing up in the advance search navigation?

Available values:
0: No
1: Yes

IsGroupBy Integer Is this a group by property?

Available values:
0: No
1: Yes

IsRequired Integer Is this a required property?

Available values:
0: No
1: Yes

Schema: GetSubcatetoryPropertiesResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetSellerSubcategoryPropertyResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <SubcategoryPropertyList>
            <SubcategoryProperty>
                <SubcategoryID>1045</SubcategoryID>
                <SubcategoryName>
                    <![CDATA[Costumes]]>
                </SubcategoryName>
                <PropertyName>
                    <![CDATA[Costume_Brand]]>
                </PropertyName>
                <IsAdvancedSearch>0</IsAdvancedSearch>
                <IsGroupBy>0</IsGroupBy>
                <IsRequired>0</IsRequired>
            </SubcategoryProperty>
            <SubcategoryProperty>
                <SubcategoryID>1045</SubcategoryID>
                <SubcategoryName>
                    <![CDATA[Costumes]]>
                </SubcategoryName>
                <PropertyName>
                    <![CDATA[Costume_Model]]>
                </PropertyName>
                <IsAdvancedSearch>1</IsAdvancedSearch>
                <IsGroupBy>1</IsGroupBy>
                <IsRequired>1</IsRequired>
            </SubcategoryProperty>
        </SubcategoryPropertyList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "GetSellerSubcategoryPropertyResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "SubcategoryPropertyList": [
            {
                "SubcategoryID": "1045",
                "SubcategoryName": "Costumes",
                "PropertyName": "Costume_Brand",
                "IsAdvancedSearch": "0",
                "IsGroupBy": "0",
                "IsRequired": "0"
            },
            {
                "SubcategoryID": "1045",
                "SubcategoryName": "Costumes",
                "PropertyName": "Costume_Model",
                "IsAdvancedSearch": "1",
                "IsGroupBy": "1",
                "IsRequired": "1"
            }
        ]
    }
}

Request Failure Errors

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

Error Code Description
DF009 Invalid subcategory ID [{0}].

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>DF009</Code>
        <Message>Invalid subcategory ID ABC</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "DF009",
    "Message": "Invalid subcategory ID ABC"
}

Last updated: October 15, 2018