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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get

get

Obtener los cargos bancarios del comercio.

Obtener los cargos bancarios 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, CREATED, SENT)

    Status del cargo bancario.

    Example:

    ACTIVE
  • dateFrom: (string)

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

    Example:

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

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

    Example:

    2020-11-14 23:59:59

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "clientId": 14873,
      "orderId": 367,
      "orderDate": "2020-04-20",
      "amount": 18000,
      "status": "CREATED",
      "name": "Eduardo Méndez Silvosa",
      "bic": null,
      "iban": "BE33138948239023339",
      "concept": "Pago ordinario",
      "creationDate": "2020-08-12T15:32:32Z",
      "lastUpdateDate": "2020-08-12T15:32:32Z",
      "chargeId": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch

patch

Pasa cargos bancarios a status CANCELLED.

Pasa cargos bancarios a status CANCELLED.

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:

{
  "chargeIds": [1, 2, 23]
}

HTTP status code 204

Se actualiza 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch

patch

Pasa cargos bancarios a status PAID.

Pasa cargos bancarios a status PAID.

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:

{
  "chargeIds": [1, 2, 23]
}

HTTP status code 204

Se actualiza 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch

patch

Pasa cargos bancarios a status RETURN.

Pasa cargos bancarios a status RETURN.

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:

{
  "chargeIds": [1, 2, 23]
}

HTTP status code 204

Se actualiza 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get

get

Obtener detalle de un cargo bancario.

