data-src=../../../includes/commerce-only.md

Import data

The POST /V1/import/csv and POST /V1/import/json endpoints provide a RESTful way to import data into Adobe Commerce. They mirror the import capabilities found in the Admin at System > Data Transfer > Import. These endpoints support the import of the following entities:

advanced_pricing
catalog_product
customer
customer_address
customer_composite
customer_finance
SaaS only requisition_list
stock_sources

data-variant=info

data-slots=text

Adobe Commerce as a Cloud Service does not support the POST /V1/import/csv endpoint. Use the POST /V1/import/json endpoint instead.

Source Data Format and Requirements

Ensure your source data conforms to the sequence and format expected by Commerce. To acquaint yourself with each import entity's requirements, visit the Import page in the Admin, select an entity from the dropdown, and click Download Sample File.

The original CSV or JSON data must use UTF-8 encoding before any compression or base64 encoding is applied. This ensures compatibility with Adobe Commerce's internal processing and supports a wide range of international characters and symbols.

CSV Import

data-src=../../../includes/paas-only.md

The import/csv endpoint expects data in base64 encoded format:

Encoding: Before submitting, your CSV data must be base64 encoded, which means there is no need to escape special characters.
Compression: You can use gzip to compress your data before encoding. This is especially useful when handling larger CSV files that might exceed server or PHP request size limits.
Delimiter: This API is tailored for CSV files that use commas as field and multi-value separators. Any other delimiters will cause the import to fail.

JSON Import

The import/json endpoint is designed for JSON data:

Convert your CSV into JSON using any trustworthy online converter.
When converting CSV to JSON using standard tools or libraries, special characters within the data are typically escaped automatically. Ensure that any manual edits or custom conversion processes handle this escaping appropriately.

Customer imports in Adobe Commerce as a Cloud Service

In Adobe Commerce as a Cloud Service, the POST /V1/import/json endpoint does not support the assistance_allowed field when the entity field is set to customer. However, you can create or modify customers that have remote shopping assistance enabled by using the following methods:

Use POST /V1/async/bulk/customers to bulk create customers with assistance_allowed pre-enabled.

 {
 "customer": {
     "email": "user@example.com",
     "firstname": "User",
     "lastname": "Name",
     "website_id": 1,
     "extension_attributes": {
     "assistance_allowed": 2
     }
 },
 "password": "Password123!"
 }

Use the PUT /V1/customers/{id} endpoint to modify existing customers individually.
```
{"customer": {"extension_attributes": {"assistance_allowed": 2}}}
```

Validation Strategy

A validation strategy is mandatory. Depending on your chosen strategy, the API will either proceed with the import or abort it upon encountering invalid rows.

validation-stop-on-errors: The API halts the import upon finding the first error. It will return an error message describing the issue and its row number.
validation-skip-errors: The API imports valid rows unless the total number of errors surpasses the allowedErrorCount. If errors go beyond this count, the import is halted (even valid rows will not be processed). The response will contain details of the first error found and its row number.

The allowedErrorCount field specifies the maximum allowable error count before terminating the import process.

Import CSV API

data-src=../../../includes/paas-only.md

The POST /V1/import/csv endpoint uses the StartImportInterface service to efficiently import entities into Adobe Commerce. The payload must contain data in a base64 encoded format.

Service Name:

StartImportInterface

REST Endpoint:

POST /V1/import/csv

StartImportInterface Parameters:

Name

Description

Format

Requirements

locale

The language and country combination for the data being imported

string

Optional

entity

The type of entity to be imported

string

Required. The value must be one of the following: advanced_pricing, catalog_product, customer, customer_address, customer_composite, customer_finance, requisition_list or stock_sources.

behavior

The action to perform

string

Required. For advanced_pricing, catalog_product, customer_composite, requisition_list, or stock_sources, the value must be: append, replace, or delete. For customer, customer_address, or customer_finance, you must use add_update, delete, or custom.

validationStrategy

Strategy to use when entities are invalid

string

Required. The value must be either validation-stop-on-errors or validation-skip-errors.

allowedErrorCount

The maximum number of errors that can occur before the import is canceled

string

Required

csvData

Base64 encoded string containing CSV data (optionally gzip compressed before base64)

string

Required

importFieldSeparator

Separator used in CSV. Default is ','

string

Optional

importMultipleValueSeparator

Separator used in columns with multiple values such as categories. Default is ','

string

Optional

importEmptyAttributeValueConstant

Constant to be replaced with an empty attribute

string

Optional

importImagesFileDir

Path to images relative to <Magento root directory>/var/import/images

string

Optional

Sample Usage:

POST /V1/import/csv

Headers:

Content-Type: application/json

Authorization: Bearer <administrator token>

Payload:

{
  "source":{
    "entity":"advanced_pricing",
    "behavior":"add_update",
    "validationStrategy": "validation-stop-on-errors",
    "allowedErrorCount":"10",
    "csvData":"c2t1LHRpZXJfcHJpY2Vfd2Vic2l0ZSx0aWVyX3ByaWNlX2N1c3RvbWVyX2dyb3VwLHRpZXJfcHJpY2VfcXR5LHRpZXJfcHJpY2UsdGllcl9wcmljZV92YWx1ZV90eXBlClNpbXBsZTEsIkFsbCBXZWJzaXRlcyBbVVNEXSIsIk5PVCBMT0dHRUQgSU4iLDEuMDAwMCwyNTAuMDAwMDAwLEZpeGVk"
  }
}

Response:

When Import is successful, the API response will contain the number of entities that were successfully imported.

[
  "Entities Processed: 1"
]

Payload 2:

This sample payload contains encoded CSV data with two valid rows and one invalid row.

{
  "source": {
    "entity":"customer",
    "behavior":"add_update",
    "validationStrategy": "validation-stop-on-errors",
    "allowedErrorCount":"10",
    "csvData":"ZW1haWwsX3dlYnNpdGUsX3N0b3JlLHdlYnNpdGVfaWQsc3RvcmVfaWQsY3JlYXRlZF9pbixwcmVmaXgsZmlyc3RuYW1lLG1pZGRsZW5hbWUsbGFzdG5hbWUsc3VmZml4LGdyb3VwX2lkLGRvYixwYXNzd29yZF9oYXNoLHJwX3Rva2VuLHJwX3Rva2VuX2NyZWF0ZWRfYXQsdGF4dmF0LGNvbmZpcm1hdGlvbixjcmVhdGVkX2F0LGdlbmRlcixkaXNhYmxlX2F1dG9fZ3JvdXBfY2hhbmdlLHVwZGF0ZWRfYXQsZmFpbHVyZXNfbnVtLGZpcnN0X2ZhaWx1cmUsbG9ja19leHBpcmVzLHJld2FyZF91cGRhdGVfbm90aWZpY2F0aW9uLHJld2FyZF93YXJuaW5nX25vdGlmaWNhdGlvbixwYXNzd29yZApjQDEuY29tLGJhc2UsZGVmYXVsdCwxLDEsIkRlZmF1bHQgU3RvcmUgVmlldyIsLEMxLCxDMUwsLDEsLCwwOjM6T2Rob245RTRWa3RWWi9Ra2I3VGxmQ3ZZWmFRZ0NUTStMelN1UFA0b3grKzdqME5lNHM1MmdRTUszNXZjY1d1REJvc1p4bXJBOTZhbUpCenQsIjIwMjItMDYtMjEgMTg6NDQ6MTgiLCwsIjIwMjItMDYtMjEgMTg6NDQ6MTgiLDAsMCwiMjAyMi0wNi0yMSAxODo0NDoxOCIsMCwsLDAsMCwKY0AyLmNvbSxiYXNlLGRlZmF1bHQsMSwxLCJEZWZhdWx0IFN0b3JlIFZpZXciLCxDMiwsQzJMLCwxLCwsMDozOkFkYzJtazNKaHpScHBpYVdabFNhM05IUTMwTnpoejBMdEtwL1A3Nm5raXovRkFsbG15Z3V4KzF4dkhQcm5MbnBNSWJSVlg2dGk4WUdsdXpPLCIyMDIyLTA2LTIxIDE4OjQ0OjQyIiwsLCIyMDIyLTA2LTIxIDE4OjQ0OjQyIiwwLDAsIjIwMjItMDYtMjEgMTg6NDQ6NDIiLDAsLCwwLDAsCkNAMy5jb20sYmFzZSxkZWZhdWx0LDEsMSwiRGVmYXVsdCBTdG9yZSBWaWV3IiwsQzMsLEMzTCwsMSwsLDA6MzpoM3g2UWg2RHNNdUxRaUZDWkNhUXZDUitDTkdFcXpFcWc1ZzRtamVjREVsSGRRdGJVVXg1ZFYrQ0lzc0h2YWgxZndZNlRIeEprUmlxSERDZywiMjAyMi0wNi0yMSAxODo0NTowOCIsLCwiMjAyMi0wNi0yMSAxODo0NTowOCIsMCwwLCIyMDIyLTA2LTIxIDE4OjQ1OjA4IiwwLCwsMCwwLDAK"
  }
}

