Brands

Get brand

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

404

Brand was not found

application/json

500

An internal server error was thrown

application/json

get/brands/{id}

HTTPcURLJavaScriptPython

GET /api/sales/brands/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "active": true,
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ]
}

Update brand

put

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

namestringObrigatório

activebooleanObrigatório

Respostas

200

Brand updated successfully

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/brands/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/brands/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "name": "text",
  "active": true,
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "active": true,
  "image": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ]
}

Remove brand

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

Brand removed successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete/brands/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/brands/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text"
}

List brand

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Brand was not found

application/json

500

An internal server error was thrown

application/json

get/brands

HTTPcURLJavaScriptPython

GET /api/sales/brands HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "resource_file_id": "text",
      "active": true
    }
  ]
}

Create brand

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

namestringObrigatório

activebooleanObrigatório

Respostas

201

Brand created successfully

application/json

idstringOpcional

namestringOpcional

activebooleanOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/brands

HTTPcURLJavaScriptPython

POST /api/sales/brands HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "id": "text",
  "name": "text",
  "active": true,
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "active": true,
  "images": [
    {
      "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
      "main": true
    }
  ]
}