Marcas

(GET) por ID

    API Endpoint

        https://api.omnik.io/HUB/v1/brands/{id}
            

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

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "brandData": {
    "id": "string",
    "code": "string",
    "name": "string"
  }
}
                
            

                
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 Marca pelo ID

Path Parameters

Campo	Tipo	Descrição
id	string	(required) ID da Marca

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

(GET) paginado

    API Endpoint

        https://api.omnik.io/HUB/v1/brands
            

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

                
Result example 2xx:

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "sort": "string",
  "values": [
    {
      "tenant": "string",
      "operator": "string",
      "createDate": "1970-01-01T00:00:00.000000",
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "brandData": {
        "id": "string",
        "code": "string",
        "name": "string"
      }
    }
  ]
}
                
            

                
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 Marcas paginada

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

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) /brands

    API Endpoint

        https://api.omnik.io/HUB/v1/brands
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/HUB/v1/brands' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "tenant": "string",
  "brandData": {
    "code": "string",
    "name": "string"
  }
}'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "brandData": {
    "code": "string",
    "name": "string"
  }
}
                
            

                
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"
    }
  ]
}
                
            

Cadastro de Marca

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

(PUT) /brands

    API Endpoint

        https://api.omnik.io/HUB/v1/brands/{id}
            

                
# Here is a curl example

curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/brands/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "tenant": "string",
  "brandData": {
    "name": "string"
  }
}'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "brandData": {
    "code": "string",
    "name": "string"
  }
}
                
            

                
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"
    }
  ]
}
                
            

Alteração de Marca por ID

Path Parameters

Campo	Tipo	Descrição
id	string	(required) ID da Marca

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)