When Import fails, the response contains the row number and a message describing cause of failure for first invalid row encountered.

Response:

[
  "Row 3: Please enter a password with a valid length."
]

Payload 3:

In this example, the CSV payload contains three rows of data, and one of them is invalid. Due to the selected validation strategy and allowedErrorCount value, only the valid rows are imported.

{
  "source": {
  "entity":"catalog_product",
  "behavior":"add_update",
  "validationStrategy": "validation-skip-errors",
  "allowedErrorCount":"1",
  "csvData":"c2t1LHN0b3JlX3ZpZXdfY29kZSxhdHRyaWJ1dGVfc2V0X2NvZGUscHJvZHVjdF90eXBlLGNhdGVnb3JpZXMscHJvZHVjdF93ZWJzaXRlcyxuYW1lLGRlc2NyaXB0aW9uLHNob3J0X2Rlc2NyaXB0aW9uLHdlaWdodCxwcm9kdWN0X29ubGluZSx0YXhfY2xhc3NfbmFtZSx2aXNpYmlsaXR5LHByaWNlLHNwZWNpYWxfcHJpY2Usc3BlY2lhbF9wcmljZV9mcm9tX2RhdGUsc3BlY2lhbF9wcmljZV90b19kYXRlLHVybF9rZXksbWV0YV90aXRsZSxtZXRhX2tleXdvcmRzLG1ldGFfZGVzY3JpcHRpb24sYmFzZV9pbWFnZSxiYXNlX2ltYWdlX2xhYmVsLHNtYWxsX2ltYWdlLHNtYWxsX2ltYWdlX2xhYmVsLHRodW1ibmFpbF9pbWFnZSx0aHVtYm5haWxfaW1hZ2VfbGFiZWwsc3dhdGNoX2ltYWdlLHN3YXRjaF9pbWFnZV9sYWJlbCxjcmVhdGVkX2F0LHVwZGF0ZWRfYXQsbmV3X2Zyb21fZGF0ZSxuZXdfdG9fZGF0ZSxkaXNwbGF5X3Byb2R1Y3Rfb3B0aW9uc19pbixtYXBfcHJpY2UsbXNycF9wcmljZSxtYXBfZW5hYmxlZCxnaWZ0X21lc3NhZ2VfYXZhaWxhYmxlLGN1c3RvbV9kZXNpZ24sY3VzdG9tX2Rlc2lnbl9mcm9tLGN1c3RvbV9kZXNpZ25fdG8sY3VzdG9tX2xheW91dF91cGRhdGUscGFnZV9sYXlvdXQscHJvZHVjdF9vcHRpb25zX2NvbnRhaW5lcixtc3JwX2Rpc3BsYXlfYWN0dWFsX3ByaWNlX3R5cGUsY291bnRyeV9vZl9tYW51ZmFjdHVyZSxhZGRpdGlvbmFsX2F0dHJpYnV0ZXMscXR5LG91dF9vZl9zdG9ja19xdHksdXNlX2NvbmZpZ19taW5fcXR5LGlzX3F0eV9kZWNpbWFsLGFsbG93X2JhY2tvcmRlcnMsdXNlX2NvbmZpZ19iYWNrb3JkZXJzLG1pbl9jYXJ0X3F0eSx1c2VfY29uZmlnX21pbl9zYWxlX3F0eSxtYXhfY2FydF9xdHksdXNlX2NvbmZpZ19tYXhfc2FsZV9xdHksaXNfaW5fc3RvY2ssbm90aWZ5X29uX3N0b2NrX2JlbG93LHVzZV9jb25maWdfbm90aWZ5X3N0b2NrX3F0eSxtYW5hZ2Vfc3RvY2ssdXNlX2NvbmZpZ19tYW5hZ2Vfc3RvY2ssdXNlX2NvbmZpZ19xdHlfaW5jcmVtZW50cyxxdHlfaW5jcmVtZW50cyx1c2VfY29uZmlnX2VuYWJsZV9xdHlfaW5jLGVuYWJsZV9xdHlfaW5jcmVtZW50cyxpc19kZWNpbWFsX2RpdmlkZWQsd2Vic2l0ZV9pZCxyZWxhdGVkX3NrdXMscmVsYXRlZF9wb3NpdGlvbixjcm9zc3NlbGxfc2t1cyxjcm9zc3NlbGxfcG9zaXRpb24sdXBzZWxsX3NrdXMsdXBzZWxsX3Bvc2l0aW9uLGFkZGl0aW9uYWxfaW1hZ2VzLGFkZGl0aW9uYWxfaW1hZ2VfbGFiZWxzLGhpZGVfZnJvbV9wcm9kdWN0X3BhZ2UsY3VzdG9tX29wdGlvbnMsYnVuZGxlX3ByaWNlX3R5cGUsYnVuZGxlX3NrdV90eXBlLGJ1bmRsZV9wcmljZV92aWV3LGJ1bmRsZV93ZWlnaHRfdHlwZSxidW5kbGVfdmFsdWVzLGJ1bmRsZV9zaGlwbWVudF90eXBlLGFzc29jaWF0ZWRfc2t1cyxkb3dubG9hZGFibGVfbGlua3MsZG93bmxvYWRhYmxlX3NhbXBsZXMsY29uZmlndXJhYmxlX3ZhcmlhdGlvbnMsY29uZmlndXJhYmxlX3ZhcmlhdGlvbl9sYWJlbHMKU2ltcGxlMSwsRGVmYXVsdCxzaW1wbGUsIkRlZmF1bHQgQ2F0ZWdvcnkiLGJhc2UsU2ltcGxlMSwsLDEuMDAwMDAwLDEsIlRheGFibGUgR29vZHMiLCJDYXRhbG9nLCBTZWFyY2giLDEwLjAwMDAwMCwsLCxzaW1wbGUxLFNpbXBsZTEsU2ltcGxlMSwiU2ltcGxlMSAiLCwsLCwsLCwsIjYvNy8yMiwgMzoxNSBQTSIsIjYvNy8yMiwgMzoxNSBQTSIsLCwiQmxvY2sgYWZ0ZXIgSW5mbyBDb2x1bW4iLCwsLCJVc2UgY29uZmlnIiwsLCwsLCwiVXNlIGNvbmZpZyIsIlVuaXRlZCBTdGF0ZXMiLCwxMDAwLjAwMDAsMC4wMDAwLDEsMCwwLDEsMS4wMDAwLDEsMTAwMDAuMDAwMCwxLDEsMS4wMDAwLDEsMSwxLDEsMS4wMDAwLDEsMCwwLDAsLCwsLCwsLCwsLCwsLCwsLCwsLCwKU2ltcGxlMiwsRGVmYXVsdCxzaW1wbGUsIkRlZmF1bHQgQ2F0ZWdvcnkiYmFzZSxTaW1wbGUyLCwsMS4wMDAwMDAsMSwiVGF4YWJsZSBHb29kcyIsIkNhdGFsb2csIFNlYXJjaCIsMjAwLjAwMDAwMCwsLCxzaW1wbGUyLFNpbXBsZTIsU2ltcGxlMiwiU2ltcGxlMiAiLCwsLCwsLCwsIjYvNy8yMiwgMzoxNiBQTSIsIjYvNy8yMiwgMzoxNiBQTSIsLCwiQmxvY2sgYWZ0ZXIgSW5mbyBDb2x1bW4iLCwsLCJVc2UgY29uZmlnIiwsLCwsLCwiVXNlIGNvbmZpZyIsIlVuaXRlZCBTdGF0ZXMiLCwxMDAwLjAwMDAsMC4wMDAwLDEsMCwwLDEsMS4wMDAwLDEsMTAwMDAuMDAwMCwxLDEsMS4wMDAwLDEsMSwxLDEsMS4wMDAwLDEsMCwwLDAsLCwsLCwsLCwsLCwsLCwsLCwsLCwKU2ltcGxlMywsRGVmYXVsdCxzaW1wbGUsIkRlZmF1bHQgQ2F0ZWdvcnkiLGJhc2UsU2ltcGxlMywsLDEuMDAwMDAwLDEsIlRheGFibGUgR29vZHMiLCJDYXRhbG9nLCBTZWFyY2giLDMwMC4wMDAwMDAsLCwsc2ltcGxlMyxTaW1wbGUzLFNpbXBsZTMsIlNpbXBsZTMgIiwsLCwsLCwsLCI2LzcvMjIsIDM6MTYgUE0iLCI2LzcvMjIsIDM6MTYgUE0iLCwsIkJsb2NrIGFmdGVyIEluZm8gQ29sdW1uIiwsLCwiVXNlIGNvbmZpZyIsLCwsLCwsIlVzZSBjb25maWciLCJVbml0ZWQgU3RhdGVzIiwsMTAwMC4wMDAwLDAuMDAwMCwxLDAsMCwxLDEuMDAwMCwxLDEwMDAwLjAwMDAsMSwxLDEuMDAwMCwxLDEsMSwxLDEuMDAwMCwxLDAsMCwwLCwsLCwsLCwsLCwsLCwsLCwsLCwsCg=="
  }
}

