Skip to content

API Reference (1.0)

El API de ZRU utiliza métodos HTTP y una estructura RESTful de endpoint.

  • La autenticación del API se realiza vía Header Authorization.
  • Todas las peticiones se deben realizar en formato JSON, y las respuestas del API son en dicho formato.
Download OpenAPI description
index.json
index.yaml
Overview
Languages
Servers
v1

https://api.zrupay.com/v1/

Transaction

Operations

Subscription

Operations

Authorization

Operations

Sale

Operations

Product

Operations

Plan

Operations

Tax

Operations

Shipping

Operations

Coupon

Operations

Listar Cupones

Request

Devuelve todos los cupones creados en el entorno.

Security
AppKeys
curl -i -X GET \
  https://api.zrupay.com/v1/coupon/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
countnumber

Cantidad de elementos

items_per_pagenumber

Cantidad de elementos por página

nextstring or null

URL a próxima página

previousstring or null

URL a página anterior

resultsArray of objects(Cupón)
Response
application/json
{
  "count": 0,
  "items_per_page": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Crear Cupón

Request

Crea un cupón en el entorno.

Security
AppKeys
Bodyapplication/json
coupon_idstring

Identificador externo

namestringrequired

Nombre

coupon_typestringrequired

Tipo (opciones: A - Cantidad, P - Por ciento)

Enum"A""P"
codestringrequired

Código para utilizar el cupón

valuenumber(float)required

Valor que se utilizará para disminuir el precio total del pedido. En caso de que sea un cupón de tipo cantidad, lo dismuirá justo en ese valor; y si es de tipo por ciento, lo disminuirá en en ese valor de manera porcentual.

enabledboolean

Si está habilitado o no (por defecto: True)

expiration_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración con el formato, en caso de no existir nunca expirará

total_usesinteger>= 1

La cantidad total de veces que se puede utilizar el cupón, en caso de no existir se puede utilizar indefinidamente

curl -i -X POST \
  https://api.zrupay.com/v1/coupon/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "COUPON_NAME",
    "coupon_type": "P",
    "code": "COUPON_CODE",
    "value": 17,
    "enabled": true,
    "expiration_date": "2024-05-31T23:59:59+00:00",
    "total_uses": 100
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

display_coupon_typestring

Tipo para mostrar

usesinteger

Usos reales del cupón

coupon_idstring

Identificador externo

namestringrequired

Nombre

coupon_typestringrequired

Tipo (opciones: A - Cantidad, P - Por ciento)

Enum"A""P"
codestringrequired

Código para utilizar el cupón

valuenumber(float)required

Valor que se utilizará para disminuir el precio total del pedido. En caso de que sea un cupón de tipo cantidad, lo dismuirá justo en ese valor; y si es de tipo por ciento, lo disminuirá en en ese valor de manera porcentual.

enabledboolean

Si está habilitado o no (por defecto: True)

expiration_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración con el formato, en caso de no existir nunca expirará

total_usesinteger>= 1

La cantidad total de veces que se puede utilizar el cupón, en caso de no existir se puede utilizar indefinidamente

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "display_coupon_type": "string",
  "uses": 0,
  "coupon_id": "string",
  "name": "string",
  "coupon_type": "A",
  "code": "string",
  "value": 0.1,
  "enabled": true,
  "expiration_date": "2019-08-24T14:15:22Z",
  "total_uses": 1
}

Obtener Cupón

Request

Devuelve el cupón solicitado.

Security
AppKeys
Path
coupon-idstring(uuid)required

Identificador del cupón que se desea solicitar

curl -i -X GET \
  'https://api.zrupay.com/v1/coupon/{coupon-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

display_coupon_typestring

Tipo para mostrar

usesinteger

Usos reales del cupón

coupon_idstring

Identificador externo

namestringrequired

Nombre

coupon_typestringrequired

Tipo (opciones: A - Cantidad, P - Por ciento)

Enum"A""P"
codestringrequired

Código para utilizar el cupón

valuenumber(float)required

Valor que se utilizará para disminuir el precio total del pedido. En caso de que sea un cupón de tipo cantidad, lo dismuirá justo en ese valor; y si es de tipo por ciento, lo disminuirá en en ese valor de manera porcentual.

enabledboolean

Si está habilitado o no (por defecto: True)

expiration_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración con el formato, en caso de no existir nunca expirará

total_usesinteger>= 1

La cantidad total de veces que se puede utilizar el cupón, en caso de no existir se puede utilizar indefinidamente

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "display_coupon_type": "string",
  "uses": 0,
  "coupon_id": "string",
  "name": "string",
  "coupon_type": "A",
  "code": "string",
  "value": 0.1,
  "enabled": true,
  "expiration_date": "2019-08-24T14:15:22Z",
  "total_uses": 1
}

Editar Cupón

Request

Edita el cupón solicitado.

Security
AppKeys
Path
coupon-idstring(uuid)required

Identificador del cupón que se desea solicitar

Bodyapplication/json
coupon_idstring

Identificador externo

namestring

Nombre

coupon_typestring

Tipo (opciones: A - Cantidad, P - Por ciento)

Enum"A""P"
codestring

Código para utilizar el cupón

valuenumber(float)

Valor que se utilizará para disminuir el precio total del pedido. En caso de que sea un cupón de tipo cantidad, lo dismuirá justo en ese valor; y si es de tipo por ciento, lo disminuirá en en ese valor de manera porcentual.

enabledboolean

Si está habilitado o no (por defecto: True)

expiration_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración con el formato, en caso de no existir nunca expirará

total_usesinteger>= 1

La cantidad total de veces que se puede utilizar el cupón, en caso de no existir se puede utilizar indefinidamente

curl -i -X PATCH \
  'https://api.zrupay.com/v1/coupon/{coupon-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "NEW_COUPON_NAME"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

display_coupon_typestring

Tipo para mostrar

usesinteger

Usos reales del cupón

coupon_idstring

Identificador externo

namestringrequired

Nombre

coupon_typestringrequired

Tipo (opciones: A - Cantidad, P - Por ciento)

Enum"A""P"
codestringrequired

Código para utilizar el cupón

valuenumber(float)required

Valor que se utilizará para disminuir el precio total del pedido. En caso de que sea un cupón de tipo cantidad, lo dismuirá justo en ese valor; y si es de tipo por ciento, lo disminuirá en en ese valor de manera porcentual.

enabledboolean

Si está habilitado o no (por defecto: True)

expiration_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración con el formato, en caso de no existir nunca expirará

total_usesinteger>= 1

La cantidad total de veces que se puede utilizar el cupón, en caso de no existir se puede utilizar indefinidamente

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "display_coupon_type": "string",
  "uses": 0,
  "coupon_id": "string",
  "name": "string",
  "coupon_type": "A",
  "code": "string",
  "value": 0.1,
  "enabled": true,
  "expiration_date": "2019-08-24T14:15:22Z",
  "total_uses": 1
}

Eliminar Cupón

Request

Elimina el cupón solicitado.

Security
AppKeys
Path
coupon-idstring(uuid)required

Identificador del cupón que se desea solicitar

curl -i -X DELETE \
  'https://api.zrupay.com/v1/coupon/{coupon-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Client

Operations

Wallet

Operations

Transfer

Operations

Gateway

Operations

Currency

Currency

Operations