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

​
What happens when a product is queued?

The main difference between this endpoint and Add Product is queuing a product adds the product request to a batch processing queue. The response time for this request is much faster than an Add Product, as the job is submitted instantly. The payload required for this endpoint is identical to the Add Product endpoint. In addition to the above, this endpoint includes the same functionality as Create or Update a Product, where an existing product is searched by external_id which will update the product if found. If no existing product is found, the product is created instead. Product variants follow the same logic, but with their sku instead
Queued products may not be created instantlyThe processing time of products submitted to the queue is subject to the other jobs within the queue. The response will contain no data relating to the product. A product.created or product.updated event will be triggered as each product is processed. Developers can use this to retrieve data relating to the submitted product.

​
When to use Queue Product

Queueing is primarily used for batch importing products. The Queue endpoint allows developers to submit high volumes of products for processing on a batch queue. This is usually done by the developer by looping through products on the external system, and sending them to the Queue Product endpoint.

​
When not to use Queue Product

If response data is required after submitting the request to this endpoint. Queue Product will return a 200 response ‘OK’ with every successful submission. This will not contain any information about the submitted product. If response data is required for population on a website or internal system, use the Add Product endpoint instead If products need to be created immediately, this endpoint is not suitable. All products submitted via this endpoint are subject to the other jobs on the queue. Because of this, Omneo cannot guarantee the time of creation.

Body

application/json
​
external_id
string
required
​
title
string
​
handle
string
​
type
enum<string> | null
Available options:
appointment,
simple,
configurable,
downloadable,
gift,
bundle,
voucher,
service,
subscription
​
status
enum<string>
Available options:
new,
active,
rundown,
discontinued,
ranged,
deleted,
archived,
draft
​
brand
string
​
description
string | null
​
web_url
string | null
​
currency
string | null
​
position
integer
​
department
string | null
​
meta
string[] | null
​
archive_existing_variants
boolean | null
​
systems
string[]
Minimum array length: 1
​
channels
string[]
Minimum array length: 1
​
tags
string[]
​
images
object[]
​
variants
object[]
Minimum array length: 1
​
custom_fields
object[]

Response

​
data
string
required
Allowed value: "OK"