Response:

[
  "Entities Processed: 2"
]

Import JSON API

The Import JSON API is exclusively available via REST and does not support SOAP. This is because the payload consists of complex JSON objects with nested arrays, which are inherently challenging to represent with the XML structure that SOAP relies upon.

The POST /V1/import/json endpoint uses the StartImportInterface service to efficiently import entities into Adobe Commerce. The payload must contain data in JSON format.

Service Name:

StartImportInterface

REST Endpoint:

POST /V1/import/json

StartImportInterface Parameters:

Name

Description

Format

Requirements

locale

The language and country combination for the data being imported

string

Optional

entity

The type of entity to be imported

string

Required. Must be one of the following values: advanced_pricing, catalog_product, customer, customer_address, customer_composite, customer_finance, or stock_sources

behavior

The action to perform

string

Required. For advanced_pricing, catalog_product, customer_composite, or stock_sources the value must be one of the following: append, replace, or delete. For customer, customer_address, or customer_finance the value must be one of the following: add_update, delete, or custom.

validationStrategy

Strategy to use when entities are invalid

string

Required. The value must be either validation-stop-on-errors or validation-skip-errors.

allowedErrorCount

The maximum number of errors that can occur before the import is canceled

string

Required

items

An array of entities to be imported. Each entity, represented as a JSON object, contains details specific to its type (such as products or customers)