Obtener detalle de un cargo bancario.

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.

  • chargeId: required(integer)

    Identificador único del cargo bancario.

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": [
    {
      "merchantId": 91,
      "clientId": 14873,
      "orderId": 367,
      "orderDate": "2020-04-20",
      "amount": 18000,
      "status": "CREATED",
      "name": "Eduardo Méndez Silvosa",
      "bic": null,
      "iban": "BE33138948239023339",
      "concept": "Pago ordinario",
      "creationDate": "2020-08-12T15:32:32Z",
      "lastUpdateDate": "2020-08-12T15:32:32Z",
      "chargeId": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get

get

Obtener remesas de un cargo bancario.

Obtener remesas de un cargo bancario.

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.

  • chargeId: required(integer)

    Identificador único del cargo bancario.

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": 2,
  "included": null,
  "input": "GET/merchants/{merchantId}/banks/charges/{chargeId}/consignments",
  "result": [
    {
      "chargeId": 16,
      "consignmentId": 16,
      "status": "PAID",
      "creationDate": "2020-08-25T13:00:52Z",
      "lastUpdateDate": "2020-08-25T13:02:22Z",
      "consignment": {
        "merchantId": 71,
        "number": 12,
        "amount": 5000,
        "status": "SENT",
        "sentDate": "2020-08-25",
        "paymentDate": "2020-08-27",
        "creationDate": "2020-08-25T12:59:34Z",
        "lastUpdateDate": "2020-08-25T13:01:55Z",
        "consignmentId": 16,
        "fileUrl": null
      }
    },
    {
      "chargeId": 16,
      "consignmentId": 15,
      "status": "RETURN",
      "creationDate": "2020-08-25T12:50:47Z",
      "lastUpdateDate": "2020-08-25T12:58:58Z",
      "consignment": {
        "merchantId": 71,
        "number": 11,
        "amount": 3900,
        "status": "SENT",
        "sentDate": "2020-08-25",
        "paymentDate": "2020-08-28",
        "creationDate": "2020-08-25T12:45:07Z",
        "lastUpdateDate": "2020-08-25T12:52:42Z",
        "consignmentId": 15,
        "fileUrl": 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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post get

post

Crea una remesa, los valores posibles para status son ACTIVE, CREATED, SENT.

get

Obtener las remesas del comercio.

Crea una remesa, los valores posibles para status son ACTIVE, CREATED, SENT.

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:

{
  "amount": 18000,
  "status": "CREATED",
  "sentDate": "2020-10-01",
  "paymentDate": "2020-10-03"
}

HTTP status code 200

Se crea el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "number": 1,
      "amount": 18000,
      "status": "CREATED",
      "sentDate": "2020-10-01",
      "paymentDate": "2020-10-03",
      "creationDate": "2020-08-12T20:26:43Z",
      "lastUpdateDate": "2020-08-12T20:26:43Z",
      "consignmentId": 2,
      "fileUrl": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Obtener las remesas 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, CREATED, SENT)

    Status del cargo.

    Example:

    ACTIVE
  • dateFrom: (string)

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

    Example:

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

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

    Example:

    2020-11-14 23:59:59

HTTP status code 200

Se obtiene el recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "number": 1,
      "amount": 18000,
      "status": "CREATED",
      "sentDate": "2020-10-01",
      "paymentDate": "2020-10-03",
      "creationDate": "2020-08-12T20:26:43Z",
      "lastUpdateDate": "2020-08-12T20:26:43Z",
      "consignmentId": 2,
      "fileUrl": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de una remesa.

patch

Actualizar una remesa.

delete

Borrar una remesa.

Obtener detalle de una remesa.

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.

  • consignmentId: required(integer)

    Identificador único de la remesa.

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": [
    {
      "merchantId": 91,
      "number": 1,
      "amount": 18000,
      "status": "CREATED",
      "sentDate": "2020-10-01",
      "paymentDate": "2020-10-03",
      "creationDate": "2020-08-12T20:26:43Z",
      "lastUpdateDate": "2020-08-12T20:26:43Z",
      "consignmentId": 2,
      "fileUrl": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Actualizar una remesa.

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.

  • consignmentId: required(integer)

    Identificador único de la remesa.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "amount": 18000,
  "status": "CREATED",
  "sentDate": "2020-10-01",
  "paymentDate": "2020-10-03"
}

HTTP status code 200

Se obtiene el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "number": 1,
      "amount": 18000,
      "status": "CREATED",
      "sentDate": "2020-10-01",
      "paymentDate": "2020-10-03",
      "creationDate": "2020-08-12T20:26:43Z",
      "lastUpdateDate": "2020-08-12T20:26:43Z",
      "consignmentId": 2,
      "fileUrl": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar una remesa.

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.

  • consignmentId: required(integer)

    Identificador único de la remesa.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post patch

post

Crea/actualiza asociaciones de una remesa con los cargos bancarios enviados.

patch

Borrar asociaciones de una remesa con los cargos bancarios enviados.

Crea/actualiza asociaciones de una remesa con los cargos bancarios enviados.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • consignmentId: required(integer)

    Identificador único de la remesa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "chargeIds": [1, 2, 23]
}

HTTP status code 204

Se actualiza 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar asociaciones de una remesa con los cargos bancarios enviados.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • consignmentId: required(integer)

    Identificador único de la remesa.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "chargeIds": [1, 2, 23]
}

HTTP status code 204

Se actualiza 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post delete

post

Crea/actualiza un registro de asociación de una remesa con el cargo bancario.

delete

Borrar un registro de asociación de una remesa con el cargo bancario.

Crea/actualiza un registro de asociación de una remesa con el cargo bancario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • consignmentId: required(integer)

    Identificador único de la remesa.

  • chargeId: required(integer)

    Identificador único del cargo bancario.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

HTTP status code 200

Se crea el registro de manera correcta.

Body

Media type: application/json

Type: any

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "chargeId": "1",
      "consignmentId": "2",
      "status": "CREATED",
      "creationDate": "2020-08-12T20:33:37Z",
      "lastUpdateDate": "2020-08-12T20:33: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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar un registro de asociación de una remesa con el cargo bancario.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • consignmentId: required(integer)

    Identificador único de la remesa.

  • chargeId: required(integer)

    Identificador único del cargo bancario.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch

patch

Actualizar status de una remesa a GENERATED.

Actualizar status de una remesa a GENERATED.

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.

  • consignmentId: required(integer)

    Identificador único de la remesa.

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:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "number": 1,
      "amount": 18000,
      "status": "CREATED",
      "sentDate": "2020-10-01",
      "paymentDate": "2020-10-03",
      "creationDate": "2020-08-12T20:26:43Z",
      "lastUpdateDate": "2020-08-12T20:26:43Z",
      "consignmentId": 2,
      "fileUrl": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch

patch

Actualizar status de una remesa a SENT.

Actualizar status de una remesa a SENT.

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.

  • consignmentId: required(integer)

    Identificador único de la remesa.

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:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "number": 1,
      "amount": 18000,
      "status": "CREATED",
      "sentDate": "2020-10-01",
      "paymentDate": "2020-10-03",
      "creationDate": "2020-08-12T20:26:43Z",
      "lastUpdateDate": "2020-08-12T20:26:43Z",
      "consignmentId": 2,
      "fileUrl": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get

get

Descarga fichero XML.

Descarga fichero XML.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • consignmentId: required(integer)

    Identificador único de la remesa.

HTTP status code 200

Headers

  • Content-type: required(string)

    Fichero en XML.

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.plaam.com/"
      }
    }
  ]
}

