Actualizar metadata

Método que permite que un servicio pueda agregar y/o modificar la metadata de una tienda. Las etiquetas HTML serán renderizadas en todas las pantallas de la tienda online.


PUT {env}/1/shops/applications

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 agregar etiquetas.

Body


{
  "head": "<meta name='copyright' content='© 2022 MDC'>",
  "body": "",
  "instructions": "Estas son las instrucciones",
  "discount": "25.5",
  "method_description": "Estas son las descripciones del método de pago o envío"
}

Nombre	Tipo	Opcional	Valores aceptados	Descripción
`head`	string	Si	Free Field	Campo que representa las etiquetas html para head. Puede enviarse vacío y será mostrado en la respuesta como un string vacío.
`body`	string	Si	Free Field	Campo que representa las etiquetas html para body. Puede enviarse vacío y será mostrado en la respuesta como un string vacío.
`instructions`	string	Si	Free Field	Contiene información expuesta al usuario luego de hacer una compra (ejemplo: puede ser un CBU, Datos de contactos etc…). Puede enviarse vacío y será mostrado en la respuesta como “null”.
`discount`	string	Si	Valores mayores a 0 y menores a 100	Indica que la aplicación posee configurado un descuento por ese medio. Puede enviarse vacío y será mostrado en la respuesta como “null”.
`method_description`	string	Si	Free Field	Contiene información de descripción de los medios de pago o envío. Puede enviarse vacío y será mostrado en la respuesta como “null”.

En el caso de head, body, instructions o method_description solo se validará que llegue un string. El contenido del mismo no será validado, se asume que llegan los datos correctamente.

Response exitosa: 201 Ok


{
  "application_id": "app-{uuid}",
  "shop_id": "1234",
  "head": "<meta name='copyright' content='© 2022 MDC'>",
  "body": "",
  "instructions": "Estas son las instrucciones",
  "discount": "25.5",
  "method_description": "Estas son las descripciones del método de pago o envío"
}

Campos de la respuesta

Nombre	Tipo	Descripción
`application_id`	string	Corresponde al id de la aplicación.
`shop_id`	string	Corresponde al id de la tienda.
`head`	string	Corresponde a las etiquetas del head.
`body`	string	Corresponde a las etiquetas del body.
`instructions`	string	Corresponde a las instrucciones expuestas al usuario luego de hacer una compra (ejemplo: puede ser un CBU, Datos de contactos etc…).
`discount`	string	Corresponde al descuento que la aplicación posee configurado por ese medio.
`method_description`	string	Corresponde a la información de descripción de los medios de pago o envío.

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 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 genérico:


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

Ejemplo response 400 Bad Request en caso de enviar un payload inválido:


{
  "status": 400,
  "code": "request_error",
  "msg": "Invalid payload format"
}

Ejemplo response 500 Internal Server Error:


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