### Making an API Request with an Authentication Token Source: https://business.aliexpress.ru/docs/api-token This example demonstrates how to use `curl` to make a GET request to the AliExpress API, including the necessary `x-auth-token` header. ```bash curl --location --request GET 'https://openapi.aliexpress.ru/api/v1/method-group/method' \ --header 'x-auth-token: token' ``` -------------------------------- ### Get Account Currency Response Example Source: https://business.aliexpress.ru/docs/get-currency This is an example of a successful response from the get-currency API endpoint, indicating the currency used for product pricing. ```json {"data":{"currency":"USD"}} ``` -------------------------------- ### Get Shipping Templates Response Example Source: https://business.aliexpress.ru/docs/local-get-shipping-templates This is an example of a successful response when retrieving shipping templates. It includes a list of templates, each with its ID, name, and the number of products associated with it. ```json { "data": { "templates": [ { "template_id": 24117182098, "template_name": "FBS. Пункт приёма Почта России 7", "products": 20 }, { "template_id": 24118936360, "template_name": "Шаблон FBS. Пункт приёма Cainiao 1", "products": 1000 } ] } } ``` -------------------------------- ### Example Response for Get Handover List Source: https://business.aliexpress.ru/docs/local-handover-list Illustrates a potential error response when retrieving a handover list, indicating an issue like 'DifferentOwner'. ```json { "error": { "code": "DifferentOwner", "message": "Отправления принадлежат другому продавцу", "details": null }, "data": null } ``` -------------------------------- ### Get Size Chart Templates Response Example Source: https://business.aliexpress.ru/docs/local-get-size-templates This is an example of a successful response from the API, containing a list of size chart templates for the requested category. Each template includes an ID, type, and name. ```json { "data": [ { "id": "1000001518517659", "type": "general", "name": "123123" } ] } ``` -------------------------------- ### Example Response for Order Status Source: https://business.aliexpress.ru/docs/change-status This is an example of a successful response when retrieving order information, including created orders and any marking errors. ```json { "data": { "created_orders": [ { "id": 1124235, "created_at": "2023-03-21T15:17:00.209293Z", "trade_order_id": 2303211998658251, "external_provider": 60, "lines": [ { "sku_id": 12000030050065440, "product_source_id": 0, "quantity": 3 } ] } ], "marking_errors": null }, "error": null } ``` -------------------------------- ### Example Response for Search Brand Source: https://business.aliexpress.ru/docs/brand This is an example response from the brand search API, listing found brands and whether approval is required. ```json { "data": [ { "id": "200746885", "name": "Adidas", "requiredApproval": true }, { "id": "6112724", "name": "Adidas.", "requiredApproval": false }, { "id": "201459775", "name": "adidas neo", "requiredApproval": false }, { "id": "877258650", "name": "ADIDAS TERREX", "requiredApproval": false }, { "id": "203594417", "name": "hkadidasty", "requiredApproval": false }, { "id": "204764116", "name": "adldas", "requiredApproval": false }, { "id": "203390135", "name": "ADIDAS ORIGINALS", "requiredApproval": false } ] } ``` -------------------------------- ### Example Response for Remove Orders Source: https://business.aliexpress.ru/docs/local-handover-list Shows an example error response for removing orders, such as 'SellerMismatch', indicating an issue with the provided seller information. ```json { "error": { "code": "SellerMismatch", "message": "Некорректный продавец.", "details": null }, "data": null } ``` -------------------------------- ### Example Response for Adding Brand Source: https://business.aliexpress.ru/docs/brand This is a sample response indicating that an existing brand has been successfully added to the user's list. ```json { "data": true } ``` -------------------------------- ### Example Response for Brand Search Source: https://business.aliexpress.ru/docs/brand This is an example of a successful response when searching for brands on AliExpress. ```json { "data": { "total": "33", "fullTotal": "33", "list": [ { "id": "310368382", "name": "ALL INCLUSIVE", "createdAt": "2022-06-20T08:39:17+00:00", "status": "approved" }, { "id": "203730195", "name": "Alvin D'or", "createdAt": "2022-06-20T08:39:39+00:00", "status": "approved" } ], "offset": "0", "limit": "2", "filters": { "dateFrom": "", "dateTo": "", "status": [], "name": "" }, "sort": { "by": "name", "dir": "asc" } } } ``` -------------------------------- ### Get Product Currency Source: https://business.aliexpress.ru/docs/category/open-api Retrieve the currency information for products. ```APIDOC ## Get Product Currency ### Description This endpoint retrieves the currency information relevant to product pricing and transactions on AliExpress. ### Method GET ### Endpoint /api/v1/currency ### Response #### Success Response (200) - **currency_code** (string) - The default currency code (e.g., 'USD', 'EUR'). - **currency_symbol** (string) - The symbol for the currency (e.g., '$', '€'). #### Response Example ```json { "currency_code": "USD", "currency_symbol": "$" } ``` ``` -------------------------------- ### Get Size Charts Source: https://business.aliexpress.ru/docs/category/open-api Retrieve available size charts for different product categories. ```APIDOC ## Get Size Charts ### Description This endpoint allows you to retrieve size charts, which are essential for clothing and apparel items. You can get size charts based on category or specific product attributes. ### Method GET ### Endpoint /api/v1/size_charts ### Parameters #### Query Parameters - **category_id** (integer) - Optional - Filter size charts by category ID. ### Response #### Success Response (200) - **size_charts** (array of objects) - A list of available size charts, each containing: - **chart_id** (integer) - The unique identifier for the size chart. - **category_id** (integer) - The category this chart applies to. - **chart_data** (object) - The actual size chart data (e.g., measurements for S, M, L). #### Response Example ```json { "size_charts": [ { "chart_id": 201, "category_id": 50, "chart_data": { "S": {"waist": 28, "hip": 34}, "M": {"waist": 30, "hip": 36} } } ] } ``` ``` -------------------------------- ### Example Get Orders List API Response Source: https://business.aliexpress.ru/docs/local-get-orders-list This JSON object represents a typical response from the Get Orders List API, showing a single cancelled order with all its associated details. ```json { "data": { "total_count": 2, "orders": [ { "id": 2306015647909084, "created_at": "2023-06-01T09:51:21.121866+00:00", "paid_at": "2023-06-01T09:51:42.757637+00:00", "updated_at": "2024-02-10T12:38:58.130552+00:00", "status": "Cancelled", "payment_status": "Cancelled", "delivery_status": "Cancelled", "delivery_address": "Россия, Свердловская обл, Екатеринбург г, Сулимова 30, кв. 50, 620137", "original_delivery_address": "", "delivery_info": { "country": "Россия", "region": "Свердловская обл", "city": "Екатеринбург г", "street_house": "Сулимова 30, кв. 50", "index": "620137", "receiver": { "name": "Тестович Тестов Тесиньо", "phone": "+79221014498" } }, "antifraud_status": "Passed", "buyer_country_code": "RU", "buyer_name": "Тестович Тестов Тесиньо", "order_display_status": "Close", "buyer_phone": "+79221014498", "order_lines": [ { "id": 2306015064072327, "item_id": "1005005218767869", "sku_id": "12000032229651507", "product_source_id": 0, "name": "Тестовые кроссовки", "item_price": 100, "currency": "RUB", "quantity": 1.0, "total_amount": 100, "properties_map": {}, "height": 10.0, "weight": 3300.0, "width": 10.0, "length": 10.0, "issue_status": "NoDispute", "promotions": [], "logistic_storage_type": "Fbs" } ], "total_amount": 100, "finish_reason": "ShippingTimeout", "fully_prepared": false, "cut_off_date": "2023-06-03T09:51:20.757+00:00", "pre_split_postings": [ { "id": 2306013785932582, "delivery_fee": 0, "first_mile_type": "Dropoff", "logistic_method": "OTHER_NEW_CITY_RUB", "logistics_type": "DBS", "posting_lines": [ { "id": 4149250, "order_line_id": 2306015064072327, "item_id": "1005005218767869", "sku_id": "12000032229651507", "product_source_id": 0, "quantity": 1.0, "height": 10.0, "weight": 3300.0, "width": 10.0, "length": 10.0, "name": "Тестовые кроссовки", "item_price": 100, "properties_map": {} } ] } ], "logistic_orders": [] } ] } } ``` -------------------------------- ### Get Product Information Source: https://business.aliexpress.ru/docs/category/open-api Retrieve detailed information about specific products listed on AliExpress. ```APIDOC ## Get Product Information ### Description This endpoint allows you to retrieve detailed information for a specific product using its unique product ID. ### Method GET ### Endpoint /api/v1/products/{product_id} ### Parameters #### Path Parameters - **product_id** (integer) - Required - The unique identifier of the product. ### Response #### Success Response (200) - **product_id** (integer) - The unique identifier for the product. - **product_name** (string) - The name of the product. - **description** (string) - A detailed description of the product. - **price** (number) - The selling price of the product. - **stock_quantity** (integer) - The available stock quantity. - **category_id** (integer) - The ID of the product category. - **images** (array of strings) - URLs to product images. #### Response Example ```json { "product_id": 98765, "product_name": "Example T-Shirt", "description": "A comfortable cotton t-shirt available in various sizes and colors.", "price": 19.99, "stock_quantity": 100, "category_id": 12345, "images": ["http://example.com/image1.jpg", "http://example.com/image2.jpg"] } ``` ``` -------------------------------- ### Create Handover List Response Source: https://business.aliexpress.ru/docs/local-handover-list Example response for the create handover list request, showing the newly created handover list ID or an error object. ```json { "data": { "handover_list_id": 105964 }, "error": null } ``` -------------------------------- ### Get Categories and Attributes Source: https://business.aliexpress.ru/docs/category/open-api Retrieve a list of product categories and their associated attributes. ```APIDOC ## Get Categories and Attributes ### Description This endpoint retrieves a hierarchical list of product categories available on AliExpress, along with the attributes relevant to each category. ### Method GET ### Endpoint /api/v1/categories ### Parameters #### Query Parameters - **parent_id** (integer) - Optional - Filter categories by parent category ID. ### Response #### Success Response (200) - **categories** (array of objects) - A list of categories, each containing: - **category_id** (integer) - The unique identifier for the category. - **category_name** (string) - The name of the category. - **attributes** (array of objects) - Attributes associated with the category, each containing: - **attribute_id** (integer) - The unique identifier for the attribute. - **attribute_name** (string) - The name of the attribute. #### Response Example ```json { "categories": [ { "category_id": 1, "category_name": "Electronics", "attributes": [ { "attribute_id": 101, "attribute_name": "Brand" }, { "attribute_id": 102, "attribute_name": "Model" } ] } ] } ``` ``` -------------------------------- ### Get Handover List Labels Source: https://business.aliexpress.ru/docs/quick-start Generate and retrieve the PDF for the handover list. Ensure the date on the list matches the labels and is not later than the delivery date. ```HTTP POST /seller-api/v1/labels/handover-lists/get ``` -------------------------------- ### Example Handover List Response Source: https://business.aliexpress.ru/docs/local-handover-list This JSON object represents a successful response when retrieving handover list information. It includes details about the data source and pagination. ```json { "data": { "data_source": [ { "handover_list_id": 10106, "arrival_date": "2021-12-30T05:00:00Z", "status": "Created", "shipment_type": "Dropoff", "logistic_order_ids": [ 88236 ], "gmt_create": "2021-05-28T16:36:21Z" }, { "handover_list_id": 40494, "arrival_date": "2021-07-15T18:34:07Z", "status": "Transferred", "shipment_type": "Dropoff", "logistic_order_ids": [ 309784 ], "gmt_create": "2021-07-12T22:05:07Z" } ], "page_info": { "current": 1, "page_size": 2, "total": 2 } }, "error": null } ``` -------------------------------- ### Example Request for Searching Brands Source: https://business.aliexpress.ru/docs/brand This cURL command demonstrates how to search for a brand on AliExpress using the API. Ensure you replace '' with your actual authentication token. ```curl curl --location --request POST 'https://openapi.aliexpress.ru/api/v1/brand/search-brand' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --data '{ "search": "ADIDAS" }' ``` -------------------------------- ### Get Order List Source: https://business.aliexpress.ru/docs/category/open-api Retrieve a list of orders placed on AliExpress. ```APIDOC ## Get Order List ### Description This endpoint allows you to retrieve a list of orders, with options to filter by status, date range, and other criteria. ### Method GET ### Endpoint /api/v1/orders ### Parameters #### Query Parameters - **status** (string) - Optional - Filter orders by status (e.g., 'processing', 'shipped', 'completed'). - **start_date** (string) - Optional - Filter orders from this date (YYYY-MM-DD). - **end_date** (string) - Optional - Filter orders up to this date (YYYY-MM-DD). ### Response #### Success Response (200) - **orders** (array of objects) - A list of orders, each containing: - **order_id** (integer) - The unique identifier for the order. - **order_date** (string) - The date the order was placed. - **status** (string) - The current status of the order. - **total_amount** (number) - The total amount of the order. #### Response Example ```json { "orders": [ { "order_id": 10001, "order_date": "2023-10-27T10:00:00Z", "status": "processing", "total_amount": 55.99 } ] } ``` ``` -------------------------------- ### Get Handover List Labels Source: https://business.aliexpress.ru/docs/quick-start Generate and retrieve a PDF of the handover list. This document must accompany your shipments. ```APIDOC ## POST /seller-api/v1/labels/handover-lists/get ### Description Generates and retrieves a PDF of the handover list. ### Method POST ### Endpoint /seller-api/v1/labels/handover-lists/get ### Parameters #### Query Parameters None #### Request Body None specified in source. ### Request Example None specified in source. ### Response #### Success Response (200) - **label_url** (string) - A URL pointing to the PDF containing the handover list. #### Response Example None specified in source. ``` -------------------------------- ### Get Order Labels Source: https://business.aliexpress.ru/docs/quick-start Generate and retrieve PDF labels for your shipments. These labels need to be affixed to each package. ```APIDOC ## POST /seller-api/v1/labels/orders/get ### Description Generates and retrieves PDF labels for orders. ### Method POST ### Endpoint /seller-api/v1/labels/orders/get ### Parameters #### Query Parameters None #### Request Body None specified in source. ### Request Example None specified in source. ### Response #### Success Response (200) - **label_url** (string) - A URL pointing to the PDF containing the labels. #### Response Example None specified in source. ``` -------------------------------- ### Get Handover List Source: https://business.aliexpress.ru/docs/local-handover-list Retrieves details for a specific handover list by its ID. Ensure you have a valid API token. ```shell curl --location --request POST 'https://openapi.aliexpress.ru/seller-api/v1/labels/handover-lists/get' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --data-raw '{ "handover_list_id": 103802 }' ``` -------------------------------- ### Example Response for Ready for Pickup Status Change Source: https://business.aliexpress.ru/docs/change-status This JSON structure represents a potential error response when attempting to change an order's status to 'Ready for Pickup'. ```json { "error": { "code": "OrderNotFound", "message": "Отправление не найдено.", "details": null }, "data": null } ``` -------------------------------- ### Get Account Currency Source: https://business.aliexpress.ru/docs/get-currency Retrieves the currency in which the seller specifies product prices. This method requires JWT token authorization. ```APIDOC ## GET /api/v1/shops/get-currency ### Description Returns the currency in which the seller specifies product prices. ### Method POST ### Endpoint https://openapi.aliexpress.ru/api/v1/shops/get-currency ### Parameters #### Request Body This endpoint does not require any request body parameters. ### Request Example ```bash curl --location --request POST 'https://openapi.aliexpress.ru/api/v1/shops/get-currency' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: ' ``` ### Response #### Success Response (200) - **currency** (string) - The name of the currency. #### Response Example ```json { "data": { "currency": "USD" } } ``` ``` -------------------------------- ### Example Error Response for Adding Orders Source: https://business.aliexpress.ru/docs/local-handover-list This JSON object illustrates a potential error response when attempting to add orders to a handover list, specifically indicating a seller mismatch. ```json { "error": { "code": "SellerMismatch", "message": "Продавец отличается от продавца в листе передачи", "details": null }, "data": null } ``` -------------------------------- ### Get Size Chart Templates Source: https://business.aliexpress.ru/docs/local-get-size-templates Retrieves size chart template identifiers for a specified category. This is useful for associating correct sizing information with products. ```APIDOC ## POST /api/v1/getSizeChartTemplates ### Description Returns size chart template identifiers for a given category. ### Method POST ### Endpoint /api/v1/getSizeChartTemplates ### Headers - **x-auth-token** (string) - Required - Your JWT token for authorization. - **x-request-locale** (string) - Optional - The locale for error messages. Example: ru_RU ### Parameters #### Request Body - **category_id** (string(int)) - Required - The category identifier on AliExpress. ### Request Example ```curl curl --location --request POST 'https://openapi.aliexpress.ru/api/v1/getSizeChartTemplates' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --data-raw '{ "category_id": "200000367" }' ``` ### Response #### Success Response (200) - **data** (object) - Response data. - **id** (string) - The size chart template ID for the selected category. - **type** (string) - The type, always 'general'. - **name** (string) - The name of the size chart template. #### Response Example ```json { "data": [ { "id": "1000001518517659", "type": "general", "name": "123123" } ] } ``` ``` -------------------------------- ### Example Category Response Structure Source: https://business.aliexpress.ru/docs/categories This JSON object shows the structure of a category response, including IDs, names, child categories, and associated SKU and regular properties with their configurations. ```json { "categories": [ { "id": "13004", "parent_id": "100005537", "name": "Рыболовные канаты", "children_ids": [], "is_visible": true, "sku_properties": [ { "id": "14", "name": "Цвет", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": true, "is_multi_select": true, "is_input_prop": false, "has_unit": false, "has_customized_pic": true, "has_customized_name": true, "units": [] }, { "id": "200007763", "name": "Доставка из", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": true, "is_multi_select": true, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] } ], "properties": [ { "id": "166", "name": "Диаметр", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": false, "is_multi_select": false, "is_input_prop": true, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [ { "rate": 12, "name": "мм", "id": "1234567890123" } ] }, { "id": "2", "name": "Название бренда", "is_required": true, "is_key": false, "is_brand": true, "is_enum_prop": true, "is_multi_select": false, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] }, { "id": "3", "name": "Номер модели", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": false, "is_multi_select": false, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] }, { "id": "10", "name": "Материал", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": false, "is_multi_select": false, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] }, { "id": "219", "name": "Происхождение", "is_required": true, "is_key": false, "is_brand": false, "is_enum_prop": true, "is_multi_select": false, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] }, { "id": "521", "name": "Назначение", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": true, "is_multi_select": false, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] }, { "id": "1238", "name": "Тип продукта", "is_required": false, "is_key": false, "is_brand": false, "is_enum_prop": true, "is_multi_select": false, "is_input_prop": false, "has_unit": false, "has_customized_pic": false, "has_customized_name": false, "units": [] } ] } ] } ``` -------------------------------- ### Get Shipping Templates Request Source: https://business.aliexpress.ru/docs/local-get-shipping-templates Use this cURL command to request a list of your configured shipping templates from the AliExpress API. Ensure you replace '' with your actual API token. ```curl curl --location --request GET 'https://openapi.aliexpress.ru/api/v1/sellercenter/get-count-product-on-onboarding-template' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' ``` -------------------------------- ### Get Top-Level Categories Source: https://business.aliexpress.ru/docs/categories Use this method to retrieve the entire AliExpress category tree. It's the starting point for understanding category hierarchy and finding leaf categories for product uploads. Ensure you include the necessary authorization and locale headers. ```curl curl --location --request POST 'https://openapi.aliexpress.ru/api/v1/categories/top' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --header 'x-request-locale: ru_RU' \ --data-raw '{}' ``` -------------------------------- ### Get Order List Source: https://business.aliexpress.ru/docs/quick-start Retrieve a list of your orders using the API. This method is used to get up-to-date information about your orders. ```HTTP POST /seller-api/v1/order/get-order-list ``` -------------------------------- ### Create and Upload Products Source: https://business.aliexpress.ru/docs/category/open-api API methods for creating new product listings and uploading product information to AliExpress. ```APIDOC ## Create and Upload Products ### Description This endpoint allows you to create new product listings on AliExpress by providing detailed product information. It supports uploading product data in a structured format. ### Method POST ### Endpoint /api/v1/products ### Parameters #### Request Body - **product_name** (string) - Required - The name of the product. - **description** (string) - Required - A detailed description of the product. - **price** (number) - Required - The selling price of the product. - **stock_quantity** (integer) - Required - The available stock quantity. - **category_id** (integer) - Required - The ID of the product category. - **images** (array of strings) - Optional - URLs to product images. ### Request Example ```json { "product_name": "Example T-Shirt", "description": "A comfortable cotton t-shirt available in various sizes and colors.", "price": 19.99, "stock_quantity": 100, "category_id": 12345, "images": ["http://example.com/image1.jpg", "http://example.com/image2.jpg"] } ``` ### Response #### Success Response (200) - **product_id** (integer) - The unique identifier for the newly created product. - **status** (string) - The status of the product listing (e.g., 'active', 'pending'). #### Response Example ```json { "product_id": 98765, "status": "pending" } ``` ``` -------------------------------- ### Get Shipment List Source: https://business.aliexpress.ru/docs/quick-start Retrieve a list of your shipments. Use filters to get specific shipment information, including IDs, cutoff dates, and statuses. ```HTTP POST /seller-api/v1/logistic-order/get ``` -------------------------------- ### Create Handover List Source: https://business.aliexpress.ru/docs/quick-start Create a handover list, which is a file you provide to the delivery service along with your shipments. This is for shipments ready for dispatch. ```HTTP POST /seller-api/v1/handover-list/create ``` -------------------------------- ### Get Shipment List Source: https://business.aliexpress.ru/docs/quick-start Retrieve a list of your created shipments. This allows you to check the status and details of your shipments. ```APIDOC ## POST /seller-api/v1/logistic-order/get ### Description Retrieves a list of logistic shipments based on provided filters. ### Method POST ### Endpoint /seller-api/v1/logistic-order/get ### Parameters #### Query Parameters - **filters** (object) - Optional. Filters to apply to the shipment list. #### Request Body None specified in source. ### Request Example None specified in source. ### Response #### Success Response (200) - **data** (object) - Contains shipment list information. - **logistic_orders** (array) - Detailed information about the shipments. - **logistic_order_id** (string) - The identifier of the shipment. - **cut_off_date** (string) - The date by which the shipment must be handed over to the delivery service. - **status** (string) - The current status of the shipment (e.g., New, AWAITING_ADDING_TO_HANDOVER). #### Response Example None specified in source. ``` -------------------------------- ### Create Handover List Source: https://business.aliexpress.ru/docs/local-handover-list Creates a handover list for specified shipments. Requires a JWT token for authorization. Ensure all orders have the same 'cut_off_date' if 'arrival_date' is not provided. ```curl curl --location --request POST 'https://openapi.aliexpress.ru/seller-api/v1/handover-list/create' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --data-raw '{ "logistic_order_ids": [ 1118070 ], "arrival_date": "2022-09-20T00:00:00.000Z" }' ``` -------------------------------- ### Manage Prices and Stock Source: https://business.aliexpress.ru/docs/category/open-api API methods for updating product prices and stock quantities. ```APIDOC ## Manage Prices and Stock ### Description This endpoint allows you to efficiently update the prices and stock quantities for your listed products in bulk or individually. ### Method PUT ### Endpoint /api/v1/products/pricing_stock ### Parameters #### Request Body - **updates** (array of objects) - A list of products to update, each containing: - **product_id** (integer) - Required - The ID of the product to update. - **price** (number) - Optional - The new price for the product. - **stock_quantity** (integer) - Optional - The new stock quantity for the product. ### Request Example ```json { "updates": [ { "product_id": 98765, "price": 20.50, "stock_quantity": 95 }, { "product_id": 98766, "stock_quantity": 50 } ] } ``` ### Response #### Success Response (200) - **success_count** (integer) - The number of products successfully updated. - **failed_count** (integer) - The number of products that failed to update. #### Response Example ```json { "success_count": 2, "failed_count": 0 } ``` ``` -------------------------------- ### Get Order Labels Source: https://business.aliexpress.ru/docs/quick-start Generate and retrieve labels for your shipments. The response provides a URL to a PDF containing the labels. ```HTTP POST /seller-api/v1/labels/orders/get ``` -------------------------------- ### Manage Products Source: https://business.aliexpress.ru/docs/category/open-api API methods for updating and deleting existing product listings on AliExpress. ```APIDOC ## Manage Products ### Description This section covers operations for managing existing product listings, including updating product details and deleting products from your catalog. ### Method PUT (for updates), DELETE (for deletion) ### Endpoint /api/v1/products/{product_id} ### Parameters #### Path Parameters - **product_id** (integer) - Required - The unique identifier of the product to manage. #### Request Body (for PUT) - **product_name** (string) - Optional - The updated name of the product. - **description** (string) - Optional - The updated description of the product. - **price** (number) - Optional - The updated selling price of the product. - **stock_quantity** (integer) - Optional - The updated available stock quantity. ### Request Example (Update) ```json { "price": 21.99, "stock_quantity": 90 } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the product was updated or deleted. #### Response Example ```json { "message": "Product updated successfully." } ``` ``` -------------------------------- ### Example Request for Adding Existing Brand Source: https://business.aliexpress.ru/docs/brand This cURL command shows how to add an existing AliExpress brand to your list. Provide the brand ID and an array of URLs for any required approval documents. ```curl curl --location --request POST 'https://openapi.aliexpress.ru/api/v1/brand/add-existing-brand' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --data '{ "id": "300092364", "fileUrls": [ "https://st.aestatic.net/scqa-storage/open-async-pictures/TEST%20PIC%204.jpeg", "https://ae04.alicdn.com/kf/S4b4c0eb782d14046a44b5cc88ff05f08J.jpeg" ] }' ``` -------------------------------- ### Get Orders List Source: https://business.aliexpress.ru/docs/local-get-orders-list Retrieves a list of orders with comprehensive details. This endpoint is useful for sellers to manage their orders and track shipments. ```APIDOC ## GET /websites/business_aliexpress_ru/orders ### Description Retrieves a list of orders with detailed information about each order, including product specifics, quantities, pricing, and logistic details. ### Endpoint /websites/business_aliexpress_ru/orders ### Parameters #### Query Parameters - **trade_order_info** (string) - Optional - Specifies the type of logistic information to include. Example: "LogisticInfo". ### Response #### Success Response (200) - **sku_id** (string) - Identifier for the product variation. - **product_source_id** (int) - Identifier for the product source. - **quantity** (int) - Quantity of the item. - **height** (int) - Height of the item in cm. - **weight** (int) - Weight of the item in g. - **width** (int) - Width of the item in cm. - **length** (int) - Length of the item in cm. - **name** (string) - Name of the product. - **img_url** (string) - URL of the product image. - **item_price** (int) - Price of the item. - **properties** (array of strings) - Properties of the item. - **properties_map** (object) - A map of product properties. - **buyer_comment** (string) - Buyer's comment. - **logistic_orders** (array of objects) - Information about shipments associated with the order. - **id** (int) - Identifier for the shipment. - **trade_order_id** (int) - Identifier for the order associated with the shipment. - **track_number** (string) - Tracking number for the shipment. - **status** (string) - Status of the shipment. Possible values include: New, AwaitingCreateOrder, OrderCreationProblems, AwaitingHandoverList, AddingToHandoverProblems, AwaitingConfirmation, AwaitingDispatch, OrderReceivedFromSeller, CrossDocSorting, CrossDocSent, ProviderPostingReceive, ProviderPostingLeftTheReception, ProviderPostingArrivedAtSorting, ProviderPostingSorting, ProviderPostingLeftTheSorting, ProviderPostingArrived, ProviderPostingDelivered, ProviderPostingUnsuccessfulAttemptOfDelivery, ProviderPostingInReturn, ProviderPostingTemporaryStorage, ProviderPostingReturned, Rejected, Cancelled. - **creation_error** (object) - Error details if there was an issue creating the shipment. - **code** (string) - Error code. - **description** (string) - Description of the error. - **commission** (object) - Commission details. - **platform_fee** (int) - Platform fee. - **affiliate_fee** (int) - Affiliate fee. - **estimate_revenue** (int) - Estimated revenue. - **actions** (object) - Available actions for the shipment. - **confirm_sending** (boolean) - Indicates if the shipment has been confirmed as sent. - **send_later** (boolean) - Indicates if the shipment date was postponed. - **cancel** (boolean) - Indicates if the order was canceled due to postponement. - **error** (object) - Information about any errors encountered. - **code** (string) - Error code. - **message** (string) - Error message. Possible values include: ErrorCode.OrderNotFound, ErrorCode.OrdersNotFbs, ErrorCode.MultipleProvidersError, ErrorCode.MultipleFirstMileProvidersError, ErrorCode.HandoverListNotFound, ErrorCode.SellerMismatch, ErrorCode.WrongHandoverListStatusError, ErrorCode.ProvidersMismatch, ErrorCode.OrdersWithoutExternalIdError, ErrorCode.LogisticOrdersIncorrectStatusError, ErrorCode.RupostError. ``` -------------------------------- ### Get Order List Source: https://business.aliexpress.ru/docs/local-get-orders-list Retrieves a list of orders with detailed information, supporting filtering and pagination. It requires an API token for authentication. ```APIDOC ## POST /seller-api/v1/order/get-order-list ### Description Returns a list of orders with detailed information, supporting filtering and pagination. ### Method POST ### Endpoint https://openapi.aliexpress.ru/seller-api/v1/order/get-order-list ### Parameters #### Query Parameters - **date_start** (string) - Optional - Filter by orders created after this date, format: YYYY-MM-DDThh:mm:ssZ. - **date_end** (string) - Optional - Filter by orders created no later than this date, format: YYYY-MM-DDThh:mm:ssZ. - **order_statuses** (array of strings) - Optional - Order status, can take values: Created, InProgress, Finished, Cancelled. - **payment_statuses** (array of strings) - Optional - Order payment status, can take values: NotPaid, Hold or Paid, Cancelled, Failed. - **delivery_statuses** (array of strings) - Optional - Order delivery status, can take values: Init, PartialShipped, Shipped, Delivered, Cancelled. - **antifraud_statuses** (array of strings) - Optional - Order fraud status, can take values: NotChecked, Checking, Blocked, Passed. - **order_ids** (array of integers) - Optional - Order identifier. - **sorting_order** (string) - Optional - Order sorting in the list, can take values: Asc, Desc, None. - **sorting_field** (string) - Optional - Field by which the order list is sorted. - **tracking_numbers** (array of strings) - Optional - Order tracking number. - **page_size** (int) - Required - Number of pages to display. - **page** (int) - Required - Page number from the list to display. - **update_at_from** (string) - Optional - Filter by orders updated after this date, format: YYYY-MM-DDThh:mm:ssZ. - **updated_at_to** (string) - Optional - Filter by orders updated no later than this date, format: YYYY-MM-DDThh:mm:ssZ. - **shipping_day_from** (string) - Optional - Filter by orders shipped after this date, format: YYYY-MM-DDThh:mm:ssZ. - **shipping_day_to** (string) - Optional - Filter by orders shipped no later than this date, format: YYYY-MM-DDThh:mm:ssZ. - **trade_order_info** (string) - Optional - Flag indicating what information to add to the response: Common (basic order information), LogisticInfo (shipment information). ### Request Example ```json { "page_size": 1, "page": 1, "trade_order_info": "LogisticInfo", "sorting_order": "Desc" } ``` ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Size Chart Templates Request Source: https://business.aliexpress.ru/docs/local-get-size-templates Use this cURL command to send a POST request to the AliExpress API to retrieve size chart templates for a specified category. Ensure you replace '' with your actual JWT token. ```bash curl --location --request POST 'https://openapi.aliexpress.ru/api/v1/getSizeChartTemplates' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --header 'x-auth-token: ' \ --data-raw '{ "category_id": "200000367" }' ``` -------------------------------- ### Create Shipment Source: https://business.aliexpress.ru/docs/quick-start Initiate the creation of a shipment for your orders. This is the first step in the shipping process. ```APIDOC ## POST /seller-api/v1/logistic-order/create ### Description Creates a shipment for one or more orders. ### Method POST ### Endpoint /seller-api/v1/logistic-order/create ### Parameters #### Query Parameters None #### Request Body None specified in source. ### Request Example None specified in source. ### Response #### Success Response (200) - **data** (object) - Contains shipment information. - **orders** (array) - List of orders within the shipment. - **logistic_orders** (array) - Details about the created logistic orders. - **id** (string) - The identifier of the created shipment. If an order is too large, it may be split into multiple shipments, returning multiple IDs. #### Response Example None specified in source. ``` -------------------------------- ### Get Handover List Source: https://business.aliexpress.ru/docs/local-handover-list Retrieves details of a specific handover list by its ID. This includes a link to the PDF of the handover list if available. ```APIDOC ## POST /seller-api/v1/labels/handover-lists/get ### Description Retrieves details of a specific handover list by its ID, including a link to the PDF of the handover list. ### Method POST ### Endpoint /seller-api/v1/labels/handover-lists/get ### Parameters #### Request Body - **handover_list_id** (int) - Required - The ID of the handover list. ### Request Example ```json { "handover_list_id": 103802 } ``` ### Response #### Success Response (200) - **data.label_url** (string) - The URL to the PDF of the handover list. - **error** (object) - Information about any errors encountered. - **code** (string) - Error code. - **message** (string) - Error message. - **details** (object) - Additional error details. #### Response Example ```json { "error": { "code": "DifferentOwner", "message": "Отправления принадлежат другому продавцу", "details": null }, "data": null } ``` ```