post get

post

Crear elemento de portada de acuerdo al tipo [BLOCK, BOX].

get

Listar los elementos de portada asociados a la empresa.

Crear elemento de portada de acuerdo al tipo [BLOCK, BOX].

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": "BLOCK",
  "position": 1,
  "status": "ACTIVE",
  "internal": true,
  "buttonAction": "/information",
  "descriptions": [
    {
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION"
    }
  ]
}

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Listar los elementos de portada asociados a la 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
  • language: (string)

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

    Example:

    es
  • type: (one of BLOCK, BOX)

    Tipo de elemento.

    Example:

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

    Status.

    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": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle del elemento.

patch

Actualizar elemento.

delete

Borrar un elemento.

Obtener detalle del elemento.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

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": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.com/"
      }
    }
  ]
}

Actualizar elemento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "type": "BLOCK",
  "position": 1,
  "status": "ACTIVE",
  "internal": true,
  "buttonAction": "/information"
}

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": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar un elemento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post get

post

Crea una nueva descripción asociada al elemento.

get

Se obtienen las descripciones en múltiples idiomas.

Crea una nueva descripción asociada al elemento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "language": "es",
  "title": "Título de elemento",
  "description": "Descripción o subtítulo",
  "buttonName": "+ INFORMACION"
}

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": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.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.plaam.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.plaam.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.

  • elementId: required(integer)

    Identificador único del elemento.

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:

Can not resolve examples/coverElementDescriptionResponse.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch delete

patch

Actualizar una descripción dado el idioma.

delete

Eliminar registro en el idioma enviado.

Actualizar una descripción dado el idioma.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

  • language: required(string)

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "title": "Título de elemento",
  "description": "Descripción o subtítulo",
  "buttonName": "+ INFORMACION"
}

HTTP status code 200

Se crea el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.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.plaam.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.plaam.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.

  • elementId: required(integer)

    Identificador único del elemento.

  • 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post delete

post

Añade o actualiza imagen del elemento.

delete

Borrar imagen del elemento.

Añade o actualiza imagen del elemento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

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": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar imagen del elemento.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • elementId: required(integer)

    Identificador único del elemento.

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": 91,
      "type": "BLOCK",
      "status": "ACTIVE",
      "internal": true,
      "local": false,
      "position": 1,
      "buttonAction": "/information",
      "language": "es",
      "title": "Título de elemento",
      "description": "Descripción o subtítulo",
      "buttonName": "+ INFORMACION",
      "creationDate": "2020-08-14T15:29:01Z",
      "lastUpdateDate": "2020-08-14T15:29:01Z",
      "elementId": 2,
      "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.plaam.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.plaam.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.plaam.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-11-12 10:30:00
  • dateTo: (string)

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

    Example:

    2020-11-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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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-11-12 10:30:00
  • dateTo: (string)

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

    Example:

    2020-11-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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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": "VERBO/recurso",
  "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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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 elimina recurso correctamente.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post