array of JSON objects

Required

importImagesFileDir

Path to images relative to <Magento root directory>/var/import/images

string

Optional

Sample Usage:

POST /V1/import/json

Headers:

Content-Type: application/json

Authorization: Bearer <administrator token>

Store: <store code> (SaaS only)

Simple product payload:

{
    "source": {
        "locale": "en_EN",
        "entity": "catalog_product",
        "behavior": "append",
        "validation_strategy": "validation-stop-on-errors",
        "allowed_error_count": 0,
        "items":    [
            {
                "sku": "Simple-Product-1",
                "store_view_code": "",
                "attribute_set_code": "Default",
                "product_type": "simple",
                "categories": [
                    "Default Category/Category 1",
                    "Default Category/Category 2"
                ],
                "product_websites": [
                    "base",
                    "french"
                ],
                "name": "Simple Product 1",
                "description": "",
                "short_description": "",
                "weight": 12,
                "product_online": 1,
                "tax_class_name": "Taxable Goods",
                "visibility": "Catalog, Search",
                "price": 9.99,
                "special_price": 8.99,
                "special_price_from_date": "7/20/23",
                "special_price_to_date": "",
                "url_key": "simple-product-1",
                "meta_title": "Simple Product 1",
                "meta_keywords": "Simple Product 1",
                "meta_description": "Simple Product 1 ",
                "base_image": "/1/_/1.png",
                "base_image_label": "one",
                "small_image": "/1/_/1.png",
                "small_image_label": "one",
                "thumbnail_image": "/1/_/1.png",
                "thumbnail_image_label": "one",
                "swatch_image": "/2/_/2.png",
                "swatch_image_label": "two",
                "created_at": "7/20/23, 11:36 AM",
                "updated_at": "7/21/23, 12:20 PM",
                "new_from_date": "7/21/23",
                "new_to_date": "",
                "display_product_options_in": "Block after Info Column",
                "map_price": "",
                "msrp_price": "",
                "map_enabled": "",
                "gift_message_available": "Yes",
                "custom_design": "",
                "custom_design_from": "",
                "custom_design_to": "",
                "custom_layout_update": "",
                "page_layout": "",
                "product_options_container": "",
                "msrp_display_actual_price_type": "Use config",
                "country_of_manufacture": "China",
                "additional_attributes": {
                    "date_time": "7/21/23",
                    "gift_wrapping_available": "Use config",
                    "gift_wrapping_price": 1.99,
                    "instructions": "Here instruction go how to use this product indoors, outdoors.",
                    "material": "cotton",
                    "size": "large",
                    "usage": [
                        "Travel",
                        "Sports",
                        "Office",
                        "Casual"
                    ]
                },
                "qty": 1000,
                "out_of_stock_qty": 0,
                "use_config_min_qty": 1,
                "is_qty_decimal": 0,
                "allow_backorders": 0,
                "use_config_backorders": 1,
                "min_cart_qty": 1,
                "use_config_min_sale_qty": 1,
                "max_cart_qty": 10000,
                "use_config_max_sale_qty": 1,
                "is_in_stock": 1,
                "notify_on_stock_below": 1,
                "use_config_notify_stock_qty": 1,
                "manage_stock": 1,
                "use_config_manage_stock": 1,
                "use_config_qty_increments": 1,
                "qty_increments": 1,
                "use_config_enable_qty_inc": 1,
                "enable_qty_increments": 0,
                "is_decimal_divided": 0,
                "website_id": 0,
                "deferred_stock_update": 0,
                "use_config_deferred_stock_update": 1,
                "related_skus": "",
                "related_position": "",
                "crosssell_skus": "",
                "crosssell_position": "",
                "upsell_skus": "",
                "upsell_position": "",
                "additional_images": [
                    "/3/_/3.png",
                    "/4/_/4.png"
                ],
                "additional_image_labels": [
                    "three",
                    "four"
                ],
                "hide_from_product_page": "",
                "custom_options":
                [
                    {
                        "name": "Option 1",
                        "type": "drop_down",
                        "required": 0,
                        "price": 25,
                        "sku": "",
                        "max_characters": 0,
                        "file_extension": "",
                        "image_size_x": 0,
                        "image_size_y": 0,
                        "price_type": "percent",
                        "option_title": "A"
                    },
                    {
                        "name": "Option 2",
                        "type": "multiple",
                        "required": 1,
                        "price": 1.99,
                        "sku": "",
                        "max_characters": 0,
                        "file_extension": "",
                        "image_size_x": 0,
                        "image_size_y": 0,
                        "price_type": "fixed",
                        "option_title": "B"
                    },
                    {
                        "name": "Option 2",
                        "type": "multiple",
                        "required": 1,
                        "price": 4.00,
                        "sku": "",
                        "max_characters": 0,
                        "file_extension": "",
                        "image_size_x": 0,
                        "image_size_y": 0,
                        "price_type": "fixed",
                        "option_title": "C"
                    }
                ],
                "giftcard_type": "",
                "giftcard_allow_open_amount": "",
                "giftcard_open_amount_min": "",
                "giftcard_open_amount_max": "",
                "giftcard_amount": "",
                "use_config_is_redeemable": "",
                "giftcard_is_redeemable": "",
                "use_config_lifetime": "",
                "giftcard_lifetime": "",
                "use_config_allow_message": "",
                "giftcard_allow_message": "",
                "use_config_email_template": "",
                "giftcard_email_template": "",
                "bundle_price_type": "",
                "bundle_sku_type": "",
                "bundle_price_view": "",
                "bundle_weight_type": "",
                "bundle_values": "",
                "bundle_shipment_type": "",
                "downloadable_links": "",
                "downloadable_samples": "",
                "associated_skus": "",
                "configurable_variations": "",
                "configurable_variation_labels": ""
            },
            {
                "sku": "Simple-Product-2",
                "_comment": "additional information for Simple Product 2"
            }
        ],
        "import_images_file_dir": "var/import/images/product_images"
    }
}

