eBay Trading API899

SetStoreCategories

Use this call to change the category configuration of a user's eBay store. You can add, delete, move, or rename a list of store categories. To call SetStoreCategories, the user must have an eBay Stores subscription and they must have created an eBay Store on the eBay website.

Usage Details

Depending on the number of listings affected, SetStoreCategories is processed either synchronously or asynchronously. If the call affects few listings, eBay processes the call synchronously. Here, processing occurs when the request is received, and the response contains the outcome in the Status field, either Complete or Failed.

If the call affects many listings, eBay processes the call asynchronously. In this case, the response indicates that the Status of the changes is Pending, and processing occurs in the background. You must make a separate call to GetStoreCategoryUpdateStatus to retrieve the outcome of SetStoreCategories when it is processed asynchronously.

Even after processing is complete, it may still take several minutes for category changes to show up on the storefront in the site UI. Store categories show up in the UI only when they have items listed in them or in a subcategory.

For information on setting up and managing eBay store categories, see Managing Store Categories.

Working with the Response

The SetStoreCategories response includes TaskID and Status fields. When the call is processed synchronously, the TaskID value is 0 and the Status indicates the outcome of the request. When the call is processed asynchronously, the TaskID value is a positive number and the Status is Pending. You must use GetStoreCategoryUpdateStatus to get the outcome of the request when SetStoreCategories is processed asynchronously.

Testing SetStoreCategories

You can test this call in the Sandbox, as follows:

  1. With a test user, create an eBay Store using the Sandbox website.
  2. Use GetStoreOptions to get the current list of options for the eBay Store.
  3. If desired, update the store configuration by making a call to SetStore using the configuration data that you retrieved in the previous step as the base data.
  4. Use SetStoreCategories to add, delete, move, and rename store categories.
  5. Lastly, verify that the store configuration by calling GetStore and examining the output. Note that it might take several minutes for your changes to show up in the site UI.

Related Information

See Managing eBay Stores.

See also the reference documentation for these calls:



Back to top

Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <Action> StoreCategoryUpdateActionCodeType </Action>
  <DestinationParentCategoryID> long </DestinationParentCategoryID>
  <ItemDestinationCategoryID> long </ItemDestinationCategoryID>
  <StoreCategories> StoreCustomCategoryArrayType
    <CustomCategory> StoreCustomCategoryType
      <CategoryID> long </CategoryID>
      <ChildCategory> StoreCustomCategoryType
        <CategoryID> long </CategoryID>
        <ChildCategory> StoreCustomCategoryType
          <CategoryID> long </CategoryID>
          <ChildCategory> StoreCustomCategoryType </ChildCategory>
            <!-- >>> ChildCategory can be nested within itself an unlimited number of times >>> -->
          <!-- ... more ChildCategory nodes allowed here ... -->
          <Name> string </Name>
          <Order> int </Order>
        </ChildCategory>
          <!-- >>> ChildCategory can be nested within itself an unlimited number of times >>> -->
        <!-- ... more ChildCategory nodes allowed here ... -->
        <Name> string </Name>
        <Order> int </Order>
      </ChildCategory>
      <!-- ... more ChildCategory nodes allowed here ... -->
      <Name> string </Name>
      <Order> int </Order>
    </CustomCategory>
    <!-- ... more CustomCategory nodes allowed here ... -->
  </StoreCategories>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetStoreCategoriesRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
Action StoreCategoryUpdateActionCodeType Required Specifies the type of action (Add, Move, Delete, or Rename) to carry out for the specified categories.

Applicable values:

Add
(in) Add the listed categories to the store.
CustomCode
(in) Reserved for internal or future use.
Delete
(in) Delete the listed categories from the store.
Move
(in) Move the listed categories from one place in the store category structure to another.
Rename
(in) Rename the listed store categories to the names provided.

DestinationParentCategoryID long Conditional When adding or moving store categories, specifies the category under which the listed categories will be located. To add or move categories to the top level, set the value to -999.
ItemDestinationCategoryID long Conditional Items can only be contained within child categories. A parent category cannot contain items. If adding, moving, or deleting categories displaces items, you must specify a destination child category under which the displaced items will be moved. The destination category must have no child categories.
StoreCategories StoreCustomCategoryArrayType Required Specifies the store categories on which to act.
StoreCategories.CustomCategory StoreCustomCategoryType Required,
repeatable: [1..*]
A custom category for your eBay Store.
StoreCategories.CustomCategory
  .CategoryID
