---
title: Inventory Mapping
description: "The **Inventory Mapping API** helps sellers create high-quality listings with AI-powered recommendations generated from their existing product data. This API allows sellers and third-party partners to use existing product data to create eBay listing previews, which are then used to create listings through eBay's Listing APIs. Specifically, the API accepts various input types, including item photos, titles, aspects, and product identifiers, and provides users with an AI-powered listing preview that includes recommendations for category, eBay-normalized item aspects, and description. This API exposes the data through GraphQL queries and mutations. This allows you to use only those fields needed or available, and provides a process that creates eBay Listing Previews based on the seller's external product information. #### How to get started Try out the **Inventory Mapping API** using the [GraphQL Explorer](/my/graphql_explorer?index=0). 1. Sign in to your developer account and use this explorer to run test calls to this API in the Production environment (Sandbox is not supported). 2. Include the **mappingReferenceID** field for all listings generated or revised with **Inventory Mapping API** recommendations to quickly diagnose and resolve issues. 3. Share your feedback on recommendations and use cases to help us improve the product. \\* If you need expanded access to support your use cases, you can Apply for an [Application Growth Check](/grow/application-growth-check) to scale your integration. **NOTE:** The **Inventory Mapping API** can be integrated with the **Notification API** to inform sellers when any of their listing preview creation tasks have completed through the LISTING\\_PREVIEW\\_CREATION\\_TASK\\_STATUS topic ID. If you are not familiar with the **Notification API**, see the [Notification API Overview](/api-docs/sell/notification/overview.html). **NOTE:** The **Inventory Mapping API** is currently available only for the U.S. marketplace, and results should only be used solely for listings on the U.S. site. Set the marketplace by including the **X-EBAY-C-MARKETPLACE-ID** header with the value `EBAY_US`. * **eBay Motors** (motor vehicles) and subordinate categories including **Parts & Accessories** are not presently supported. * We'll notify you as soon as coverage expands to additional marketplaces."
api_version: 1.0
api_name: inventory_mapping
api_type: GraphQL
api_group: inventory/mapping
source_url:
  html: https://developer.ebay.com/develop/api/inventory/mapping
  md: https://developer.ebay.com/develop/api/inventory/mapping.md
---

# Inventory Mapping API

The **Inventory Mapping API** helps sellers create high-quality listings with AI-powered recommendations generated from their existing product data. This API allows sellers and third-party partners to use existing product data to create eBay listing previews, which are then used to create listings through eBay's Listing APIs.

  

Specifically, the API accepts various input types, including item photos, titles, aspects, and product identifiers, and provides users with an AI-powered listing preview that includes recommendations for category, eBay-normalized item aspects, and description.

  

This API exposes the data through GraphQL queries and mutations. This allows you to use only those fields needed or available, and provides a process that creates eBay Listing Previews based on the seller's external product information.

#### How to get started

Try out the **Inventory Mapping API** using the [GraphQL Explorer](/my/graphql_explorer?index=0).

1.  Sign in to your developer account and use this explorer to run test calls to this API in the Production environment (Sandbox is not supported).
2.  Include the **mappingReferenceID** field for all listings generated or revised with **Inventory Mapping API** recommendations to quickly diagnose and resolve issues.
3.  Share your feedback on recommendations and use cases to help us improve the product.

\* If you need expanded access to support your use cases, you can Apply for an [Application Growth Check](/grow/application-growth-check) to scale your integration.

  

**NOTE:** The **Inventory Mapping API** can be integrated with the **Notification API** to inform sellers when any of their listing preview creation tasks have completed through the LISTING\_PREVIEW\_CREATION\_TASK\_STATUS topic ID. If you are not familiar with the **Notification API**, see the [Notification API Overview](/api-docs/sell/notification/overview.html).

  

**NOTE:** The **Inventory Mapping API** is currently available only for the U.S. marketplace, and results should only be used solely for listings on the U.S. site. Set the marketplace by including the **X-EBAY-C-MARKETPLACE-ID** header with the value `EBAY_US`.