post

Crear una entrada a un evento GRATIS.

Crear una entrada a un evento GRATIS.

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.

  • eventId: required(integer)

    Identificador único del evento.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "userId": 273,
  "quantity": 1,
  "zoneId": 15,
  "attendees": [
    {
      "firstName": "Alberto",
      "lastName": "Carreño",
      "email": "ac121@gmail.com",
      "phone": "688281811",
      "document": "390132332D"
    },
    {
      "firstName": "Mónica",
      "lastName": "Centeno",
      "email": "moniquec75@yahoo.com",
      "phone": "688285427",
      "document": "567782529D"
    }
  ]
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "input": "VERBO/recurso",
  "result": [
    {
      "information": "Email enviado exitosamente"
    }
  ],
  "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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

delete

delete

Borrar un ticket de evento.

Borrar un 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 204

Se elimina recurso correctamente.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get

get

Descarga ticket de evento en PDF.

Descarga ticket de evento en PDF.

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.

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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post get

post

Crear una zona asociada al evento.

get

Listado de las zonas ordenadas alfabéticamente.

Crear una zona asociada al 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.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "preffix": "VIP",
  "name": "Zona VIP",
  "capacity": 36
}

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": [
    {
      "eventId": "1883",
      "preffix": "VIP",
      "number": 0,
      "name": "Zona VIP",
      "capacity": 36,
      "creationDate": "2020-07-13T15:28:28Z",
      "lastUpdateDate": "2020-07-13T15:28:28Z",
      "zoneId": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Listado de las zonas ordenadas alfabéticamente.

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

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": [
    {
      "eventId": "1883",
      "preffix": "VIP",
      "number": 0,
      "name": "Zona VIP",
      "capacity": 36,
      "creationDate": "2020-07-13T15:28:28Z",
      "lastUpdateDate": "2020-07-13T15:28:28Z",
      "zoneId": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de una zona.

patch

Actualizar zona.

delete

Borrar una zona.

Obtener detalle de una zona.

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.

  • zoneId: required(number)

    Identificador de la zona.

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": [
    {
      "eventId": "1883",
      "preffix": "VIP",
      "number": 0,
      "name": "Zona VIP",
      "capacity": 36,
      "creationDate": "2020-07-13T15:28:28Z",
      "lastUpdateDate": "2020-07-13T15:28:28Z",
      "zoneId": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Actualizar zona.

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.

  • zoneId: required(number)

    Identificador de la zona.

Headers

  • Application-Token: required(string)

    Token de aplicación para poder acceder a los recursos

Body

Media type: application/json

Example:

{
  "preffix": "VIP",
  "name": "Zona VIP",
  "capacity": 36
}

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": [
    {
      "eventId": "1883",
      "preffix": "VIP",
      "number": 0,
      "name": "Zona VIP",
      "capacity": 36,
      "creationDate": "2020-07-13T15:28:28Z",
      "lastUpdateDate": "2020-07-13T15:28:28Z",
      "zoneId": 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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar una zona.

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.

  • zoneId: required(number)

    Identificador de la zona.

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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post get

post

Crea una galería para la empresa.

get

Listar las galerías.

Crea una galería para la empresa.

Secured by appToken

Application-Token for 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:

{
  "merchantId": 71,
  "status": "ACTIVE",
  "descriptions": [
    {
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería"
    }
  ]
}

HTTP status code 201

Se crea recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Listar las galerías.

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
  • status: (one of CREATED, ACTIVE, INACTIVE)

    Status de la galería.

    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": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de la galería.

patch

Actualiza una galería.

delete

Borrar una galería.

Obtener detalle de la galería.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • galleryId: required(integer)

    Identificador único de la galerí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:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.com/"
      }
    }
  ]
}

Actualiza una galería.

Secured by appToken

Application-Token for API requests.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • galleryId: required(integer)

    Identificador único de la galería.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "status": "ACTIVE"
}

HTTP status code 200

Se actualiza recurso exitosamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar una galerí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.

  • galleryId: required(integer)

    Identificador único de la galería.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 204

