Promociones

Es la entidad que almacena la información general de las distintas promociones configuradas en el ecommerce. Las promociones se componen de reglas (que deben cumplirse para aplicarse) y de acciones (las que se aplican al cumplirse las reglas indicadas).

Listado de promociones

GET https://tiendagoshop.com/api/v1/promotions

Query Parameters

Name	Type	Description
q[name_cont]	string	Nombre de la promoción.
q[promotion_category_id_eq]	string	Categoría de la promoción.
q[code_cont]	string	Código de la promoción.
q[external_id_eq]	String	Id externo

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "promotions": [
    {
      "id": 2,
      "name": "Test api",
      "description": null,
      "expires_at": null,
      "starts_at": null,
      "usage_limit": null,
      "match_policy": "all",
      "code": null,
      "created_at": "2020-11-09T11:52:11.366-04:00",
      "updated_at": "2020-11-09T11:52:11.366-04:00",
      "promotion_category_id": null,
      "included": false
    },
    {
      "id": 3,
      "name": "10% descuento Black Friday",
      "description": null,
      "expires_at": null,
      "starts_at": null,
      "usage_limit": null,
      "match_policy": "all",
      "code": null,
      "created_at": "2020-11-09T14:02:20.388-04:00",
      "updated_at": "2020-11-09T14:02:20.388-04:00",
      "promotion_category_id": null,
      "included": false
    },
    {
      "id": 4,
      "name": "15% primera compra",
      "description": "Descuento de 15% en primera compra",
      "expires_at": null,
      "starts_at": null,
      "usage_limit": null,
      "match_policy": "all",
      "code": null,
      "created_at": "2020-11-09T14:12:17.966-04:00",
      "updated_at": "2020-11-14T06:06:23.371-04:00",
      "promotion_category_id": null,
      "included": false
    }
  ],
  "count": 3,
  "current_page": 1,
  "pages": 1
}

Obtener una promoción

GET https://tiendagoshop.com/api/v1/promotions/:id

Path Parameters

Name	Type	Description
:id	integer	ID de la promoción

Query Parameters

Name	Type	Description
q[external_id_eq]	String	Id externo

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "id": 4,
  "name": "15% primera compra",
  "description": "Descuento de 15% en primera compra",
  "expires_at": null,
  "starts_at": null,
  "usage_limit": null,
  "match_policy": "all",
  "code": null,
  "created_at": "2020-11-09T14:12:17.966-04:00",
  "updated_at": "2020-11-14T06:06:23.371-04:00",
  "promotion_category_id": null,
  "included": false,
  "rules": [
    {
      "id": 24,
      "promotion_id": 4,
      "type": "Spree::Promotion::Rules::FirstOrder",
      "created_at": "2020-11-14T06:05:01.214-04:00",
      "updated_at": "2020-11-14T06:05:01.214-04:00",
      "preferences": {}
    }
  ],
  "actions": [
    {
      "id": 66,
      "type": "Spree::Promotion::Actions::CreateAdjustment",
      "calculator": {
        "type": "Spree::Calculator::FlatPercentItemTotal",
        "preferences": {
          "flat_percent": "15.0"
        }
      },
      "promotion_action_line_items": {}
    }
  ]
}

Crear una promoción

POST https://tiendagoshop.com/api/v1/promotions

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

Request Body

Name	Type	Description
promotion_category_id	integer	ID de la categoría de la promoción.
name	integer	Nombre de la promoción.
description	string	Descripción de la promoción.
expires_at	string	Fecha de expiración.
starts_at	string	Fecha de inicio.
usage_limit	integer	Límite de uso (veces que se aplicara esa promoción a nivel global).
code	string	Código del cupón en caso de que no se quiera que la promoción se aplique automáticamente, sino que se deba canjear un cupón.
match_policy	string	Política de cumplimiento de reglas asociadas a la promoción: All = se deben cumplir todas. Any = se debe cumplir al menos una.
external_id	String	Id externo

200

{
  "id": 4,
  "name": "10% descuento Black Friday",
  "description": "Promoción de Black Friday...",
  "expires_at": "2020-12-31T00:00:00.000Z",
  "starts_at": "2020-09-01T00:00:00.000Z",
  "type": null,
  "usage_limit": 500,
  "match_policy": "all",
  "code": "BLACK123",
  "advertise": false,
  "path": null
}

Eliminar una promoción

DELETE https://tiendagoshop.com/api/v1/promotions/:id

Path Parameters

Name	Type	Description
:id	integer	ID de la promoción

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

204