Skip to main content
POST
/
v3
/
products
/
batch.json
Batch Products
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/products/batch.json \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {
      "handle": "<string>",
      "title": "<string>",
      "external_id": "<string>",
      "brand": "<string>",
      "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>",
          "value": "<string>"
        }
      ]
    }
  ],
  "import_job_id": "<string>"
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/products/batch.json"

payload = {
"products": [
{
"handle": "<string>",
"title": "<string>",
"external_id": "<string>",
"brand": "<string>",
"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>",
"value": "<string>"
}
]
}
],
"import_job_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
products: [
{
handle: '<string>',
title: '<string>',
external_id: '<string>',
brand: '<string>',
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>', value: '<string>'}]
}
],
import_job_id: '<string>'
})
};

fetch('https://api.{tenant}.getomneo.com/api/v3/products/batch.json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/products/batch.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'products' => [
[
'handle' => '<string>',
'title' => '<string>',
'external_id' => '<string>',
'brand' => '<string>',
'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>',
'value' => '<string>'
]
]
]
],
'import_job_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.{tenant}.getomneo.com/api/v3/products/batch.json"

payload := strings.NewReader("{\n \"products\": [\n {\n \"handle\": \"<string>\",\n \"title\": \"<string>\",\n \"external_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"position\": 123,\n \"systems\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"department\": \"<string>\",\n \"web_url\": \"<string>\",\n \"images\": [\n {\n \"url\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"archive_existing_variants\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"variants\": [\n {\n \"id\": 123,\n \"title\": \"<string>\",\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"available_quantity\": 123,\n \"price\": 123,\n \"images\": [\n {\n \"url\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"price_discounted\": 123,\n \"price_comparison\": 123,\n \"price_cost\": 123,\n \"position\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"meta\": [\n \"<string>\"\n ]\n }\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"import_job_id\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/products/batch.json")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"handle\": \"<string>\",\n \"title\": \"<string>\",\n \"external_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"position\": 123,\n \"systems\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"department\": \"<string>\",\n \"web_url\": \"<string>\",\n \"images\": [\n {\n \"url\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"archive_existing_variants\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"variants\": [\n {\n \"id\": 123,\n \"title\": \"<string>\",\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"available_quantity\": 123,\n \"price\": 123,\n \"images\": [\n {\n \"url\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"price_discounted\": 123,\n \"price_comparison\": 123,\n \"price_cost\": 123,\n \"position\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"meta\": [\n \"<string>\"\n ]\n }\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/products/batch.json")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"handle\": \"<string>\",\n \"title\": \"<string>\",\n \"external_id\": \"<string>\",\n \"brand\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"position\": 123,\n \"systems\": [\n \"<string>\"\n ],\n \"channels\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"department\": \"<string>\",\n \"web_url\": \"<string>\",\n \"images\": [\n {\n \"url\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"archive_existing_variants\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"variants\": [\n {\n \"id\": 123,\n \"title\": \"<string>\",\n \"sku\": \"<string>\",\n \"description\": \"<string>\",\n \"available_quantity\": 123,\n \"price\": 123,\n \"images\": [\n {\n \"url\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"price_discounted\": 123,\n \"price_comparison\": 123,\n \"price_cost\": 123,\n \"position\": 123,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sort_order\": 123\n }\n ],\n \"meta\": [\n \"<string>\"\n ]\n }\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"import_job_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "batch_id": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"errors": {}
}

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