long Conditional Custom category ID. For SetStoreCategories, required only if Action is set to Rename, Move or Delete.
StoreCategories.CustomCategory
  .ChildCategory
StoreCustomCategoryType Conditional,
repeatable: [0..*]
Contains the properties of a custom subcategory for an eBay Store. eBay Stores support three category levels.
StoreCategories.CustomCategory
  .ChildCategory.CategoryID
long Conditional Custom category ID. For SetStoreCategories, required only if Action is set to Rename, Move or Delete.
StoreCategories.CustomCategory
  .ChildCategory.ChildCategory
StoreCustomCategoryType Conditional,
repeatable: [0..*]
Contains the properties of a custom subcategory for an eBay Store. eBay Stores support three category levels.
Recursion: There is no limit to the number of levels you can submit. The deepest level cannot include ChildCategory.
StoreCategories.CustomCategory
  .ChildCategory.ChildCategory
  .CategoryID
long Conditional Custom category ID. For SetStoreCategories, required only if Action is set to Rename, Move or Delete.
StoreCategories.CustomCategory
  .ChildCategory.ChildCategory
  .ChildCategory
StoreCustomCategoryType Conditional,
repeatable: [0..*]
Contains the properties of a custom subcategory for an eBay Store. eBay Stores support three category levels.
Recursion: There is no limit to the number of levels you can submit. The deepest level cannot include ChildCategory.
StoreCategories.CustomCategory
  .ChildCategory.ChildCategory
  .Name
string Conditional Name of the custom category.
StoreCategories.CustomCategory
  .ChildCategory.ChildCategory
  .Order
int Optional Order in which the custom category appears in the list of store categories.
StoreCategories.CustomCategory
  .ChildCategory.Name
string Conditional Name of the custom category.
StoreCategories.CustomCategory
  .ChildCategory.Order
int Optional Order in which the custom category appears in the list of store categories.
StoreCategories.CustomCategory
  .Name
string Conditional Name of the custom category.
StoreCategories.CustomCategory
  .Order
int Optional Order in which the custom category appears in the list of store categories.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 859). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) Return warnings when the application passes unrecognized or deprecated elements in a request.
Low
(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.

See Warning Level.



Back to top

Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <CustomCategory> StoreCustomCategoryArrayType </CustomCategory>
  <Status> TaskStatusCodeType </Status>
  <TaskID> long </TaskID>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</SetStoreCategoriesResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
CustomCategory StoreCustomCategoryArrayType Always Contains data for store categories that you have created.
Status TaskStatusCodeType Always When a category structure change is processed synchronously, the status is returned as Complete or Failed. For asynchronously processed changes, the status is reported as Pending. Use GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes.

Applicable values:

Complete
(out) The category changes completed successfully.
CustomCode
(out) Reserved for internal or future use.
Failed
(out) The category changes failed.
InProgress
(out) The category changes are in progress.
Pending
(out) The category changes have not started.

TaskID long Always The task ID associated with the category structure change request. For a simple change, the SetStoreCategories call is processed synchronously. That is, simple changes are made immediately and then the response is returned. For synchronous processing, the task ID in the response is 0. If the category structure changes affect many listings, the changes will be processed asynchronously and the task ID will be a positive number. Use the non-zero task ID with GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) Request processing failed
Success
(out) Request processing succeeded
Warning
(out) Request processing completed with warning information being included in the response message

