Skip to main content
POST
/
v3
/
products
/
batch.json
Batch Products
curl --request POST \
  --url http://localhost/api/v3/products/batch.json \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {
      "handle": "<string>",
      "title": "<string>",
      "external_id": "<string>",
      "status": "new",
      "brand": "<string>",
      "type": "appointment",
      "description": "<string>",
      "currency": "<string>",
      "position": 123,
      "systems": [
        "<string>"
      ],
      "channels": [
        "<string>"
      ],
      "tags": [
        "<string>"
      ],
      "department": "<string>",
      "web_url": "<string>",
      "images": [
        {
          "url": "<string>",
          "sort_order": 123
        }
      ],
      "archive_existing_variants": true,
      "meta": [
        "<string>"
      ],
      "variants": [
        {
          "id": 123,
          "title": "<string>",
          "sku": "<string>",
          "description": "<string>",
          "available_quantity": 123,
          "price": 123,
          "images": [
            {
              "url": "<string>",
              "sort_order": 123
            }
          ],
          "price_discounted": 123,
          "price_comparison": 123,
          "price_cost": 123,
          "position": 123,
          "tags": [
            "<string>"
          ],
          "options": [
            {
              "name": "<string>",
              "value": "<string>",
              "sort_order": 123
            }
          ],
          "meta": [
            "<string>"
          ]
        }
      ],
      "custom_fields": [
        {
          "namespace": "<string>",
          "handle": "<string>",
          "type": "string",
          "value": "<string>"
        }
      ]
    }
  ],
  "import_job_id": "<string>"
}
'
{
  "message": "<string>",
  "batch_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
products
object[]
required
Required array length: 1 - 500 elements
import_job_id
string

Response

message
string
required
Allowed value: "Queued for processing."
batch_id
string
required