Brands

Get brand

get

Authorizations

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

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/brands/{id}' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

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

OK

Update brand

put

Authorizations

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

Path parameters

idstringrequired

Body

namestringrequired

activebooleanrequired

imagesobject[]required

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.zydon.com.br/api/sales/brands/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "active": true,
    "images": [
      {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "main": true
      }
    ]
  }'

200

422

500

200

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

Brand updated successfully

Remove brand

delete

Authorizations

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

Path parameters

idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.zydon.com.br/api/sales/brands/{id}' \
  --header 'Authorization: Bearer JWT'

204

422

500

204

{
  "id": "text"
}

Brand removed successfully

List brand

get

Authorizations

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

Query parameters

searchstring · default: ""optional

pageinteger · int32 · default: 0optional

perPageinteger · int32 · default: 25optional

sortstring · default: ""optional

dirstring · default: "asc"optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.zydon.com.br/api/sales/brands' \
  --header 'Authorization: Bearer JWT'

200

404

500

200

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

OK

Create brand

post

Authorizations

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

Body

idstringoptional

namestringrequired

activebooleanrequired

imagesobject[]required

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.zydon.com.br/api/sales/brands' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "active": true,
    "images": [
      {
        "resource_file_id": "123e4567-e89b-12d3-a456-426614174000",
        "main": true
      }
    ]
  }'

201

422

500

201

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

Brand created successfully