Se elimina el recurso correctamente.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post get

post

Crea una descripción en un idioma específico.

get

Se obtienen las descripciones en múltiples idiomas.

Crea una descripción en un idioma específico.

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.

  • galleryId: required(integer)

    Identificador único de la galería.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "language": "es",
  "title": "Título de galería",
  "description": "Descripción de galería"
}

HTTP status code 201

Se añade una descripción.

Body

Media type: application/json

Type: any

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Se obtienen las descripciones en múltiples idiomas.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • galleryId: required(integer)

    Identificador único de la galería.

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",
      "title": "Título de galería",
      "description": "Descripción de galería"
    }
  ],
  "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.plaam.com/"
      }
    }
  ]
}

patch delete get

patch

Actualizar una descripción dado el idioma.

delete

Borrar una descripción asociado.

get

Se obtiene la descripción en un idioma determinado.

Actualizar una descripción dado el idioma.

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.

  • galleryId: required(integer)

    Identificador único de la galería.

  • language: required(string)

    Identificador del lenguaje en formato ISO ejemplo es.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: application/json

Example:

{
  "title": "Título de galería",
  "description": "Descripción de galería"
}

HTTP status code 200

Se actualiza la descripción correctamente.

Body

Media type: application/json

Type: any

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar una descripción asociado.

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.

  • galleryId: required(integer)

    Identificador único de la galería.

  • language: required(string)

    Identificador del lenguaje en formato ISO ejemplo es.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 204

Se elimina el recurso correctamente.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Se obtiene la descripción en un idioma determinado.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • galleryId: required(integer)

    Identificador único de la galería.

  • language: required(string)

    Identificador del lenguaje en formato ISO ejemplo es.

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": [
    {
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería"
    }
  ],
  "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.plaam.com/"
      }
    }
  ]
}

post get

post

Añadir una imagen a la galería.

get

Traer todas las imágenes de la galería.

Añadir una imagen a la galerí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.

  • galleryId: required(integer)

    Identificador único de la galería.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

Body

Media type: image/png

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Type: any

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "merchantId": 71,
      "status": "ACTIVE",
      "language": "es",
      "title": "Título de galería",
      "description": "Descripción de galería",
      "creationDate": "2020-08-31T20:56:12Z",
      "lastUpdateDate": "2020-08-31T20:56:12Z",
      "galleryId": 1,
      "imagesURL": [
        {
          "creationDate": "2020-08-31T21:42:59Z",
          "lastUpdateDate": "2020-08-31T21:42:59Z",
          "imageId": 5,
          "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Traer todas las imágenes de la galerí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.

  • galleryId: required(integer)

    Identificador único de la galerí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

Type: any

Example:

{
  "count": 1,
  "included": null,
  "input": "VERBO/recurso",
  "result": [
    {
      "creationDate": "2020-08-31T21:42:59Z",
      "lastUpdateDate": "2020-08-31T21:42:59Z",
      "imageId": 5,
      "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchants/71/galleries/1/images/5_22.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

delete

delete

Borrar una imagen.

Borrar una imagen.

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.

  • galleryId: required(integer)

    Identificador único de la galería.

  • imageId: required(string)

    Identificador único de la imagen.

Headers

  • Authorization: required(string)

    Bearer Token de Oauth generado por Laravel Passport

  • Content-type: required(string)

    JSON

HTTP status code 204

Se elimina el recurso correctamente.

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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

post get

post

Crear asociación/gremio/federación. Los tipos de status son CREATED, ACTIVE, INACTIVE, sino se envía se guarda como CREATED.

get

Listar los grupos de una empresa.

Crear asociación/gremio/federación. Los tipos de status son CREATED, ACTIVE, INACTIVE, sino se envía se guarda como CREATED.

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",
  "formId": null,
  "categoryId": null,
  "status": "ACTIVE",
  "months": 6,
  "monthType": "MONTH",
  "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,
            "monthType": "MONTH",
            "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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

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
  • hasPartner: (boolean)

    Tiene clubes. 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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get patch delete

get

Obtener detalle de la categoría.

patch

Actualizar categoría de grupo.

delete

Borrar una 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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

Borrar una 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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

get

get

Listar las compañías de un comercio.

Listar las compañías de un comercio.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

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.plaam.com/"
      }
    }
  ]
}

get

get

Listar perfil de las compañías de un comercio.

Listar perfil de las compañías de un comercio.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

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
  • search: (number)

    Buscar por name, tradename.

    Example:

    Empresa

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "GET/merchants/{merchantId}/groups/companies/profiles",
  "result": [
    {
      "profileId": 61,
      "name": "Empresa SL",
      "tradename": "Empresa",
      "description": null,
      "address": {
        "alias": null,
        "line1": "calle",
        "line2": null,
        "postalCode": "12312",
        "city": "laxe",
        "stateProvince": "Albacete",
        "country": "ES",
        "creationDate": "2020-08-14T11:06:43Z",
        "lastUpdateDate": "2020-08-14T11:06:43Z",
        "addressId": 64
      },
      "imageUrl": null
    }
  ],
  "links": {
    "total": 26,
    "first": "http://plaam-api.test/v1/merchants/71/groups/companies/profiles?page=1",
    "last": "http://plaam-api.test/v1/merchants/71/groups/companies/profiles?page=26",
    "prev": null,
    "next": "http://plaam-api.test/v1/merchants/71/groups/companies/profiles?page=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.plaam.com/"
      }
    }
  ]
}