Response:

When the import is successful, the API response will contain the number of entities that were successfully imported.

[
  "Entities Processed: 2"
]

Arguments that support multiple values, such as categories, product_websites, additional_attributes, additional_images, additional_image_labels, and custom_options, can accept inputs in the form of an array, an array of JSON objects, or a singular JSON object.

Additionally, these arguments can also accept string values, similar to the import CSV API.

{
    "categories": "Default Category/Category 1,Default Category/Category 2",
    "product_websites": "base,french",
    "additional_attributes": "date_time=7/21/23,gift_wrapping_available=Use config,gift_wrapping_price=1.990000,instructions=Here instruction go how to use this product indoors, outdoors.,material=cotton,size=large,usage=Travel|Sports|Office|Casual",
    "additional_images": "/3/_/3.png,/4/_/4.png",
    "additional_image_labels": "three,four",
    "custom_options": "name=Option 1,type=drop_down,required=1,price=25,sku=,max_characters=0,file_extension=,image_size_x=0,image_size_y=0,price_type=percent,option_title=A|name=Option 2,type=multiple,required=1,price=1.99,sku=,max_characters=0,file_extension=,image_size_x=0,image_size_y=0,price_type=fixed,option_title=B|name=Option 2,type=multiple,required=1,price=4,sku=,max_characters=0,file_extension=,image_size_x=0,image_size_y=0,price_type=fixed,option_title=C"
}

Although the string format shown above provides compatibility with the import CSV API, using a structured JSON format is recommended for better readability and precision.

Configurable product payload:

For a configurable product:

The configurable_variations attribute accepts an array of JSON objects that describe variations. Each object represents a product variation, denoted by SKU, with associated attributes (such as color or size).
The configurable_variation_labels attribute accepts a JSON object that assigns human-readable labels to the variation attributes.

{
    "configurable_variations":
    [
        {
            "sku": "Configurable 1-Red-small",
            "color_swatch": "Red",
            "size": "small"
        },
        {
            "sku": "Configurable 1-Red-large",
            "color_swatch": "Red",
            "size": "large"
        },
        {
            "sku": "Configurable 1-Green-small",
            "color_swatch": "Green",
            "size": "small"
        },
        {
            "sku": "Configurable 1-Green-large",
            "color_swatch": "Green",
            "size": "large"
        }
    ],
    "configurable_variation_labels":
    {
        "color_swatch": "Color Swatch",
        "size": "Size"
    }
}