*   **eBay Motors** (motor vehicles) and subordinate categories including **Parts & Accessories** are not presently supported.
*   We'll notify you as soon as coverage expands to additional marketplaces.

## GraphQL Schema Information

**Queries:** 1
**Mutations:** 1
**Types:** 27

## Queries

### listingPreviewsCreationTaskById

The listingPreviewsCreationTaskById query retrieves a ListingPreviewsCreationTask by ID. The data returned includes the task's status and results, including the listing previews created and any products not processed, unmapped, or invalid. Use this query to check task status or obtain the results of converting a seller's external products into eBay listing previews. You can call this query immediately after submitting the startListingPreviewsCreation mutation to check the task's status. However, if that mutation has not completed, the query may return a null or an incomplete result.

**Returns:** `ListingPreviewsCreationTaskByIdOutput`

**Arguments:**
- **input** (ListingPreviewsCreationTaskByIdInput!)

**OAuth scope**

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):

**Required Scopes:**

**Authorization Code Grant:**

- `https://api.ebay.com/oauth/api_scope/sell.inventory.mapping`

## Mutations

### startListingPreviewsCreation

The \*\*startListingPreviewsCreation\*\* mutation initiates a process that leverages a seller’s provided external product data (maximum 10 products) and uses this data to create an eBay listing preview for each provided product. This asynchronous process can take some time to complete, which is partially dependent on the number of external products being processed. The \*\*startListingPreviewsCreation\*\* mutation includes details of the external products. The output of the mutation will include the status and ID of the task, and may include errors if there are any issues. Once the listing previews task is complete, the mutation response will also include the results of the listing preview. The startListingPreviewsCreation mutation initiates a process that creates eBay Listing Previews from a seller's external products. This process is asynchronous and can take some time to complete. The mutation takes an input that includes details of the external products. The output of the mutation includes the details of the listing previews creation task and any errors that occurred during the process. This mutation is useful for sellers who want to convert their external products into eBay Listing Previews. The field will only be null when there is a server error prior to starting the preview creation process.

**Returns:** `StartListingPreviewsCreationOutput`

**Arguments:**
- **input** (StartListingPreviewsCreationInput!)

**OAuth scope**

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):

**Required Scopes:**

**Authorization Code Grant:**

- `https://api.ebay.com/oauth/api_scope/sell.inventory.mapping`

## Error Codes

The following error codes may be returned by this GraphQL API:

### REQUEST Errors

#### 500000 - API_INVENTORY_MAPPING
**Description:** Marketplace not supported. See documentation for supported marketplaces.

#### 500001 - API_INVENTORY_MAPPING
**Description:** Request cannot be empty. Please provide valid input.

#### 500003 - API_INVENTORY_MAPPING
**Description:** Invalid Task ID. Please provide a valid ID.

#### 500004 - API_INVENTORY_MAPPING
**Description:** Invalid image URL. The URL must start with "https".

#### 500006 - API_INVENTORY_MAPPING
**Description:** The provided URL is invalid or could not be resolved. Please check and provide a valid URL.

#### 500007 - API_INVENTORY_MAPPING
**Description:** Title exceeds maximum allowed length: 250.

#### 500008 - API_INVENTORY_MAPPING
**Description:** Product ID is missing or has an invalid value. Check value and see documentation as necessary.

#### 500009 - API_INVENTORY_MAPPING
**Description:** Product type is missing or has an invalid value. See documentation for the supported GTIN types.

#### 500010 - API_INVENTORY_MAPPING
**Description:** Duplicate image URLs were found under the images array. Please remove duplicates.

#### 500011 - API_INVENTORY_MAPPING
**Description:** You must provide a title or at least one image URL under the images array.

#### 500014 - API_INVENTORY_MAPPING
**Description:** You have exceeded the maximum number of products allowed: 10.

#### 500015 - API_INVENTORY_MAPPING
**Description:** All aspects.name fields must have corresponding values.

#### 500016 - API_INVENTORY_MAPPING
**Description:** All aspectValues arrays must have one or more corresponding values.

