Order Templates

Overview

Order templates allow you to generate template files for various order management operations in SellerCenter. These templates provide structured CSV or XLSX files that make it easier to perform bulk operations on orders, including status updates and order item management.

Order Templates Available:

• Pending Order Items: Generate templates for managing pending order items
• Pending Order Numbers: Generate templates for managing pending order numbers
• Order Item Status Update: Generate templates for updating order item statuses
• Order Status Change: Generate templates for changing order statuses with various filters

Most order templates return file content directly, making them immediately available for download and use in bulk operations.

Get Pending Order Items Template

GET /v2/template/pending-order-items

Summary: Get pending order items template

Description: Returns a pending order items template. This endpoint returns the file content directly, providing you with a template for managing pending order items in bulk.

Note:

• The template file is returned directly in the response
• Contains order item information for pending orders
• Use this template to prepare bulk order item operations

curl -X GET "https://loading/v2/template/pending-order-items"

"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 Pending Order Numbers Template

GET /v2/template/pending-order-numbers

Summary: Get pending order numbers template

Description: Returns a pending order numbers template. This endpoint returns the file content directly, providing you with a template for managing pending order numbers in bulk.

Note:

• The template file is returned directly in the response
• Contains order number information for pending orders
• Use this template to prepare bulk order number operations

curl -X GET "https://loading/v2/template/pending-order-numbers"

"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 Order Item Status Update Template

GET /v2/template/order-item-status-update

Summary: Get order item status update template

Description: Returns an order item status template. This endpoint returns the file content directly, providing you with a template for updating order item statuses in bulk.

Note:

• The template file is returned directly in the response
• Contains order item status information
• Use this template to prepare bulk order item status updates

curl -X GET "https://loading/v2/template/order-item-status-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."
}

Get Order Status Change Template

GET /v2/template/order-status-change

Summary: Triggers background action for order status change template generation

Description: Triggers a background action for order status change template generation. This process can take a couple of seconds, but you'll only get the export job ID instantly, not the file itself.

Possible statuses for specific types:

• order-items → pending, shipped (only if bulk status to delivered feature is enabled)
• order-items-by-package → ready-to-ship (only if bulk status to shipped feature is enabled)
• order-numbers → pending, ready-to-ship (only if bulk status to shipped feature is enabled), shipped (only if bulk status to delivered feature is enabled)
• order-items-status → pending

Note:

• The template file is generated asynchronously in the background
• Both type and status parameters are required
• Use the returned exportItemId or uuid to track export status
• Available statuses depend on enabled features and the selected type

curl -X GET "https://loading/v2/template/order-status-change?type=order-items-status&status=ready-to-ship"

{
  "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."
}