To further enhance their listings and make them more enticing to buyers, sellers can associate videos with their listings.

Note: Multiple-variation listings do not support videos.

For additional information about associating videos with listings, refer to:

Requirements

Refer to Video Format Requirements for important information about supported video formats, file size, resolution, and other requirements when associating video files with listings.

Associate a video with a listing

Using methods from the Media API combined with the Add/Revise/Relist families of calls from the Trading API, videos can easily be associated with listing.

To associate a video with a listing:

  • Create the video resource

    A video resource is created by calling the createVideo method of the Media API.

    Note: A video resource is not a video file (i.e., MP4 file types.) In this context, video resource refers to a construct used by the Media API to reference video files.

    When a video resource has been successfully created, this method returns the HTTP Status Code 201 Created as well as the video ID for the newly created resource within the location response header. Be sure to take note of the video ID as it will be required to upload the video file.

  • Upload the video (MP4 file type)

    To upload the desired video file, call the uploadVideo method and pass in/include the video ID as part of the URI {video_id}. This will associate the uploaded video file with the video resource/video ID.

  • Associate the video with a listing

    Once a video has been created/uploaded using the Media API, it can be associated with listings using the Add/Revise/Relist calls of the Trading API.

    Note: Although a video can be attached to a listing before it is in the LIVE state, the video will not be available for viewing in a listing until it is in the LIVE state. The getVideo method of the Media API can be used to retrieve the status of the video. The status is shown in the status response field.

    The Video ID for the desired video is passed in via the Item.VideoDetails.VideoID field.

    For example:

    <Item>
      ...
      <VideoDetails>
        <VideoID>f******************************a</VideoID>
      </VideoDetails>
      ...
    </Item>
               

    Provided the Item.VideoDetails.VideoID value is valid and belongs to the seller, the video should be successfully attached to the listing

    Issue a GetItem call to verify the video was added to the listing. If the video was successfully added, the same Item.VideoDetails.VideoID value will be returned in the response.

    Note: Item.VideoDetails.VideoID will be returned only if the seller of the listing is issuing the GetItem call.

Replace a video

To replace a video already attached to a listing, issue a ReviseItem or ReviseFixedPriceItem call. Pass in the Item.VideoDetails.VideoID value for the new video. The specified video will replace the existing video.

For example

<Item>
  ...
  <VideoDetails>
    <VideoID>h******************************t</VideoID>
  </VideoDetails>
  ...
</Item>

Issue a GetItem call to verify the original video has been replaced. Verify that the Item.VideoDetails.VideoID value returned in the response matches that of the desired replacement video.

Remove a video

To remove a video from a listing, issue a ReviseItem, ReviseFixedPriceItem, RelistItem, or RelistFixedPriceItem call. Set the value of DeletedField to be the string Item.VideoDetails.VideoID.

For example:

<?xml version="1.0" encoding="utf-8"?>
<RelistItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  ...
  <DeletedField>
    Item.VideoDetails.VideoID
  </DeletedField>
  ...
</RelistItemRequest>

If the call is successful, the video will be removed from the listing.

To determine if the video has been successfully removed from the listing, issue a GetItem call. If the video was successfully removed, Item.VideoDetails.VideoID will not be returned in the response.