Categories

Get category

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

root_idstringOpcional

namestringOpcional

activebooleanOpcional

characteristicsstringOpcional

seo_titlestringOpcional

seo_descriptionstringOpcional

seo_meta_keywordsstring[]Opcional

ordernumberOpcional

image_resource_idstringOpcional

404

Category was not found

application/json

500

An internal server error was thrown

application/json

get/categories/{id}

HTTPcURLJavaScriptPython

GET /api/sales/categories/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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

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

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

idstringOpcional

root_idstringOpcional

namestringOpcional

activebooleanOpcional

characteristicsstringOpcional

seo_titlestringOpcional

seo_descriptionstringOpcional

seo_meta_keywordsstring[]Opcional

ordernumberOpcional

image_resource_idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/categories/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/categories/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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": {}
  }
}

Remove an existing category

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

Category removed successfully

application/json

idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete/categories/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text"
}

List categories

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

root_idstringOpcional

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

only_activebooleanOpcionalDefault: false

Respostas

200

OK

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Category was not found

application/json

500

An internal server error was thrown

application/json

get/categories

HTTPcURLJavaScriptPython

GET /api/sales/categories HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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

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

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

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

idstringOpcional

root_idstringOpcional

namestringOpcional

activebooleanOpcional

characteristicsstringOpcional

seo_titlestringOpcional

seo_descriptionstringOpcional

seo_meta_keywordsstring[]Opcional

ordernumberOpcional

image_resource_idstringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/categories

HTTPcURLJavaScriptPython

POST /api/sales/categories HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
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": {}
  }
}