This call also uses the X-EBAY-C-MARKETPLACE-ID
header to identify the user's business context. This header is currently limited to EBAY-US
, EBAY-AU
, EBAY-CA
, and EBAY-GB
values. If not included with your request, the marketplace value defaults to EBAY-US
. Note that it does not indicate a language preference or end-user location.
Examples:X-EBAY-C-MARKETPLACE-ID: EBAY-US
X-EBAY-C-MARKETPLACE-ID: EBAY-AU
This method has the additional request header requirements listed below. See HTTP request headers - opens rest request components page for details.
Header | Type | Description |
---|---|---|
X-EBAY-C-MARKETPLACE-ID | string | Use this header to identify the authenticated user's business context. This header is currently limited to EBAY_US , EBAY_AU , EBAY_CA , and EBAY_GB values. If not included with your request, the marketplace value defaults to EBAY_US . Note that it does not indicate a language preference or end-user location. Occurrence: Required |
Accept-Language | string | Use this header to specify the natural language in which the authenticated user desires the response. Occurrence: Strongly Recommended |
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
See OAuth access tokens for more information.
Note: Only the sell.inventory
scope is required for selling applications, and only the commerce.catalog.readonly
scope is required for buying applications.
Input container/field | Type | Description |
---|---|---|
changeRequestType | ChangeRequestType | The type of catalog modification being requested by this change request. Available values:
Occurrence: Required |
reasonForChangeRequest | string | Required if the value of changeRequestType is PRODUCT_UPDATE , and optional otherwise; this is a text description of why this change is being requested. Occurrence: Conditional |
referenceId | string | Required if the referenceType field is included in the request. This is the identifier of an object of the type specified by the value of referenceType. For example, if the value of referenceType is INVENTORY_ITEM , this field should contain the seller's SKU for an inventory item. Occurrence: Conditional |
referenceType | ReferenceType | The type of object that the requested change is intended to support. This applies to objects that are incomplete due to the need for a matching catalog product. Providing a referenceType and a referenceId in a catalog change request enables eBay to automatically apply the resulting new or updated product directly to the specified object without requiring additional action on your part. Available values:
Occurrence: Optional |
suggestedProduct | SuggestedProduct | Contains the full details of the suggested product, including information about the product's identifiers, description, product images, categories, and aspects. Occurrence: Required |
suggestedProduct.additionalImageUrls | array of string | A list of URLs for additional images associated with the suggested product. For the URL of the primary image, see the imageUrl field. Occurrence: Optional |
suggestedProduct.aspects | array of ProductAspect | Contains one or more category aspects and their values that are associated with the suggested product. Occurrence: Optional |
suggestedProduct.aspects.name | string | The name of the product aspect, such as Model Number , Size , or Color . Occurrence: Optional |
suggestedProduct.aspects.values | array of string | Required or returned if a value is provided for the name field. This is a list of one or more localized values of this product aspect. Occurrence: Conditional |
suggestedProduct.brand | string | The manufacturer's brand name for the suggested product. Occurrence: Optional |
suggestedProduct.description | string | A rich description of the suggested product, which can contain HTML, including the following basic tags:
Occurrence: Optional |
suggestedProduct.ean | array of string | A list of all European Article Numbers (EANs) that identify the suggested product. Occurrence: Optional |
suggestedProduct.epid | string | Required or returned only if the value of the changeRequestType field is PRODUCT_UPDATE . This is the eBay product ID of the product record for which an update is being suggested. Occurrence: Conditional |
suggestedProduct.imageUrl | string | Required or returned if the value of the changeRequestType field is PRODUCT_CREATION . This is the URL of the primary image associated with the suggested product. Occurrence: Conditional |
suggestedProduct.isbn | array of string | A list of all International Standard Book Numbers (ISBNs) that identify the suggested product. Occurrence: Optional |
suggestedProduct.mpn | array of string | A list of all Manufacturer Product Number (MPN) values that the manufacturer uses to identify the suggested product. Occurrence: Optional |
suggestedProduct.otherApplicableCategoryIds | array of string | A list of category IDs (other than the value of primaryCategoryId) for all the leaf categories to which the suggested product might belong. Occurrence: Optional |
suggestedProduct.primaryCategoryId | string | The identifier of the category that eBay recommends using to list the suggested product, based on previous listings of similar products. Products in the eBay catalog are not automatically associated with any particular category, but using an inappropriate category can make it difficult for prospective buyers to find the product. For other possible categories that might be used, see otherApplicableCategoryIds. Occurrence: Required |
suggestedProduct.title | string | The catalog title that will be used as the listing title for all item listings based on the suggested product. Occurrence: Required |
suggestedProduct.upc | array of string | A list of all Universal Product Codes (UPCs) that identify the suggested product. Occurrence: Optional |
suggestedProduct.version | string | Required or returned only if the value of changeRequestType is PRODUCT_UPDATE . This is the current version number in the catalog of the product record for which an update is being suggested. Occurrence: Optional |
See HTTP response headers for details.
Header | Meaning |
---|---|
Location | A successful call returns the following location code in the HTTP header: {ENV}/commerce/catalog/v1_beta/change_request/{REQUESTID} The ENV string is the HTTPS path to the same eBay supported environment in which this call was issued. The REQUESTID parameter identifies the newly created change request. Use this getChangeRequest URI to retrieve the contents of the new change request. |
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
202 | Accepted |
400 | Bad Request |
403 | Forbidden |
500 | Internal Server Error |
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
75000 | API_CATALOG | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
75007 | API_CATALOG | REQUEST | Currently, the {marketplaceId} marketplace is not supported. The supported Marketplaces are: {allowedMarketplaces} . |
75008 | API_CATALOG | REQUEST | Primary Category Id {primaryCategoryId} should not be repeated in Other Applicable Category Ids. For more information, see the API call reference documentation. |
75015 | API_CATALOG | REQUEST | Insufficient permissions to fulfill the request. |
75152 | API_CATALOG | REQUEST | The field {fieldName} is invalid. For more information, see the API call reference documentation. |
75153 | API_CATALOG | REQUEST | The field {fieldName} is missing. For more information, see the API call reference documentation. |
75154 | API_CATALOG | REQUEST | The field {fieldName} is not required for product creation. For more information, see the API call reference documentation. |
75155 | API_CATALOG | REQUEST | Aspect values are missing. For more information, see the API call reference documentation. |
75156 | API_CATALOG | REQUEST | Length of 'reasonForChangeRequest' should not exceed 250 characters. |
75157 | API_CATALOG | REQUEST | Change Request is not supported for the product at this moment. |
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
114795376
.
http://api.ebay.com/commerce/catalog/v1_beta/change_request/5ac7a780ca4c591b0c3248fe