Editar categoría


PUT /1/categories/:id

Método utilizado para editar el nombre de una determinada categoría o sub categoría en una tienda en particular.

Headers


{
  "Authorization": "Bearer {access_token}",
  "X-Shop-Id": "12345"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
Authorization	string	Si	Bearer + access_token	Token obtenido mediante client_id y client_secret.
X-Shop-Id	string	Si	String numérico	Identificador único de la tienda a la cual se desea obtener sus ventas.

Params


{
  "id": "category-1234"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
id	string	Si	`category-{id}`	Especifica qué categoría editar a través de su identificador único.

Body


{
  "name": "Category name"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
name	string	Si	Debe respetar el regex: `/^(?=.{2,35}$)(a-zá-úÁ-ÚA-Z0-9?(\s)?)*$/`	Es el nombre de la categoría o sub categoría.

Response exitosa: 201 Ok


{
  "id": "category-1234",
  "name": "Remeras",
  "slug": "remeras",
  "parent_id": null
}

Campos de la respuesta

Atributo	Tipo	Descripción
id	string	Corresponde al id de la categoría.
name	string	Corresponde al nombre de la categoría.
slug	string	Corresponde al nombre de la categoría en formato link.
parent_id	string	Corresponde a la categoría padre de la categoría en cuestión. Si su valor es null, entonces es una categoría root.

Responses de error

En caso de que la respuesta http no sea 201, entonces se debe considerar el error.

Atributo	Tipo	Descripción
status	int	Http code de respuesta.
code	string	Código de error, indica la naturaleza del mismo.
msg	string	Mensaje de error.

Ejemplo response 401 Unauthorized:


{
  "status": 401,
  "code": "error",
  "msg": "Unauthorized"
}

Ejemplo response 400 Bad Request genérico:


{
  "status": 400,
  "code": "request_error",
  "msg": "Send valid data"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada requerido no es enviado:


{
  "status": 400,
  "code": "param_required",
  "msg": "invalid <param_name>. The value is required"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada es inválido:


{
  "status": 400,
  "code": "param_invalid",
  "msg": "Invalid <param_name>. The value is invalid"
}

Ejemplo response 400 Bad Request si ya existe una categoría con ese mismo nombre o link en ese nivel:


{
  "status": 400,
  "code": "request_error",
  "msg": "The category or subcategory name you are trying to use already exist on the specified level"
}

Ejemplo response 500 Internal Server Error:


{
  "status": 500,
  "code": "server_error",
  "msg": "Something went wrong"
}