Plaam API documentation version v1

https://{subdomain}.qaroni.com/{version}

  • subdomain: required(string - default: plaam.api)

    Subdominio del API

  • version: required(v1)

/accounts

get

get

Listar los accounts.

post

post

Login de acceso para account.

Login de acceso para account.

Body

Media type: application/json

Example:

{
  "username": "atpjulio@gmail.com",
  "password": "1234"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "accountId": 8,
      "access_token": "eyJpdiI6InVVK1FwTWlSOWhZNG1KYkRWU0hCQXc9PSIsInZhbHVlIjoiQm4yeml0QU1DYVoxNEpacGVEdFVuWHhGbE1LcWcySE9zalhMTWYzZmJ2cldUOU1tOEc3NjNReXhHeTNjcGRHMyIsIm1hYyI6IjBjMTA3OWZiNWRkOGE5Mzc5ODJhMjQ4NWQ5YmUyMDNjMmM3ZjhlNTNjNWE4MmFiMTEyODBhZjE4MDgwNzliOTQifQ==",
      "issued": "2020-04-07T17:12:00Z",
      "expires": "2020-04-08T17:12:00Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Detalle de un account.

Detalle de un account.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • accountId: required(integer)

    Identificador único del account.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "accountId": 8,
      "email": "atpjulio@gmail.com",
      "phone": "640233822",
      "firstName": "Julio",
      "lastName": "Amaya",
      "documentType": "PASSPORT",
      "document": "134545343221",
      "birthday": "1985-02-07",
      "gender": "MALE",
      "language": "es",
      "image": null,
      "creationDate": "2020-04-07T16:37:06Z",
      "lastUpdateDate": "2020-04-07T16:37:06Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar las empresas a las que tiene acceso el account.

Listar las empresas a las que tiene acceso el account.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • accountId: required(integer)

    Identificador único del account.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants",
  "result": [
    {
      "merchantId": 114,
      "name": "Labrax Soluciones S.L",
      "tradeName": "Labrax",
      "state": "ENABLED",
      "logoImageUrl": "https://www.labraxsoluciones.com/images/logo.png",
      "web": "www.labraxsoluciones.com",
      "phone": "+34111111111",
      "email": " acliente@labraxsoluciones.com",
      "document": "B11117282",
      "address":{
        "line1":"Calle Emilio González López 51 Bajo",
        "line2":"",
        "city":"A Coruña",
        "stateProvince":"A Coruña",
        "postalCode":"15011",
        "country":"ES"
      },
      "language": "es",
      "creationDate": "2020-01-19T21:16:50Z",
      "lastUpdateDate": "2020-01-19T21:16:50Z"
    },
    {
      "merchantId": 124,
      "name": "Qaroni Emea S.L",
      "tradeName": "Qaroní",
      "state": "ENABLED",
      "logoImageUrl": "https://s3.amazonaws.com/www.qaroni.com/qaroni.png",
      "web": "www.qaroni.com",
      "phone": "+34111111111",
      "email": "contact@qaroni.com",
      "document": "B52387282",
      "address":{
        "line1":"Rúa Hábitat, 10 Bajo",
        "line2":"",
        "city":"Oleiros",
        "stateProvince":"A Coruña",
        "postalCode":"15172",
        "country":"ES"
      },
      "language": "es",
      "creationDate": "2020-01-19T21:16:50Z",
      "lastUpdateDate": "2020-01-19T21:16:50Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

/buckets/uploads

post

post

Subir fichero al bucket de S3.

Subir fichero al bucket de S3.

Secured by appToken

Application-Token for API requests.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • path: required(string)

    Example:

    /imagenes/subidas
  • file: required(file)

    Fichero a subir.

HTTP status code 200

Se sube el fichero de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/news/{newId}",
  "result": [
    {
      "information": "File uploaded successfully",
      "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/subidos/portadas/849237a5-54ec-4971-89d8-1233c7422ea0.png"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

/merchants

get

get

Listar las empresas.

get

get

Detalle de una empresa.

Detalle de una empresa.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Query Parameters

  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "input": "GET/merchants/{merchantId}",
    "result": [
    {
      "merchantId": 114,
      "name": "Qaroni Emea S.L",
      "tradeName": "Qaroní",
      "state": "ENABLED",
      "logoImageUrl": "https://s3.amazonaws.com/www.qaroni.com/qaroni.png",
      "web": "www.qaroni.com",
      "phone": "+34111111111",
      "email": "contact@qaroni.com",
      "document": "B52387282",
      "address":{
        "line1":"Rúa Hábitat, 10 Bajo",
        "line2":"",
        "city":"Oleiros",
        "stateProvince":"A Coruña",
        "postalCode":"15172",
        "country":"ES"
      },
      "language": "es",
      "creationDate": "2020-01-19T21:16:50Z",
      "lastUpdateDate": "2020-01-19T21:16:50Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch

patch

Recuperación de contraseña de account.

Recuperación de contraseña de account.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Body

Media type: application/json

Example:

{
  "username": "atpjulio@gmail.com"
}

HTTP status code 200

Se envia un email al account con Link para el cambio de password.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Login de acceso para account.

Login de acceso para account.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Body

Media type: application/json

Example:

{
  "username": "atpjulio@gmail.com",
  "password": "1234"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "accountId": 8,
      "access_token": "eyJpdiI6InVVK1FwTWlSOWhZNG1KYkRWU0hCQXc9PSIsInZhbHVlIjoiQm4yeml0QU1DYVoxNEpacGVEdFVuWHhGbE1LcWcySE9zalhMTWYzZmJ2cldUOU1tOEc3NjNReXhHeTNjcGRHMyIsIm1hYyI6IjBjMTA3OWZiNWRkOGE5Mzc5ODJhMjQ4NWQ5YmUyMDNjMmM3ZjhlNTNjNWE4MmFiMTEyODBhZjE4MDgwNzliOTQifQ==",
      "issued": "2020-04-07T17:12:00Z",
      "expires": "2020-04-08T17:12:00Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Registro de account.

Registro de account.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Body

Media type: application/json

Example:

{
  "username": "atpjulio@gmail.com",
  "password": "1234",
  "language": "es"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/merchants/{merchantId}/accounts/registers",
  "result": [
    {
      "username": "atpjulio@gmail.com",
      "status": "CREATED",
      "otp": null,
      "creationDate": "2020-04-07T15:40:38Z",
      "lastUpdateDate": "2020-04-07T15:40:38Z",
      "accountId": 1,
      "image": null
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

patch

patch

Activar account (Pasar el status de CREATED a ACTIVE).

Activar account (Pasar el status de CREATED a ACTIVE).

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • accountId: required(integer)

    Identificador único del account.

Body

Media type: application/json

Example:

{
  "otp": 4545
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "accountId": 8,
      "access_token": "eyJpdiI6InVVK1FwTWlSOWhZNG1KYkRWU0hCQXc9PSIsInZhbHVlIjoiQm4yeml0QU1DYVoxNEpacGVEdFVuWHhGbE1LcWcySE9zalhMTWYzZmJ2cldUOU1tOEc3NjNReXhHeTNjcGRHMyIsIm1hYyI6IjBjMTA3OWZiNWRkOGE5Mzc5ODJhMjQ4NWQ5YmUyMDNjMmM3ZjhlNTNjNWE4MmFiMTEyODBhZjE4MDgwNzliOTQifQ==",
      "issued": "2020-04-07T17:12:00Z",
      "expires": "2020-04-08T17:12:00Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Crear un nuevo campo en la plantilla de la tarjeta.

Crear un nuevo campo en la plantilla de la tarjeta.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
  "fieldName": "thumbnailImage",
  "type": "VARIABLE",
  "value": "image"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
      "fieldName": "thumbnailImage",
      "type": "VARIABLE",
      "value": "image",
      "creationDate": "2020-05-20T14:17:09Z",
      "lastUpdateDate": "2020-05-20T14:17:09Z",
      "fieldId": 6
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Añade o actualiza campo imagen.

Añade o actualiza campo imagen.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • fieldName: required(string)

    Nombre del campo.

    Example:

    thumbnailImage
  • type: required(string)

    Tipo de campo.

    Example:

    CONSTANT
  • image: required(file)

    Fichero a subir.

HTTP status code 201

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
      "fieldName": "thumbnailImage",
      "type": "CONSTANT",
      "value": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/cards/templates/ad126412-90bd-4395-b924-93f523d70da4/6/images/ejemplo.png",
      "creationDate": "2020-05-20T14:17:09Z",
      "lastUpdateDate": "2020-05-20T14:17:09Z",
      "fieldId": 6
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listado de los campos presentes en la plantilla de la tarjeta.

Listado de los campos presentes en la plantilla de la tarjeta.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateUUID: required(string)

    Identificador único del template de la tarjeta.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (number)

    Cantidad de registros que se desea obtener, por defecto trae todos.

    Example:

    10

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
      "fieldName": "thumbnailImage",
      "type": "VARIABLE",
      "value": "image",
      "creationDate": "2020-05-20T14:17:09Z",
      "lastUpdateDate": "2020-05-20T14:17:09Z",
      "fieldId": 6
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de un campo en la plantilla de la tarjeta.

patch

Actualizar campo en la plantilla de la tarjeta.

delete

Borrar un campo de la plantilla de la tarjeta.

Obtener detalle de un campo en la plantilla de la tarjeta.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateUUID: required(string)

    Identificador único del template de la tarjeta.

  • fieldId: required(number)

    Identificador del campo en la plantilla de la tarjeta.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
      "fieldName": "thumbnailImage",
      "type": "VARIABLE",
      "value": "image",
      "creationDate": "2020-05-20T14:17:09Z",
      "lastUpdateDate": "2020-05-20T14:17:09Z",
      "fieldId": 6
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar campo en la plantilla de la tarjeta.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateUUID: required(string)

    Identificador único del template de la tarjeta.

  • fieldId: required(number)

    Identificador del campo en la plantilla de la tarjeta.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "fieldName": "thumbnailImage",
  "type": "VARIABLE",
  "value": "image"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
      "fieldName": "thumbnailImage",
      "type": "VARIABLE",
      "value": "image",
      "creationDate": "2020-05-20T14:17:09Z",
      "lastUpdateDate": "2020-05-20T14:17:09Z",
      "fieldId": 6
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un campo de la plantilla de la tarjeta.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateUUID: required(string)

    Identificador único del template de la tarjeta.

  • fieldId: required(number)

    Identificador del campo en la plantilla de la tarjeta.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Recurso eliminado exitosamente.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crea un cliente, los valores posibles para type son PHYSICAL, LEGAL.

get

Obtener los clientes del comercio.

Crea un cliente, los valores posibles para type son PHYSICAL, LEGAL.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "type": "LEGAL",
  "firstName": "Julio",
  "lastName": "Amaya Uzcategui",
  "tradename": "Julio Amaya Uzcategui",
  "document": "52061111H",
  "phone": "6342722711",
  "email": "atpjulio@gmail.com",
  "birthday": "1987-06-28",
  "gender": "MALE",
  "line1": "Rúa Hábitat, 10 Bajo",
  "line2": "",
  "city": "Oleiros",
  "stateProvince": "A Coruña",
  "postalCode": "15172",
  "country": "ES"
}

HTTP status code 200

Se crea el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "clientId": 17893,
      "merchantId": 87,
      "type": "LEGAL",
      "firstName": "Julio",
      "lastName": "Amaya Uzcategui",
      "document": "52061111H",
      "phone": "6342722711",
      "email": "atpjulio@gmail.com",
      "tradename": "Julio Amaya Uzcategui",
      "status": "ACTIVE",
      "birthday": "1987-06-28",
      "gender": "MALE",
      "address": {
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "A Coruña",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES"
      },
      "lastUpdateDate": "2021-01-24T19:33:04Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Obtener los clientes del comercio.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Query Parameters

  • page: (integer)

    Activa la paginación, ubica la página enviada.

    Example:

    1
  • pagination: (integer)

    Cantidad de registros a paginar, por defecto son 60.

    Example:

    10
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of ACTIVE, INACTIVE)

    Status de la compañía.

    Example:

    ACTIVE
  • type: (one of LEGAL, PHYSICAL)

    Tipo de cliente.

    Example:

    LEGAL
  • search: (number)

    Buscar por firstName, lastName, tradename, email, document, phone.

    Example:

    correo@ejemplo.com

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "clientId": 17893,
      "merchantId": 87,
      "type": "LEGAL",
      "firstName": "Julio",
      "lastName": "Amaya Uzcategui",
      "document": "52061111H",
      "phone": "6342722711",
      "email": "atpjulio@gmail.com",
      "tradename": "Julio Amaya Uzcategui",
      "status": "ACTIVE",
      "birthday": "1987-06-28",
      "gender": "MALE",
      "address": {
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "A Coruña",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES"
      },
      "lastUpdateDate": "2021-01-24T19:33:04Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de un cliente.

patch

Actualizar un cliente.

delete

Borrar un cliente.

Obtener detalle de un cliente.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • clientId: required(integer)

    Identificador único del cliente.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "clientId": 17893,
      "merchantId": 87,
      "type": "LEGAL",
      "firstName": "Julio",
      "lastName": "Amaya Uzcategui",
      "document": "52061111H",
      "phone": "6342722711",
      "email": "atpjulio@gmail.com",
      "tradename": "Julio Amaya Uzcategui",
      "status": "ACTIVE",
      "birthday": "1987-06-28",
      "gender": "MALE",
      "address": {
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "A Coruña",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES"
      },
      "lastUpdateDate": "2021-01-24T19:33:04Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar un cliente.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • clientId: required(integer)

    Identificador único del cliente.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "type": "LEGAL",
  "firstName": "Julio",
  "lastName": "Amaya Uzcategui",
  "tradename": "Julio Amaya Uzcategui",
  "document": "52061111H",
  "phone": "6342722711",
  "email": "atpjulio@gmail.com",
  "birthday": "1987-06-28",
  "gender": "MALE",
  "line1": "Rúa Hábitat, 10 Bajo",
  "line2": "",
  "city": "Oleiros",
  "stateProvince": "A Coruña",
  "postalCode": "15172",
  "country": "ES"
}

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "clientId": 17893,
      "merchantId": 87,
      "type": "LEGAL",
      "firstName": "Julio",
      "lastName": "Amaya Uzcategui",
      "document": "52061111H",
      "phone": "6342722711",
      "email": "atpjulio@gmail.com",
      "tradename": "Julio Amaya Uzcategui",
      "status": "ACTIVE",
      "birthday": "1987-06-28",
      "gender": "MALE",
      "address": {
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "A Coruña",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES"
      },
      "lastUpdateDate": "2021-01-24T19:33:04Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un cliente.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • clientId: required(integer)

    Identificador único del cliente.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 204

Se elimina recurso exitosamente.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Generar códigos promocionales asociados a la empresa.

get

Listar los códigos promocionales de una empresa.

Generar códigos promocionales asociados a la empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "quantity": 2,
  "uses": 5,
  "discountId": 12
}

HTTP status code 201

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "code": "008222162505",
      "status": "ENABLED",
      "uses": 5,
      "usesCount": 0,
      "creationDate": "2020-03-10T18:55:45Z",
      "lastUpdateDate": "2020-03-10T18:55:45Z",
      "promocodeId": 25
    },
    {
      "merchantId": "82",
      "code": "008223495811",
      "status": "ENABLED",
      "uses": 10,
      "usesCount": 0,
      "creationDate": "2020-03-10T18:55:45Z",
      "lastUpdateDate": "2020-03-10T18:55:45Z",
      "promocodeId": 26
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar los códigos promocionales de una empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • discounts: (string)

    Id de descuentos separados por coma.

    Example:

    12,16
  • status: (one of ENABLED, DISABLED, USED)

    Status del código promocional, por defecto trae los ENABLED.

    Example:

    ENABLED

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/codes",
  "result": [
    {
      "merchantId": 114,
      "productId": 555321,
      "variantId": 66778,
      "code": "011403997286",
      "status": "ENABLED",
      "uses": 1,
      "usesCount": 0,
      "type": "TOTAL",
      "creationDate": "2020-02-20T11:43:29Z",
      "lastUpdateDate": "2020-02-20T11:43:29Z",
      "promocodeId": 22
    },
    {
      "merchantId": 114,
      "productId": 555321,
      "variantId": 66778,
      "code": "011499541993",
      "status": "ENABLED",
      "uses": 1,
      "usesCount": 0,
      "type": "TOTAL",
      "creationDate": "2020-02-20T11:41:42Z",
      "lastUpdateDate": "2020-02-20T11:41:42Z",
      "promocodeId": 15
    },
    {
      "merchantId": 114,
      "productId": 555321,
      "variantId": 66778,
      "code": "011458656011",
      "status": "ENABLED",
      "uses": 1,
      "usesCount": 0,
      "type": "TOTAL",
      "creationDate": "2020-02-19T11:09:26Z",
      "lastUpdateDate": "2020-02-19T11:09:26Z",
      "promocodeId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch

patch

Habilitar un código promocional.

Habilitar un código promocional.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • codeId: required(integer)

    Identificador único del código promocional.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "productId": "555321",
      "variantId": "66778",
      "code": "008222162505",
      "status": "ENABLED",
      "creationDate": "2020-03-10T18:55:45Z",
      "lastUpdateDate": "2020-03-10T18:55:45Z",
      "promocodeId": 25
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch

patch

Deshabilitar un código promocional.

Deshabilitar un código promocional.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • codeId: required(integer)

    Identificador único del código promocional.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "productId": "555321",
      "variantId": "66778",
      "code": "008222162505",
      "status": "DISABLED",
      "creationDate": "2020-03-10T18:55:45Z",
      "lastUpdateDate": "2020-03-10T18:55:45Z",
      "promocodeId": 25
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener los usuarios que han utilizado este código promocional, la fecha en que se utilizó es pivotCreationDate.

Obtener los usuarios que han utilizado este código promocional, la fecha en que se utilizó es pivotCreationDate.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • codeId: required(integer)

    Identificador único del código promocional.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/codes/{codeId}/users",
  "result": [
    {
      "userId": 1,
      "merchantId": 114,
      "email": "atpjulio@gmail.com",
      "phone": "636246343",
      "firstName": "Julio",
      "lastName": "Amaya",
      "documentType": "PASSPORT",
      "document": "11838138383",
      "birthday": null,
      "gender": "MALE",
      "language": "es",
      "image": "https://s3.eu-central-1.amazonaws.com/plaam.dev/users/1/profileImage.jpg",
      "creationDate": "2020-01-22T04:18:30Z",
      "lastUpdateDate": "2020-01-22T04:18:30Z",
      "pivotCreationDate": "2020-04-14T10:21:45Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar los envíos de una empresa.

Listar los envíos de una empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of CREATED, PENDING, ATTENDED, SENT, CANCELLED, RECEIVED, CLAIM)

    Status del descuento.

    Example:

    PENDING
  • trackingNumber: (string)

    Búsqueda de usuario por trackingNumber, no es necesario colocarlo completo.

    Example:

    32940J1D
  • dateFrom: (string)

    Filtrar por fecha en formato Y-m-d H:i:s (DESDE).

    Example:

    2020-04-12 10:30:00
  • dateTo: (string)

    Filtrar por fecha en formato Y-m-d H:i:s (HASTA).

    Example:

    2020-04-14 23:59:59

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "shippingId": 2,
      "userId": 1,
      "orderId": 5,
      "merchantId": 82,
      "addressId": 1,
      "status": "PENDING",
      "trackingNumber": "324234UJK",
      "alias": null,
      "line1": "Rua Habitat",
      "line2": "10 Bajo",
      "postalCode": "15172",
      "city": "Oleiros",
      "stateProvince": "A Coruna",
      "country": "es",
      "userInfo": {
        "userId": 1,
        "merchantId": 114,
        "email": "atpjulio@gmail.com",
        "phone": null,
        "firstName": null,
        "lastName": null,
        "documentType": null,
        "document": null,
        "birthday": null,
        "gender": "MALE",
        "language": null,
        "image": "https://s3.eu-central-1.amazonaws.com/plaam.dev/users/1/profileImage.jpg",
        "creationDate": "2020-01-22T04:18:30Z",
        "lastUpdateDate": "2020-01-22T04:18:30Z"
      },
      "creationDate": "2020-04-29T13:49:10Z",
      "lastUpdateDate": "2020-04-29T13:49:10Z",
      "deliveryId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle del envío.

patch

Actualizar envío.

delete

Borrar un envío.

Obtener detalle del envío.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • deliveryId: required(integer)

    Identificador único del envío.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "shippingId": 2,
      "userId": 1,
      "orderId": 5,
      "merchantId": 82,
      "addressId": 1,
      "status": "PENDING",
      "trackingNumber": "324234UJK",
      "alias": null,
      "line1": "Rua Habitat",
      "line2": "10 Bajo",
      "postalCode": "15172",
      "city": "Oleiros",
      "stateProvince": "A Coruna",
      "country": "es",
      "userInfo": {
        "userId": 1,
        "merchantId": 114,
        "email": "atpjulio@gmail.com",
        "phone": null,
        "firstName": null,
        "lastName": null,
        "documentType": null,
        "document": null,
        "birthday": null,
        "gender": "MALE",
        "language": null,
        "image": "https://s3.eu-central-1.amazonaws.com/plaam.dev/users/1/profileImage.jpg",
        "creationDate": "2020-01-22T04:18:30Z",
        "lastUpdateDate": "2020-01-22T04:18:30Z"
      },
      "creationDate": "2020-04-29T13:49:10Z",
      "lastUpdateDate": "2020-04-29T13:49:10Z",
      "deliveryId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar envío.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • deliveryId: required(integer)

    Identificador único del envío.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"status": "CLAIM"
}

HTTP status code 201

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "shippingId": 2,
      "userId": 1,
      "orderId": 5,
      "merchantId": 82,
      "addressId": 1,
      "status": "PENDING",
      "trackingNumber": "324234UJK",
      "alias": null,
      "line1": "Rua Habitat",
      "line2": "10 Bajo",
      "postalCode": "15172",
      "city": "Oleiros",
      "stateProvince": "A Coruna",
      "country": "es",
      "userInfo": {
        "userId": 1,
        "merchantId": 114,
        "email": "atpjulio@gmail.com",
        "phone": null,
        "firstName": null,
        "lastName": null,
        "documentType": null,
        "document": null,
        "birthday": null,
        "gender": "MALE",
        "language": null,
        "image": "https://s3.eu-central-1.amazonaws.com/plaam.dev/users/1/profileImage.jpg",
        "creationDate": "2020-01-22T04:18:30Z",
        "lastUpdateDate": "2020-01-22T04:18:30Z"
      },
      "creationDate": "2020-04-29T13:49:10Z",
      "lastUpdateDate": "2020-04-29T13:49:10Z",
      "deliveryId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un envío.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • deliveryId: required(integer)

    Identificador único del envío.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de manera correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear descuento de acuerdo al tipo [BRAND, CATEGORY, COLLECTION, PRODUCT].

get

Listar los descuentos de una empresa.

Crear descuento de acuerdo al tipo [BRAND, CATEGORY, COLLECTION, PRODUCT].

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"percentage": 7.25,
	"public": true,
	"dateFrom": "2020-04-09 00:00:00",
	"dateTo": "2020-04-20 23:59:59",
	"type": "PRODUCT",
	"typeId": 444281,
	"descriptions": [
		{
			"language":"es",
			"name":"Día de las madres",
			"description":"Descuento por el día de las madres"
		}
	]
}

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "type": "PRODUCT",
      "typeId": 444281,
      "percentage": 7.25,
      "public": true,
      "status": "ACTIVE",
      "dateFrom": "2020-04-09 00:00:00",
      "dateTo": "2020-04-20 23:59:59",
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción en español",
      "creationDate": "2020-04-09T18:36:51Z",
      "lastUpdateDate": "2020-04-09T18:36:51Z",
      "discountId": 1,
      "launchStatus": "LAUNCHED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar los descuentos de una empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Status del descuento.

    Example:

    ACTIVE
  • public: (boolean)

    Descuento público o privado. Por defecto trae todos.

    Example:

    true
  • type: (one of BRAND, CATEGORY, COLLECTION, PRODUCT)

    Tipo de descuento.

    Example:

    PRODUCT
  • launchStatus: (one of LAUNCHED, WAITING, INFINITE, EXPIRED, DISABLED)

    Estados de lanzamiento, se pueden enviar uno o más separados por coma.

    Example:

    LAUNCHED
  • dateFrom: (string)

    Filtrar por fecha en formato Y-m-d H:i:s (DESDE).

    Example:

    2020-04-12 10:30:00
  • dateTo: (string)

    Filtrar por fecha en formato Y-m-d H:i:s (HASTA).

    Example:

    2020-04-14 23:59:59

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "type": "PRODUCT",
      "typeId": 444281,
      "percentage": 7.25,
      "public": true,
      "status": "ACTIVE",
      "dateFrom": "2020-04-09 00:00:00",
      "dateTo": "2020-04-20 23:59:59",
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción en español",
      "creationDate": "2020-04-09T18:36:51Z",
      "lastUpdateDate": "2020-04-09T18:36:51Z",
      "discountId": 1,
      "launchStatus": "LAUNCHED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle del descuento.

patch

Actualizar descuento.

delete

Borrar un descuento.

Obtener detalle del descuento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "type": "PRODUCT",
      "typeId": 444281,
      "percentage": 7.25,
      "public": true,
      "status": "ACTIVE",
      "dateFrom": "2020-04-09 00:00:00",
      "dateTo": "2020-04-20 23:59:59",
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción en español",
      "creationDate": "2020-04-09T18:36:51Z",
      "lastUpdateDate": "2020-04-09T18:36:51Z",
      "discountId": 1,
      "launchStatus": "LAUNCHED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar descuento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"percentage": 7.25,
	"public": true,
	"dateFrom": "2020-04-09 00:00:00",
	"dateTo": "2020-04-20 23:59:59",
	"type": "PRODUCT",
	"typeId": 444281,
	"status": "ACTIVE"
}

HTTP status code 200

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "type": "PRODUCT",
      "typeId": 444281,
      "percentage": 7.25,
      "public": true,
      "status": "ACTIVE",
      "dateFrom": "2020-04-09 00:00:00",
      "dateTo": "2020-04-20 23:59:59",
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción en español",
      "creationDate": "2020-04-09T18:36:51Z",
      "lastUpdateDate": "2020-04-09T18:36:51Z",
      "discountId": 1,
      "launchStatus": "LAUNCHED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un descuento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de manera correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea un registro de asociación de un descuento con un código promocional.

delete

Borrar un registro de asociación de una reserva con producto y variante.

Crea un registro de asociación de un descuento con un código promocional.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

  • codeId: required(integer)

    Identificador único del código promocional.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 201

Se crea el registro de manera correcta.

Body

Media type: application/json

Type: any

Example:

{
  "input": "POST/merchants/{merchantId}/discounts/{discountId}/codes/{codeId}",
  "result": [
    {
      "merchantId": 82,
      "percentage": "9.00",
      "public": true,
      "status": "ACTIVE",
      "type": "PRODUCT",
      "typeId": 444281,
      "dateFrom": null,
      "dateTo": null,
      "creationDate": "2020-04-09T18:39:17Z",
      "lastUpdateDate": "2020-04-09T18:39:17Z",
      "discountId": 2,
      "promocodes": [
        {
          "merchantId": 82,
          "productId": 555321,
          "variantId": 66778,
          "code": "008222162505",
          "status": "ENABLED",
          "creationDate": "2020-03-10T18:55:45Z",
          "lastUpdateDate": "2020-03-10T18:55:45Z",
          "promocodeId": 25
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un registro de asociación de una reserva con producto y variante.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

  • codeId: required(integer)

    Identificador único del código promocional.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crea una nueva descripción asociada al descuento.

get

Se obtienen las descripciones en múltiples idiomas.

Crea una nueva descripción asociada al descuento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "language": "es",
  "name": "Nombre del descuento",
  "description": "Descripción del descuento en español"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "type": "PRODUCT",
      "typeId": 444281,
      "percentage": 7.25,
      "public": true,
      "status": "ACTIVE",
      "dateFrom": "2020-04-09 00:00:00",
      "dateTo": "2020-04-20 23:59:59",
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción en español",
      "creationDate": "2020-04-09T18:36:51Z",
      "lastUpdateDate": "2020-04-09T18:36:51Z",
      "discountId": 1,
      "launchStatus": "LAUNCHED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Se obtienen las descripciones en múltiples idiomas.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción del descuento en español"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea una nueva descripción en el idioma recibido, asociada al descuento.

delete

Eliminar registro en el idioma enviado.

Crea una nueva descripción en el idioma recibido, asociada al descuento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "name": "Descuento",
  "description": "Descripción detallada del descuento"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "type": "PRODUCT",
      "typeId": 444281,
      "percentage": 7.25,
      "public": true,
      "status": "ACTIVE",
      "dateFrom": "2020-04-09 00:00:00",
      "dateTo": "2020-04-20 23:59:59",
      "language": "es",
      "name": "Nombre del descuento",
      "description": "Descripción en español",
      "creationDate": "2020-04-09T18:36:51Z",
      "lastUpdateDate": "2020-04-09T18:36:51Z",
      "discountId": 1,
      "launchStatus": "LAUNCHED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Eliminar registro en el idioma enviado.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina el recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea un registro de asociación de un descuento con una subscripción.

delete

Borrar un registro de asociación de una reserva con producto y variante.

Crea un registro de asociación de un descuento con una subscripción.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

  • subscriptionId: required(integer)

    Identificador único de la subscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 201

Se crea el registro de manera correcta.

Body

Media type: application/json

Type: any

Example:

{
  "input": "POST/merchants/{merchantId}/discounts/{discountId}/subscriptions/{subscriptionId}",
  "result": [
    {
      "merchantId": 82,
      "percentage": "9.00",
      "public": true,
      "status": "ACTIVE",
      "type": "PRODUCT",
      "typeId": 444281,
      "dateFrom": null,
      "dateTo": null,
      "creationDate": "2020-04-09T18:39:17Z",
      "lastUpdateDate": "2020-04-09T18:39:17Z",
      "discountId": 2,
      "subscriptions": [
        {
          "merchantId": 82,
          "templateUUID": null,
          "creationDate": "2020-02-02T20:24:44Z",
          "lastUpdateDate": "2020-02-02T20:24:44Z",
          "subscriptionId": 2,
          "imagesURL": []
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un registro de asociación de una reserva con producto y variante.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • discountId: required(integer)

    Identificador único del descuento.

  • subscriptionId: required(integer)

    Identificador único de la subscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear una plantilla de correo.

get

Listado de plantillas de correo disponibles.

Crear una plantilla de correo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "subject": "Asunto del correo",
  "body": "<p>Cuerpo del correo, normalmente con etiquetas HTML</p>"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "subject": "Asunto del correo",
      "body": "<p>Cuerpo del correo, normalmente con etiquetas HTML</p>",
      "creationDate": "2020-05-28T13:16:57Z",
      "lastUpdateDate": "2020-05-28T13:16:57Z",
      "templateId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listado de plantillas de correo disponibles.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (number)

    Cantidad de registros que se desea obtener, por defecto trae todos.

    Example:

    10

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

Can not resolve examples/emailTemplatesResponse.json

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de la plantilla.

patch

Actualizar plantilla de correo.

delete

Borrar una plantilla de correo.

Obtener detalle de la plantilla.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateId: required(number)

    Identificador de la plantilla.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "subject": "Asunto del correo",
      "body": "<p>Cuerpo del correo, normalmente con etiquetas HTML</p>",
      "creationDate": "2020-05-28T13:16:57Z",
      "lastUpdateDate": "2020-05-28T13:16:57Z",
      "templateId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar plantilla de correo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateId: required(number)

    Identificador de la plantilla.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "subject": "Asunto del correo",
  "body": "<p>Cuerpo del correo, normalmente con etiquetas HTML</p>"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "subject": "Asunto del correo",
      "body": "<p>Cuerpo del correo, normalmente con etiquetas HTML</p>",
      "creationDate": "2020-05-28T13:16:57Z",
      "lastUpdateDate": "2020-05-28T13:16:57Z",
      "templateId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar una plantilla de correo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • templateId: required(number)

    Identificador de la plantilla.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Recurso eliminado exitosamente.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear una entidad.

get

Listar las entidades.

Crear una entidad.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"name": "Otra tienda Coruña de Prueba",
	"address": "Calle estación 1",
	"postalCode": "28223",
	"location": "Pozuelo de Alarcón",
	"phone": "910 37 66 00",
	"email": "pozuelo@lafugacycling.com",
	"longitude": "",
	"latitude": "",
	"stateProvince": 4324,
	"country": 70,
	"status": 1,
	"isWeb": 0
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/entities/{entityId}",
  "result": [
    {
      "entityId": 47,
      "merchantId": 82,
      "userId": 0,
      "name": "Tienda Coruña de Prueba",
      "address": "Calle estación 1",
      "postalCode": "28223",
      "location": "Pozuelo de Alarcón",
      "phone": "910 37 66 00",
      "email": "pozuelo@lafugacycling.com",
      "longitude": "",
      "latitude": "",
      "stateProvince": 4324,
      "country": 70,
      "status": 1,
      "isWeb": 0,
      "comment": "",
      "hasSchedule": 0,
      "lastUpdateDate": "2020-03-25T16:09:19Z",
      "creationDate": "2020-03-25T16:09:19Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar las entidades.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/entities/{entityId}",
  "result": [
    {
      "entityId": 47,
      "merchantId": 82,
      "userId": 0,
      "name": "Tienda Coruña de Prueba",
      "address": "Calle estación 1",
      "postalCode": "28223",
      "location": "Pozuelo de Alarcón",
      "phone": "910 37 66 00",
      "email": "pozuelo@lafugacycling.com",
      "longitude": "",
      "latitude": "",
      "stateProvince": 4324,
      "country": 70,
      "status": 1,
      "isWeb": 0,
      "comment": "",
      "hasSchedule": 0,
      "lastUpdateDate": "2020-03-25T16:09:19Z",
      "creationDate": "2020-03-25T16:09:19Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch get delete

patch

Actualizar entidad.

get

Obtener detalle de la entidad.

delete

Borrar una entidad.

Actualizar entidad.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"name": "Otra tienda Coruña de Prueba",
	"address": "Calle estación 1",
	"postalCode": "28223",
	"location": "Pozuelo de Alarcón",
	"phone": "910 37 66 00",
	"email": "pozuelo@lafugacycling.com",
	"longitude": "",
	"latitude": "",
	"stateProvince": 4324,
	"country": 70,
	"status": 1,
	"isWeb": 0
}

HTTP status code 200

Se actualiza la descripción correctamente.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/entities/{entityId}",
  "result": [
    {
      "entityId": 47,
      "merchantId": 82,
      "userId": 0,
      "name": "Tienda Coruña de Prueba",
      "address": "Calle estación 1",
      "postalCode": "28223",
      "location": "Pozuelo de Alarcón",
      "phone": "910 37 66 00",
      "email": "pozuelo@lafugacycling.com",
      "longitude": "",
      "latitude": "",
      "stateProvince": 4324,
      "country": 70,
      "status": 1,
      "isWeb": 0,
      "comment": "",
      "hasSchedule": 0,
      "lastUpdateDate": "2020-03-25T16:09:19Z",
      "creationDate": "2020-03-25T16:09:19Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Obtener detalle de la entidad.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/entities/{entityId}",
  "result": [
    {
      "entityId": 47,
      "merchantId": 82,
      "userId": 0,
      "name": "Tienda Coruña de Prueba",
      "address": "Calle estación 1",
      "postalCode": "28223",
      "location": "Pozuelo de Alarcón",
      "phone": "910 37 66 00",
      "email": "pozuelo@lafugacycling.com",
      "longitude": "",
      "latitude": "",
      "stateProvince": 4324,
      "country": 70,
      "status": 1,
      "isWeb": 0,
      "comment": "",
      "hasSchedule": 0,
      "lastUpdateDate": "2020-03-25T16:09:19Z",
      "creationDate": "2020-03-25T16:09:19Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar una entidad.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar las reservas asociadas al centro/entidad.

Listar las reservas asociadas al centro/entidad.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 82,
      "status": "ENABLED",
      "type": "PAID",
      "minutes": 60,
      "creationDate": "2020-03-20T15:12:08Z",
      "lastUpdateDate": "2020-03-20T15:12:08Z",
      "reservationId": 2
    },
    {
      "merchantId": 82,
      "status": "ENABLED",
      "type": "PAID",
      "minutes": 30,
      "creationDate": "2020-03-20T15:10:26Z",
      "lastUpdateDate": "2020-03-20T15:10:26Z",
      "reservationId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar los recurso items asociados a una entidad / centro.

Listar los recurso items asociados a una entidad / centro.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "resourceId": 2,
      "entityId": 1,
      "name": "Melissa Iñaqui",
      "description": "MD. Especialista en tratamiento reductor",
      "quantity": 1,
      "priority": 2,
      "hasSchedule": true,
      "creationDate": "2020-03-20T22:22:44Z",
      "lastUpdateDate": "2020-03-20T22:22:44Z",
      "itemId": 2
    },
    {
      "resourceId": 2,
      "entityId": 1,
      "name": "Ariadna Collante",
      "description": "MD., PhD. especialista en nutrición de la piel",
      "quantity": 1,
      "priority": 1,
      "hasSchedule": false,
      "creationDate": "2020-03-20T22:20:17Z",
      "lastUpdateDate": "2020-03-20T22:20:17Z",
      "itemId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Añadir horario a un centro de trabajo.

get

Listar los horarios de un centro de trabajo.

Añadir horario a un centro de trabajo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "weekDay": "MONDAY",
  "startTime": "08:00",
  "endTime": "20:00"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "entityId": 21,
      "weekDay": "MONDAY",
      "startTime": "08:00:00",
      "endTime": "20:00:00",
      "creationDate": "2020-04-02T19:25:37Z",
      "lastUpdateDate": "2020-04-02T19:25:37Z",
      "scheduleId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar los horarios de un centro de trabajo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "entityId": 21,
      "weekDay": "MONDAY",
      "startTime": "08:00:00",
      "endTime": "20:00:00",
      "creationDate": "2020-04-02T19:25:37Z",
      "lastUpdateDate": "2020-04-02T19:25:37Z",
      "scheduleId": 1
    },
    {
      "entityId": 21,
      "weekDay": "TUESDAY",
      "startTime": "08:00:00",
      "endTime": "20:00:00",
      "creationDate": "2020-04-02T19:27:16Z",
      "lastUpdateDate": "2020-04-02T19:28:20Z",
      "scheduleId": 2
    },
    {
      "entityId": 21,
      "weekDay": "WEDNESDAY",
      "startTime": "08:00:00",
      "endTime": "20:00:00",
      "creationDate": "2020-04-02T19:27:45Z",
      "lastUpdateDate": "2020-04-02T19:27:45Z",
      "scheduleId": 3
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch get delete

patch

Actualizar horario.

get

Obtener detalle del horario.

delete

Borrar un horario.

Actualizar horario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

  • scheduleId: required(integer)

    Identificador único del horario.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "weekDay": "MONDAY",
  "startTime": "08:00",
  "endTime": "20:00"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "entityId": 21,
      "weekDay": "MONDAY",
      "startTime": "08:00:00",
      "endTime": "20:00:00",
      "creationDate": "2020-04-02T19:25:37Z",
      "lastUpdateDate": "2020-04-02T19:25:37Z",
      "scheduleId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Obtener detalle del horario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

  • scheduleId: required(integer)

    Identificador único del horario.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "entityId": 21,
      "weekDay": "MONDAY",
      "startTime": "08:00:00",
      "endTime": "20:00:00",
      "creationDate": "2020-04-02T19:25:37Z",
      "lastUpdateDate": "2020-04-02T19:25:37Z",
      "scheduleId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un horario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • entityId: required(integer)

    Identificador único de la entidad.

  • scheduleId: required(integer)

    Identificador único del horario.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar los eventos.

Listar los eventos.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Query Parameters

  • categories: (string)

    Id de categorías de noticias separadas por coma.

    Example:

    75,1,78
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es
  • novelty: (integer)

    Especifica si los eventos son novedades o no (1 o 0).

    Example:

    0

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/events",
  "result": [
    {
      "eventId": 1859,
      "merchantId": 114,
      "categoryId": 23,
      "novelty": 0,
      "code": "2020N35",
      "state": "ACTIVE",
      "startDate": "2020-05-16T12:00:00Z",
      "finishDate": "2020-05-16T13:00:00Z",
      "language":"es",
      "images": [
        "https://plataforma.plaam.com/modulos/eventos/subido/82/clasificaciones/20200110190936_socialsociality.jpg",
        "https://plataforma.plaam.com/modulos/eventos/subido/82/clasificaciones/20200110174512_educacioneducation.jpg"
      ],
      "title": "El mundo suena - Concierto en familia",
      "shortDescription": "<p>ARCOS IRIS</p>\r\n<p><a href=\"https://entradas.abanca.com/es/event/el-mundo-suena-concierto-en-familia/\">Comprar entradas y + info</a></p>",
      "largeDescription": "El centro A Coruña, ciudad eminentemente artística y cultural, llena de espacios verdes y mágia, es el marco perfecto para acoger el domingo nuestra Ágora sobre Wellness. En ella se hablará de deporte, se hablará del poder de \"lo natural\", de nuestra esencia. Pero no nos quedaremos solo en Madrid. Irémos de peregrinación por la ruta dos \"Camiños dos Faros\", siguiendo las luces que iluminaron durante siglos a los marinos a través de la oscuridad del mar. Ahora, convertidos en simples edificios, siguen guiando una de las rutas más hermosas del Norte peninsular.",
      "type": "BRICK",
      "place": "Palacio de la Ópera de A Coruña",
      "address":{
        "line1":"Rúa Hábitat, 10 Bajo",
        "line2":"",
        "city":"Oleiros",
        "stateProvince":"A Coruña",
        "postalCode":"15172",
        "country":"ES"
      },
      "location":{
        "longitude":43.363133,
        "latitude":-8.411265,
        "altitude":0,
        "relevantText":"Bienvenido al Palacio de la Ópera de A Coruña"
      },
      "capacity": 20,
      "creationDate": "2020-01-19T22:32:42Z",
      "lastUpdateDate": "2020-01-19T22:32:42Z"
    },
    {
      "eventId": 1858,
      "merchantId": 114,
      "categoryId": 24,
      "novelty": 1,
      "code": "2020N36",
      "state": "ACTIVE",
      "startDate": "2020-05-16T13:00:00Z",
      "finishDate": "2020-05-16T14:00:00Z",
      "language":"es",
      "images": [
        "https://plataforma.plaam.com/modulos/eventos/subido/82/clasificaciones/20200110190936_socialsociality.jpg",
        "https://plataforma.plaam.com/modulos/eventos/subido/82/clasificaciones/20200110174512_educacioneducation.jpg"
      ],
      "title": "Ágora México - Cocoyoc",
      "shortDescription": "La felicidad es un sentimiento que nos esmeramos por encontrar y mantener a lo largo de la vida por todos los beneficios que genera. Ser feliz significa sentirse satisfecho, alegre y tener la sensación de que la vida es significativa.",
      "largeDescription": "La felicidad es un sentimiento que nos esmeramos por encontrar y mantener a lo largo de la vida por todos los beneficios que genera. Ser feliz significa sentirse satisfecho, alegre y tener la sensación de que la vida es significativa. En este encuentro, analizaremos la felicidad desde una perspectiva integral y propondremos métodos prácticos para poder aumentar nuestra felicidad en los diferentes escenarios: a nivel personal, en nuestra organización, con nuestra pareja, con nuestros hijos y en diversos ámbitos a nivel social.",
      "type": "ONLINE",
      "capacity": 0,
      "creationDate": "2020-01-19T22:32:42Z",
      "lastUpdateDate": "2020-01-19T22:32:42Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar las categorías de evento.

Listar las categorías de evento.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • active: (one of WEB, APP)

    Activas y para WEB, APP. Por defecto trae todos los resultados.

    Example:

    WEB
  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/events/categories",
  "result": [
    {
      "categoryId": 59,
      "merchantId": 82,
      "name": "Webinar",
      "status": 1,
      "configuration": 3,
      "lastUpdateDate": "2019-10-04T08:11:15Z"
    },
    {
      "categoryId": 58,
      "merchantId": 82,
      "name": "Nuevo tipo",
      "status": 1,
      "configuration": 3,
      "lastUpdateDate": "2019-09-25T14:55:54Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener detalle de una categoría.

Obtener detalle de una categoría.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(string)

    Identificador único de la categoría.

Query Parameters

  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/events/categories/{categoryId}",
  "result": [
    {
      "categoryId": 59,
      "merchantId": 82,
      "name": "Webinar",
      "status": 1,
      "configuration": 3,
      "lastUpdateDate": "2019-10-04T08:11:15Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener detalle de un evento.

Obtener detalle de un evento.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • eventId: required(integer)

    Identificador único del evento.

Query Parameters

  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/events/{eventId}",
  "result": [
    {
      "eventId": 1859,
      "merchantId": 114,
      "categoryId": 23,
      "novelty": 0,
      "code": "2020N35",
      "state": "ACTIVE",
      "startDate": "2020-05-16T12:00:00Z",
      "finishDate": "2020-05-16T13:00:00Z",
      "language":"es",
      "images": [
        "https://plataforma.plaam.com/modulos/eventos/subido/82/clasificaciones/20200110190936_socialsociality.jpg",
        "https://plataforma.plaam.com/modulos/eventos/subido/82/clasificaciones/20200110174512_educacioneducation.jpg"
      ],
      "title": "El mundo suena - Concierto en familia",
      "shortDescription": "<p>ARCOS IRIS</p>\r\n<p><a href=\"https://entradas.abanca.com/es/event/el-mundo-suena-concierto-en-familia/\">Comprar entradas y + info</a></p>",
      "largeDescription": "El centro Madrid, ciudad eminentemente artística y cultural, llena de espacios verdes y mágia, es el marco perfecto para acoger el domingo nuestra Ágora sobre Wellness. En ella se hablará de deporte, se hablará del poder de \"lo natural\", de nuestra esencia. Pero no nos quedaremos solo en Madrid. Irémos de peregrinación por la ruta dos \"Camiños dos Faros\", siguiendo las luces que iluminaron durante siglos a los marinos a través de la oscuridad del mar. Ahora, convertidos en simples edificios, siguen guiando una de las rutas más hermosas del Norte peninsular.",
      "type": "BRICK",
      "place": "Palacio de la Ópera de A Coruña",
      "address":{
        "line1":"Rúa Hábitat, 10 Bajo",
        "line2":"",
        "city":"Oleiros",
        "stateProvince":"A Coruña",
        "postalCode":"15172",
        "country":"ES"
      },
      "location":{
        "longitude":43.363133,
        "latitude":-8.411265,
        "altitude":0,
        "relevantText":"Bienvenido al Palacio de la Ópera de A Coruña"
      },
      "capacity": 20,
      "creationDate": "2020-01-19T22:32:42Z",
      "lastUpdateDate": "2020-01-19T22:32:42Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener los productos asociados al evento.

Obtener los productos asociados al evento.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • eventId: required(integer)

    Identificador único del evento.

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "productId": 444279,
      "merchantId": 82,
      "categoryId": 2233,
      "brandId": 0,
      "collectionId": 0,
      "name": "Camiseta Felicidad",
      "description": "Camiseta 100% algodón con el logo del Happiness Fest",
      "iva": 21,
      "unitType": "UNIT",
      "unitName": "",
      "currency": "EUR",
      "type": "MERCHANDISE",
      "keywords": "",
      "variant": {
        "barcode": "243290441KTAM",
        "factoryCode": "",
        "imagesURL": [
          "https://plataforma.plaam.com/modulos/e-commerce/archivos/82/variantes/14223_20191031144512_camisetablanca"
        ],
        "color": "#ffffff",
        "dimensions": {
          "weight": "0.000",
          "width": "0.000",
          "high": "0.000",
          "depth": "0.000"
        },
        "variantId": 14223,
        "price": 2995,
        "stock": 5,
        "offer": 0,
        "options": [
          {
            "id": 107,
            "value": "S"
          },
          {
            "id": 108,
            "value": "Blanco"
          }
        ]
      },
      "imagesURL": [
        "https://plataforma.plaam.com/modulos/e-commerce/archivos/82/444279_20191031144052_camisetanegra"
      ],
      "creationDate": "2019-10-31T12:57:10Z",
      "lastUpdateDate": "2020-01-26T18:14:20Z",
      "options": [
        {
          "id": 108,
          "label": "Color",
          "values": [
            {
              "value": "Blanco",
              "backgroundColor": "#ffffff",
              "imageURL": "https://plataforma.plaam.com/modulos/e-commerce/archivos/82/108_20200126163710_file.png"
            },
            {
              "value": "Negro",
              "backgroundColor": "#000000",
              "imageURL": "https://plataforma.plaam.com/modulos/e-commerce/archivos/82/108_20200126163718_LOGOWORLDHAPPINESSFESTBECREATION.jpg"
            }
          ]
        },
        {
          "id": 107,
          "name": "Talla",
          "values": [
            {
              "value": "S",
              "backgroundColor": null,
              "imageURL": null
            },
            {
              "value": "M",
              "backgroundColor": null,
              "imageURL": null
            },
            {
              "value": "L",
              "backgroundColor": null,
              "imageURL": null
            }
          ]
        }
      ],
      "attributes": [
        {
          "label": "Material",
          "value": "Algodon"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea un registro de asociación de un evento con un producto.

delete

Borrar un registro de asociación de un evento con un producto.

Crea un registro de asociación de un evento con un producto.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • eventId: required(integer)

    Identificador único del evento.

  • productId: required(integer)

    Identificador único del producto.

  • variantId: required(integer)

    Identificador único de la variante.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "eventId": 1859,
  "merchantId": 114,
  "productId": 11,
  "variantId": 14,
  "type": "PHYSICAL"
}

HTTP status code 201

Se crea un registro de asociación de un evento con un producto.

Body

Media type: application/json

Type: any

Example:

{
  "input": "POST/merchants/{merchantId}/events/{eventId}/products/{productId}/variants/{variantId}",
  "result": [
    {
      "eventId": 1859,
      "merchantId": 114,
      "productId": 11,
      "variantId": 14,
      "type": "PHYSICAL",
      "creationDate": "2020-01-19T22:32:42Z",
      "lastUpdateDate": "2020-01-19T22:32:42Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un registro de asociación de un evento con un producto.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • eventId: required(integer)

    Identificador único del evento.

  • productId: required(integer)

    Identificador único del producto.

  • variantId: required(integer)

    Identificador único de la variante.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimino un registro de asociación de un evento con un producto.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar el conteo de entradas vendidas y adquiridas por código promocional.

Listar el conteo de entradas vendidas y adquiridas por código promocional.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • eventId: required(integer)

    Identificador único del evento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/events/{eventId}/tickets/sells",
  "result": [
    {
      "count": 14,
      "soldCount": 14,
      "promocodeCount": 0,
      "users": [
        {
          "name": "José Delgado Pérez",
          "email": "josed43@gmail.com",
          "ticketUUID": "fac4d2ef-ab7c-4cef-9a6b-0bc1232537db"
        },
        {
          "name": "Julio Amaya",
          "email": "atpjulio@gmail.com",
          "ticketUUID": "7abf3742-a3de-4fe3-a919-e1e20c6d0635"
        },
        {
          "name": "Julio Amaya",
          "email": "atpjulio@gmail.com",
          "ticketUUID": "e35e5dc1-f3c2-4de7-8610-5070fabde5e1"
        },
        {
          "name": "Julio Amaya",
          "email": "atpjulio@gmail.com",
          "ticketUUID": "6b801d7c-0053-45bb-b7ff-42c37f7ca92a"
        },
        {
          "name": "Mario A. Contreras Baruh",
          "email": "mcontreras@qaroni.com",
          "ticketUUID": "6f63fb86-61cb-4411-86bb-b24efab0fa61"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Validar el ticket de evento.

Validar el ticket de evento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • eventId: required(integer)

    Identificador único del evento.

  • UUID: required(string)

    Identificador único del ticket del evento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/events/{eventId}/tickets/{UUID}/validates",
  "result": [
    {
      "status": "ENABLED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear un nuevo campo.

get

Listado de los campos ordenados alfabéticamente.

Crear un nuevo campo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"type": "EMAIL",
	"name": "Campo email"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "type": "EMAIL",
      "name": "Campo email",
      "creationDate": "2020-03-31T02:43:27Z",
      "lastUpdateDate": "2020-03-31T02:43:27Z",
      "fieldId": 1,
      "options": []
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listado de los campos ordenados alfabéticamente.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (number)

    Cantidad de registros que se desea obtener, por defecto trae todos.

    Example:

    10

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "type": "PASSWORD",
      "name": "Campo contraseña",
      "creationDate": "2020-03-31T02:46:57Z",
      "lastUpdateDate": "2020-03-31T02:46:57Z",
      "fieldId": 2,
      "options": []
    },
    {
      "merchantId": "82",
      "type": "EMAIL",
      "name": "Campo email",
      "creationDate": "2020-03-31T02:43:27Z",
      "lastUpdateDate": "2020-03-31T02:43:27Z",
      "fieldId": 1,
      "options": []
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de un campo.

patch

Actualizar campo.

delete

Borrar un campo.

Obtener detalle de un campo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "type": "EMAIL",
      "name": "Campo email",
      "creationDate": "2020-03-31T02:43:27Z",
      "lastUpdateDate": "2020-03-31T02:43:27Z",
      "fieldId": 1,
      "options": []
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar campo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"type": "EMAIL",
	"name": "Campo email"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": "82",
      "type": "EMAIL",
      "name": "Campo email",
      "creationDate": "2020-03-31T02:43:27Z",
      "lastUpdateDate": "2020-03-31T02:43:27Z",
      "fieldId": 1,
      "options": []
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un campo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Recurso eliminado exitosamente.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Añadir una opción al campo del formulario dinámico.

get

Listado de las opciones del campo.

Añadir una opción al campo del formulario dinámico.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "value": "PASSPORT",
  "name": "Pasaporte"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "fieldId": 4,
      "value": "PASSPORT",
      "name": "Pasaporte",
      "creationDate": "2020-03-31T03:07:02Z",
      "lastUpdateDate": "2020-03-31T03:07:02Z",
      "optionId": 1
    },
    {
      "fieldId": 4,
      "value": "DNI",
      "name": "DNI",
      "creationDate": "2020-03-31T03:11:20Z",
      "lastUpdateDate": "2020-03-31T03:11:20Z",
      "optionId": 2
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listado de las opciones del campo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "fieldId": 4,
      "value": "PASSPORT",
      "name": "Pasaporte",
      "creationDate": "2020-03-31T03:07:02Z",
      "lastUpdateDate": "2020-03-31T03:07:02Z",
      "optionId": 1
    },
    {
      "fieldId": 4,
      "value": "DNI",
      "name": "DNI",
      "creationDate": "2020-03-31T03:11:20Z",
      "lastUpdateDate": "2020-03-31T03:11:20Z",
      "optionId": 2
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch delete

patch

Actualizar opción de un campo de formulario dinámico.

delete

Borrar una opción de un campo del formulario dinámico y devuelve listado actualizado.

Actualizar opción de un campo de formulario dinámico.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

  • optionId: required(number)

    Identificador único de la opción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "value": "PASSPORT",
  "name": "Pasaporte"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "fieldId": 4,
      "value": "PASSPORT",
      "name": "Pasaporte",
      "creationDate": "2020-03-31T03:07:02Z",
      "lastUpdateDate": "2020-03-31T03:07:02Z",
      "optionId": 1
    },
    {
      "fieldId": 4,
      "value": "DNI",
      "name": "DNI",
      "creationDate": "2020-03-31T03:11:20Z",
      "lastUpdateDate": "2020-03-31T03:11:20Z",
      "optionId": 2
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar una opción de un campo del formulario dinámico y devuelve listado actualizado.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • fieldId: required(number)

    Identificador del campo.

  • optionId: required(number)

    Identificador único de la opción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "fieldId": 4,
      "value": "PASSPORT",
      "name": "Pasaporte",
      "creationDate": "2020-03-31T03:07:02Z",
      "lastUpdateDate": "2020-03-31T03:07:02Z",
      "optionId": 1
    },
    {
      "fieldId": 4,
      "value": "DNI",
      "name": "DNI",
      "creationDate": "2020-03-31T03:11:20Z",
      "lastUpdateDate": "2020-03-31T03:11:20Z",
      "optionId": 2
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear un nuevo formulario dinámico.

get

Listado de los formularios dinámicos.

Crear un nuevo formulario dinámico.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil",
      "creationDate": "2020-03-16T14:59:28Z",
      "lastUpdateDate": "2020-03-16T14:59:28Z",
      "formId": 1
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listado de los formularios dinámicos.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (number)

    Cantidad de registros que se desea obtener, por defecto trae todos.

    Example:

    10

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "name": "Formulario de datos personales y fecha de nacimiento: Nombre, Apellido, DNI, Móvil y Fecha de nacimiento",
      "creationDate": "2020-03-16T15:13:37Z",
      "lastUpdateDate": "2020-03-16T15:16:11Z",
      "formId": 2
    },
    {
      "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil",
      "creationDate": "2020-03-16T15:13:29Z",
      "lastUpdateDate": "2020-03-16T15:13:29Z",
      "formId": 1
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listado de los formularios dinámicos.

Listado de los formularios dinámicos.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (number)

    Cantidad de registros que se desea obtener, por defecto trae todos.

    Example:

    10

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "name": "Formulario de datos personales y fecha de nacimiento: Nombre, Apellido, DNI, Móvil y Fecha de nacimiento",
      "creationDate": "2020-03-16T15:13:37Z",
      "lastUpdateDate": "2020-03-16T15:16:11Z",
      "formId": 2
    },
    {
      "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil",
      "creationDate": "2020-03-16T15:13:29Z",
      "lastUpdateDate": "2020-03-16T15:13:29Z",
      "formId": 1
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de un formulario dinámico.

patch

Actualizar nombre de formulario dinámico.

delete

Borrar un formulario dinámico.

Obtener detalle de un formulario dinámico.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil",
      "creationDate": "2020-03-16T14:59:28Z",
      "lastUpdateDate": "2020-03-16T14:59:28Z",
      "formId": 1
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar nombre de formulario dinámico.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "name": "Formulario de datos personales básicos: Nombre, Apellido, DNI, Móvil",
      "creationDate": "2020-03-16T14:59:28Z",
      "lastUpdateDate": "2020-03-16T14:59:28Z",
      "formId": 1
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un formulario dinámico.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Recurso eliminado exitosamente.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear un nuevo campo y asociarlo al formulario.

get

Listado de los campos asociados al formulario.

Crear un nuevo campo y asociarlo al formulario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "type": "TEXT",
  "position": 1,
  "required": true,
  "name": "first_name",
  "label": "Nombres",
  "line": 1,
  "hint": "Ayuda que se puede mostrar en el campo"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/forms/{formId}/fields/{fieldId}",
  "result": [
    {
      "formId": 1,
      "fieldId": 5,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:29:31Z",
      "lastUpdateDate": "2020-03-31T03:29:31Z",
      "field": {
        "type": "TEXT",
        "name": "first_name",
        "label": "Nombres",
        "creationDate": "2020-03-31T03:29:31Z",
        "lastUpdateDate": "2020-03-31T03:29:31Z",
        "fieldId": 5,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 6,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:30:52Z",
      "lastUpdateDate": "2020-03-31T03:30:52Z",
      "field": {
        "type": "TEXT",
        "name": "last_name",
        "label": "Apellidos"
        "creationDate": "2020-03-31T03:30:52Z",
        "lastUpdateDate": "2020-03-31T03:37:52Z",
        "fieldId": 6,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 4,
      "position": 3,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:59:55Z",
      "lastUpdateDate": "2020-03-31T03:59:55Z",
      "field": {
        "type": "SELECT",
        "name": "document_type",
        "label": "Tipo de documento",
        "creationDate": "2020-03-31T03:06:33Z",
        "lastUpdateDate": "2020-03-31T03:06:33Z",
        "fieldId": 4,
        "options": [
          {
            "fieldId": 4,
            "value": "PASSPORT",
            "name": "Pasaporte",
            "creationDate": "2020-03-31T03:07:02Z",
            "lastUpdateDate": "2020-03-31T03:07:02Z",
            "optionId": 1
          },
          {
            "fieldId": 4,
            "value": "DNI",
            "name": "DNI editado",
            "creationDate": "2020-03-31T03:11:20Z",
            "lastUpdateDate": "2020-03-31T03:17:05Z",
            "optionId": 2
          }
        ]
      }
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listado de los campos asociados al formulario.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "input": "POST/forms/{formId}/fields/{fieldId}",
  "result": [
    {
      "formId": 1,
      "fieldId": 5,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:29:31Z",
      "lastUpdateDate": "2020-03-31T03:29:31Z",
      "field": {
        "type": "TEXT",
        "name": "first_name",
        "label": "Nombres",
        "creationDate": "2020-03-31T03:29:31Z",
        "lastUpdateDate": "2020-03-31T03:29:31Z",
        "fieldId": 5,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 6,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:30:52Z",
      "lastUpdateDate": "2020-03-31T03:30:52Z",
      "field": {
        "type": "TEXT",
        "name": "last_name",
        "label": "Apellidos"
        "creationDate": "2020-03-31T03:30:52Z",
        "lastUpdateDate": "2020-03-31T03:37:52Z",
        "fieldId": 6,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 4,
      "position": 3,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:59:55Z",
      "lastUpdateDate": "2020-03-31T03:59:55Z",
      "field": {
        "type": "SELECT",
        "name": "document_type",
        "label": "Tipo de documento",
        "creationDate": "2020-03-31T03:06:33Z",
        "lastUpdateDate": "2020-03-31T03:06:33Z",
        "fieldId": 4,
        "options": [
          {
            "fieldId": 4,
            "value": "PASSPORT",
            "name": "Pasaporte",
            "creationDate": "2020-03-31T03:07:02Z",
            "lastUpdateDate": "2020-03-31T03:07:02Z",
            "optionId": 1
          },
          {
            "fieldId": 4,
            "value": "DNI",
            "name": "DNI editado",
            "creationDate": "2020-03-31T03:11:20Z",
            "lastUpdateDate": "2020-03-31T03:17:05Z",
            "optionId": 2
          }
        ]
      }
    }
  ]
}

HTTP status code 400

post delete

post

Asociar campo al formulario, especificando posición y si es requerido.

delete

Desasociar campo al formulario.

Asociar campo al formulario, especificando posición y si es requerido.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "position": 1,
  "required": true,
  "line": 1,
  "hint": "Ayuda que se puede mostrar en el campo"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/forms/{formId}/fields/{fieldId}",
  "result": [
    {
      "formId": 1,
      "fieldId": 5,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:29:31Z",
      "lastUpdateDate": "2020-03-31T03:29:31Z",
      "field": {
        "type": "TEXT",
        "name": "first_name",
        "label": "Nombres",
        "creationDate": "2020-03-31T03:29:31Z",
        "lastUpdateDate": "2020-03-31T03:29:31Z",
        "fieldId": 5,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 6,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:30:52Z",
      "lastUpdateDate": "2020-03-31T03:30:52Z",
      "field": {
        "type": "TEXT",
        "name": "last_name",
        "label": "Apellidos"
        "creationDate": "2020-03-31T03:30:52Z",
        "lastUpdateDate": "2020-03-31T03:37:52Z",
        "fieldId": 6,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 4,
      "position": 3,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:59:55Z",
      "lastUpdateDate": "2020-03-31T03:59:55Z",
      "field": {
        "type": "SELECT",
        "name": "document_type",
        "label": "Tipo de documento",
        "creationDate": "2020-03-31T03:06:33Z",
        "lastUpdateDate": "2020-03-31T03:06:33Z",
        "fieldId": 4,
        "options": [
          {
            "fieldId": 4,
            "value": "PASSPORT",
            "name": "Pasaporte",
            "creationDate": "2020-03-31T03:07:02Z",
            "lastUpdateDate": "2020-03-31T03:07:02Z",
            "optionId": 1
          },
          {
            "fieldId": 4,
            "value": "DNI",
            "name": "DNI editado",
            "creationDate": "2020-03-31T03:11:20Z",
            "lastUpdateDate": "2020-03-31T03:17:05Z",
            "optionId": 2
          }
        ]
      }
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Desasociar campo al formulario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • formId: required(number)

    Identificador de la inscripción.

  • fieldId: required(number)

    Identificador del campo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se desasocia el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/forms/{formId}/fields/{fieldId}",
  "result": [
    {
      "formId": 1,
      "fieldId": 5,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:29:31Z",
      "lastUpdateDate": "2020-03-31T03:29:31Z",
      "field": {
        "type": "TEXT",
        "name": "first_name",
        "label": "Nombres",
        "creationDate": "2020-03-31T03:29:31Z",
        "lastUpdateDate": "2020-03-31T03:29:31Z",
        "fieldId": 5,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 6,
      "position": 1,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:30:52Z",
      "lastUpdateDate": "2020-03-31T03:30:52Z",
      "field": {
        "type": "TEXT",
        "name": "last_name",
        "label": "Apellidos"
        "creationDate": "2020-03-31T03:30:52Z",
        "lastUpdateDate": "2020-03-31T03:37:52Z",
        "fieldId": 6,
        "options": []
      }
    },
    {
      "formId": 1,
      "fieldId": 4,
      "position": 3,
      "required": true,
      "line": 1,
      "hint": "Consejo en el campo",
      "creationDate": "2020-03-31T03:59:55Z",
      "lastUpdateDate": "2020-03-31T03:59:55Z",
      "field": {
        "type": "SELECT",
        "name": "document_type",
        "label": "Tipo de documento",
        "creationDate": "2020-03-31T03:06:33Z",
        "lastUpdateDate": "2020-03-31T03:06:33Z",
        "fieldId": 4,
        "options": [
          {
            "fieldId": 4,
            "value": "PASSPORT",
            "name": "Pasaporte",
            "creationDate": "2020-03-31T03:07:02Z",
            "lastUpdateDate": "2020-03-31T03:07:02Z",
            "optionId": 1
          },
          {
            "fieldId": 4,
            "value": "DNI",
            "name": "DNI editado",
            "creationDate": "2020-03-31T03:11:20Z",
            "lastUpdateDate": "2020-03-31T03:17:05Z",
            "optionId": 2
          }
        ]
      }
    }
  ]
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post
get

Listar los grupos de una empresa.

Secured by

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
	"formId": null,
	"categoryId": null,
	"status": "ACTIVE",
	"months": 6,
	"isPaid": true,
	"hasApproval": true,
	"descriptions": [
		"language": "es",
		"name": "Gremio de conductores",
		"description": "Gremio de conductores de la línea de taxis 123"
	]
}

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by

Listar los grupos de una empresa.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Status del grupo.

    Example:

    ACTIVE
  • type: (one of PERSON, ENTITY)

    Tipo del grupo.

    Example:

    PERSON
  • isPaid: (boolean)

    Es de tipo paga. Por defecto trae todos.

    Example:

    true
  • hasApproval: (boolean)

    Requiere aprobación. Por defecto trae todos.

    Example:

    true

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 2,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "months": 12,
            "name": "Gremio de mototaxistas",
            "description": "Gremio de conductores de la línea de mototaxis 123",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": null,
            "variantId": null,
            "price": null,
            "iva": null,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 2,
            "imageUrl": null
        },
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": null,
            "status": "ACTIVE",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear categoría de grupo, se debe enviar la descripción en al menos un idioma.

get

Listar categorías de grupos.

Crear categoría de grupo, se debe enviar la descripción en al menos un idioma.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "status": "ACTIVE",
  "descriptions": [
    {
      "language": "es",
      "name": "Nombre de categoría de asociación",
      "description": "Descripción de categoría de asociación"
    }
  ]
}

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar categorías de grupos.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Status del descuento.

    Example:

    ACTIVE

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de la categoría.

patch

Actualizar categoría de grupo.

delete

Borrar un a categoría de grupo.

Obtener detalle de la categoría.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar categoría de grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"status": "ACTIVE"
}

HTTP status code 200

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un a categoría de grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de manera correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crea una nueva descripción asociada a la categoría de grupo.

get

Se obtienen las descripciones en múltiples idiomas.

Crea una nueva descripción asociada a la categoría de grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "language":"es",
  "name":"Nombre de categoría de asociación",
  "description":"Descripción de categoría de asociación"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Se obtienen las descripciones en múltiples idiomas.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "language": "es",
      "name": "Nombre de categoría de asociación",
      "description": "Descripción de categoría de asociación"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea una nueva descripción en el idioma recibido, asociada a la categoría del grupo.

delete

Eliminar registro en el idioma enviado.

Crea una nueva descripción en el idioma recibido, asociada a la categoría del grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "name": "Nombre de categoría de asociación",
  "description": "Descripción de categoría de asociación"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Eliminar registro en el idioma enviado.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina el recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Añade o actualiza imagen de la categoría del grupo.

delete

Borrar imagen de la categoría del grupo.

Añade o actualiza imagen de la categoría del grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • image: required(file)

    Fichero a subir.

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar imagen de la categoría del grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • categoryId: required(integer)

    Identificador único de la categoría.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se elimina registro correctamente.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "status": "ACTIVE",
            "language": "es",
            "name": "Nombre de categoría de asociación",
            "description": "Descripción de categoría de asociación",
            "creationDate": "2020-05-09T23:48:50Z",
            "lastUpdateDate": "2020-05-09T23:54:43Z",
            "categoryId": 1,
            "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/category/87/1/logoSolo.png"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar las compañías de un comercio.

Listar las compañías de un comercio.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • page: (integer)

    Activa la paginación, ubica la página enviada.

    Example:

    1
  • pagination: (integer)

    Cantidad de registros a paginar, por defecto son 60.

    Example:

    10
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Status de la compañía.

    Example:

    ACTIVE
  • groups: (number)

    Id del grupo o grupos separados por coma.

    Example:

    1
  • categories: (number)

    Id de la categoría del grupo o categorías separados por coma.

    Example:

    13
  • isPartner: (boolean)

    Es de tipo partner. Por defecto trae todos.

    Example:

    true
  • search: (number)

    Buscar por name, tradename, email, cif, phone, secondaryPhone.

    Example:

    correo@ejemplo.com

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "userId": 89,
      "inscriptionId": 13,
      "partnerId": null,
      "groupId": 2,
      "isPartner": false,
      "status": "ACTIVE",
      "name": "Qaroni EMEA",
      "tradename": null,
      "cif": "B70611942",
      "email": "contact@qaroni.com",
      "phone": "62839823",
      "secondaryPhone": null,
      "code": "scjnc239333r",
      "walletUrl": null,
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "companyId": 2,
      "imageUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "postalCode": "15172",
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-05-26T01:41:37Z",
          "lastUpdateDate": "2020-05-26T01:41:37Z",
          "addressId": 2
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch

patch

Expirar socios y compañías que se les termine el tiempo de su licencia.

Expirar socios y compañías que se les termine el tiempo de su licencia.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

HTTP status code 200

Se actualizan los recursos de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar miembros de grupo/asociación.

Listar miembros de grupo/asociación.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • page: (integer)

    Activa la paginación, ubica la página enviada.

    Example:

    1
  • pagination: (integer)

    Cantidad de registros a paginar, por defecto son 60.

    Example:

    10
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • groups: (number)

    Id del grupo o grupos separados por coma.

    Example:

    1
  • categories: (number)

    Id de la categoría del grupo o categorías separados por coma.

    Example:

    13
  • partners: (number)

    Id del partner o partners separados por coma.

    Example:

    13
  • search: (number)

    Buscar por code, firstName, lastName, email, phone.

    Example:

    correo@ejemplo.com

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "groupId": 23,
      "userId": 211,
      "inscriptionId": 12,
      "status": "ACTIVE",
      "code": "3fc0e463-b93e-4ad0-a7e3-480cced98de6",
      "userInfo": {
        "id": 9,
        "memberId": 51,
        "partnerId": null,
        "email": "pablo@labraxsoluciones.com",
        "firstName": "MArio",
        "lastName": "Cernandas",
        "gender": "MALE",
        "documentType": "CIF",
        "document": "123123123w",
        "birthday": "2020-06-04",
        "phone": "91231231",
        "language": "es",
        "creationDate": "2020-06-04T13:09:51Z",
        "lastUpdateDate": "2020-06-04T13:09:51Z"
      },
      "groupInfo": {
        "merchantId": 71,
        "formId": 11,
        "categoryId": 6,
        "emailTemplateId": null,
        "serieId": null,
        "templateUUID": null,
        "status": "ACTIVE",
        "type": "PERSON",
        "months": 12,
        "isPaid": false,
        "hasApproval": true,
        "language": "es",
        "name": "Pasaporte del Surf",
        "description": "<p><strong>Hola, nuevo surfista, est&aacute;s a punto de entrar en el apasionante mundo del deporte del surfing, y desde la Federaci&oacute;n Espa&ntilde;ola de Surf queremos darte la bienvenida y ayudarte en tus primeros pasos.</strong></p>\r\n<p>Muchos de vosotros no hab&eacute;is practicado antes este deporte, y con este pasaporte y las ense&ntilde;anzas de<br /> vuestros monitores en el surfcamp, estamos seguros de que disfrutareis una experiencia inolvidable<br /> que esperamos os una al mar, las olas y el surf de ahora en adelante.</p>\r\n<p>El pasaporte digital que tienes en tus manos es una gu&iacute;a b&aacute;sica de iniciaci&oacute;n a este deporte, con informaci&oacute;n<br /> del material deportivo que se utiliza y su correcto uso, adem&aacute;s de contenido que nos explica el origen<br /> y funcionamiento de las olas y las importantes caracter&iacute;sticas del medio marino donde practicamos<br /> el surf (oleaje, corrientes, mareas, fondos, vientos, etc) realizada por Todosurf.com. Tambi&eacute;n incluye<br /> las normas b&aacute;sicas de comportamiento en el agua ilustradas por Surf and Comics y una parte dedicada<br /> al cuidado y protecci&oacute;n del medioambiente a trav&eacute;s del surfing a cargo de Surf&amp;Clean. Todo ello con<br /> citas del libro &ldquo;La Ciencia del Surf&rdquo; del ocean&oacute;grafo y surfista de olas grandes, Tony Butt.</p>\r\n<p><br /><br /></p>\r\n<p><a href=\"https://fesurf.staging.plaam.com/#/pages/854\">Cuestionario</a></p>",
        "creationDate": "2020-05-25T11:57:58Z",
        "lastUpdateDate": "2020-05-25T12:22:22Z",
        "groupId": 23,
        "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/71/23/fondo-hola.jpg"
      },
      "creationDate": "2020-06-04T13:09:51Z",
      "lastUpdateDate": "2020-06-04T13:09:51Z",
      "memberId": 51,
      "walletUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "calle",
          "line2": null,
          "postalCode": "12312",
          "city": "coruña",
          "stateProvince": "coruña",
          "country": "ES",
          "creationDate": "2020-06-04T13:09:51Z",
          "lastUpdateDate": "2020-06-04T13:09:51Z",
          "addressId": 3
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar las inscripciones de un grupo.

Listar las inscripciones de un grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • page: (integer)

    Activa la paginación, ubica la página enviada.

    Example:

    1
  • pagination: (integer)

    Cantidad de registros a paginar, por defecto son 60.

    Example:

    10
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of ADMITTED, ACTIVE, PENDING, REJECTED, REVISION)

    Status de la inscripción.

    Example:

    ADMITTED
  • categories: (number)

    Id de la categoría del grupo o categorías separados por coma.

    Example:

    13
  • partners: (number)

    Id del partner o partners separados por coma.

    Example:

    13
  • search: (number)

    Buscar por firstName, lastName, email, phone.

    Example:

    correo@ejemplo.com

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear serie para el grupo.

get

Listar las series de grupo de un comercio.

Crear serie para el grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "preffix": "M",
  "description": "Prefijo de la serie"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "serieId": 1,
      "merchantId": 87,
      "preffix": "M",
      "number": 0,
      "description": "Prefijo de la serie",
      "creationDate": "2020-05-21T09:00:17Z",
      "lastUpdateDate": "2020-05-21T09:00:17Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar las series de grupo de un comercio.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "serieId": 1,
      "merchantId": 87,
      "preffix": "M",
      "number": 0,
      "description": "Prefijo de la serie",
      "creationDate": "2020-05-21T09:00:17Z",
      "lastUpdateDate": "2020-05-21T09:00:17Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Obtener detalle de la serie.

patch

Actualizar serie. Ningún campo es obligatorio en el request.

Obtener detalle de la serie.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • serieId: required(string)
  • groupId: required(integer)

    Identificador único de la serie del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "serieId": 1,
      "merchantId": 87,
      "preffix": "M",
      "number": 0,
      "description": "Prefijo de la serie",
      "creationDate": "2020-05-21T09:00:17Z",
      "lastUpdateDate": "2020-05-21T09:00:17Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar serie. Ningún campo es obligatorio en el request.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • serieId: required(string)
  • groupId: required(integer)

    Identificador único de la serie del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "preffix": "M",
  "description": "Prefijo de la serie"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "serieId": 1,
      "merchantId": 87,
      "preffix": "M",
      "number": 0,
      "description": "Prefijo de la serie",
      "creationDate": "2020-05-21T09:00:17Z",
      "lastUpdateDate": "2020-05-21T09:00:17Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle del grupo.

patch

Actualizar grupo. No se puede modificar la descripción ni el nombre, esto se hace desde descriptions.

delete

Borrar un grupo.

Obtener detalle del grupo.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar grupo. No se puede modificar la descripción ni el nombre, esto se hace desde descriptions.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
	"templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
	"formId": null,
	"categoryId": null,
	"status": "ACTIVE",
	"months": 6,
	"isPaid": true,
	"hasApproval": true
}

HTTP status code 200

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de manera correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear inscripción de compañía. Valores posibles de status ACTIVE, ADMITTED, PENDING, REJECTED, REVISION.

get

Listar las inscripciones de un grupo de tipo ENTITY.

Crear inscripción de compañía. Valores posibles de status ACTIVE, ADMITTED, PENDING, REJECTED, REVISION.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "status": "PENDING",
  "userId": 89,
  "isPartner": false,
  "formId": 4,
  "partnerId": null,
  "formJson": {
    "company_mission": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento",
    "company_description": "Descripción sencilla de lo que somos"
  },
  "addressJson": {
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "postalCode": "15172",
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "country": "ES"
  },
  "companyJson": {
    "name": "Qaroni EMEA",
    "tradename": "Qaroni",
    "cif": "B70611942",
    "email": "contact@qaroni.com",
    "phone": "62839823",
    "secondaryPhone": null
  },
  "companyAddressJson": {
    "line1": "Rúa Hábitat, 11 Bajo",
    "line2": null,
    "postalCode": "15173",
    "city": "Oleiros",
    "stateProvince": "A Coruña",
  }
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "groupId": 2,
      "userId": "89",
      "isPartner": false,
      "merchantId": 87,
      "formId": 4,
      "partnerId": null,
      "partner": null,
      "reason": null,
      "formJson": {
        "4": {
          "label": "Mision de la compania",
          "value": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento"
        },
        "5": {
          "label": "Descripcion de la compania",
          "value": "Descripción sencilla de lo que somos"
        }
      },
      "status": "ACTIVE",
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "inscriptionId": 13,
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "company": {
        "userId": 89,
        "name": "Qaroni EMEA",
        "tradename": null,
        "cif": "B70611942",
        "email": "contact@qaroni.com",
        "phone": "62839823",
        "secondaryPhone": null,
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "companyAddress": {
        "alias": null,
        "line1": "Rúa Hábitat, 11 Bajo",
        "line2": null,
        "postalCode": "15173",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar las inscripciones de un grupo de tipo ENTITY.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • page: (integer)

    Activa la paginación, ubica la página enviada.

    Example:

    1
  • pagination: (integer)

    Cantidad de registros a paginar, por defecto son 60.

    Example:

    10
  • status: (one of ADMITTED, ACTIVE, PENDING, REJECTED, REVISION)

    Status de la inscripción.

    Example:

    ADMITTED
  • categories: (number)

    Id de la categoría del grupo o categorías separados por coma.

    Example:

    13
  • isPartner: (boolean)

    Es de tipo partner. Por defecto trae todos.

    Example:

    true
  • search: (number)

    Buscar por name, tradename, email, cif, phone, secondaryPhone.

    Example:

    correo@ejemplo.com

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "groupId": 2,
      "userId": "89",
      "isPartner": false,
      "merchantId": 87,
      "formId": 4,
      "partnerId": null,
      "partner": null,
      "reason": null,
      "formJson": {
        "4": {
          "label": "Mision de la compania",
          "value": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento"
        },
        "5": {
          "label": "Descripcion de la compania",
          "value": "Descripción sencilla de lo que somos"
        }
      },
      "status": "ACTIVE",
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "inscriptionId": 13,
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "company": {
        "userId": 89,
        "name": "Qaroni EMEA",
        "tradename": null,
        "cif": "B70611942",
        "email": "contact@qaroni.com",
        "phone": "62839823",
        "secondaryPhone": null,
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "companyAddress": {
        "alias": null,
        "line1": "Rúa Hábitat, 11 Bajo",
        "line2": null,
        "postalCode": "15173",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de la inscripción.

patch

Actualizar inscripción de compañía. Valores posibles de status APPROVED, PENDING, REJECTED, WAITING_LIST. Ningún campo es obligatorio en el request.

delete

Borrar una inscripción de compañía.

Obtener detalle de la inscripción.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "groupId": 2,
      "userId": "89",
      "isPartner": false,
      "merchantId": 87,
      "formId": 4,
      "partnerId": null,
      "partner": null,
      "reason": null,
      "formJson": {
        "4": {
          "label": "Mision de la compania",
          "value": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento"
        },
        "5": {
          "label": "Descripcion de la compania",
          "value": "Descripción sencilla de lo que somos"
        }
      },
      "status": "ACTIVE",
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "inscriptionId": 13,
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "company": {
        "userId": 89,
        "name": "Qaroni EMEA",
        "tradename": null,
        "cif": "B70611942",
        "email": "contact@qaroni.com",
        "phone": "62839823",
        "secondaryPhone": null,
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "companyAddress": {
        "alias": null,
        "line1": "Rúa Hábitat, 11 Bajo",
        "line2": null,
        "postalCode": "15173",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar inscripción de compañía. Valores posibles de status APPROVED, PENDING, REJECTED, WAITING_LIST. Ningún campo es obligatorio en el request.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "status": "PENDING",
  "userId": 89,
  "isPartner": false,
  "formId": 4,
  "partnerId": null,
  "formJson": {
    "company_mission": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento",
    "company_description": "Descripción sencilla de lo que somos"
  },
  "addressJson": {
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "postalCode": "15172",
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "country": "ES"
  },
  "companyJson": {
    "name": "Qaroni EMEA",
    "tradename": "Qaroni",
    "cif": "B70611942",
    "email": "contact@qaroni.com",
    "phone": "62839823",
    "secondaryPhone": null
  },
  "companyAddressJson": {
    "line1": "Rúa Hábitat, 11 Bajo",
    "line2": null,
    "postalCode": "15173",
    "city": "Oleiros",
    "stateProvince": "A Coruña",
  }
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "groupId": 2,
      "userId": "89",
      "isPartner": false,
      "merchantId": 87,
      "formId": 4,
      "partnerId": null,
      "partner": null,
      "reason": null,
      "formJson": {
        "4": {
          "label": "Mision de la compania",
          "value": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento"
        },
        "5": {
          "label": "Descripcion de la compania",
          "value": "Descripción sencilla de lo que somos"
        }
      },
      "status": "ACTIVE",
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "inscriptionId": 13,
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "company": {
        "userId": 89,
        "name": "Qaroni EMEA",
        "tradename": null,
        "cif": "B70611942",
        "email": "contact@qaroni.com",
        "phone": "62839823",
        "secondaryPhone": null,
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "companyAddress": {
        "alias": null,
        "line1": "Rúa Hábitat, 11 Bajo",
        "line2": null,
        "postalCode": "15173",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar una inscripción de compañía.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de manera correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Añade o actualiza fichero a inscripción.

delete

Borrar fichero.

Añade o actualiza fichero a inscripción.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • nombrePersonalizado: required(file)

    Fichero a subir.

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "groupId": 2,
      "userId": "89",
      "isPartner": false,
      "merchantId": 87,
      "formId": 4,
      "partnerId": null,
      "partner": null,
      "reason": null,
      "formJson": {
        "4": {
          "label": "Mision de la compania",
          "value": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento"
        },
        "5": {
          "label": "Descripcion de la compania",
          "value": "Descripción sencilla de lo que somos"
        }
      },
      "status": "ACTIVE",
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "inscriptionId": 13,
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "company": {
        "userId": 89,
        "name": "Qaroni EMEA",
        "tradename": null,
        "cif": "B70611942",
        "email": "contact@qaroni.com",
        "phone": "62839823",
        "secondaryPhone": null,
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "companyAddress": {
        "alias": null,
        "line1": "Rúa Hábitat, 11 Bajo",
        "line2": null,
        "postalCode": "15173",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar fichero.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se elimina registro correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "groupId": 2,
      "userId": "89",
      "isPartner": false,
      "merchantId": 87,
      "formId": 4,
      "partnerId": null,
      "partner": null,
      "reason": null,
      "formJson": {
        "4": {
          "label": "Mision de la compania",
          "value": "Nuestra misión es la de elaborar productos tecnológicos escalables, con una arquitectura robusta y que a ojos del usuario final sean sencillos de utilizar y agradables y eficientes en funcionamiento"
        },
        "5": {
          "label": "Descripcion de la compania",
          "value": "Descripción sencilla de lo que somos"
        }
      },
      "status": "ACTIVE",
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "inscriptionId": 13,
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "company": {
        "userId": 89,
        "name": "Qaroni EMEA",
        "tradename": null,
        "cif": "B70611942",
        "email": "contact@qaroni.com",
        "phone": "62839823",
        "secondaryPhone": null,
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      },
      "companyAddress": {
        "alias": null,
        "line1": "Rúa Hábitat, 11 Bajo",
        "line2": null,
        "postalCode": "15173",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-26T01:41:37Z",
        "lastUpdateDate": "2020-05-26T01:41:37Z"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Obtener detalle de la compañía.

patch

Actualizar compañía. Ningún campo es obligatorio en el request.

Obtener detalle de la compañía.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "userId": 89,
      "inscriptionId": 13,
      "partnerId": null,
      "groupId": 2,
      "isPartner": false,
      "status": "ACTIVE",
      "name": "Qaroni EMEA",
      "tradename": null,
      "cif": "B70611942",
      "email": "contact@qaroni.com",
      "phone": "62839823",
      "secondaryPhone": null,
      "code": "scjnc239333r",
      "walletUrl": null,
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "companyId": 2,
      "imageUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "postalCode": "15172",
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-05-26T01:41:37Z",
          "lastUpdateDate": "2020-05-26T01:41:37Z",
          "addressId": 2
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar compañía. Ningún campo es obligatorio en el request.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "userId": 89,
  "status": "ACTIVE",
  "name": "Qaroni EMEA",
  "tradename": null,
  "cif": "B70611942",
  "email": "contact@qaroni.com",
  "phone": "62839823",
  "secondaryPhone": null,
  "code": "scjnc239333r",
  "wallet": null
}

HTTP status code 200

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "userId": 89,
      "inscriptionId": 13,
      "partnerId": null,
      "groupId": 2,
      "isPartner": false,
      "status": "ACTIVE",
      "name": "Qaroni EMEA",
      "tradename": null,
      "cif": "B70611942",
      "email": "contact@qaroni.com",
      "phone": "62839823",
      "secondaryPhone": null,
      "code": "scjnc239333r",
      "walletUrl": null,
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "companyId": 2,
      "imageUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "postalCode": "15172",
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-05-26T01:41:37Z",
          "lastUpdateDate": "2020-05-26T01:41:37Z",
          "addressId": 2
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Obtener la dirección asociada de la compañía.

patch

Actualizar dirección de la compañía.

Obtener la dirección asociada de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "addressId": 1,
      "companyId": 12,
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": "",
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES",
      "creationDate": "2020-01-19T19:57:02Z",
      "lastUpdateDate": "2020-01-19T19:57:02Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar dirección de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "line1": "Rúa Hábitat, 10 Bajo",
  "line2": "",
  "city": "Oleiros",
  "stateProvince": "A Coruña",
  "postalCode": "15172",
  "country": "ES"
}

HTTP status code 200

Se actualiza el recurso correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "addressId": 1,
      "companyId": 12,
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": "",
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES",
      "creationDate": "2020-01-19T19:57:02Z",
      "lastUpdateDate": "2020-01-19T19:57:02Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Ver detalle de un contacto.

patch

Actualizar datos del contacto.

Ver detalle de un contacto.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "companyId": 37,
      "email": "mcontreras@qaroni.com",
      "firstName": "Mario A.",
      "lastName": "Contreras Baruh",
      "gender": "MALE",
      "documentType": "NIE",
      "document": "Y5537130D",
      "birthday": "1988-01-01",
      "phone": "684238803",
      "language": "es",
      "creationDate": "2020-06-20T09:15:19Z",
      "lastUpdateDate": "2020-06-20T09:15:19Z",
      "contactId": 33,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Brañas, 21",
          "line2": "3-B",
          "postalCode": "15174",
          "city": "Culleredo",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-06-20T09:15:19Z",
          "lastUpdateDate": "2020-06-20T09:15:19Z",
          "addressId": 30
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar datos del contacto.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "email": "pablo@labraxsoluciones.com",
  "firstName": "Mario",
  "lastName": "Cernandas",
  "gender": "MALE",
  "documentType": "CIF",
  "document": "123123123w",
  "birthday": "2020-06-04",
  "phone": "91231231"
}

HTTP status code 200

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "userId": 89,
      "inscriptionId": 13,
      "partnerId": null,
      "groupId": 2,
      "isPartner": false,
      "status": "ACTIVE",
      "name": "Qaroni EMEA",
      "tradename": null,
      "cif": "B70611942",
      "email": "contact@qaroni.com",
      "phone": "62839823",
      "secondaryPhone": null,
      "code": "scjnc239333r",
      "walletUrl": null,
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "companyId": 2,
      "imageUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "postalCode": "15172",
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-05-26T01:41:37Z",
          "lastUpdateDate": "2020-05-26T01:41:37Z",
          "addressId": 2
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Obtener dirección asociada al contacto.

patch

Actualizar dirección asociada al contacto.

Obtener dirección asociada al contacto.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "addressId": 1,
      "userId": 12233,
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": "",
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES",
      "creationDate": "2020-01-19T19:57:02Z",
      "lastUpdateDate": "2020-01-19T19:57:02Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar dirección asociada al contacto.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "line1": "Rúa Hábitat, 10 Bajo",
  "line2": "",
  "city": "Oleiros",
  "stateProvince": "A Coruña",
  "postalCode": "15172",
  "country": "ES"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "addressId": 1,
      "userId": 12233,
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": "",
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES",
      "creationDate": "2020-01-19T19:57:02Z",
      "lastUpdateDate": "2020-01-19T19:57:02Z"
    }
  ],
  "links": null
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Reenviar wallet al email de la compañía registrado en la base de datos.

Reenviar wallet al email de la compañía registrado en la base de datos.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se envía el correo de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Añade o actualiza imagen de la compañía.

delete

Borrar imagen de la compañía.

Añade o actualiza imagen de la compañía.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • image: required(file)

    Fichero a subir.

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "userId": 89,
      "inscriptionId": 13,
      "partnerId": null,
      "groupId": 2,
      "isPartner": false,
      "status": "ACTIVE",
      "name": "Qaroni EMEA",
      "tradename": null,
      "cif": "B70611942",
      "email": "contact@qaroni.com",
      "phone": "62839823",
      "secondaryPhone": null,
      "code": "scjnc239333r",
      "walletUrl": null,
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "companyId": 2,
      "imageUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "postalCode": "15172",
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-05-26T01:41:37Z",
          "lastUpdateDate": "2020-05-26T01:41:37Z",
          "addressId": 2
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar imagen de la compañía.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • companyId: required(integer)

    Identificador único de la compañía.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se elimina registro correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "userId": 89,
      "inscriptionId": 13,
      "partnerId": null,
      "groupId": 2,
      "isPartner": false,
      "status": "ACTIVE",
      "name": "Qaroni EMEA",
      "tradename": null,
      "cif": "B70611942",
      "email": "contact@qaroni.com",
      "phone": "62839823",
      "secondaryPhone": null,
      "code": "scjnc239333r",
      "walletUrl": null,
      "creationDate": "2020-05-26T01:41:37Z",
      "lastUpdateDate": "2020-05-26T01:41:37Z",
      "companyId": 2,
      "imageUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "postalCode": "15172",
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "country": "ES",
          "creationDate": "2020-05-26T01:41:37Z",
          "lastUpdateDate": "2020-05-26T01:41:37Z",
          "addressId": 2
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crea una nueva descripción asociada al grupo.

get

Se obtienen las descripciones en múltiples idiomas.

Crea una nueva descripción asociada al grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "language": "es",
  "name": "Gremio de taxistas",
  "description": "Gremio de conductores de la línea de taxis 123"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Se obtienen las descripciones en múltiples idiomas.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "language": "es",
      "name": "Gremio de taxistas",
      "description": "Gremio de conductores de la línea de taxis 123"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea una nueva descripción en el idioma recibido, asociada a la categoría del grupo.

delete

Eliminar registro en el idioma enviado.

Crea una nueva descripción en el idioma recibido, asociada a la categoría del grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "name": "Gremio de taxistas",
  "description": "Gremio de conductores de la línea de taxis 123"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Eliminar registro en el idioma enviado.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina el recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Añade o actualiza imagen del grupo.

delete

Borrar imagen del grupo.

Añade o actualiza imagen del grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • image: required(file)

    Fichero a subir.

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar imagen del grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se elimina registro correctamente.

Body

Media type: application/json

Example:

{
    "count": 1,
    "included": null,
    "input": "VERBO/recurso",
    "result": [
        {
            "merchantId": 87,
            "formId": 1,
            "categoryId": 1,
            "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
            "status": "ACTIVE",
            "type": "PERSON",
            "months": 6,
            "name": "Gremio de taxistas",
            "description": "Gremio de conductores de la línea de taxis 1234",
            "isPaid": true,
            "hasApproval": true,
            "language": "es",
            "category": {
                "merchantId": 87,
                "status": "ACTIVE",
                "language": "es",
                "name": "Licencias para surfistas",
                "description": "Este tipo de licencias son para todos aquellos que quieran formar parte de este prestigioso grupo",
                "creationDate": "2020-05-11T08:00:12Z",
                "lastUpdateDate": "2020-05-11T08:00:12Z",
                "categoryId": 1,
                "imageUrl": null
            },
            "productId": 424220,
            "variantId": 511,
            "price": 18995,
            "iva": 21,
            "creationDate": "2020-05-06T16:40:24Z",
            "lastUpdateDate": "2020-05-06T16:41:12Z",
            "groupId": 1,
            "imageUrl": null
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crear inscripción. Valores posibles de status ACTIVE, ADMITTED, PENDING, REJECTED, REVISION.

get

Listar las inscripciones de un grupo.

Crear inscripción. Valores posibles de status ACTIVE, ADMITTED, PENDING, REJECTED, REVISION.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "formId": 1,
  "userId": 89,
  "clubId": null,
  "formJson": {
    "parent_full_name": "Javier Hurtado",
    "document_type": "DNI",
    "document_number": "3572484H",
    "quantity": 1,
    "parent_birth_date": "1987-07-23",
    "parent_email": "jhurtado@gmail.com"
  },
  "addressJson": {
    "alias": null,
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "postalCode": "15172",
    "country": "ES"
  },
  "userJson": {
    "email": "jamaya@qaroni.com",
    "firstName": "Julio",
    "lastName": "Amaya Uzcategui",
    "documentType": "DNI",
    "document": "52061111H",
    "birthday": "1985-02-07",
    "gender": "MALE",
    "phone": null,
    "language": "es"
  }
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar las inscripciones de un grupo.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • page: (integer)

    Activa la paginación, ubica la página enviada.

    Example:

    1
  • pagination: (integer)

    Cantidad de registros a paginar, por defecto son 60.

    Example:

    10
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of ADMITTED, ACTIVE, PENDING, REJECTED, REVISION)

    Status de la inscripción.

    Example:

    ADMITTED
  • categories: (number)

    Id de la categoría del grupo o categorías separados por coma.

    Example:

    13

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de la inscripción.

patch

Actualizar inscripción. Valores posibles de status APPROVED, PENDING, REJECTED, WAITING_LIST. Ningún campo es obligatorio en el request.

delete

Borrar una inscripción.

Obtener detalle de la inscripción.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar inscripción. Valores posibles de status APPROVED, PENDING, REJECTED, WAITING_LIST. Ningún campo es obligatorio en el request.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "formId": 1,
  "userId": 89,
  "clubId": null,
  "formJson": {
    "parent_full_name": "Javier Hurtado",
    "document_type": "DNI",
    "document_number": "3572484H",
    "quantity": 1,
    "parent_birth_date": "1987-07-23",
    "parent_email": "jhurtado@gmail.com"
  },
  "addressJson": {
    "alias": null,
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "postalCode": "15172",
    "country": "ES"
  },
  "userJson": {
    "email": "jamaya@qaroni.com",
    "firstName": "Julio",
    "lastName": "Amaya Uzcategui",
    "documentType": "DNI",
    "document": "52061111H",
    "birthday": "1985-02-07",
    "gender": "MALE",
    "phone": null,
    "language": "es"
  }
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar una inscripción.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de manera correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Añade o actualiza fichero a inscripción.

delete

Borrar fichero.

Añade o actualiza fichero a inscripción.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • nombrePersonalizado: required(file)

    Fichero a subir.

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar fichero.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • inscriptionId: required(integer)

    Identificador único de la inscripción.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se elimina registro correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 87,
      "groupId": 1,
      "userId": 89,
      "formId": 1,
      "parentId": null,
      "partner": null,
      "status": "PENDING",
      "reason": null,
      "formJson": {
        "parent_full_name": "Javier Hurtado",
        "document_type": "DNI",
        "document_number": "3572484H",
        "quantity": 1,
        "parent_birth_date": "1987-07-23",
        "parent_email": "jhurtado@gmail.com"
      },
      "creationDate": "2020-05-10T00:55:30Z",
      "lastUpdateDate": "2020-05-10T00:55:30Z",
      "inscriptionId": 3,
      "user": {
        "email": "jamaya@qaroni.com",
        "firstName": "Julio",
        "lastName": "Amaya Uzcategui",
        "documentType": "DNI",
        "document": "52061111H",
        "gender": "MALE",
        "birthday": "1985-02-07",
        "phone": null,
        "language": "es",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z"
      },
      "address": {
        "alias": null,
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "postalCode": "15172",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "country": "ES",
        "creationDate": "2020-05-10T00:55:30Z",
        "lastUpdateDate": "2020-05-10T00:55:30Z",
        "addressId": 1
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Ver detalle de un socio.

patch

Actualizar socio. Ningún campo es obligatorio en el request.

Ver detalle de un socio.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • memberId: required(number)

    Identificador único del socio.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "groupId": 23,
      "userId": 211,
      "inscriptionId": 12,
      "status": "ACTIVE",
      "code": "3fc0e463-b93e-4ad0-a7e3-480cced98de6",
      "userInfo": {
        "id": 9,
        "memberId": 51,
        "partnerId": null,
        "email": "pablo@labraxsoluciones.com",
        "firstName": "MArio",
        "lastName": "Cernandas",
        "gender": "MALE",
        "documentType": "CIF",
        "document": "123123123w",
        "birthday": "2020-06-04",
        "phone": "91231231",
        "language": "es",
        "creationDate": "2020-06-04T13:09:51Z",
        "lastUpdateDate": "2020-06-04T13:09:51Z"
      },
      "groupInfo": {
        "merchantId": 71,
        "formId": 11,
        "categoryId": 6,
        "emailTemplateId": null,
        "serieId": null,
        "templateUUID": null,
        "status": "ACTIVE",
        "type": "PERSON",
        "months": 12,
        "isPaid": false,
        "hasApproval": true,
        "language": "es",
        "name": "Pasaporte del Surf",
        "description": "<p><strong>Hola, nuevo surfista, est&aacute;s a punto de entrar en el apasionante mundo del deporte del surfing, y desde la Federaci&oacute;n Espa&ntilde;ola de Surf queremos darte la bienvenida y ayudarte en tus primeros pasos.</strong></p>\r\n<p>Muchos de vosotros no hab&eacute;is practicado antes este deporte, y con este pasaporte y las ense&ntilde;anzas de<br /> vuestros monitores en el surfcamp, estamos seguros de que disfrutareis una experiencia inolvidable<br /> que esperamos os una al mar, las olas y el surf de ahora en adelante.</p>\r\n<p>El pasaporte digital que tienes en tus manos es una gu&iacute;a b&aacute;sica de iniciaci&oacute;n a este deporte, con informaci&oacute;n<br /> del material deportivo que se utiliza y su correcto uso, adem&aacute;s de contenido que nos explica el origen<br /> y funcionamiento de las olas y las importantes caracter&iacute;sticas del medio marino donde practicamos<br /> el surf (oleaje, corrientes, mareas, fondos, vientos, etc) realizada por Todosurf.com. Tambi&eacute;n incluye<br /> las normas b&aacute;sicas de comportamiento en el agua ilustradas por Surf and Comics y una parte dedicada<br /> al cuidado y protecci&oacute;n del medioambiente a trav&eacute;s del surfing a cargo de Surf&amp;Clean. Todo ello con<br /> citas del libro &ldquo;La Ciencia del Surf&rdquo; del ocean&oacute;grafo y surfista de olas grandes, Tony Butt.</p>\r\n<p><br /><br /></p>\r\n<p><a href=\"https://fesurf.staging.plaam.com/#/pages/854\">Cuestionario</a></p>",
        "creationDate": "2020-05-25T11:57:58Z",
        "lastUpdateDate": "2020-05-25T12:22:22Z",
        "groupId": 23,
        "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/71/23/fondo-hola.jpg"
      },
      "creationDate": "2020-06-04T13:09:51Z",
      "lastUpdateDate": "2020-06-04T13:09:51Z",
      "memberId": 51,
      "walletUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "calle",
          "line2": null,
          "postalCode": "12312",
          "city": "coruña",
          "stateProvince": "coruña",
          "country": "ES",
          "creationDate": "2020-06-04T13:09:51Z",
          "lastUpdateDate": "2020-06-04T13:09:51Z",
          "addressId": 3
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar socio. Ningún campo es obligatorio en el request.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • memberId: required(number)

    Identificador único del socio.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "status": "CANCELLED",
  "code": "432093402384dcnw2348",
  "email": "pablo@labraxsoluciones.com",
  "firstName": "Mario",
  "lastName": "Cernandas",
  "gender": "MALE",
  "documentType": "CIF",
  "document": "123123123w",
  "birthday": "2020-06-04",
  "phone": "91231231"
}

HTTP status code 200

Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "groupId": 23,
      "userId": 211,
      "inscriptionId": 12,
      "status": "ACTIVE",
      "code": "3fc0e463-b93e-4ad0-a7e3-480cced98de6",
      "userInfo": {
        "id": 9,
        "memberId": 51,
        "partnerId": null,
        "email": "pablo@labraxsoluciones.com",
        "firstName": "MArio",
        "lastName": "Cernandas",
        "gender": "MALE",
        "documentType": "CIF",
        "document": "123123123w",
        "birthday": "2020-06-04",
        "phone": "91231231",
        "language": "es",
        "creationDate": "2020-06-04T13:09:51Z",
        "lastUpdateDate": "2020-06-04T13:09:51Z"
      },
      "groupInfo": {
        "merchantId": 71,
        "formId": 11,
        "categoryId": 6,
        "emailTemplateId": null,
        "serieId": null,
        "templateUUID": null,
        "status": "ACTIVE",
        "type": "PERSON",
        "months": 12,
        "isPaid": false,
        "hasApproval": true,
        "language": "es",
        "name": "Pasaporte del Surf",
        "description": "<p><strong>Hola, nuevo surfista, est&aacute;s a punto de entrar en el apasionante mundo del deporte del surfing, y desde la Federaci&oacute;n Espa&ntilde;ola de Surf queremos darte la bienvenida y ayudarte en tus primeros pasos.</strong></p>\r\n<p>Muchos de vosotros no hab&eacute;is practicado antes este deporte, y con este pasaporte y las ense&ntilde;anzas de<br /> vuestros monitores en el surfcamp, estamos seguros de que disfrutareis una experiencia inolvidable<br /> que esperamos os una al mar, las olas y el surf de ahora en adelante.</p>\r\n<p>El pasaporte digital que tienes en tus manos es una gu&iacute;a b&aacute;sica de iniciaci&oacute;n a este deporte, con informaci&oacute;n<br /> del material deportivo que se utiliza y su correcto uso, adem&aacute;s de contenido que nos explica el origen<br /> y funcionamiento de las olas y las importantes caracter&iacute;sticas del medio marino donde practicamos<br /> el surf (oleaje, corrientes, mareas, fondos, vientos, etc) realizada por Todosurf.com. Tambi&eacute;n incluye<br /> las normas b&aacute;sicas de comportamiento en el agua ilustradas por Surf and Comics y una parte dedicada<br /> al cuidado y protecci&oacute;n del medioambiente a trav&eacute;s del surfing a cargo de Surf&amp;Clean. Todo ello con<br /> citas del libro &ldquo;La Ciencia del Surf&rdquo; del ocean&oacute;grafo y surfista de olas grandes, Tony Butt.</p>\r\n<p><br /><br /></p>\r\n<p><a href=\"https://fesurf.staging.plaam.com/#/pages/854\">Cuestionario</a></p>",
        "creationDate": "2020-05-25T11:57:58Z",
        "lastUpdateDate": "2020-05-25T12:22:22Z",
        "groupId": 23,
        "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/71/23/fondo-hola.jpg"
      },
      "creationDate": "2020-06-04T13:09:51Z",
      "lastUpdateDate": "2020-06-04T13:09:51Z",
      "memberId": 51,
      "walletUrl": null,
      "addresses": [
        {
          "alias": null,
          "line1": "calle",
          "line2": null,
          "postalCode": "12312",
          "city": "coruña",
          "stateProvince": "coruña",
          "country": "ES",
          "creationDate": "2020-06-04T13:09:51Z",
          "lastUpdateDate": "2020-06-04T13:09:51Z",
          "addressId": 3
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Obtener dirección asociada al socio.

patch

Actualizar dirección asociada al socio.

Obtener dirección asociada al socio.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • memberId: required(number)

    Identificador único del socio.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "addressId": 1,
      "userId": 12233,
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": "",
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES",
      "creationDate": "2020-01-19T19:57:02Z",
      "lastUpdateDate": "2020-01-19T19:57:02Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar dirección asociada al socio.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • memberId: required(number)

    Identificador único del socio.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "line1": "Rúa Hábitat, 10 Bajo",
  "line2": "",
  "city": "Oleiros",
  "stateProvince": "A Coruña",
  "postalCode": "15172",
  "country": "ES"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "addressId": 1,
      "userId": 12233,
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": "",
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES",
      "creationDate": "2020-01-19T19:57:02Z",
      "lastUpdateDate": "2020-01-19T19:57:02Z"
    }
  ],
  "links": null
}

Secured by oauth_2_0

Headers

  • Authorization

    Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

  • access_token

    Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Reenviar wallet al socio seleccionado por su email registrado en la base de datos.

Reenviar wallet al socio seleccionado por su email registrado en la base de datos.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • memberId: required(number)

    Identificador único del socio.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se envía el correo de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post delete

post

Crea un registro de asociación de un grupo/asociación con producto y variante.

delete

Borrar un registro de asociación de grupo/asociación con producto y variante.

Crea un registro de asociación de un grupo/asociación con producto y variante.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • productId: required(integer)

    Identificador único del producto.

  • variantId: required(integer)

    Identificador único de la variante.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 201

Se crea el registro de manera correcta.

Body

Media type: application/json

Type: any

Example:

{
    "count": 1,
    "included": null,
    "input": "POST/merchants/{merchantId}/groups/{groupId}/products/{productId}/variants/{variantId}",
    "result": [
        {
            "groupId": 1,
            "merchantId": 87,
            "productId": 424220,
            "variantId": 511,
            "creationDate": "2020-05-09T03:21:16Z",
            "lastUpdateDate": "2020-05-09T03:21:16Z"
        }
    ],
    "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un registro de asociación de grupo/asociación con producto y variante.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • groupId: required(integer)

    Identificador único del grupo.

  • productId: required(integer)

    Identificador único del producto.

  • variantId: required(integer)

    Identificador único de la variante.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener todas las facturas asociadas a la empresa.

Obtener todas las facturas asociadas a la empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • clients: (number)

    Id del cliente separado por coma.

    Example:

    17893
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/invoices",
  "result": [
    {
      "userId": 1,
      "orderId": 179,
      "merchantId": 82,
      "serieId": 1,
      "line1": "Av Fonteculler 16 2-C",
      "line2": null,
      "postalCode": "15174",
      "city": "A Coruña",
      "stateProvince": "A Coruña",
      "country": "ES",
      "number": 20,
      "name": "José Delgado Pérez",
      "nif": "DNI 52062427H",
      "email": "josed43@gmail.com",
      "phone": "632899315",
      "year": 2020,
      "date": "2020-03-05",
      "subtotal": 5145,
      "tax": 955,
      "total": 6100,
      "paymentMethod": "PAYPAL",
      "status": "PAID",
      "creationDate": "2020-03-05T18:22:25Z",
      "lastUpdateDate": "2020-03-05T18:22:25Z",
      "invoiceId": 26,
      "items": [
        {
          "invoiceId": 26,
          "productId": 555366,
          "variantId": 31952,
          "name": "Public policies and welfare economics",
          "description": "Welfare economics is a branch of economic and political sciences that tells us about economic efficiency and social welfare, analyzing the general well-being in terms of the economic activities of the individuals that make up a society. The welfare of these individuals is the objective of this economy.\r\n\r\nWithin this economy, the political task is to be responsible for maintaining a minimum standard of living and seeking the maximum efficiency of its individuals without harming others.\r\n\r\n",
          "quantity": 1,
          "amount": 4050,
          "discount": 0,
          "tax": 21,
          "total": 4900,
          "creationDate": "2020-03-05T18:22:25Z",
          "lastUpdateDate": "2020-03-05T18:22:25Z",
          "itemId": 36
        },
        {
          "invoiceId": 26,
          "productId": 555366,
          "variantId": 31951,
          "name": "Public policies and welfare economics",
          "description": "Welfare economics is a branch of economic and political sciences that tells us about economic efficiency and social welfare, analyzing the general well-being in terms of the economic activities of the individuals that make up a society. The welfare of these individuals is the objective of this economy.\r\n\r\nWithin this economy, the political task is to be responsible for maintaining a minimum standard of living and seeking the maximum efficiency of its individuals without harming others.\r\n\r\n",
          "quantity": 2,
          "amount": 496,
          "discount": 0,
          "tax": 21,
          "total": 1200,
          "creationDate": "2020-03-05T18:22:25Z",
          "lastUpdateDate": "2020-03-05T18:22:25Z",
          "itemId": 37
        }
      ]
    },
    {
      "userId": 1,
      "orderId": 177,
      "merchantId": 82,
      "serieId": 1,
      "line1": "Av Fonteculler 16 2-C",
      "line2": null,
      "postalCode": "15174",
      "city": "A Coruña",
      "stateProvince": "A Coruña",
      "country": "ES",
      "number": 19,
      "name": "José Delgado Pérez",
      "nif": "DNI 52062427H",
      "email": "josed43@gmail.com",
      "phone": "632899315",
      "year": 2020,
      "date": "2020-03-05",
      "subtotal": 4050,
      "tax": 850,
      "total": 4900,
      "paymentMethod": "PAYPAL",
      "status": "PAID",
      "creationDate": "2020-03-05T17:19:42Z",
      "lastUpdateDate": "2020-03-05T17:19:42Z",
      "invoiceId": 25,
      "items": [
        {
          "invoiceId": 25,
          "productId": 555365,
          "variantId": 31950,
          "name": "Health and mental health",
          "description": "Health as a welfare state\r\n1. Why and how to deal with mental health?\r\n2. The mind, the brain and the heart. Latest discoveries and their applications.\r\n3. The keys to healthy nutrition in the 21st century.\r\n4. Addictions. How do we overcome them and how do we recover?\r\n5. Wellbeing and aging. The future of humanity is here.\r\n6. The importance of physical exercise to generate consistency in mint health.\r\n",
          "quantity": 1,
          "amount": 4050,
          "discount": 0,
          "tax": 21,
          "total": 4900,
          "creationDate": "2020-03-05T17:19:42Z",
          "lastUpdateDate": "2020-03-05T17:19:42Z",
          "itemId": 35
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crea un registro de serie de factura, por ahora, si ya existe solo actualiza el anterior.

get

Listar las series de factura de un comercio.

Crea un registro de serie de factura, por ahora, si ya existe solo actualiza el anterior.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "type": "ONLINE",
  "preffix": "FOL",
  "number": 47,
  "description": "Factura en línea"
}

HTTP status code 201

Se crea el registro de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "type": "ONLINE",
      "preffix": "FOL",
      "number": 47,
      "description": "Factura en línea",
      "creationDate": "2020-04-30T12:22:57Z",
      "lastUpdateDate": "2020-04-30T12:22:57Z",
      "serieId": 13
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Listar las series de factura de un comercio.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • type: (one of ONLINE, BRICK)

    Tipo de serie ONLINE, BRICK.

    Example:

    ONLINE
  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 2,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "type": "BRICK",
      "preffix": "FOB",
      "number": 71,
      "description": "Factura en tienda física",
      "creationDate": "2020-04-30T12:22:57Z",
      "lastUpdateDate": "2020-04-30T12:22:57Z",
      "serieId": 14
    },
    {
      "merchantId": 91,
      "type": "ONLINE",
      "preffix": "FOL",
      "number": 47,
      "description": "Factura en línea",
      "creationDate": "2020-04-30T12:22:57Z",
      "lastUpdateDate": "2020-04-30T12:22:57Z",
      "serieId": 13
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get patch

get

Obtener detalle de la serie.

patch

Actualizar serie. Ningún campo es obligatorio en el request.

Obtener detalle de la serie.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • serieId: required(integer)

    Identificador único de la serie de la factura.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "type": "ONLINE",
      "preffix": "FOL",
      "number": 47,
      "description": "Factura en línea",
      "creationDate": "2020-04-30T12:22:57Z",
      "lastUpdateDate": "2020-04-30T12:22:57Z",
      "serieId": 13
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar serie. Ningún campo es obligatorio en el request.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • serieId: required(integer)

    Identificador único de la serie de la factura.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "type": "ONLINE",
  "preffix": "FOL",
  "description": "Factura en línea"
}

HTTP status code 200

Se actualiza el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "type": "ONLINE",
      "preffix": "FOL",
      "number": 47,
      "description": "Factura en línea",
      "creationDate": "2020-04-30T12:22:57Z",
      "lastUpdateDate": "2020-04-30T12:22:57Z",
      "serieId": 13
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener el detalle de una factura.

Obtener el detalle de una factura.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • invoiceId: required(integer)

    Identificador único de la factura.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/invoices/{invoiceId}",
  "result": [
    {
      "userId": 1,
      "orderId": 179,
      "merchantId": 82,
      "serieId": 1,
      "line1": "Av Fonteculler 16 2-C",
      "line2": null,
      "postalCode": "15174",
      "city": "A Coruña",
      "stateProvince": "A Coruña",
      "country": "ES",
      "number": 20,
      "name": "José Delgado Pérez",
      "nif": "DNI 52062427H",
      "email": "josed43@gmail.com",
      "phone": "632899315",
      "year": 2020,
      "date": "2020-03-05",
      "subtotal": 5145,
      "tax": 955,
      "total": 6100,
      "paymentMethod": "PAYPAL",
      "status": "PAID",
      "creationDate": "2020-03-05T18:22:25Z",
      "lastUpdateDate": "2020-03-05T18:22:25Z",
      "invoiceId": 26,
      "items": [
        {
          "invoiceId": 26,
          "productId": 555366,
          "variantId": 31952,
          "name": "Public policies and welfare economics",
          "description": "Welfare economics is a branch of economic and political sciences that tells us about economic efficiency and social welfare, analyzing the general well-being in terms of the economic activities of the individuals that make up a society. The welfare of these individuals is the objective of this economy.\r\n\r\nWithin this economy, the political task is to be responsible for maintaining a minimum standard of living and seeking the maximum efficiency of its individuals without harming others.\r\n\r\n",
          "quantity": 1,
          "amount": 4050,
          "discount": 0,
          "tax": 21,
          "total": 4900,
          "creationDate": "2020-03-05T18:22:25Z",
          "lastUpdateDate": "2020-03-05T18:22:25Z",
          "itemId": 36
        },
        {
          "invoiceId": 26,
          "productId": 555366,
          "variantId": 31951,
          "name": "Public policies and welfare economics",
          "description": "Welfare economics is a branch of economic and political sciences that tells us about economic efficiency and social welfare, analyzing the general well-being in terms of the economic activities of the individuals that make up a society. The welfare of these individuals is the objective of this economy.\r\n\r\nWithin this economy, the political task is to be responsible for maintaining a minimum standard of living and seeking the maximum efficiency of its individuals without harming others.\r\n\r\n",
          "quantity": 2,
          "amount": 496,
          "discount": 0,
          "tax": 21,
          "total": 1200,
          "creationDate": "2020-03-05T18:22:25Z",
          "lastUpdateDate": "2020-03-05T18:22:25Z",
          "itemId": 37
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Descarga factura en PDF.

Descarga factura en PDF.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • invoiceId: required(integer)

    Identificador único de la factura.

HTTP status code 200

Headers

  • Content-type: required(string)

    Fichero en PDF.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Listar metatags.

Listar metatags.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es
  • type: (string)

    Tipo de metatag.

    Example:

    es
  • status: (integer)

    Estado de metatag puede ser 0 o 1.

    Example:

    1
  • categories: (string)

    Id de categorías de noticias separadas por coma.

    Example:

    23,1

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "metatagId": 65,
      "merchantId": 82,
      "categoryId": 0,
      "userId": 5886,
      "status": 1,
      "type": "tarjeta-digital-happiness",
      "title": "Tarjeta digital Very Happy People | World Happiness Fest 2020",
      "description": "<p>World Happiness Fest es un foro sobre felicidad y bienestar global y diverso. Una comunidad con un objetivo: impulsar una humanidad libre, consciente y feliz.</p>",
      "keywords": "<p>Foro de la felicidad, festival de la felicidad, happiness fest, happiness fest espa&ntilde;a, musica, arte, reflexion, movimiento, alimentacion, tecnologia, sue&ntilde;os y metas, ciencia y energ&iacute;a, agenda world happiness fest, agenga happiness fest, agenda happiness fest 2020, agenda world happiness fest 2020</p>",
      "creationDate": "2019-12-05T08:08:19Z",
      "lastUpdateDate": "2019-12-05T08:09:48Z"
    },
    {
      "metatagId": 63,
      "merchantId": 82,
      "categoryId": 0,
      "userId": 9067,
      "status": 1,
      "type": "historias",
      "title": "World Happiness Fest 2020 - Historias",
      "description": "<p>World Happiness Fest, es el foro m&aacute;s grande del mundo con los mejores profesionales y activistas de la felicidad y bienestar.&nbsp;</p>",
      "keywords": "<p>Alianzas, be happiness, comunicaci&oacute;n, actualidad, felicidad, salud y bienestar, world happiness agora, world happiness fest</p>",
      "creationDate": "2019-11-13T11:50:07Z",
      "lastUpdateDate": "2019-11-13T11:50:12Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get

get

Obtener detalle de metatag.

Obtener detalle de metatag.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • metatagId: required(integer)

    Identificador único de metatag.

Query Parameters

  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "metatagId": 65,
      "merchantId": 82,
      "categoryId": 1,
      "userId": 5886,
      "status": 1,
      "type": "tarjeta-digital-happiness",
      "title": "Tarjeta digital Very Happy People | World Happiness Fest 2020",
      "description": "<p>World Happiness Fest es un foro sobre felicidad y bienestar global y diverso. Una comunidad con un objetivo: impulsar una humanidad libre, consciente y feliz.</p>",
      "keywords": "<p>Foro de la felicidad, festival de la felicidad, happiness fest, happiness fest espa&ntilde;a, musica, arte, reflexion, movimiento, alimentacion, tecnologia, sue&ntilde;os y metas, ciencia y energ&iacute;a, agenda world happiness fest, agenga happiness fest, agenda happiness fest 2020, agenda world happiness fest 2020</p>",
      "creationDate": "2019-12-05T08:08:19Z",
      "lastUpdateDate": "2019-12-05T08:09:48Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post get

post

Crea un nuevo multimedia asociado a la empresa.

get

Obtener todos los recursos multimedia asociados a la empresa.

Crea un nuevo multimedia asociado a la empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • content: (file)

    Fichero a subir.

  • license: required(one of PRIVATE, PUBLIC)

    tipo de licencia

    Example:

    PRIVATE
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Estado del multimedia. Por defecto se guarda ACTIVE.

    Example:

    ACTIVE
  • descriptions: required(object)

    Array de de descripciones

    Example:

    {
  "language": "fr",
  "name": "Tutoriels vidéo de formation",
  "description": "Meilleurs tutoriels vidéo"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/merchants/{merchantId}/multimedias",
  "result": [
    {
      "merchantId": "82",
      "license": "PRIVATE",
      "status": "ACTIVE",
      "descriptions": [
        {
          "language": "es",
          "name": "Video tutoriales de capacitación",
          "description": "Los mejores video tutoriales",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        },
        {
          "language": "en",
          "name": "Training video tutorials",
          "description": "Best video tutorials",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        }
      ],
      "contents": [
        {
          "contentId": 1,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/glasses.jpg"
        },
        {
          "contentId": 2,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/apple-black.png"
        }
      ],
      "creationDate": "2020-03-10T12:32:51Z",
      "lastUpdateDate": "2020-03-10T12:32:51Z",
      "multimediaId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Obtener todos los recursos multimedia asociados a la empresa.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Query Parameters

  • last: (integer)

    Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.

    Example:

    2
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Estado del multimedia. Por defecto trae todos.

    Example:

    ACTIVE
  • language: (string)

    Idioma de la solicitud en formato ISO, si no se usa toma un default.

    Example:

    es

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/merchants/{merchantId}/multimedias",
  "result": [
    {
      "merchantId": "82",
      "license": "PRIVATE",
      "status": "ACTIVE",
      "descriptions": [
        {
          "language": "es",
          "name": "Video tutoriales de capacitación",
          "description": "Los mejores video tutoriales",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        },
        {
          "language": "en",
          "name": "Training video tutorials",
          "description": "Best video tutorials",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        }
      ],
      "contents": [
        {
          "contentId": 1,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/glasses.jpg"
        },
        {
          "contentId": 2,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/apple-black.png"
        }
      ],
      "creationDate": "2020-03-10T12:32:51Z",
      "lastUpdateDate": "2020-03-10T12:32:51Z",
      "multimediaId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

get put delete

get

Obtener el detalle de un recurso multimedia.

put

Actualizar recurso multimedia.

delete

Eliminar recurso multimedia.

Obtener el detalle de un recurso multimedia.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • multimediaId: required(integer)

    Identificador único del elemento multimedia.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/merchants/{merchantId}/multimedias",
  "result": [
    {
      "merchantId": "82",
      "license": "PRIVATE",
      "status": "ACTIVE",
      "descriptions": [
        {
          "language": "es",
          "name": "Video tutoriales de capacitación",
          "description": "Los mejores video tutoriales",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        },
        {
          "language": "en",
          "name": "Training video tutorials",
          "description": "Best video tutorials",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        }
      ],
      "contents": [
        {
          "contentId": 1,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/glasses.jpg"
        },
        {
          "contentId": 2,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/apple-black.png"
        }
      ],
      "creationDate": "2020-03-10T12:32:51Z",
      "lastUpdateDate": "2020-03-10T12:32:51Z",
      "multimediaId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar recurso multimedia.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • multimediaId: required(integer)

    Identificador único del elemento multimedia.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "license": "PRIVATE",
  "status": "ACTIVE",
  "descriptions": [
    {
      "language": "es",
      "name": "Video tutoriales de capacitación",
      "description": "Los mejores video tutoriales"
    },
    {
      "language": "en",
      "name": "Training video tutorials",
      "description": "Best video tutorials"
    }
  ]
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/merchants/{merchantId}/multimedias",
  "result": [
    {
      "merchantId": "82",
      "license": "PRIVATE",
      "status": "ACTIVE",
      "descriptions": [
        {
          "language": "es",
          "name": "Video tutoriales de capacitación",
          "description": "Los mejores video tutoriales",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        },
        {
          "language": "en",
          "name": "Training video tutorials",
          "description": "Best video tutorials",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        }
      ],
      "contents": [
        {
          "contentId": 1,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/glasses.jpg"
        },
        {
          "contentId": 2,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/apple-black.png"
        }
      ],
      "creationDate": "2020-03-10T12:32:51Z",
      "lastUpdateDate": "2020-03-10T12:32:51Z",
      "multimediaId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Eliminar recurso multimedia.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • multimediaId: required(integer)

    Identificador único del elemento multimedia.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina el recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Subir contenido multimedia.

Subir contenido multimedia.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • multimediaId: required(integer)

    Identificador único del elemento multimedia.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: multipart/form-data

Type: object

Properties
  • content: required(file)

    Fichero a subir.

HTTP status code 200

Se sube el fichero de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "POST/merchants/{merchantId}/multimedias",
  "result": [
    {
      "merchantId": "82",
      "license": "PRIVATE",
      "status": "ACTIVE",
      "descriptions": [
        {
          "language": "es",
          "name": "Video tutoriales de capacitación",
          "description": "Los mejores video tutoriales",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        },
        {
          "language": "en",
          "name": "Training video tutorials",
          "description": "Best video tutorials",
          "creationDate": "2020-03-10T12:32:51Z",
          "lastUpdateDate": "2020-03-10T12:32:51Z"
        }
      ],
      "contents": [
        {
          "contentId": 1,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/glasses.jpg"
        },
        {
          "contentId": 2,
          "multimediaId": 1,
          "url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/multimedia/82/1/apple-black.png"
        }
      ],
      "creationDate": "2020-03-10T12:32:51Z",
      "lastUpdateDate": "2020-03-10T12:32:51Z",
      "multimediaId": 1
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

delete

delete

Eliminar contenido multimedia.

Eliminar contenido multimedia.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • multimediaId: required(integer)

    Identificador único del elemento multimedia.

  • contentId: required(string)

    Identificador único del contenido.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 204

Se elimina el recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

post

post

Crea una nueva descripción asociada al recurso multimedia.

Crea una nueva descripción asociada al recurso multimedia.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • multimediaId: required(integer)

    Identificador único del elemento multimedia.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "language": "fr",
  "name": "Tutoriels vidéo de formation",
  "description": "Meilleurs tutoriels vidéo"
}

HTTP status code 201

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "GET/merchants/{merchantId}/multimedias/{multimediaId}",
  "result": [
    {
      "merchantId": 82,
      "license": "PUBLIC",
      "creationDate": "2020-03-10T12:39:44Z",
      "lastUpdateDate": "2020-03-10T12:39:44Z",
      "multimediaId": 3,
      "descriptions": [
        {
          "language": "es",
          "name": "Video tutoriales de entrenamiento",
          "description": "Los mejores video tutoriales",
          "creationDate": "2020-03-10T12:39:44Z",
          "lastUpdateDate": "2020-03-10T12:39:44Z"
        },
        {
          "language": "en",
          "name": "Training video tutorials",
          "description": "Best video tutorials",
          "creationDate": "2020-03-10T12:39:44Z",
          "lastUpdateDate": "2020-03-10T12:39:44Z"
        },
        {
          "language": "fr",
          "name": "Tutoriels vidéo de formation",
          "description": "Meilleurs tutoriels vidéo",
          "creationDate": "2020-03-10T12:41:55Z",
          "lastUpdateDate": "2020-03-10T12:41:55Z"
        }
      ],
      "contents": []
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

Secured by appToken

Headers

  • Application-Token

    Token de aplicación para poder acceder a los recursos.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "El campo es obligatorio",
      "source": {
        "pointer": "VERBO/recurso",
        "parameter": ""
      },
      "links": {
        "about": "https://plaam.docs.qaroni.com/"
      }
    }
  ]
}

patch delete

patch

Crea una nueva descripción en el idioma recibido, asociada al recurso multimedia.

delete

Eliminar recurso multimedia en el idioma enviado.

Crea una nueva descripción en el idioma recibido, asociada al recurso multimedia.

Secured by appToken

Application-Token for API requests.