Product Templates

Overview

Product templates allow you to generate template files for various product management operations in SellerCenter. These templates provide structured CSV or XLSX files that make it easier to perform bulk operations on products, including creation, removal, updates, and category management.

Product Templates Available:

• Product Creation: Generate templates for creating new products with attribute sets
• Product Removal: Generate templates for bulk product removal operations
• Category Tree: Generate templates showing the complete product category hierarchy
• Price Updates: Generate templates for bulk price updates
• Stock Updates: Generate templates for bulk stock/inventory updates
• Status Updates: Generate templates for bulk product status updates
• Image Updates: Generate templates for bulk product image updates

Template generation can be either synchronous (returns file content directly) or asynchronous (returns export job information for background processing). Asynchronous templates are recommended for large product catalogs as they prevent timeout issues.

Get Product Creation Template

GET /v2/template/product-creation

Summary: Get product creation template export job

Description: Triggers an export job to generate a product creation template file (XLSX). The response returns an exportItemId and uuid; the file is produced asynchronously in the background.

Use query parameter type to choose full (all visible attributes, default) or light (flagged attributes only).

Template modes (query parameters):

Validation:

• Unknown attributeSetId or non-numeric id → 400 Bad Request
• Non-numeric categoryId → 400 Bad Request
• Master template without the seller feature enabled → 400 Bad Request
• Omitted or empty attributeSetId / categoryId are treated as not provided; numeric ids (including 0) are validated like any other integer
• categoryId without attributeSetId is accepted but ignored — treated as a master template request; categoryId does not change content or filename in that case

Export filenames (generated file includes type suffix _Full or _Light):

• Master: ProductCreationTemplate_Master_*
• Attribute set: ProductCreationTemplate_{AttributeSetLabel}_*
• Category: ProductCreationTemplate_{CategoryName}_*

Note:

• Use the returned exportItemId or uuid to track export status and download the completed file
• categoryId is optional; it is not required when downloading an attribute-set template
• categoryId does not change template content — it is used only to name the export file (mapped category name) when attributeSetId is also provided. Template columns and attributes are determined by attributeSetId (and type).

Get Product Removal Template

GET /v2/template/product-removal

Summary: Get product removal template file

Description: Returns a product removal template file. This endpoint returns the file content directly, allowing you to download the template immediately for bulk product removal operations.

Note:

• The template file is returned directly in the response
• Use this template to prepare bulk product removal operations
• The file format is typically CSV or XLSX

Get Product Removal Template Async

GET /v2/template/product-removal-async

Summary: Get product removal template file (asynchronous)

Description: Returns an export job ID for a product removal template file process. The file is generated asynchronously in the background, making this endpoint suitable for large product catalogs.

Note:

• The template file is generated asynchronously in the background
• Use the returned exportItemId or uuid to track export status
• Recommended for large product catalogs to avoid timeout issues

Get Product Category Tree Template

GET /v2/template/product-category-tree

Summary: Get product category tree template file

Description: Returns a product category tree template file. This endpoint returns the file content directly, providing you with the complete category hierarchy structure for reference or bulk operations.

Note:

• The template file is returned directly in the response
• Contains the complete category tree structure
• Useful for understanding category relationships and preparing bulk category assignments

Get Product Category Tree Template Async

GET /v2/template/product-category-tree-async

Summary: Get product category tree template file in an asynchronous way

Description: Use this endpoint to start a background job for category tree template generation. The export item ID will be returned here, not the file itself. This is recommended for large category trees.

Note:

• The template file is generated asynchronously in the background
• Use the returned exportItemId or uuid to track export status
• Recommended for large category trees to avoid timeout issues

Generate Price Update Template

GET /v2/template/price-update

Summary: Generate price update template file

Description: Returns an export job ID for a price update template file. The template includes product pricing information that can be updated in bulk. Returns export item ID, not the file itself.

Note:

• The template file is generated asynchronously in the background
• Use the onlyActive parameter to filter for active products only
• Use the returned exportItemId or uuid to track export status
• The template includes all necessary fields for bulk price updates

Generate Stock Update Template

GET /v2/template/stock-update

Summary: Get update stock template file

Description: Returns a stock update template file. This endpoint returns the file content directly, allowing you to download the template immediately for bulk stock updates.

Note:

• The template file is returned directly in the response
• Use the onlyActive parameter to filter for active products only
• Use this template to prepare bulk stock update operations

Generate Stock Update Template Async

GET /v2/template/stock-update-async

Summary: Get update stock template file (asynchronous)

Description: Returns an export job ID for a stock update template file process. The file is generated asynchronously in the background, making this endpoint suitable for large product catalogs.

Note:

• The template file is generated asynchronously in the background
• Use the onlyActive parameter to filter for active products only
• Use the returned exportItemId or uuid to track export status
• Recommended for large product catalogs to avoid timeout issues

Generate Status Update Template

GET /v2/template/status-update

Summary: Generate status update template file

Description: Returns an export job ID for a status update template file. The template includes product status information that can be updated in bulk. Returns export item ID, not the file itself.

Note:

• The template file is generated asynchronously in the background
• Use the onlyActive parameter to filter for active products only
• Use the returned exportItemId or uuid to track export status
• The template includes all necessary fields for bulk status updates

Create Images Update Template

GET /v2/template/image-update

Summary: Creates images update template file

Description: Returns an export job ID for an images update template file process. The template includes product image information that can be updated in bulk.

Note:

• The template file is generated asynchronously in the background
• Use the format parameter to specify CSV or XLSX format (default: CSV)
• Use the returned exportItemId or uuid to track export status
• The template includes all necessary fields for bulk image updates