⚡
Zydon
Uptime serviços Zydon
  • Bem-vindo à Zydon
  • Quickstart
    • Chaves de acesso
    • Autenticação
  • Cadastros Gerais
    • Profiles
      • Import
      • Get import spreadsheet
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Companies
      • Import
      • Get import spreadsheet
    • Resource files
      • Details
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
  • Produtos
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Prices
      • Product
        • Calculate
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Discounts
      • Products
    • Price tables
      • Copy
      • Products
    • Warehouses
      • Import
      • Get import spreadsheet
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Portal User Search
      • User
        • Search
  • Pedidos
    • Payment groups
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Status
    • Coupons
      • Manual
      • Automatic
    • Sales
      • Statuses
        • Available
  • Financeiro
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
  • Webhooks
    • Sincronização de dados
    • Envio de Pedido
    • Cadastro de Parceiro
  • About
  • API reference
    • Warehouses
      • Import
      • Get import spreadsheet
    • Variations
      • Values
      • Import
      • Get import spreadsheet
    • Status
    • Sellers
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Partners
    • Profiles
      • Import
      • Get import spreadsheet
    • Products
      • Variations
        • Import
        • Get import spreadsheet
      • Specification
        • Import
        • Get import spreadsheet
      • Images
      • Enable
      • Disable
      • Alternative units
        • Import
        • Get import spreadsheet
      • Search
        • Synchronize
        • Status
      • Main images
      • Import
      • Get import spreadsheet
      • Generate sku code
      • Similar
      • Recommended
      • Image
      • Analysis
        • Most sold
        • Highlight
    • Price tables
      • Copy
      • Products
    • Payment methods
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
    • Payment groups
    • Partners
      • Sellers
        • Import
        • Get import spreadsheet
      • Contact
      • Address
        • Import
        • Get import spreadsheet
      • Enable
      • Disable
      • Query
      • Import
      • Get import spreadsheet
      • Analysis
    • Orders
      • Items
        • Import
        • Get import spreadsheet
      • Payments
        • Import
        • Get import spreadsheet
      • Joint
      • Attachments
      • Report
      • Invoices
      • Import
      • Get import spreadsheet
      • Status
      • Summary
    • Measure units
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Description
    • Financials
      • Attachments
      • Import
      • Get import spreadsheet
      • Order
    • Discounts
      • Products
    • Coupons
      • Manual
      • Automatic
    • Companies
      • Import
      • Get import spreadsheet
    • Categories
      • Order
      • Enable
      • Disable
      • Specification
        • Import
        • Get import spreadsheet
      • Import
      • Get import spreadsheet
      • Image
      • Has products
      • Tree
    • Brands
      • Enable
      • Disable
      • Import
      • Get import spreadsheet
      • Image
    • Sales
      • Statuses
        • Available
    • Resource files
      • Details
    • Stock
      • Enable
      • Disable
      • Override
      • Movement
      • Query
    • Sales funnel
    • Template
      • Validate
      • Install
      • Export
    • Home
      • Sales
      • Sales by period
      • Products
      • Users
    • Prices
      • Product
        • Calculate
  • Specification
  • About
  • Specification
Fornecido por GitBook
Nesta página
  1. Produtos

Categories

Remove an existing category

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Category removed successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
delete
DELETE /api/sales/categories/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text"
}

List categories

get
Autorizações
Parâmetros de consulta
root_idstringOpcional
searchstringOpcionalDefault: ""
pageinteger · int32OpcionalDefault: 0
perPageinteger · int32OpcionalDefault: 25
sortstringOpcionalDefault: ""
dirstringOpcionalDefault: asc
only_activebooleanOpcionalDefault: false
Respostas
200
OK
application/json
404
Category was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/categories HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "root_id": "text",
      "name": "text",
      "active": true,
      "characteristics": "text",
      "seo_title": "text",
      "seo_description": "text",
      "seo_meta_keywords": [
        "text"
      ],
      "order": 1,
      "image_resource_id": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}
  • GETGet category
  • PUTUpdate an existing category
  • DELETERemove an existing category
  • GETList categories
  • POSTCreate a new category

Get category

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
application/json
404
Category was not found
application/json
500
An internal server error was thrown
application/json
get
GET /api/sales/categories/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Accept: */*
{
  "id": "text",
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "order": 1,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "category_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update an existing category

put
Autorizações
Parâmetros de rota
idstringObrigatório
Corpo
root_idstringObrigatório
namestringObrigatório
activebooleanObrigatório
characteristicsstringOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
image_resource_idstringOpcional
Respostas
200
Category updated successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
put
PUT /api/sales/categories/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 341

{
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "id": "text",
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "order": 1,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "category_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Create a new category

post
Autorizações
Corpo
idstringOpcional
root_idstringObrigatório
namestringObrigatório
activebooleanObrigatório
characteristicsstringOpcional
seo_titlestringOpcional
seo_descriptionstringOpcional
seo_meta_keywordsstring[]Opcional
image_resource_idstringOpcional
Respostas
201
Category created successfully
application/json
422
A validation error was thrown
application/json
500
An internal server error was thrown
application/json
post
POST /api/sales/categories HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "id": "text",
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "id": "text",
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "order": 1,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "category_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}