Descuentos

Consulta descuentos creados, todos los descuentos se trabajan porcentualmente. Si se desea usar el descuento, ver documentos.

Estructura JSON

Al realizar una petición HTTP, el servicio retornara un JSON con la siguiente estructura:

{
  "href": "https://api.bsale.com.pe/v1/discounts/1.json",
  "id": 1,
  "name": "Ajuste Precio",
  "percentage": "14.3",
  "state": 1,
  "automatic": 0
}
  • href, url del descuento (String).
  • id, identificador único del descuento (Integer).
  • name, nombre del descuento (String).
  • percentage, porcentaje del descuento (String).
  • state, estado del descuento indica si el descuento esta activo(0) o inactivo (1) (Boolean).
  • automatic, indica si el descuento se aplica automáticamente, No(0) o Si (1) (Boolean).

GET lista de descuentos

  • GET /v1/discounts.json retornara todos los descuentos.

####Parametros

  • limit, limita la cantidad de items de una respuesta JSON, por defecto el limit es 25, el máximo permitido es 50.
  • offset, permite paginar los items de una respuesta JSON, por defecto el offset es 0.
  • fields, solo devolver atributos específicos de un recurso
  • expand, permite expandir instancias y colecciones.
  • name, Permite filtrar por nombre del descuento.
  • percentage, filtra por porcentaje de descuento.
  • state, boolean (0 o 1) indica si los descuentos están activos(0) inactivos(1).

####Ejemplos

  • GET /v1/discounts.json?limit=10&offset=0
  • GET /v1/discounts.json?fields=[name,percentage,state]

####Respuesta

{
  "href": "https://api.bsale.com.pe/v1/discounts.json",
  "count": 3,
  "limit": 25,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.com.pe/v1/discounts/1.json",
      "id": 1,
      "name": "Ajuste Precio",
      "percentage": "14.3",
      "state": 1,
      "automatic": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/discounts/3.json",
      "id": 3,
      "name": "Descuento CPT",
      "percentage": "75.0",
      "state": 0,
      "automatic": 0
    },
    {
      "href": "https://api.bsale.com.pe/v1/discounts/2.json",
      "id": 2,
      "name": "Descuento Imagestion",
      "percentage": "25.0",
      "state": 1,
      "automatic": 0
    }
  ]
}

GET único descuento

  • GET /v1/discounts/1.json retornara un descuento específico.

####Respuesta

{
  "href": "https://api.bsale.com.pe/v1/discounts/1.json",
  "id": 1,
  "name": "Ajuste Precio",
  "percentage": "14.3",
  "state": 1,
  "automatic": 0
}

GET cantidad de descuentos

  • GET /v1/discounts/count.json

####Parametros

  • state, permite filtrar por estado, activos (0) inactivos (1).

####Respuesta

{
  "count": 3
}