Update products in catalog

PATCH /catalog/product/

Allows batch updates of products in the catalog, including currency, images and attributes information.

application/json

Body Required

A list of products to update.

products array[object] Required

An array of products to be updated in the catalog.

At least 1 but not more than 500 elements.
Hide products attributes Show products attributes object
- sku string Required
  
  Stock Keeping Unit (SKU).
  
  Minimum length is 1.
- currency string
  
  The currency code for the product's pricing, in ISO 4217 format (e.g., USD, EUR).
  
  Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$.
- title string
  
  The title or name of the product.
- description string
  
  A detailed description of the product.
- images array[string(url)]
  
  URL of the product image.
- attributes array[object]
  
  A list of key-value pairs representing attributes.
  Hide attributes attributes Show attributes attributes object
  
  name string Required
  
  The name of the attribute (e.g., material, size, color).
  
  value string Required
  
  The value of the attribute corresponding to its name (e.g., cotton, red, large).

Responses

200 application/json

Successfully updated products in catalog.
Hide headers attributes Show headers attributes
- X-RateLimit-Limit number
  
  The number of allowed requests in the current period.
- X-RateLimit-Remaining number
  
  The number of remaining requests in the current period.
- X-RateLimit-Retry-After string(datetime)
  
  The date of number of remaining requests will reset.
Hide response attribute Show response attribute object
- updated integer Required
  
  The count of products successfully updated.
400 application/json

Bad request
Hide headers attributes Show headers attributes
- X-RateLimit-Limit number
  
  The number of allowed requests in the current period.
- X-RateLimit-Remaining number
  
  The number of remaining requests in the current period.
- X-RateLimit-Retry-After string(datetime)
  
  The date of number of remaining requests will reset.
Hide response attributes Show response attributes object
- code string Required
  
  An error code that identifies the type of error that occurred.
- message string Required
  
  A message that describes the error condition in a human-readable form.
- data object | array Required
  
  Additional information that can help the caller understand or fix the issue.
404 application/json

Not found
Hide response attributes Show response attributes object
- code string Required
  
  An error code that identifies the type of error that occurred.
- message string Required
  
  A message that describes the error condition in a human-readable form.
- data object | array Required
  
  Additional information that can help the caller understand or fix the issue.
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- code string Required
  
  An error code that identifies the type of error that occurred.
- message string Required
  
  A message that describes the error condition in a human-readable form.
- data object | array Required
  
  Additional information that can help the caller understand or fix the issue.
429 application/json

Too many requests
Hide headers attributes Show headers attributes
- X-RateLimit-Limit number
  
  The number of allowed requests in the current period.
- X-RateLimit-Remaining number
  
  The number of remaining requests in the current period.
- X-RateLimit-Retry-After string(datetime)
  
  The date of number of remaining requests will reset.
Hide response attributes Show response attributes object
- code string Required
  
  An error code that identifies the type of error that occurred.
- message string Required
  
  A message that describes the error condition in a human-readable form.
- data object | array Required
  
  Additional information that can help the caller understand or fix the issue.
500 application/json

Internal server error
Hide response attributes Show response attributes object
- code string Required
  
  An error code that identifies the type of error that occurred.
- message string Required
  
  A message that describes the error condition in a human-readable form.
- data object | array Required
  
  Additional information that can help the caller understand or fix the issue.

PATCH /catalog/product/

curl \
 -X PATCH https://m2e.cloud/api/v1/api/catalog/product/ \
 -H "Content-Type: application/json" \
 -d '{"products":[{"sku":"test-product-SKU","currency":"USD","title":"Wireless Bluetooth Headphones","description":"High-quality wireless Bluetooth headphones with noise-cancelling feature.","images":["https://example.com/product-image.jpg"],"attributes":[{"name":"material","value":"cotton"}]}]}'

Request examples

{
  "products": [
    {
      "sku": "test-product-SKU",
      "currency": "USD",
      "title": "Wireless Bluetooth Headphones",
      "description": "High-quality wireless Bluetooth headphones with noise-cancelling feature.",
      "images": [
        "https://example.com/product-image.jpg"
      ],
      "attributes": [
        {
          "name": "material",
          "value": "cotton"
        }
      ]
    }
  ]
}

Response examples (200)

# Headers
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 90
X-RateLimit-Retry-After: 2022-11-04T13:43:28Z

# Payload
{
  "updated": 10
}

Response examples (400)

[
  {
    "code": null,
    "message": "All array items must match schema"
  },
  {
    "code": null,
    "message": "The required properties (currency) are missing"
  }
]

Response examples (404)

[
  {
    "code": 404,
    "message": "Entity is not found."
  }
]

Response examples (401)

[
  {
    "code": 401,
    "message": "Unauthorized"
  }
]

Response examples (429)

[
  {
    "code": 429,
    "message": "Too many requests."
  }
]

Response examples (500)

[
  {
    "code": 500,
    "message": "Internal server error."
  }
]