#### 500017 - API_INVENTORY_MAPPING
**Description:** One or more duplicate aspect names were provided for the product. Please remove duplicates.

#### 500018 - API_INVENTORY_MAPPING
**Description:** One or more image URLs exceed the maximum length allowed: 250.

#### 500019 - API_INVENTORY_MAPPING
**Description:** You have exceeded the maximum number of aspects allowed: 50.

#### 500020 - API_INVENTORY_MAPPING
**Description:** One or more image aspect names exceed the maximum length allowed: 100.

#### 500021 - API_INVENTORY_MAPPING
**Description:** One or more image aspect values exceed the maximum length allowed: 100.

#### 500022 - API_INVENTORY_MAPPING
**Description:** You have exceeded the maximum number of images allowed: 24.

#### 500023 - API_INVENTORY_MAPPING
**Description:** One or more identical products found. Please check and revise or remove duplicates and try again.

### APPLICATION Errors

#### 500002 - API_INVENTORY_MAPPING
**Description:** Internal system error. Please try again later.

## Types

### ListingPreviewsCreationTaskByIdOutput
**Description:** The base type of the \*\*listingPreviewsCreationTaskById\*\* query response. A successful query will return the \*\*id\*\* value for the task, and the listing preview results cannot be returned until the task is complete.
**Type:** GraphQLObjectType

**Properties:**
- **listingPreviewsCreationTask** (ListingPreviewsCreationTask)
  - If a \*\*ListingPreviewsCreationTask\*\* corresponding to the \*\*requestId\*\* value exists, it will be returned here. If no task with the \*\*requestId\*\* exists, this field will be null.
- **requestedId** (ID!)
  - The unique identifier of the listing preview task that was passed into the query request. \*\*Max length\*\* 25 characters

### ListingPreviewsCreationTask
**Description:** This type shows the ID and the results of a listing previews task that was generated with the mutation request. This asynchronous task can take some time to complete. The listing preview results cannot be returned until the task is complete.
**Type:** GraphQLObjectType

**Properties:**
- **id** (ID!)
  - The unique identifier of the task. It is returned after a successful \*\*StartListingPreviewsCreation\*\* mutation. \*\*Max length\*\*: 25
- **result** (ListingPreviewsCreationTaskResult)
  - This container provides the status and results of the listing previews creation Task. It remains null until the task has completed execution.

### ListingPreviewsCreationTaskResult
**Description:** This type is used to show the final outcome of a listing previews creation task, and includes the completion status and the actual eBay listing previews. If applicable, unprocessed external products, unmapped external products, and invalid external products are displayed in separate arrays.
**Type:** GraphQLObjectType

