catalog APIv1_beta.3.1

CreateChangeRequestPayload

This type contains the input payload of the createChangeRequest call, including the type of request, the reason for a product update request, and the details of the new or updated product being suggested.

Types that use CreateChangeRequestPayload

Not used by any types

Call that uses CreateChangeRequestPayload

Fields

Field
Type
Description
changeRequestType
The type of catalog modification being requested by this change request.

Available values:
  • PRODUCT_CREATION — Change request to create a new product
  • PRODUCT_UPDATE — Change request to update an existing product
reasonForChangeRequest
Required if the value of changeRequestType is PRODUCT_UPDATE, and optional otherwise; this is a text description of why this change is being requested.
referenceId
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.
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:
  • INVENTORY_ITEM — The requested change will support the completion of an inventory item, which you can then use to create an offer.
  • LISTING — The requested change will support the modification of an active product listing.
  • LISTING_DRAFT — The requested change will support the completion of an offer, which you can then publish as a product listing.
suggestedProduct
Contains the full details of the suggested product, including information about the product's identifiers, description, product images, categories, and aspects.