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 file by attribute set Id

Description: Triggers an export job to generate a product creation template file by attribute set ID. The file can be full (contains all visible attributes) or light (contains only flagged attributes) versions. This can be set with the query parameter type with one of two values - full or light (full set by default). The export item ID will be returned here, not the file itself.

You can also get a master product template without specifying an attribute set ID if it is available for your account.

Note:

• The template file is generated asynchronously in the background
• Use the returned exportItemId or uuid to track export status and download the completed file
• Full templates include all visible attributes, while light templates include only flagged attributes
• If no attributeSetId is provided, you'll receive the master product template (if available)

curl -X GET "https://loading/v2/template/product-creation"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "The request parameters are invalid"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/product-removal"

"string"

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/product-removal-async"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/product-category-tree"

"string"

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/product-category-tree-async"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/price-update"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/stock-update"

"string"

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/stock-update-async"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "The request parameters are invalid"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/status-update"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

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

curl -X GET "https://loading/v2/template/image-update"

{
  "exportItemId": 852,
  "uuid": "78838546-777e-47c8-ba09-43d49bb9efa5"
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}

{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}

{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}