Marca¶

Adicionar Marca¶

Referência¶

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

Parâmetros	Tipo	Descrição
description*	string	Nome/título da marca
logo	string	URL do logotipo da marca
active	boolean	Marca ativa?
orderNumber	int	Nº da ordenação da marca

Nota

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

Exemplo de Requisição¶

{
    "description": "Marca 1",
    "logo": "http://url-logo-marca.com",
    "active": true,
    "orderNumber": 1
}

Resposta¶

Status 201: CREATED¶

{
  "success": true,
  "data": {
    "brand": {
      "id": 1,
      "description": "Marca 1",
      "url": "marca-1",
      "logo": "http://url-logo-marca.com",
      "active": true,
      "orderNumber": 1
    }
  }
}

Status 400: Bad Request¶

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

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

Atualizar Marca¶

Referência¶

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

Nota

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

Exemplo de Requisição¶

{
  "id": 1,
  "description": "Marca 1",
  "logo": "http://url-logo-marca.com",
  "active": true,
  "orderNumber": 1
}

Resposta¶

Status 200: OK¶

{
  "success": true,
  "data": {
    "brand": {
      "id": 1,
      "description": "Marca 1",
      "url": "marca-1",
      "logo": "http://url-logo-marca.com",
      "active": true,
      "orderNumber": 1
    }
  }
}

Status 400: Bad Request¶

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

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

Consultar Marcas¶

Referência¶

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

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

Resposta¶

Status 200: OK¶

{
  "success": true,
  "data": {
    "brands": [
      {
        "id": 1,
        "description": "Marca 1",
        "url": "marca-1",
        "logo": "http://url-logo-marca.com",
        "active": true,
        "orderNumber": 1
      },
      {
        "id": 2,
        "description": "Marca 2",
        "url": "marca-2",
        "logo": "http://url-logo-marca2.com",
        "active": true,
        "orderNumber": 2
      }
    ]
  }
}

Status 400: Bad Request¶

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

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

Consultar Marca por ID¶

Referência¶

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

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

Resposta¶

Status 200: OK¶

{
  "success": true,
  "data": {
    "brand": {
      "id": 1,
      "description": "Marca 1",
      "url": "marca-1",
      "logo": "http://url-logo-marca.com",
      "active": true,
      "orderNumber": 1
    }
  }
}

Status 400: Bad Request¶

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

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

Excluir Marca¶

Referência¶

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

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

Resposta¶

Status 200: OK¶

{
  "success": true,
  "data": {
    "brand": {
      "id": 1,
      "description": "Marca 1",
      "url": "marca-1",
      "logo": "http://url-logo-marca.com",
      "active": true,
      "orderNumber": 1
    }
  }
}

Status 400: Bad Request¶

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

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