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.
El API de ZRU utiliza métodos HTTP y una estructura RESTful de endpoint.
curl -i -X GET \
https://api.zrupay.com/v1/coupon/ \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 0, "items_per_page": 0, "next": "string", "previous": "string", "results": [ { … } ] }
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.
Fecha de expiración con el formato, en caso de no existir nunca expirará
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
}'OK
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.
Fecha de expiración con el formato, en caso de no existir nunca expirará
{ "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 }
curl -i -X GET \
'https://api.zrupay.com/v1/coupon/{coupon-id}/' \
-H 'Authorization: YOUR_API_KEY_HERE'OK
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.
Fecha de expiración con el formato, en caso de no existir nunca expirará
{ "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 }
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.
Fecha de expiración con el formato, en caso de no existir nunca expirará
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"
}'OK
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.
Fecha de expiración con el formato, en caso de no existir nunca expirará
{ "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 }
curl -i -X DELETE \
'https://api.zrupay.com/v1/coupon/{coupon-id}/' \
-H 'Authorization: YOUR_API_KEY_HERE'