**Properties:**
- **completionStatus** (ListingPreviewsCreationTaskCompletionStatus!)
  - This enumeration value indicates the success or failure of the \*\*StartListingPreviewsCreation\*\* mutation. Applicable values are \`COMPLETED\`, \`COMPLETED\_WITH\_ERROR\`, or \`FAILED\`
- **invalidProducts** ([InvalidExternalProductDetails!]!)
  - An array of invalid external products that could not be processed. Each invalid product will include a \*\*description\*\* field that indicates why the external product details could not be used to create a listing preview. This field is intended to be a debugging aid for humans. The description is not localized and is subject to change. Do not use this description field for client-side handling logic. This array will be empty if there are no invalid products.
- **listingPreviews** ([ListingPreview!]!)
  - This array will show the eBay listing previews that were successfully created based on the seller's provided external products. Each listing preview will contain the eBay product ID (if found), the title, the product description, the eBay category ID, one or more eBay Picture Service (ePS) image URLs, product aspect name-value pairs, and SKU (if provided). Additionally, this container will also have the \*\*clientProvidedProductDetails\*\* container that shows the client-provided details for the external products.
- **unmappedProducts** ([ExternalProductDetails!]!)
  - An array of valid external products that were not successfully mapped by eBay into listing previews. These products should not be retried by the client. This array will be empty if there are no unmapped products.
- **unprocessedProducts** ([ExternalProductDetails!]!)
  - An array of external products that were not processed due to unforeseen circumstances. All of the details provided for each external product in the mutation request are returned under this array. Unprocessed external products can be included in a subsequent mutation request. This array will not be returned or will be null if there are no unprocessed products.

### InvalidExternalProductDetails
**Description:** This type provides details of an external product that could not be used to create an eBay listing preview. Each invalid product includes a \*\*description\*\* field that explains why the external product details were unsuitable for creating a listing preview. The description is not localized and may change over time. This field is intended as a debugging aid for humans—-do not use \*\*description\*\* for client-side handling logic.
**Type:** GraphQLObjectType

**Properties:**
- **clientProvidedProductDetails** (ExternalProductDetails!)
  - The external product details originally provided through the mutation request.
- **description** (String!)
  - A human-readable description of why the external product details could not be used to create an eBay listing preview. This field is intended as a debugging aid for humans--do not use description for client-side handling logic.

### ExternalProductDetails
**Description:** This type represents the specifics of a single external product. These details are used to create eBay Listing Previews.
**Type:** GraphQLObjectType

**Properties:**
- **aspects** ([ExternalProductDetailsAspect!])
  - An array of product aspect name-value pairs for an external product.
- **category** (String)
  - The full path to the listing category of the external product, such as \`/Electronics/Cell Phones & Accessories/Smart Watches\` This field will be returned as null if not provided for an external product.
- **externalProductIdentifier** (ExternalProductIdentifier)
  - This container shows the Global Trade Identifier Number (GTIN) for an external product. This container will be returned as null if not provided for an external product.
- **images** ([HttpOrHttpsUrl!])
  - An array of URLs pointing to images of the product.
- **sku** (String)
  - Represents the seller-defined Stock Keeping Unit (SKU) of the external product. If the SKU was not provided for an external product, this field returns null.
- **title** (String)
  - The title of the external product. This field will be returned as null if not provided for an external product.

### ExternalProductDetailsAspect
**Description:** This type is used to represent a specific feature or aspect of an external product. Each aspect is defined by a name and a list of one or more values.
**Type:** GraphQLObjectType

**Properties:**
- **name** (String!)
  - The name of the aspect for the external product.
- **values** ([String!]!)
  - A list of one or more corresponding values for the aspect.

### ExternalProductIdentifier
**Description:** This type is used to show the Global Trade Identifier Number (GTIN) for an external product.
**Type:** GraphQLObjectType

**Properties:**
- **productId** (String!)
  - The GTIN value of the external product, corresponding to the GTIN type specified in the \*\*productType\*\* field. This field will be returned as null if a GTIN was not provided for the external product.
- **productType** (ExternalProductIdentifierEnum!)
  - The GTIN type of the external product. \`UPC\`, \`ISBN\`, and \`EAN\` are the supported values. This field will be returned as null if a GTIN was not provided for the external product.

### ListingPreview
**Description:** This type shows the listing previews, and the external product details used to generate each of the listing previews. A listing preview provides recommended details for key fields to be used in an eBay listing, such as eBay product ID (if found), the title, the product description, the eBay category ID, one or more eBay Picture Service (ePS) image URLs, product aspect name-value pairs, and SKU (if provided). A listing preview is neither a draft nor a live listing, but rather information generated from external product details that sellers can leverage when creating a listing in a subsequent step using eBay listing APIs.
**Type:** GraphQLObjectType

**Properties:**
- **aspects** ([ListingPreviewProductAspect!])
  - eBay's recommended product aspect name-value pairs for the product, or if an eBay catalog product was found, the product aspect name-value pairs associated with the catalog product.
- **category** (Category)
  - eBay's recommended eBay leaf category in which to list the product, or if an eBay catalog product was found, the eBay leaf category associated with the catalog product. A null value signifies that the data is unavailable or undefined under certain exceptional conditions.
- **clientProvidedProductDetails** (ExternalProductDetails!)
  - This container shows the provided details of the external product that was mapped to an eBay listing preview.
- **description** (String)
  - eBay's recommendation for the description of the product, or if an eBay catalog product was found, the description used for the catalog product. A null value signifies that the data is unavailable or undefined under certain exceptional conditions.
- **images** ([HttpOrHttpsUrl!])
  - An array of one or more EPS image URLs that can be used with the listing. If images were provided through the \*\*images\*\* array in the mutation request, eBay returns the corresponding EPS image URLs. Additionally, if an eBay catalog product was matched for the external product, the field may also include the catalog product's stock photo URL(s). If no images are available, the array will be null.
- **mappingReferenceId** (String!)
  - The unique identifier of this listing preview. Use this 25-character ID when creating or revising a listing based on the listing preview via related APIs. \*\*Maximum length:\*\* 25 characters
- **product** (Product)
  - The eBay product ID (ePID) field under this container shows the eBay catalog product that the external product was matched to. An ePID value can be used in eBay listing APIs to prefill a listing with product title, product description, product aspects, stock photo(s), and eBay category. If the external product could not be mapped to an ePID, this field will be null.
- **sku** (String)
  - The seller-defined SKU of the external product. If the SKU was not provided for an external product, this field returns null.
- **title** (String)
  - eBay's recommendation for the title of the product, or if an eBay catalog product was found, the title used for the catalog product. eBay listings only allow 80 characters for a listing title, so this recommended title may be shorter than the title provided for the external product. A null value signifies that the data is unavailable or undefined under certain exceptional conditions.

### ListingPreviewProductAspect
**Description:** This type shows eBay's recommended product aspect name-value pairs for the product. Each aspect is defined by a name and a list of one or more values. The value in the \*\*values.confidence\*\* field will indicate how confident eBay is about that value being the right value for that corresponding aspect. \*\*Edge cases to consider\*\* While most aspects are expected to have a single value associated with it, some aspects may accept multiple values. Please cross-reference aspect properties for any given category through the \*\*Taxonomy APIs\*\*. For such aspects, multiple \`PREFILL\` values may be returned when available. For example, an aspect could be \`Color\` with values like \`Red\`, \`Blue\`, and \`Green\` and confidence levels \`PREFILL\` or \`HINT\`.
**Type:** GraphQLObjectType

**Properties:**
- **aspectValues** ([String!]!)
  - An array of one or more values for the aspect.
- **name** (String!)
  - The name of the aspect.
- **values** ([ListingPreviewProductAspectValue!]!)
  - An array that has one or more values for the corresponding aspect, and a \*\*confidence\*\* field that indicate how confident eBay is about indicate how confident eBay is about that value being the right value for that corresponding aspect

### ListingPreviewProductAspectValue
**Description:** This type shows the corresponding value(s) for an aspect and the confidence level that eBay has that a value is the right value for that aspect.
**Type:** GraphQLObjectType

**Properties:**
- **confidence** (ListingPreviewProductAspectValueConfidenceEnum)
  - The confidence level of the aspect value. See the \*\*ListingPreviewProductAspectValueConfidenceEnum\*\* type for descriptions of each supported value. This field will only be null under exceptional circumstances.
- **value** (String)
  - The value of the aspect. This field will only be null under exceptional circumstances.

### Category
**Description:** This type defines information about a specific category within the marketplace, including identifiers and hierarchical structure.
**Type:** GraphQLObjectType

**Properties:**
- **id** (ID!)
  - Category Id

### Product
**Description:** This type defines the details of a specific catalog product such as its title, identifier, product aspects, recommended category, and links to images of the product.
**Type:** GraphQLObjectType

**Properties:**
- **epid** (Epid)
  - The unique identifier of an eBay catalog product. An ePID value can be used in eBay listing APIs to prefill a listing with product title, product description, product aspects, stock photo(s), and eBay category.
- **id** (ID!)
  - The unique identifier of an eBay catalog product. An ePID value can be used in eBay listing APIs to prefill a listing with product title, product description, product aspects, stock photo(s), and eBay category.

### ListingPreviewsCreationTaskByIdInput
**Description:** The base type of the \*\*listingPreviewsCreationTaskById\*\* query request, where the \*\*id\*\* value for a listing preview task is passed in.
**Type:** GraphQLInputObjectType

**Properties:**
- **id** (ID!)
  - The unique identifier of the listing preview task to retrieve. This \*\*id\*\* value is returned in the \*\*StartListingPreviewsCreation\*\* mutation response. \*\*Max length\*\*: 25 characters

### StartListingPreviewsCreationOutput
**Description:** The base type of the \*\*startListingPreviewsCreation\*\* mutation response. A successful mutation will return the \*\*id\*\* value for the task, and the listing preview results cannot be returned until the task is complete.
**Type:** GraphQLObjectType

**Properties:**
- **errors** ([StartListingPreviewsCreationError!])
  - An array of one or more errors that may have been triggered with the mutation request. This field will be returned as null if there are no errors.
- **listingPreviewsCreationTask** (ListingPreviewsCreationTask)
  - This base response container should be returned with a successful mutation, but the listing preview results cannot be returned until the task is complete.

### StartListingPreviewsCreationError
**Description:** This type is used to show any errors that occurred during the execution of a mutation or query.
**Type:** GraphQLObjectType

**Properties:**
- **errorDescription** (String!)
  - A description of an error that occurred while executing a mutation or query. This field is intended to be a debugging aid for humans. The description is not localized and is subject to change. Do not use these error descriptions for client-side error handling logic.

### StartListingPreviewsCreationInput
**Description:** This is the base type for the \*\*startListingPreviewsCreation\*\* mutation. It contains an array of \*\*externalProducts\*\* that need to be converted into eBay listing previews.
**Type:** GraphQLInputObjectType

**Properties:**
- **externalProducts** ([ExternalProductDetailsInput!])
  - This array is used to provide details of external products. Product details include title, images, product identifiers, product aspects, category name, and SKU value. In order to successfully identify an external product, at least one of the following three fields must be used: \* title \* image \* product id only (UPC, ISBN, or EAN) Include as many fields as possible to increase chances of creating higher-quality eBay listing previews. For example, including title, images, category name, and aspects is better than just including title and images. A SKU is optional, but it is highly recommended as it acts as a key to track/identify different external products.

### ExternalProductDetailsInput
**Description:** This type is used to provide details of external products. Product details include title, images, product identifiers, product aspects, category name, and SKU value. If product aspects are provided, a category name must also be provided or a listing preview cannot be generated for that external product. A SKU is optional, but it is highly recommended as it acts as a key to track/identify different external products. Include as many fields as possible to increase chances of creating higher-quality eBay listing previews.
**Type:** GraphQLInputObjectType

**Properties:**
- **aspects** ([ExternalProductDetailsAspectInput!])
  - An array of product aspect name-value pairs for the external product. If the array is included, it is required that it contain no null entries. Some aspects will only have one value and other aspects will have multiple values. \*\*Example\*\* \`\[{"name":"Color","values":\["Black","Red"\]},{"name":"Storage Capacity","values":\["64GB"\]}\]\`
- **categoryName** (String)
  - The listing category of the external product. A simple category name can be supplied here such as "Smart Watches", or you can provide the path to the category, such as /Electronics/Cell Phones & Accessories/Smart Watches.\`
- **externalProductIdentifierInput** (ExternalProductIdentifierInput)
  - This container is used to provide a Global Trade Identifier Number (GTIN) for an external product. If a GTIN value is provided for an external product, no other data under \*\*externalProductDetails\*\* shall be provided.
- **images** ([HttpOrHttpsUrl!])
  - An array of image URLs provided for the external product. Each provided image must be a valid URL that uses 'https'. If the array is included, it is required that it contain no null entries. \*\*Max images\*\*: 24
- **sku** (String)
  - The SKU (Stock Keeping Unit) of the external product. This value is a seller-defined identifier for the product. This is an optional field, but it is highly recommended as it acts as a key to track/identify different external products.
- **title** (String)
  - The title of the external product. The title field should not contain HTML or JavaScript code. Any HTML characters will be treated as plain text. The title should be a string of characters, with support for all characters in the Unicode character set. An example of a title is \*\*\`Apple iPhone 11 Pro Max\`\*\*. \*\*Max length:\*\* 250 characters

### ExternalProductDetailsAspectInput
**Description:** This type is used to specify product aspect name-value pairs of an external product. Each aspect is defined by a name and a list of one or more values. The maximum number of aspects allowed is 50.
**Type:** GraphQLInputObjectType

**Properties:**
- **name** (String!)
  - The name of the aspect for the external product. \*\*Max length\*\*: 100 characters
- **values** ([String!]!)
  - An array of one or more corresponding values for the aspect. \*\*Max length\*\*: 100 characters

### ExternalProductIdentifierInput
**Description:** This type is used to provide a Global Trade Identifier Number (GTIN) for an external product.
**Type:** GraphQLInputObjectType

**Properties:**
- **productId** (String!)
  - The GTIN value of the external product, corresponding to the GTIN type specified in the \*\*productType\*\* field. The pattern of characters in this field should match the \*\*productId\*\* type.
- **productType** (ExternalProductIdentifierEnum!)
  - The GTIN type of the external product. \`UPC\`, \`ISBN\`, and \`EAN\` are the supported values and one of these should be specified in this field.

### ListingPreviewsCreationTaskCompletionStatus
**Description:** This type is used to describe the outcome of a listing preview creation task. | - **COMPLETED**: This enumeration value indicates that the task has completed successfully with no errors. - **COMPLETED_WITH_ERROR**: This enumeration value indicates that the task has completed successfully, but with one or more errors. Issues that would lead to this status include one or more products being invalid and/or unmapped. The task may have still completed successfully for other products. - **FAILED**: This enumeration value indicates that the task was not completed successfully, and no listing previews were generated for any of the external products.
**Type:** string

### ExternalProductIdentifierEnum
**Description:** An enumerated type defining values for different external product types. | - **EAN**: A European Article Number (EAN) is a unique 8 or 13-digit identifier code that identifies products worldwide. The EAN values are typically used across Europe. - **ISBN**: An International Standard Book Number (ISBN) is a unique numeric commercial book identifier. Both 10 and 13-character ISBNs are supported. - **MPN**: Manufacturer Part Number (MPN) values are currently not supported, so please don't specify this value in the \*\*productType\*\* field. - **UPC**: A Universal Product Code (UPC) is a unique numerical identifier for commercial products. UPC values are typically used in the US and Canada.
**Type:** string

### ListingPreviewProductAspectValueConfidenceEnum
**Description:** An enumerated type that represents the confidence level that eBay has that a recommended product aspect value is the correct one. | - **HINT**: This value indicates a medium to high confidence threshold for the suggested aspect value, making sellers more likely to select one of the recommended or hinted values from a set. - **PREFILL**: This value indicates a high confidence threshold for the suggested aspect value, meaning sellers are more likely to select this prefilled value over other options, when this aspect value is prefilled.
**Type:** string

### HttpOrHttpsUrl
**Description:** A scalar representing a valid HTTP or HTTPS URL string value.
**Type:** scalar

### Epid
**Description:** This type represents the eBay Product ID (e.g. ePID), which is the unique identifier of an eBay catalog product.
**Type:** scalar

## Rate Limits

See [API Call Limits](https://developer.ebay.com/develop/get-started/api-call-limits) on the eBay Developer Program.

## Resources

### Documentation

- [eBay Developer Program](https://developer.ebay.com/)
- [API Documentation](https://developer.ebay.com/develop/api/)
- [SDKs and Widgets](https://developer.ebay.com/develop/sdks-and-widgets)
- [Developer Community Forum](https://community.ebay.com/t5/Developer-Groups/ct-p/developergroup)

### Tools

- [API Explorer](https://developer.ebay.com/my/api_test_tool)
- [GraphQL Explorer](https://developer.ebay.com/my/graphql_explorer)

### Support

- [Developer Support](https://developer.ebay.com/support/)
- [API Status](https://developer.ebay.com/support/api-status)
- [Release Notes](https://developer.ebay.com/develop/api/release_notes/)

---
*Generated on 2026-04-02T22:51:19.123Z*