Categorias

(GET) por ID

    API Endpoint

        https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}/{marketplacecategoryid}
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}/{marketplacecategoryid}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "id": "string",
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "channel": "string",
  "eanRequired": true,
  "categoryData": {
    "channel": "string",
    "tag": "string",
    "id1": "string",
    "name1": "string",
    "id2": "string",
    "name2": "string",
    "id3": "string",
    "name3": "string",
    "id4": "string",
    "name4": "string",
    "id5": "string",
    "name5": "string",
    "id6": "string",
    "name6": "string",
    "id7": "string",
    "name7": "string",
    "id8": "string",
    "name8": "string"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Categoria pelo ID

Path Parameters

Campo	Tipo	Descrição
marketplace	string	(required) ID do Marketplace
marketplacecategoryid	string	(required) ID da Categoria

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso

(GET) paginado

    API Endpoint

        https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "values": [
    {
      "id": "string",
      "tenant": "string",
      "operator": "string",
      "createDate": "1970-01-01T00:00:00.000000",
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "channel": "string",
      "eanRequired": true,
      "categoryData": {
        "channel": "string",
        "tag": "string",
        "id1": "string",
        "name1": "string",
        "id2": "string",
        "name2": "string",
        "id3": "string",
        "name3": "string",
        "id4": "string",
        "name4": "string",
        "id5": "string",
        "name5": "string",
        "id6": "string",
        "name6": "string",
        "id7": "string",
        "name7": "string",
        "id8": "string",
        "name8": "string"
      },
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "required": true,
          "valueData": [
            {
              "id": "string",
              "name": "string",
              "value": "string",
              "descriptionValue": "string",
              "code": "string",
              "active": true
            }
          ]
        }
      ]
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Categorias paginada

Path Parameters

Campo	Tipo	Descrição
marketplace	string	(required) ID do Marketplace

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso

Query Parameters

Campo	Tipo	Descrição
offset	integer	(optional) indica a partir de onde ocorre um aumento
limit	integer	(optional) indica a quantidade de recursos a serem devolvidos, variando de 10 a no máximo 10
sort	string	(optional) indica por qual atributo a consulta deve ser classificada (lastUpdate ou createDate) (Default lastUpdate)
last_update	string($yyyy-MM-dd'T'HH:mm:ss)	(optional) last update

(POST) /categories

    API Endpoint

        https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "string",
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "channel": "string",
  "eanRequired": true,
  "categoryData": {
    "channel": "string",
    "tag": "string",
    "id1": "string",
    "name1": "string",
    "id2": "string",
    "name2": "string",
    "id3": "string",
    "name3": "string",
    "id4": "string",
    "name4": "string",
    "id5": "string",
    "name5": "string",
    "id6": "string",
    "name6": "string",
    "id7": "string",
    "name7": "string",
    "id8": "string",
    "name8": "string"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "id": "string",
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "channel": "string",
  "eanRequired": true,
  "categoryData": {
    "channel": "string",
    "tag": "string",
    "id1": "string",
    "name1": "string",
    "id2": "string",
    "name2": "string",
    "id3": "string",
    "name3": "string",
    "id4": "string",
    "name4": "string",
    "id5": "string",
    "name5": "string",
    "id6": "string",
    "name6": "string",
    "id7": "string",
    "name7": "string",
    "id8": "string",
    "name8": "string"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Categorias paginada

Path Parameters

Campo	Tipo	Descrição
marketplace	string	(required) ID do Marketplace

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso

(POST) /attributes

    API Endpoint

        https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}/{marketplacecategoryid}/attributes
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}/{marketplacecategoryid}/attributes' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json' \
--data '{
  "attributeData": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "id": "string",
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "channel": "string",
  "eanRequired": true,
  "categoryData": {
    "channel": "string",
    "tag": "string",
    "id1": "string",
    "name1": "string",
    "id2": "string",
    "name2": "string",
    "id3": "string",
    "name3": "string",
    "id4": "string",
    "name4": "string",
    "id5": "string",
    "name5": "string",
    "id6": "string",
    "name6": "string",
    "id7": "string",
    "name7": "string",
    "id8": "string",
    "name8": "string"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Categorias paginada

Path Parameters

Campo	Tipo	Descrição
marketplace	string	(required) ID do Marketplace
marketplacecategoryid	string	(required) ID da Categoria

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso

(PUT) /categories

    API Endpoint

        https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}/{marketplacecategoryid}
            

                
# Here is a curl example

curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/categories/marketplaces/{marketplace}/{marketplacecategoryid}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "string",
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "channel": "string",
  "eanRequired": true,
  "categoryData": {
    "channel": "string",
    "tag": "string",
    "id1": "string",
    "name1": "string",
    "id2": "string",
    "name2": "string",
    "id3": "string",
    "name3": "string",
    "id4": "string",
    "name4": "string",
    "id5": "string",
    "name5": "string",
    "id6": "string",
    "name6": "string",
    "id7": "string",
    "name7": "string",
    "id8": "string",
    "name8": "string"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "id": "string",
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "channel": "string",
  "eanRequired": true,
  "categoryData": {
    "channel": "string",
    "tag": "string",
    "id1": "string",
    "name1": "string",
    "id2": "string",
    "name2": "string",
    "id3": "string",
    "name3": "string",
    "id4": "string",
    "name4": "string",
    "id5": "string",
    "name5": "string",
    "id6": "string",
    "name6": "string",
    "id7": "string",
    "name7": "string",
    "id8": "string",
    "name8": "string"
  },
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "required": true,
      "valueData": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "descriptionValue": "string",
          "code": "string",
          "active": true
        }
      ]
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Categorias paginada

Path Parameters

Campo	Tipo	Descrição
marketplace	string	(required) ID do Marketplace
marketplacecategoryid	string	(required) ID da Categoria

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso