COconstructor
Items

Update items

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(w), search_suggestions(w).

Update existing item data. Data included in the request will be merged with data of the existing items. Returns an identifier for a background task.

patch/v2/items

Request

  • Base URL
    https://ac.cnstrc.com
  • URL
    https://ac.cnstrc.com/v2/items
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90
forceboolean

A flag to process the catalog even if it will invalidate a large part of existing data. Defaults to False.

notification_emailstring[]

The email address(es) to send a notification to if the task fails. Multiple addresses may be specified for multiple recipients.

[
  "user@example.com"
]
on_missing'CREATE' | 'IGNORE' | 'FAIL'

Request body

Example request

{
  "items": [
    {
      "id": "nike-shoes",
      "name": "Running Shoes",
      "suggested_score": 100,
      "data": {
        "keywords": [
          "running"
        ],
        "url": "http://www.example.com/product/123",
        "image_url": "http://www.example.com/images/product.jpg",
        "group_ids": [
          "shoes"
        ],
        "description": "A comfortable running shoe with cushioned sole",
        "active": true
      }
    }
  ]
}

Response

OK

task_idinteger required
task_status_pathstring required

Changes

No recorded changes to this operation across all 1 revision of this API.