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
Overview
Languages
Servers
v1
https://api.zrupay.com/v1/

Transaction

Operations

Subscription

Operations

Authorization

Operations

Sale

Operations

Product

Operations

Plan

Operations

Tax

Operations

Listar Impuestos

Request

Devuelve todos los impuestos creados en el entorno.

curl -i -X GET \
  https://api.zrupay.com/v1/tax/ \
  -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(Impuesto)
Response
application/json
{ "count": 0, "items_per_page": 0, "next": "string", "previous": "string", "results": [ {} ] }

Crear Impuesto

Request

Crea un impuesto en el entorno.

Bodyapplication/json
namestringrequired

Nombre

percentnumber(float)required

Por ciento

curl -i -X POST \
  https://api.zrupay.com/v1/tax/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "TAX_NAME",
    "percent": 19
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

namestringrequired

Nombre

percentnumber(float)required

Por ciento

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "percent": 0.1 }

Obtener Impuesto

Request

Devuelve el impuesto solicitado.

Path
tax-idstring(uuid)required

Identificador del impuesto que se desea solicitar

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

namestringrequired

Nombre

percentnumber(float)required

Por ciento

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "percent": 0.1 }

Editar Impuesto

Request

Edita el impuesto solicitado.

Path
tax-idstring(uuid)required

Identificador del impuesto que se desea solicitar

Bodyapplication/json
namestring

Nombre

percentnumber(float)

Por ciento

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

namestringrequired

Nombre

percentnumber(float)required

Por ciento

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "percent": 0.1 }

Eliminar Impuesto

Request

Elimina el impuesto solicitado.

Path
tax-idstring(uuid)required

Identificador del impuesto que se desea solicitar

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

Responses

OK

Shipping

Operations

Coupon

Operations

Client

Operations

Wallet

Operations

Transfer

Operations

Gateway

Operations

Currency

Currency

Operations