Uptime serviços Zydon

Categories

Get category

get
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
200
OK
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,
  "is_solution_specific": true,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "category_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "solutions": [
    "text"
  ],
  "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
is_solution_specificbooleanOpcional
solutionsstring[]Opcional
image_resource_idstringOpcional
Respostas
200
Category updated successfully
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: 390

{
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "is_solution_specific": true,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "solutions": [
    "text"
  ],
  "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,
  "is_solution_specific": true,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "category_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "solutions": [
    "text"
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remove an existing category

delete
Autorizações
Parâmetros de rota
idstringObrigatório
Respostas
204
Category removed successfully
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
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": {}
      }
    }
  ]
}

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
is_solution_specificbooleanOpcional
solutionsstring[]Opcional
image_resource_idstringOpcional
Respostas
201
Category created successfully
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: 402

{
  "id": "text",
  "root_id": "text",
  "name": "text",
  "active": true,
  "characteristics": "text",
  "seo_title": "text",
  "seo_description": "text",
  "seo_meta_keywords": [
    "text"
  ],
  "is_solution_specific": true,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "solutions": [
    "text"
  ],
  "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,
  "is_solution_specific": true,
  "specifications": [
    {
      "name": "text",
      "items": [
        {
          "id": "text",
          "category_id": "text",
          "name": "text",
          "type": "text",
          "values": [
            "text"
          ],
          "is_searchable": true
        }
      ]
    }
  ],
  "solutions": [
    "text"
  ],
  "image_resource_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}