Categoria¶

Adicionar Categoria¶

Referência¶

POST https://api.dezwork.com/v1/produtos/categorias

Parâmetros	Tipo	Descrição
description*	string	Nome/título da categoria
idParent	int	ID da categoria pai. Caso não informado, será uma categoria principal.
active	boolean	Categoria ativa?
orderNumber	int	Nº da ordenação da categoria
children	array	Array contendo as categorias filhas

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição¶

{
  "description": "Marca 1",
  "idParent": 2,
  "active": true,
  "orderNumber": 1
}

Resposta¶

Status 201: CREATED¶

{
    "success": true,
    "data": {
        "category": {
            "id": 1,
            "idParent": 2,
            "description": "Marca 1",
            "url": "marca-1",
            "active": true,
            "orderNumber": 1,
            "children": []
        }
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Atualizar Categoria¶

Referência¶

PUT https://api.dezwork.com/v1/produtos/categorias

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição¶

{
    "id": 1,
    "description": "Marca 1",
    "active": true,
    "orderNumber": 1
}

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "category": {
            "id": 1,
            "idParent": 2,
            "description": "Marca 1",
            "url": "marca-1",
            "active": true,
            "orderNumber": 1,
            "children": []
        }
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Consultar Categorias¶

Referência¶

GET https://api.dezwork.com/v1/produtos/categorias

Basta uma requisição GET simples para esse endpoint para retornar todas as categorias cadastradas em uma loja.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "categories": [
            {
                "id": 1,
                "idParent": 2,
                "description": "Marca 1",
                "url": "marca-1",
                "active": true,
                "orderNumber": 1,
                "children": []
            },
            {
                "id": 2,
                "idParent": null,
                "description": "Marca 2",
                "url": "marca-2",
                "active": true,
                "orderNumber": 2,
                "children": [
                    {
                        "id": 1,
                        "idParent": 2,
                        "description": "Marca 1",
                        "url": "marca-1",
                        "active": true,
                        "orderNumber": 1,
                        "children": []
                    }
                ]
            }
        ]
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Consultar Categoria por ID¶

Referência¶

GET https://api.dezwork.com/v1/produtos/categorias/{id}

Basta uma requisição GET simples para esse endpoint, informando o ID da categoria na URL para retornar a categoria em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "category": {
            "id": 1,
            "idParent": 2,
            "description": "Marca 1",
            "url": "marca-1",
            "active": true,
            "orderNumber": 1,
            "children": []
        }
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Excluir Categoria¶

Referência¶

DELETE https://api.dezwork.com/v1/produtos/categorias/{id}

Basta uma requisição DELETE simples para esse endpoint, informando o ID da categoria na URL para excluir a categoria em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "category": {
            "id": 1,
            "idParent": 2,
            "description": "Marca 1",
            "url": "marca-1",
            "active": true,
            "orderNumber": 1,
            "children": []
        }
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}