get

get

Detalle de perfil de la compañía de un comercio.

Detalle de perfil de la compañía de un comercio.

URI Parameters

  • merchantId: required(integer)

    Identificador único de la empresa.

  • profileId: required(integer)

    Identificador único del perfil de compañía.

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "included": null,
  "input": "GET/merchants/{merchantId}/groups/companies/profiles",
  "result": [
    {
      "profileId": 61,
      "name": "Empresa SL",
      "tradename": "Empresa",
      "description": null,
      "address": {
        "alias": null,
        "line1": "calle",
        "line2": null,
        "postalCode": "12312",
        "city": "laxe",
        "stateProvince": "Albacete",
        "country": "ES",
        "creationDate": "2020-08-14T11:06:43Z",
        "lastUpdateDate": "2020-08-14T11:06:43Z",
        "addressId": 64
      },
      "imageUrl": null
    }
  ],
  "links": {
    "total": 26,
    "first": "http://plaam-api.test/v1/merchants/71/groups/companies/profiles?page=1",
    "last": "http://plaam-api.test/v1/merchants/71/groups/companies/profiles?page=26",
    "prev": null,
    "next": "http://plaam-api.test/v1/merchants/71/groups/companies/profiles?page=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.plaam.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.plaam.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": 1,
      "userId": 300,
      "inscriptionId": 428,
      "partnerId": 55,
      "clientId": 179656,
      "automaticRenewal": true,
      "bankCharge": null,
      "maxRenewalAlerts": 1,
      "status": "ACTIVE",
      "code": "INF/3",
      "expirationDate": "2020-08-31",
      "renewalDate": null,
      "userInfo": {
        "id": 202,
        "memberId": 256,
        "email": "atpjulio@gmail.com",
        "firstName": "Julio",
        "lastName": "Amaya",
        "gender": "MALE",
        "documentType": "NIE",
        "document": "432423Y",
        "birthday": "1985-02-07",
        "phone": "4021911111",
        "language": "es",
        "creationDate": "2020-08-17T14:58:13Z",
        "lastUpdateDate": "2020-08-17T14:58:13Z"
      },
      "groupInfo": {
        "merchantId": 71,
        "formId": 1,
        "categoryId": 1,
        "emailTemplateId": null,
        "serieId": 48,
        "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
        "status": "ACTIVE",
        "type": "PERSON",
        "alertDays": 15,
        "months": 8,
        "monthType": "NATURAL_YEAR",
        "isPaid": true,
        "isPartner": false,
        "hasPartner": true,
        "hasApproval": false,
        "hasRenewal": true,
        "language": "es",
        "name": "Infantil",
        "description": "Hasta 14 años",
        "creationDate": "2020-05-07T19:03:28Z",
        "lastUpdateDate": "2020-08-17T16:11:35Z",
        "groupId": 1,
        "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/group/71/1/SEGUROS.jpg"
      },
      "creationDate": "2020-08-17T14:58:13Z",
      "lastUpdateDate": "2020-08-17T15:00:20Z",
      "memberId": 256,
      "imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/members/256/images/plaam-icon.jpg",
      "walletUrl": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/0768ff5a-f0f4-4bbc-930c-89a13c5ceaa8.pkpass",
      "addresses": [
        {
          "alias": null,
          "line1": "Curelledo 3212",
          "line2": "Curelledo 3212",
          "postalCode": "150002",
          "city": "Coruña",
          "stateProvince": "Coruña",
          "country": "ES",
          "creationDate": "2020-08-17T14:58:16Z",
          "lastUpdateDate": "2020-08-17T14:58:16Z",
          "addressId": 189
        }
      ],
      "partner": {
        "merchantId": 71,
        "userId": 258,
        "groupId": 99,
        "inscriptionId": 388,
        "partnerId": null,
        "clientId": 179640,
        "automaticRenewal": true,
        "bankCharge": null,
        "maxRenewalAlerts": 1,
        "isPartner": true,
        "status": "ACTIVE",
        "name": "Club deportivo Laxe SL",
        "tradename": "Laxe CD",
        "description": null,
        "cif": "B55444333",
        "email": "pablo@labraxsoluciones.com",
        "phone": "981981988",
        "secondaryPhone": "665888333",
        "code": "TEST/13",
        "expirationDate": "2020-08-31",
        "renewalDate": "2020-08-11",
        "creationDate": "2020-08-05T17:51:56Z",
        "lastUpdateDate": "2020-08-14T11:02:01Z",
        "companyId": 55,
        "imageUrl": null,
        "walletUrl": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/a788d6a4-9550-4c49-b730-b18cfaf6c4d4.pkpass",
        "group": {
          "merchantId": 71,
          "formId": null,
          "categoryId": 16,
          "emailTemplateId": null,
          "serieId": 29,
          "templateUUID": "ad126412-90bd-4395-b924-93f523d70da4",
          "status": "ACTIVE",
          "type": "ENTITY",
          "alertDays": 30,
          "months": 8,
          "monthType": "NATURAL_YEAR",
          "isPaid": true,
          "isPartner": true,
          "hasPartner": false,
          "hasApproval": false,
          "hasRenewal": true,
          "creationDate": "2020-08-05T17:07:33Z",
          "lastUpdateDate": "2020-08-14T11:01:28Z",
          "groupId": 99,
          "imageUrl": null,
          "serie": {
            "merchantId": 71,
            "preffix": "TEST/",
            "number": 16,
            "description": "Nueva serie de prueba",
            "creationDate": "2020-05-29T18:48:22Z",
            "lastUpdateDate": "2020-08-17T13:19:27Z",
            "serieId": 29
          }
        }
      },
      "unsubscribes": []
    }
  ],
  "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.plaam.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.plaam.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.plaam.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

  • automaticRenewal: (boolean)

    Filtra por la columna automaticRenewal.

    Example:

    true
  • 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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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 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.plaam.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.plaam.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.plaam.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 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.plaam.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.plaam.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.plaam.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,
            "monthType": "MONTH",
            "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.plaam.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,
            "monthType": "MONTH",
            "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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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

  • automaticRenewal: (boolean)

    Filtra por la columna automaticRenewal.

    Example:

    true
  • 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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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,
      "automaticRenewal": true,
      "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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.com/"
      }
    }
  ]
}

patch

patch

Activar compañía.

Activar 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:

{
  "reason": "Se realiza activación correctamente"
}

HTTP status code 200

Se actualiza el 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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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.plaam.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