Upsert SKUs

curl -X POST 'https://product.api.e-cross.tech/ext/merchant/skus' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "skuId": "1234567890",
      "productId": "1234567",
      "main": true,
      "name": "USB charger type C",
      "description": "Beautiful and reliable super fast USB Type C charger.\nCharge your phone as never before!",
      "weight": 0.100,
      "height": 4,
      "width": 4,
      "length": 19,
      "ean": "0799439112766",
      "countryOfOrigin": "CN",
      "hscode": "850440",
      "hscodes": [
        {
          "country": "BR",
          "hscode": "85044090"
        },
        {
          "country": "PT",
          "hscode": "85044095"
        }
      ],
      "localizedListPriceWithTaxes": 9.99,
      "localizedSalePriceWithTaxes": 8.00,
      "globalSaleChannelData": {
        "active": true,
        "tags": ["featured", "summer-sale"],
        "brand": "ChargerW",
        "size": "2 meters",
        "color": "silver",
        "category": "Telefones e Celulares/Acessórios/Carregadores",
        "attributes": [
          {
            "name": "Connection Type",
            "value": "USB-C"
          }
        ]
      },
      "images": [
        "https://image-host/1234567/1.jpeg",
        "https://image-host/1234567/2.jpeg"
      ]
    }
  ]'

[
  {
    "skuId": "1234567890",
    "productId": "1234567",
    "main": true,
    "name": "USB charger type C",
    "description": "Beautiful and reliable super fast USB Type C charger.\nCharge your phone as never before!",
    "weight": 0.1,
    "height": 4,
    "width": 4,
    "length": 19,
    "ean": "0799439112766",
    "countryOfOrigin": "CN",
    "hscode": "850440",
    "hscodes": [
      {
        "country": "BR",
        "hscode": "85044090"
      },
      {
        "country": "PT",
        "hscode": "85044095"
      }
    ],
    "globalSaleChannelData": {
      "active": true,
      "tags": ["featured", "summer-sale"],
      "brand": "ChargerW",
      "size": "2 meters",
      "color": "silver",
      "category": "Telefones e Celulares/Acessórios/Carregadores",
      "attributes": [
        {
          "name": "Connection Type",
          "value": "USB-C"
        }
      ]
    },
    "images": [
      "https://image-host/1234567/1.jpeg",
      "https://image-host/1234567/2.jpeg"
    ],
    "salesChannelStatus": {},
    "localizationStatus": "PENDING_LOCALIZATION"
  }
]

All the variations (SKUs) of a product must be sent together in the same request, even if only one SKU is being updated. SKUs not included in the request will be considered DELETED from the product and will be removed the connected sales channels.

curl -X POST 'https://product.api.e-cross.tech/ext/merchant/skus' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "skuId": "1234567890",
      "productId": "1234567",
      "main": true,
      "name": "USB charger type C",
      "description": "Beautiful and reliable super fast USB Type C charger.\nCharge your phone as never before!",
      "weight": 0.100,
      "height": 4,
      "width": 4,
      "length": 19,
      "ean": "0799439112766",
      "countryOfOrigin": "CN",
      "hscode": "850440",
      "hscodes": [
        {
          "country": "BR",
          "hscode": "85044090"
        },
        {
          "country": "PT",
          "hscode": "85044095"
        }
      ],
      "localizedListPriceWithTaxes": 9.99,
      "localizedSalePriceWithTaxes": 8.00,
      "globalSaleChannelData": {
        "active": true,
        "tags": ["featured", "summer-sale"],
        "brand": "ChargerW",
        "size": "2 meters",
        "color": "silver",
        "category": "Telefones e Celulares/Acessórios/Carregadores",
        "attributes": [
          {
            "name": "Connection Type",
            "value": "USB-C"
          }
        ]
      },
      "images": [
        "https://image-host/1234567/1.jpeg",
        "https://image-host/1234567/2.jpeg"
      ]
    }
  ]'

[
  {
    "skuId": "1234567890",
    "productId": "1234567",
    "main": true,
    "name": "USB charger type C",
    "description": "Beautiful and reliable super fast USB Type C charger.\nCharge your phone as never before!",
    "weight": 0.1,
    "height": 4,
    "width": 4,
    "length": 19,
    "ean": "0799439112766",
    "countryOfOrigin": "CN",
    "hscode": "850440",
    "hscodes": [
      {
        "country": "BR",
        "hscode": "85044090"
      },
      {
        "country": "PT",
        "hscode": "85044095"
      }
    ],
    "globalSaleChannelData": {
      "active": true,
      "tags": ["featured", "summer-sale"],
      "brand": "ChargerW",
      "size": "2 meters",
      "color": "silver",
      "category": "Telefones e Celulares/Acessórios/Carregadores",
      "attributes": [
        {
          "name": "Connection Type",
          "value": "USB-C"
        }
      ]
    },
    "images": [
      "https://image-host/1234567/1.jpeg",
      "https://image-host/1234567/2.jpeg"
    ],
    "salesChannelStatus": {},
    "localizationStatus": "PENDING_LOCALIZATION"
  }
]

