Skip to main content
POST
/
api
/
v1
/
:team_slug
/
:app_slug
/
omnichannels
Error
A valid request URL is required to generate request examples
{
  "data": {
    "created_at": "<string>",
    "field_type": "<string>",
    "id": "<string>",
    "market_id": "<string>",
    "parent_id": "<string>",
    "parent_type": "<string>",
    "preview": [
      "<string>"
    ],
    "relationships": [
      "<string>"
    ],
    "store_group_id": "<string>",
    "updated_at": "<string>",
    "value": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
team_slug
string
required

Team slug

​
app_slug
string
required

App slug

Body

application/json

Omnichannel data

​
field_type
enum<string>
required

Defines the type of field: text types (name, description, etc.) require a 'value', relationship types (category, collection, etc.) require 'relationships' array

Available options:
name,
description,
short_description,
meta_description,
slug,
meta_title,
html_description,
html_short_description,
category,
collection,
tag,
attribute,
image
​
parent_id
string
required
​
parent_type
enum<string>
required
Available options:
product,
variant,
translation
​
store_group_id
string
required
​
market_id
string
​
relationships
string[]

Set the new relationships for this omnichannel. This will remove the old ones and add the relationships which exists in the array. The priority will be the order in the array

​
value
string

Response

OK

​
data
object
​
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

​
success
boolean