Product update (or creation)

POST /products

This endpoint is used for all data manipulation with products - creating, updating, removing and also for updating specific values of stocks, prices and mapping to each of the marketplaces

Create a new product

application/json

Body Required

productSetId integer(int64)
itemgroupId string
currency string

ISO currency code
remoteId string Required
ean string Required
brand string
isActive boolean
isAvailable boolean
vat number(float)
price object
Hide price attributes Show price attributes object
- sellingPrice number(float)
- buyPrice number(float)
- forcedPrice number(float)
- salePrice number(float)
- currency string
  
  ISO currency code
- strategies array[object]
  Hide strategies attributes Show strategies attributes object
  
  remoteId string
  
  productSetId integer
  
  pricingStrategy array[object]
  
  Hide pricingStrategy attributes Show pricingStrategy attributes object
  
  price number(float)
  
  currency string
  
  ISO currency code
  
  connectorId string
images array[object]
Hide images attributes Show images attributes object
- id number(int)
- imageType string
  
  Values are basic_image, information_list, energy_label, or size_table.
- source string
- isMain boolean
  
  Default value is false.
- isActive boolean
  
  Default value is true.
- ranking number(int)
categories array[object]
Hide categories attribute Show categories attribute object
- source array[object]
  Hide source attributes Show source attributes object
  
  title string
  
  slug string
  
  remoteId number
translations array[object]
Hide translations attributes Show translations attributes object
- languageCode string
- title string
- shortDescription string
- description string
parameters array[object]
Hide parameters attributes Show parameters attributes object
- languageCode string
- paramName string
- paramValues array[string]
stock array[object]
Hide stock attributes Show stock attributes object
- availableStock number(float)
- inOurWarehouseAvailableStock number(float)
- realStock number(float)
- strategies array[object]
  Hide strategies attributes Show strategies attributes object
  
  stock number(float)
  
  connectorId string
deliveryDelay integer(int64)
weight string

Weight in your defined unit (defaults to Kg)
width string

Width in your defined unit (defaults to cm)
height string

Height in your defined unit (defaults to cm)
length string

Length in your defined unit (defaults to cm)
packageType string

Type of the package. One of S/M/L/XL
packageSize string

Size of the package. One of smallbox/bigbox

Responses

200 application/json

all products are returned with default page limit of 1000 items
Hide response attributes Show response attributes object
- productSetId integer(int64)
- itemgroupId string
- currency string
  
  ISO currency code
- remoteId string Required
- ean string Required
- brand string
- isActive boolean
- isAvailable boolean
- vat number(float)
- price object
  
  Hide price attributes Show price attributes object
  
  sellingPrice number(float)
  
  buyPrice number(float)
  
  forcedPrice number(float)
  
  salePrice number(float)
  
  currency string
  
  ISO currency code
  
  strategies array[object]
  
  Hide strategies attributes Show strategies attributes object
  
  remoteId string
  
  productSetId integer
  
  pricingStrategy array[object]
  
  Hide pricingStrategy attributes Show pricingStrategy attributes object
  
  price number(float)
  
  currency string
  
  ISO currency code
  
  connectorId string
- images array[object]
  
  Hide images attributes Show images attributes object
  
  id number(int)
  
  imageType string
  
  Values are basic_image, information_list, energy_label, or size_table.
  
  source string
  
  isMain boolean
  
  Default value is false.
  
  isActive boolean
  
  Default value is true.
  
  ranking number(int)
- categories array[object]
  
  Hide categories attribute Show categories attribute object
  
  source array[object]
  
  Hide source attributes Show source attributes object
  
  title string
  
  slug string
  
  remoteId number
- translations array[object]
  
  Hide translations attributes Show translations attributes object
  
  languageCode string
  
  title string
  
  shortDescription string
  
  description string
- parameters array[object]
  
  Hide parameters attributes Show parameters attributes object
  
  languageCode string
  
  paramName string
  
  paramValues array[string]
- stock array[object]
  
  Hide stock attributes Show stock attributes object
  
  availableStock number(float)
  
  inOurWarehouseAvailableStock number(float)
  
  realStock number(float)
  
  strategies array[object]
  
  Hide strategies attributes Show strategies attributes object
  
  stock number(float)
  
  connectorId string
- deliveryDelay integer(int64)
- weight string
  
  Weight in your defined unit (defaults to Kg)
- width string
  
  Width in your defined unit (defaults to cm)
- height string
  
  Height in your defined unit (defaults to cm)
- length string
  
  Length in your defined unit (defaults to cm)
- packageType string
  
  Type of the package. One of S/M/L/XL
- packageSize string
  
  Size of the package. One of smallbox/bigbox

POST /products