(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Back to top

Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Available samples:

Sample: Basic Call

Adds categories to an eBay store.

Description

This sample shows how to add categories to your store. Store category IDs are assigned automatically. The added categories appear in the order specified under the category set with DestinationParentCategoryID. If there are items under the specified parent category, they are moved to the category specified with ItemDestinationCategoryID.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>449</Version>
  <Action>Add</Action>
  <ItemDestinationCategoryID>14122</ItemDestinationCategoryID>
  <DestinationParentCategoryID>14125</DestinationParentCategoryID>
  <StoreCategories>
    <CustomCategory>
      <Name>MP3 Players and Accessories</Name>
      <Order>1</Order>
    </CustomCategory>
    <CustomCategory>
      <Name>GPS Devices</Name>
      <Order>2</Order>
    </CustomCategory>
  </StoreCategories>
</SetStoreCategoriesRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-21T23:16:29.683Z</Timestamp>
  <Ack>Success</Ack>
  <Version>449</Version>
  <Build>e449_core_API_2421920_R1</Build>
  <TaskID>0</TaskID>
  <Status>Complete</Status>
</SetStoreCategoriesResponse>


Back to list of samples

Sample: Delete a Category

Deletes an existing eBay store category.

Description

This sample shows how to delete categories from an eBay store. Any items listed under the deleted categories will be moved under the category specified with ItemDestinationCategoryID.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Action>Delete</Action>
  <ItemDestinationCategoryID>14122</ItemDestinationCategoryID>
  <StoreCategories>
    <CustomCategory>
      <CategoryID>19227</CategoryID>
    </CustomCategory>
    <CustomCategory>
      <CategoryID>19228</CategoryID>
    </CustomCategory>
  </StoreCategories>
</SetStoreCategoriesRequest>

Output

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<SetStoreCategoriesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-23T04:19:40.621Z</Timestamp>
  <Ack>Success</Ack>
  <Version>449</Version>
  <Build>e449_core_API_2421920_R1</Build>
  <TaskID>0</TaskID>
  <Status>Complete</Status>
</SetStoreCategoriesResponse>

Back to list of samples

Sample: Move Categories

Moves eBay store categories under a new parent category.

Description

This sample moves two categories underneath a new parent category in an eBay store category structure.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Action>Move</Action>
  <ItemDestinationCategoryID>14127</ItemDestinationCategoryID>
  <DestinationParentCategoryID>14122</DestinationParentCategoryID>
  <StoreCategories>
    <CustomCategory>
      <CategoryID>19227</CategoryID>
      <Name>MP3 Players and Accessories</Name>
      <Order>1</Order>
    </CustomCategory>
    <CustomCategory>
      <CategoryID>19228</CategoryID>
      <Name>GPS Devices</Name>
      <Order>2</Order>
    </CustomCategory>
  </StoreCategories>
</SetStoreCategoriesRequest>

Output

The response showing that the call is being processed asynchronously.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<SetStoreCategoriesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-21T23:31:47.902Z</Timestamp>
  <Ack>Success</Ack>
  <Version>449</Version>
  <Build>e449_core_API_2421920_R1</Build>
  <TaskID>798</TaskID>
  <Status>Pending</Status>
</SetStoreCategoriesResponse>

Back to list of samples

Sample: Move to Top

Moves a category to the top of the category structure.

Description

Moves an eBay store categories to the top level of the eBay store category structure.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Action>Move</Action>
  <DestinationParentCategoryID>-999</DestinationParentCategoryID>
  <StoreCategories>
    <CustomCategory>
      <CategoryID>14122</CategoryID>
      <Name>Electronics</Name>
      <Order>4</Order>
    </CustomCategory>
  </StoreCategories>
</SetStoreCategoriesRequest>

Output

The response showing that the call is being processed synchronously.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<SetStoreCategoriesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-23T03:26:41.496Z</Timestamp>
  <Ack>Success</Ack>
  <Version>449</Version>
  <Build>e449_core_API_2421920_R1</Build>
  <TaskID>0</TaskID>
  <Status>Complete</Status>
</SetStoreCategoriesResponse>

Back to list of samples

Sample: Renames a Category

Renames an eBay store category.

Description

This sample renames two existing eBay store categories.

Input

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreCategoriesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Action>Rename</Action>
  <StoreCategories>
    <CustomCategory>
      <CategoryID>19227</CategoryID>
      <Name>Portable Audio</Name>
    </CustomCategory>
    <CustomCategory>
      <CategoryID>19228</CategoryID>
      <Name>Techno Gadgets</Name>
    </CustomCategory>
  </StoreCategories>
</SetStoreCategoriesRequest>

Output

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<SetStoreCategoriesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-02-23T04:28:08.824Z</Timestamp>
  <Ack>Success</Ack>
  <Version>449</Version>
  <Build>e449_core_API_2421920_R1</Build>
  <TaskID>0</TaskID>
  <Status>Complete</Status>
</SetStoreCategoriesResponse>


Back to list of samples



Back to top

Change History

Version Description
637
2009-09-30
  • SetStoreCategoriesResponseType.CustomCategory (added): Developers can now add their own categories for eBay stores.
499
2007-02-07
  • DestinationParentCategoryID, ItemDestinationCategoryID (modified): The data types for IDs used for eBay Stores have changed from xs:int to xs:long to prepare for future increases in ID values.



Back to top

User-Contributed Notes