Request Body Parameters

string

required

The SKU identifier provided by the merchant. Must be unique within your catalog.

string

required

The product identifier that groups all SKUs together. All SKUs with the same productId must be sent in the same request.

boolean

required

Indicates if this SKU is the main variation among all SKUs of the product. The main SKU is generally used by sales channels to display product information in product listing pages.

string

required

The title of the SKU in the original language.

string

required

The description of the SKU in the original language.

It’s recommended to have the same description for all SKUs of the same product due to limitations on sales channels.

number

required

The weight of the SKU in kilograms.

integer

required

The height of the SKU in centimeters.

integer

required

The width of the SKU in centimeters.

integer

required

The length of the SKU in centimeters.

string

required

EAN-13, UPS, ISBN, etc.

string

Two-letter ISO 3166-1 alpha-2 code for the country where the SKU was manufactured or produced, such as CN, BR, or US.

string

General HS Code of the SKU. e-CROSS uses this value as a fallback when hscodes does not contain an entry for the destination country.If you are in doubt about the HS Code, check it on World Customs Organization Trade Tools.

array

Country-specific HS Codes of the SKU. For each destination country, e-CROSS uses the matching entry from this array. When no matching entry exists, e-CROSS falls back to the general hscode value.

Show hscodes properties

string

required

Two-letter country code for which the HS Code applies, such as BR or PT.

string

required

HS Code used for customs, duties, taxes, and import/export processing in the specified country.

number

deprecated

This field is deprecated and will be removed in the future. Use the Update Price (Origin) API or Update Price (Destination) API to update the price instead.

List price of the SKU, in the merchant currency. This is the “origin list price” that will be used as the basis price for the localization process.

number

deprecated

This field is deprecated and will be removed in the future. Use the Update Price (Origin) API or Update Price (Destination) API to update the price instead.

Sale price of the SKU, in the merchant currency. This is the “origin sale price” that will be used as the basis price for the localization process.

object

required

Sales channel data used to map SKU data to all connected sales channels.

Show globalSaleChannelData properties

boolean

required

Boolean indicating if the SKU is active/inactive in the sales channels.

array

Tags associated with the SKU. Each tag must contain at least one non-whitespace character and cannot contain commas. Send an empty array to remove all tags.

string

required

Sales channel category in which the SKU should be published. This category is used as a reference for mapping with each sales channel’s specific categories.

string

Color of the variation in the original language.

string

Size of the variation in the original language.

string

required

Name of the brand of the product in the original language.

array

List of custom attributes of the product (maximum of 10 attributes). Each attribute contains:

name: name of the attribute
value: value of the attribute

array

required

Array containing URLs for the images of the SKU. Images should be publicly accessible.

Response Fields

All the fields from the request body are returned in the response, plus the following fields:

string

The unique identifier of the SKU within e-CROSS.

string

The unique identifier of the merchant in e-CROSS.

string

Status of the localization process. Can be one of:

PENDING_LOCALIZATION: The SKU is queued for localization processing (default status for newly created SKUs)
REVIEW_DENIED: The localization review was denied due to incomplete or incorrect data (title, description, color, size,..)
DENIED_REGULATORY: The SKU was denied due to regulatory compliance issues
READY_FOR_SALES_CHANNEL: Localization is complete and the SKU is ready to be published to sales channels
LOCALIZATION_SKIPPED: Localization was skipped (when automatic localization is disabled)

Besides the status above, if any other status is returned it should be threated as the localization process is still in progress.

object

A complex object (Record) where the key is the sales channel identifier within e-CROSS and the value contains the specific sales channel integration status.

Show salesChannelStatus properties

string

Status in the sales channel. Can be one of:

READY_FOR_SALES_CHANNEL: Pending integration with the sales channel
SALES_CHANNEL_APPROVED: Integration with sales channel was successful
SALES_CHANNEL_DENIED: Sales channel refused the integration

string

Date when the status was set for the SKU.

string

Additional message related to the status.

Overview

Authentication APIs

Sales Channel APIs

Merchant Catalog APIs

Order APIs

Shipment APIs

Parcel APIs

Sandbox APIs

Request Body Parameters

Response Fields

​Request Body Parameters

​Response Fields

Request Body Parameters

Response Fields