curl \
 --request POST 'api.services.omnicado.com/api/v2/products' \
 --header "X-OMNICADO-TOKEN: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"productSetId":42,"itemgroupId":"string","currency":"CZK","remoteId":"H839941","ean":"0764502620","brand":"Amazon","isActive":true,"isAvailable":true,"vat":21.0,"price":{"sellingPrice":42.0,"buyPrice":42.0,"forcedPrice":42.0,"salePrice":42.0,"currency":"CZK","strategies":[{"remoteId":"H1234443","productSetId":1234,"pricingStrategy":[{"price":129.0,"currency":"CZK","connectorId":"mallCz"}]}]},"images":[{"id":42.0,"imageType":"basic_image","source":"https://image.eshop.cz/1.jpg","isMain":false,"isActive":true,"ranking":2}],"categories":[{"source":[{"title":"Domácnost a zahrada","slug":"domacnost-a-zahrada","remoteId":123}]}],"translations":[{"languageCode":"cs_CZ","title":"Produkt v češtině","shortDescription":"Popis v češtině","description":"Dlouhý popis v češtině"}],"parameters":[{"languageCode":"cs_CZ","paramName":"Barva","paramValues":["Černá","Fialová"]}],"stock":[{"availableStock":2.0,"inOurWarehouseAvailableStock":3.0,"realStock":5.0,"strategies":[{"stock":4.0,"connectorId":"mallCz"}]}],"deliveryDelay":42,"weight":"1.2","width":"30.2","height":"40.3","length":"50.1","packageType":"M","packageSize":"smallbox"}'

Request examples

{
  "productSetId": 42,
  "itemgroupId": "string",
  "currency": "CZK",
  "remoteId": "H839941",
  "ean": "0764502620",
  "brand": "Amazon",
  "isActive": true,
  "isAvailable": true,
  "vat": 21.0,
  "price": {
    "sellingPrice": 42.0,
    "buyPrice": 42.0,
    "forcedPrice": 42.0,
    "salePrice": 42.0,
    "currency": "CZK",
    "strategies": [
      {
        "remoteId": "H1234443",
        "productSetId": 1234,
        "pricingStrategy": [
          {
            "price": 129.0,
            "currency": "CZK",
            "connectorId": "mallCz"
          }
        ]
      }
    ]
  },
  "images": [
    {
      "id": 42.0,
      "imageType": "basic_image",
      "source": "https://image.eshop.cz/1.jpg",
      "isMain": false,
      "isActive": true,
      "ranking": 2
    }
  ],
  "categories": [
    {
      "source": [
        {
          "title": "Domácnost a zahrada",
          "slug": "domacnost-a-zahrada",
          "remoteId": 123
        }
      ]
    }
  ],
  "translations": [
    {
      "languageCode": "cs_CZ",
      "title": "Produkt v češtině",
      "shortDescription": "Popis v češtině",
      "description": "Dlouhý popis v češtině"
    }
  ],
  "parameters": [
    {
      "languageCode": "cs_CZ",
      "paramName": "Barva",
      "paramValues": [
        "Černá",
        "Fialová"
      ]
    }
  ],
  "stock": [
    {
      "availableStock": 2.0,
      "inOurWarehouseAvailableStock": 3.0,
      "realStock": 5.0,
      "strategies": [
        {
          "stock": 4.0,
          "connectorId": "mallCz"
        }
      ]
    }
  ],
  "deliveryDelay": 42,
  "weight": "1.2",
  "width": "30.2",
  "height": "40.3",
  "length": "50.1",
  "packageType": "M",
  "packageSize": "smallbox"
}

Response examples (200)

{
  "productSetId": 42,
  "itemgroupId": "string",
  "currency": "CZK",
  "remoteId": "H839941",
  "ean": "0764502620",
  "brand": "Amazon",
  "isActive": true,
  "isAvailable": true,
  "vat": 21.0,
  "price": {
    "sellingPrice": 42.0,
    "buyPrice": 42.0,
    "forcedPrice": 42.0,
    "salePrice": 42.0,
    "currency": "CZK",
    "strategies": [
      {
        "remoteId": "H1234443",
        "productSetId": 1234,
        "pricingStrategy": [
          {
            "price": 129.0,
            "currency": "CZK",
            "connectorId": "mallCz"
          }
        ]
      }
    ]
  },
  "images": [
    {
      "id": 42.0,
      "imageType": "basic_image",
      "source": "https://image.eshop.cz/1.jpg",
      "isMain": false,
      "isActive": true,
      "ranking": 2
    }
  ],
  "categories": [
    {
      "source": [
        {
          "title": "Domácnost a zahrada",
          "slug": "domacnost-a-zahrada",
          "remoteId": 123
        }
      ]
    }
  ],
  "translations": [
    {
      "languageCode": "cs_CZ",
      "title": "Produkt v češtině",
      "shortDescription": "Popis v češtině",
      "description": "Dlouhý popis v češtině"
    }
  ],
  "parameters": [
    {
      "languageCode": "cs_CZ",
      "paramName": "Barva",
      "paramValues": [
        "Černá",
        "Fialová"
      ]
    }
  ],
  "stock": [
    {
      "availableStock": 2.0,
      "inOurWarehouseAvailableStock": 3.0,
      "realStock": 5.0,
      "strategies": [
        {
          "stock": 4.0,
          "connectorId": "mallCz"
        }
      ]
    }
  ],
  "deliveryDelay": 42,
  "weight": "1.2",
  "width": "30.2",
  "height": "40.3",
  "length": "50.1",
  "packageType": "M",
  "packageSize": "smallbox"
}