Plaam API documentation version v1
https://{subdomain}.plaam.com/{version}
- subdomain: required(string - default: plaam.docs)
Subdominio del API
- version: required(v1)
/accounts
Listar los accounts.
get /accounts
Listar los accounts.
Qaroni supports OAuth 2.0 for authenticating all API requests.
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 - status: (one of CREATED, ENABLED, DISABLED)
Estado del account.
Example:
ENABLED
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/"
}
}
]
}
Login de acceso para account.
post /accounts/logins
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/"
}
}
]
}
Detalle de un account.
get /accounts/{accountId}
Detalle de un account.
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/"
}
}
]
}
Listar las empresas a las que tiene acceso el account.
get /accounts/{accountId}/merchants
Listar las empresas a las que tiene acceso el account.
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
Subir fichero al bucket de S3.
post /buckets/uploads
Subir fichero al bucket de S3.
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/"
}
}
]
}
/files/temps/storages
Subir fichero de manera genérica.
post /files/temps/storages
Subir fichero de manera genérica.
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- file: required(file)
Fichero a subir.
HTTP status code 200
Se sube el fichero de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"originalName": "22.png",
"storageId": "699dd381-6131-4baf-88c2-d723fb40d004",
"fileUrl": "http://plaam-api.test/storage/uploads/699dd381-6131-4baf-88c2-d723fb40d004.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
Listar las empresas.
get /merchants
Listar las empresas.
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
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/"
}
}
]
}
Detalle de una empresa.
get /merchants/{merchantId}
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/"
}
}
]
}
Recuperación de contraseña de account.
patch /merchants/{merchantId}/accounts/forgots
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/"
}
}
]
}
Login de acceso para account.
post /merchants/{merchantId}/accounts/logins
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/"
}
}
]
}
Registro de account.
post /merchants/{merchantId}/accounts/registers
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
Activar account (Pasar el status de CREATED a ACTIVE).
patch /merchants/{merchantId}/accounts/{accountId}/validates
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/"
}
}
]
}
Obtener los cargos bancarios del comercio.
get /merchants/{merchantId}/banks/charges
Obtener los cargos bancarios del comercio.
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
- sortField: (string)
Posibles valores permitidos -> id, orderDate, name, creationDate.
Example:
date - sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC - search: (string)
Búsqueda por concept, name.
Example:
bienestar - 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:
2021-11-12 10:30:00 - dateTo: (string)
Filtrar por fecha en formato Y-m-d H:i:s (HASTA).
Example:
2021-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/"
}
}
]
}
Pasa cargos bancarios a status CANCELLED.
patch /merchants/{merchantId}/banks/charges/cancels
Pasa cargos bancarios a status CANCELLED.
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/"
}
}
]
}
Pasa cargos bancarios a status PAID.
patch /merchants/{merchantId}/banks/charges/pays
Pasa cargos bancarios a status PAID.
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/"
}
}
]
}
Pasa cargos bancarios a status RETURN.
patch /merchants/{merchantId}/banks/charges/returns
Pasa cargos bancarios a status RETURN.
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/"
}
}
]
}
Obtener detalle de un cargo bancario.
Actualizar cargo bancario.
get /merchants/{merchantId}/banks/charges/{chargeId}
Obtener detalle de un cargo bancario.
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/"
}
}
]
}
patch /merchants/{merchantId}/banks/charges/{chargeId}
Actualizar cargo bancario.
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
Body
Media type: application/json
Example:
{
"amount": 18000,
"bic": null,
"iban": "BE33138948239023339",
"concept": "Pago ordinario"
}
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/"
}
}
]
}
Obtener remesas de un cargo bancario.
get /merchants/{merchantId}/banks/charges/{chargeId}/consignments
Obtener remesas de un cargo bancario.
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/"
}
}
]
}
Crea un autor de blog.
Obtener los autores.
post /merchants/{merchantId}/blogs/authors
Crea un autor de blog.
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:
{
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2020-11-20T04:45:41Z",
"lastUpdateDate": "2020-11-20T04:45:41Z",
"authorId": 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 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 /merchants/{merchantId}/blogs/authors
Obtener los autores.
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.
Example:
ACTIVE - sortField: (string)
Posibles valores permitidos -> id, firstName, status.
Example:
date - sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
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,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2020-11-20T04:45:41Z",
"lastUpdateDate": "2020-11-20T04:45:41Z",
"authorId": 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/"
}
}
]
}
Obtener detalle de un autor.
Actualizar un autor.
Borrar un autor.
get /merchants/{merchantId}/blogs/authors/{authorId}
Obtener detalle de un autor.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
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": 71,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2020-11-20T04:45:41Z",
"lastUpdateDate": "2020-11-20T04:45:41Z",
"authorId": 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/"
}
}
]
}
patch /merchants/{merchantId}/blogs/authors/{authorId}
Actualizar un autor.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2020-11-20T04:45:41Z",
"lastUpdateDate": "2020-11-20T04:45:41Z",
"authorId": 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 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 /merchants/{merchantId}/blogs/authors/{authorId}
Borrar un autor.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
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/"
}
}
]
}
Borrar imagen del autor.
delete /merchants/{merchantId}/blogs/authors/{authorId}/images
Borrar imagen del autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
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": 71,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2020-11-20T04:45:41Z",
"lastUpdateDate": "2020-11-20T04:45:41Z",
"authorId": 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/"
}
}
]
}
Crea una categoría de blog.
Obtener las categorías de blog.
post /merchants/{merchantId}/blogs/categories
Crea una categoría de blog.
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:
{
"name": "Nombre interno",
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación"
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/categories
Obtener las categorías de blog.
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 - countPosts: (boolean)
Cuentas los posts que tiene asociado en el lenguaje enviado o por defecto
es.Example:
true - status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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/"
}
}
]
}
Obtener detalle de una categoría de blog.
Actualizar una categoría.
Borrar una categoría.
get /merchants/{merchantId}/blogs/categories/{categoryId}
Obtener detalle de una categoría de blog.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categorí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 exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/categories/{categoryId}
Actualizar una categoría.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Nombre interno",
"status": "ACTIVE"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/categories/{categoryId}
Borrar una categoría.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
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/"
}
}
]
}
Crea una nueva descripción asociada a la categoría.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions
Crea una nueva descripción asociada a la categoría.
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",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programació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": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
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": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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 una descripción dado el idioma.
Eliminar registro en el idioma enviado.
patch /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions/{language}
Actualizar una descripción dado el idioma.
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:
{
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación"
}
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": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions/{language}
Eliminar registro en el idioma enviado.
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/"
}
}
]
}
Crea un post.
Obtener los posts.
post /merchants/{merchantId}/blogs/posts
Crea un post.
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:
{
"name": "Nombre interno",
"featured": true,
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0",
"descriptions": [
{
"language": "es",
"slug": "titulo-del-post",
"title": "Título del post",
"subtitle": "Subtítulo del post",
"shortDescription": "Es la descripción corta",
"largeDescription": "Es la descripción larga donde normalmente van tags HTML"
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts
Obtener los posts.
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.
Example:
ACTIVE - search: (string)
Búsqueda por title.
Example:
bienestar - authors: (number)
Id del autor o autores separados por coma.
Example:
89 - categories: (number)
Id de la categoría o categorías separados por coma.
Example:
13 - tags: (number)
Id del tag o tags separados por coma.
Example:
56
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,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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/"
}
}
]
}
Obtener detalle de un post.
Actualizar un post.
Borrar un post.
get /merchants/{merchantId}/blogs/posts/{postId}
Obtener detalle de un post.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
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": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}
Actualizar un post.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
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",
"name": "Nombre interno",
"featured": true,
"date": "2020-11-20",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}
Borrar un post.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
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/"
}
}
]
}
Crea/actualiza un registro de asociación de un post con un autor.
Borrar un registro de asociación de un post con un autor.
post /merchants/{merchantId}/blogs/posts/{postId}/authors/{authorId}
Crea/actualiza un registro de asociación de un post con un autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- authorId: required(integer)
Identificador único del autor.
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": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}/authors/{authorId}
Borrar un registro de asociación de un post con un autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- authorId: required(integer)
Identificador único del autor.
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/"
}
}
]
}
Crea/actualiza un registro de asociación de un post con una categoría.
Borrar un registro de asociación de un post con una categoría.
post /merchants/{merchantId}/blogs/posts/{postId}/categories/{categoryId}
Crea/actualiza un registro de asociación de un post con una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- 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 crea el registro de manera correcta.
Body
Media type: application/json
Type: any
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}/categories/{categoryId}
Borrar un registro de asociación de un post con una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- 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 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/"
}
}
]
}
Crea una nueva descripción asociada al post.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/blogs/posts/{postId}/descriptions
Crea una nueva descripción asociada al post.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"language": "es",
"slug": "titulo-del-post",
"title": "Título del post",
"subtitle": "Subtítulo del post",
"shortDescription": "Es la descripción corta",
"largeDescription": "Es la descripción larga donde normalmente van tags HTML"
}
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,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
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",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
],
"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 una descripción dado el idioma.
Eliminar registro en el idioma enviado.
patch /merchants/{merchantId}/blogs/posts/{postId}/descriptions/{language}
Actualizar una descripción dado el idioma.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"slug": "titulo-del-post",
"title": "Título del post",
"subtitle": "Subtítulo del post",
"shortDescription": "Es la descripción corta",
"largeDescription": "Es la descripción larga donde normalmente van tags HTML"
}
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": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}/descriptions/{language}
Eliminar registro en el idioma enviado.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- 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/"
}
}
]
}
Borrar imagen del autor.
delete /merchants/{merchantId}/blogs/posts/{postId}/images
Borrar imagen del autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
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": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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/"
}
}
]
}
Crea/actualiza un registro de asociación de un post con un tag.
Borrar un registro de asociación de un post con un tag.
post /merchants/{merchantId}/blogs/posts/{postId}/tags/{tagId}
Crea/actualiza un registro de asociación de un post con un tag.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- tagId: required(integer)
Identificador único del tag.
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": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"authors": [
{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}
],
"categories": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [
{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04:59Z"
}
]
}
],
"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 /merchants/{merchantId}/blogs/posts/{postId}/tags/{tagId}
Borrar un registro de asociación de un post con un tag.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- tagId: required(integer)
Identificador único del tag.
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/"
}
}
]
}
Crea un tag de blog.
Obtener los tags.
post /merchants/{merchantId}/blogs/tags
Crea un tag de blog.
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:
{
"name": "Deportes"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 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 /merchants/{merchantId}/blogs/tags
Obtener los tags.
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.
Example:
ACTIVE
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 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/"
}
}
]
}
Obtener detalle de un tag.
Actualizar un tag.
Borrar un tag.
get /merchants/{merchantId}/blogs/tags/{tagId}
Obtener detalle de un tag.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- tagId: required(integer)
Identificador único del tag.
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": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 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/"
}
}
]
}
patch /merchants/{merchantId}/blogs/tags/{tagId}
Actualizar un tag.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- tagId: required(integer)
Identificador único del tag.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Deportes"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 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/"
}
}
]
}
delete /merchants/{merchantId}/blogs/tags/{tagId}
Borrar un tag.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- tagId: required(integer)
Identificador único del tag.
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/"
}
}
]
}
Crear un nuevo campo en la plantilla de la tarjeta.
post /merchants/{merchantId}/cards/templates/fields
Crear un nuevo campo en la plantilla de la tarjeta.
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/"
}
}
]
}
Añade o actualiza campo imagen.
post /merchants/{merchantId}/cards/templates/fields/images
Añade o actualiza campo imagen.
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/"
}
}
]
}
Listado de los campos presentes en la plantilla de la tarjeta.
get /merchants/{merchantId}/cards/templates/{templateUUID}/fields
Listado de los campos presentes en la plantilla de la tarjeta.
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/"
}
}
]
}
Obtener detalle de un campo en la plantilla de la tarjeta.
Actualizar campo en la plantilla de la tarjeta.
Borrar un campo de la plantilla de la tarjeta.
get /merchants/{merchantId}/cards/templates/{templateUUID}/fields/{fieldId}
Obtener detalle de un campo en la plantilla de la tarjeta.
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/"
}
}
]
}
patch /merchants/{merchantId}/cards/templates/{templateUUID}/fields/{fieldId}
Actualizar campo en la plantilla de la tarjeta.
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/"
}
}
]
}
delete /merchants/{merchantId}/cards/templates/{templateUUID}/fields/{fieldId}
Borrar un campo de la plantilla de la tarjeta.
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/"
}
}
]
}
Crea un cliente, los valores posibles para type son PHYSICAL, LEGAL.
Obtener los clientes del comercio.
post /merchants/{merchantId}/clients
Crea un cliente, los valores posibles para type son PHYSICAL, LEGAL.
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:
{
"code": "SOC/12139",
"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,
"code": "SOC/12139",
"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 /merchants/{merchantId}/clients
Obtener los clientes del comercio.
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,
"code": "SOC/12139",
"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 detalle de un cliente.
Actualizar un cliente.
Borrar un cliente.
get /merchants/{merchantId}/clients/{clientId}
Obtener detalle de un cliente.
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,
"code": "SOC/12139",
"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/"
}
}
]
}
patch /merchants/{merchantId}/clients/{clientId}
Actualizar un cliente.
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:
{
"code": "SOC/12139",
"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,
"code": "SOC/12139",
"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/"
}
}
]
}
delete /merchants/{merchantId}/clients/{clientId}
Borrar un cliente.
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/"
}
}
]
}
Generar códigos promocionales asociados a la empresa.
Listar los códigos promocionales de una empresa.
post /merchants/{merchantId}/codes
Generar códigos promocionales asociados a la empresa.
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/"
}
}
]
}
get /merchants/{merchantId}/codes
Listar los códigos promocionales de una empresa.
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/"
}
}
]
}
Habilitar un código promocional.
patch /merchants/{merchantId}/codes/{codeId}/enables
Habilitar un código promocional.
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/"
}
}
]
}
Deshabilitar un código promocional.
patch /merchants/{merchantId}/codes/{codeId}/disables
Deshabilitar un código promocional.
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/"
}
}
]
}
Obtener los usuarios que han utilizado este código promocional, la fecha en que se utilizó es pivotCreationDate.
get /merchants/{merchantId}/codes/{codeId}/users
Obtener los usuarios que han utilizado este código promocional, la fecha en que se utilizó es pivotCreationDate.
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/"
}
}
]
}
Crea una remesa, los valores posibles para status son ACTIVE, CREATED, SENT.
Obtener las remesas del comercio.
post /merchants/{merchantId}/consignments
Crea una remesa, los valores posibles para status son ACTIVE, CREATED, SENT.
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/"
}
}
]
}
get /merchants/{merchantId}/consignments
Obtener las remesas del comercio.
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:
2021-11-12 10:30:00 - dateTo: (string)
Filtrar por fecha en formato Y-m-d H:i:s (HASTA).
Example:
2021-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/"
}
}
]
}
Obtener detalle de una remesa.
Actualizar una remesa.
Borrar una remesa.
get /merchants/{merchantId}/consignments/{consignmentId}
Obtener detalle de una remesa.
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/"
}
}
]
}
patch /merchants/{merchantId}/consignments/{consignmentId}
Actualizar una remesa.
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/"
}
}
]
}
delete /merchants/{merchantId}/consignments/{consignmentId}
Borrar una remesa.
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/"
}
}
]
}
Crea/actualiza asociaciones de una remesa con los cargos bancarios enviados.
Borrar asociaciones de una remesa con los cargos bancarios enviados.
post /merchants/{merchantId}/consignments/{consignmentId}/banks/charges
Crea/actualiza asociaciones de una remesa con los cargos bancarios enviados.
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/"
}
}
]
}
patch /merchants/{merchantId}/consignments/{consignmentId}/banks/charges
Borrar asociaciones de una remesa con los cargos bancarios enviados.
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/"
}
}
]
}
Crea/actualiza un registro de asociación de una remesa con el cargo bancario.
Borrar un registro de asociación de una remesa con el cargo bancario.
post /merchants/{merchantId}/consignments/{consignmentId}/banks/charges/{chargeId}
Crea/actualiza un registro de asociación de una remesa con el cargo bancario.
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/"
}
}
]
}
delete /merchants/{merchantId}/consignments/{consignmentId}/banks/charges/{chargeId}
Borrar un registro de asociación de una remesa con el cargo bancario.
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/"
}
}
]
}
Actualizar status de una remesa a GENERATED.
patch /merchants/{merchantId}/consignments/{consignmentId}/generates
Actualizar status de una remesa a GENERATED.
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/"
}
}
]
}
Actualizar status de una remesa a SENT.
patch /merchants/{merchantId}/consignments/{consignmentId}/sends
Actualizar status de una remesa a SENT.
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/"
}
}
]
}
Descarga fichero XML.
get /merchants/{merchantId}/consignments/{consignmentId}/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/"
}
}
]
}
Listar los envíos de una empresa.
get /merchants/{merchantId}/deliveries
Listar los envíos de una empresa.
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:
2021-11-12 10:30:00 - dateTo: (string)
Filtrar por fecha en formato Y-m-d H:i:s (HASTA).
Example:
2021-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/"
}
}
]
}
Obtener detalle del envío.
Actualizar envío.
Borrar un envío.
get /merchants/{merchantId}/deliveries/{deliveryId}
Obtener detalle del envío.
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/"
}
}
]
}
patch /merchants/{merchantId}/deliveries/{deliveryId}
Actualizar envío.
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",
"trackingNumber": "324234UJK",
"sendEmail": true
}
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/"
}
}
]
}
delete /merchants/{merchantId}/deliveries/{deliveryId}
Borrar un envío.
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/"
}
}
]
}
Crear descuento de acuerdo al tipo [BRAND, CATEGORY, COLLECTION, PRODUCT].
Listar los descuentos de una empresa.
post /merchants/{merchantId}/discounts
Crear descuento de acuerdo al tipo [BRAND, CATEGORY, COLLECTION, PRODUCT].
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/"
}
}
]
}
get /merchants/{merchantId}/discounts
Listar los descuentos de una empresa.
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:
2021-11-12 10:30:00 - dateTo: (string)
Filtrar por fecha en formato Y-m-d H:i:s (HASTA).
Example:
2021-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/"
}
}
]
}
Obtener detalle del descuento.
Actualizar descuento.
Borrar un descuento.
get /merchants/{merchantId}/discounts/{discountId}
Obtener detalle del descuento.
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/"
}
}
]
}
patch /merchants/{merchantId}/discounts/{discountId}
Actualizar descuento.
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/"
}
}
]
}
delete /merchants/{merchantId}/discounts/{discountId}
Borrar un descuento.
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/"
}
}
]
}
Crea un registro de asociación de un descuento con un código promocional.
Borrar un registro de asociación de una reserva con producto y variante.
post /merchants/{merchantId}/discounts/{discountId}/codes/{codeId}
Crea un registro de asociación de un descuento con un código promocional.
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/"
}
}
]
}
delete /merchants/{merchantId}/discounts/{discountId}/codes/{codeId}
Borrar un registro de asociación de una reserva con producto y variante.
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/"
}
}
]
}
Crea una nueva descripción asociada al descuento.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/discounts/{discountId}/descriptions
Crea una nueva descripción asociada al descuento.
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/"
}
}
]
}
get /merchants/{merchantId}/discounts/{discountId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
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/"
}
}
]
}
Crea una nueva descripción en el idioma recibido, asociada al descuento.
Eliminar registro en el idioma enviado.
post /merchants/{merchantId}/discounts/{discountId}/descriptions/{language}
Crea una nueva descripción en el idioma recibido, asociada al descuento.
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/"
}
}
]
}
delete /merchants/{merchantId}/discounts/{discountId}/descriptions/{language}
Eliminar registro en el idioma enviado.
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/"
}
}
]
}
Crea un registro de asociación de un descuento con una subscripción.
Borrar un registro de asociación de una reserva con producto y variante.
post /merchants/{merchantId}/discounts/{discountId}/subscriptions/{subscriptionId}
Crea un registro de asociación de un descuento con una subscripción.
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/"
}
}
]
}
delete /merchants/{merchantId}/discounts/{discountId}/subscriptions/{subscriptionId}
Borrar un registro de asociación de una reserva con producto y variante.
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/"
}
}
]
}
Crear un documento, los posibles valores para type son IN, OUT.
Listado de documentos disponibles.
post /merchants/{merchantId}/documents
Crear un documento, los posibles valores para type son IN, OUT.
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": "OUT",
"date": "2020-12-28",
"serieId": 65,
"clientId": 123,
"categoryId": 30,
"externalCode": "COD-123",
"subject": "Subject",
"description": "Esto es una descripción",
"observations": "Esto es una observación",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
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": 57,
"serieId": 1,
"clientId": null,
"categoryId": null,
"number": 1,
"type": "IN",
"code": "ES20210001/2020",
"externalCode": null,
"date": "2020-12-28",
"subject": null,
"description": "Esto es una descripción",
"observations": null,
"creationDate": "2021-01-12T12:50:50Z",
"lastUpdateDate": "2021-02-02T15:54:20Z",
"documentId": 1,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20.png",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20-voucher.pdf"
}
],
"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 /merchants/{merchantId}/documents
Listado de documentos disponibles.
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
- sortField: (string)
Posibles valores permitidos -> date, type, categoryId, code, externalCode, clientName.
Example:
clientName - sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC - serieId: (integer)
Filtrar por serieId.
Example:
1 - dateFrom: (string)
Filtrar por fecha
dateen formato Y-m-d (DESDE).Example:
2021-03-12 - dateTo: (string)
Filtrar por fecha
dateen formato Y-m-d (HASTA).Example:
2021-03-14 - search: (string)
Buscar por los campos
description, subject, externalCode, code, nombre, apellidos, email.Example:
2021-03-14 - type: (string)
Filtrar por
type.Example:
2021-03-14
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 57,
"serieId": 1,
"clientId": null,
"categoryId": null,
"number": 1,
"type": "IN",
"code": "ES20210001/2020",
"externalCode": null,
"date": "2020-12-28",
"subject": null,
"description": "Esto es una descripción",
"observations": null,
"creationDate": "2021-01-12T12:50:50Z",
"lastUpdateDate": "2021-02-02T15:54:20Z",
"documentId": 1,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20.png",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20-voucher.pdf"
}
],
"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 documento.
Actualizar documento.
Borrar un documento.
get /merchants/{merchantId}/documents/{documentId}
Obtener detalle de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
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": 57,
"serieId": 1,
"clientId": null,
"categoryId": null,
"number": 1,
"type": "IN",
"code": "ES20210001/2020",
"externalCode": null,
"date": "2020-12-28",
"subject": null,
"description": "Esto es una descripción",
"observations": null,
"creationDate": "2021-01-12T12:50:50Z",
"lastUpdateDate": "2021-02-02T15:54:20Z",
"documentId": 1,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20.png",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20-voucher.pdf"
}
],
"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 /merchants/{merchantId}/documents/{documentId}
Actualizar documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"type": "OUT",
"date": "2020-12-28",
"serieId": 65,
"clientId": 123,
"categoryId": 30,
"externalCode": "COD-123",
"subject": "Subject",
"description": "Esto es una descripción",
"observations": "Esto es una observación",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
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": 57,
"serieId": 1,
"clientId": null,
"categoryId": null,
"number": 1,
"type": "IN",
"code": "ES20210001/2020",
"externalCode": null,
"date": "2020-12-28",
"subject": null,
"description": "Esto es una descripción",
"observations": null,
"creationDate": "2021-01-12T12:50:50Z",
"lastUpdateDate": "2021-02-02T15:54:20Z",
"documentId": 1,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20.png",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20-voucher.pdf"
}
],
"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 /merchants/{merchantId}/documents/{documentId}
Borrar un documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
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/"
}
}
]
}
Añade o actualiza fichero del documento.
Borrar fichero del documento.
post /merchants/{merchantId}/documents/{documentId}/files
Añade o actualiza fichero del documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: multipart/form-data
Type: object
Properties- file: 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": [
{
"date": "2020-12-28",
"serieId": 1,
"description": "Esto es una descripción",
"merchantId": "119",
"number": 1,
"code": "DS20211",
"creationDate": "2020-12-29T19:31:09Z",
"lastUpdateDate": "2020-12-29T19:31:09Z",
"documentId": 1,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/20/documents/2056/files/sample.txt"
}
],
"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 /merchants/{merchantId}/documents/{documentId}/files
Borrar fichero del documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
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": 57,
"serieId": 1,
"clientId": null,
"categoryId": null,
"number": 1,
"type": "IN",
"code": "ES20210001/2020",
"externalCode": null,
"date": "2020-12-28",
"subject": null,
"description": "Esto es una descripción",
"observations": null,
"creationDate": "2021-01-12T12:50:50Z",
"lastUpdateDate": "2021-02-02T15:54:20Z",
"documentId": 1,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20.png",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/documents/1/files/20-voucher.pdf"
}
],
"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/"
}
}
]
}
Agregar participantes a documento.
Obtener todos los participantes vinculados al documento.
Eliminar participantes de documento.
post /merchants/{merchantId}/documents/{documentId}/participants
Agregar participantes a documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"participantIds": [179739, 179740],
"all": true
}
HTTP status code 204
Se actualiza 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/"
}
}
]
}
get /merchants/{merchantId}/documents/{documentId}/participants
Obtener todos los participantes vinculados al documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
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 - sortField: (string)
Posibles valores permitidos -> fullName.
Example:
name - sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se actualiza el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"clientId": 179740,
"code": "",
"fullName": "Pablo David Zenande",
"email": "",
"dni": "79444555T",
"phone": "981981981"
},
{
"clientId": 179739,
"code": "",
"fullName": "Pablo Senande",
"email": "",
"dni": "79333096L",
"phone": "981981981"
}
],
"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 /merchants/{merchantId}/documents/{documentId}/participants
Eliminar participantes de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- documentId: required(number)
Identificador del documento.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"participantIds": [179739, 179740],
"all": true
}
HTTP status code 204
Se actualiza 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/"
}
}
]
}
Crear una categoría de documento.
Listado de categorías de documento disponibles.
post /merchants/{merchantId}/documents/categories
Crear una categoría de documento.
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": "Planillas físicas",
"status": "ACTIVE",
"parentId": null
}
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": [
{
"name": "Planillas físicas",
"status": "ACTIVE",
"parentId": null,
"merchantId": "87",
"creationDate": "2021-02-02T11:28:57Z",
"lastUpdateDate": "2021-02-02T11:28:57Z",
"categoryId": 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 /merchants/{merchantId}/documents/categories
Listado de categorías de documento disponibles.
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
- sortField: (string)
Posibles valores permitidos -> name, status.
Example:
name - sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Planillas físicas",
"status": "ACTIVE",
"parentId": null,
"merchantId": "87",
"creationDate": "2021-02-02T11:28:57Z",
"lastUpdateDate": "2021-02-02T11:28:57Z",
"categoryId": 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 de la categoría de documento.
Actualizar categoría de documento.
Borrar una categoría de documento.
get /merchants/{merchantId}/documents/categories/{categoryId}
Obtener detalle de la categoría de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(number)
Identificador 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 exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Planillas físicas",
"status": "ACTIVE",
"parentId": null,
"merchantId": "87",
"creationDate": "2021-02-02T11:28:57Z",
"lastUpdateDate": "2021-02-02T11:28:57Z",
"categoryId": 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 /merchants/{merchantId}/documents/categories/{categoryId}
Actualizar categoría de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(number)
Identificador 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:
{
"name": "Planillas físicas",
"status": "ACTIVE",
"parentId": null
}
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": [
{
"name": "Planillas físicas",
"status": "ACTIVE",
"parentId": null,
"merchantId": "87",
"creationDate": "2021-02-02T11:28:57Z",
"lastUpdateDate": "2021-02-02T11:28:57Z",
"categoryId": 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/"
}
}
]
}
delete /merchants/{merchantId}/documents/categories/{categoryId}
Borrar una categoría de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(number)
Identificador de la categoría.
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/"
}
}
]
}
Crear una serie de documento.
Listado de series de documento disponibles.
post /merchants/{merchantId}/documents/series
Crear una serie de documento.
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:
{
"prefix": "DS2021",
"description": "Documentos de Salida durante el 2021"
}
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": 20,
"prefix": "DS2021",
"number": 0,
"description": "Documentos de Salida durante el 2021",
"creationDate": "2020-12-28T17:20:55Z",
"lastUpdateDate": "2020-12-28T17:20:55Z",
"serieId": 2028
}
],
"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 /merchants/{merchantId}/documents/series
Listado de series de documento disponibles.
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
- prefix: (string)
Filtrar por tipo de serie.
Example:
DS
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 20,
"prefix": "DS2021",
"number": 0,
"description": "Documentos de Salida durante el 2021",
"creationDate": "2020-12-28T17:20:55Z",
"lastUpdateDate": "2020-12-28T17:20:55Z",
"serieId": 2028
}
],
"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 serie de documento.
Actualizar serie de documento.
Borrar una serie de documento.
get /merchants/{merchantId}/documents/series/{serieId}
Obtener detalle de la serie de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- serieId: required(number)
Identificador de la serie.
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": 20,
"prefix": "DS2021",
"number": 0,
"description": "Documentos de Salida durante el 2021",
"creationDate": "2020-12-28T17:20:55Z",
"lastUpdateDate": "2020-12-28T17:20:55Z",
"serieId": 2028
}
],
"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 /merchants/{merchantId}/documents/series/{serieId}
Actualizar serie de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- serieId: required(number)
Identificador de la serie.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"prefix": "DS2021",
"description": "Documentos de Salida durante el 2021"
}
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": 20,
"prefix": "DS2021",
"number": 0,
"description": "Documentos de Salida durante el 2021",
"creationDate": "2020-12-28T17:20:55Z",
"lastUpdateDate": "2020-12-28T17:20:55Z",
"serieId": 2028
}
],
"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 /merchants/{merchantId}/documents/series/{serieId}
Borrar una serie de documento.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- serieId: required(number)
Identificador de la serie.
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/"
}
}
]
}
Crear una plantilla de correo.
Listado de plantillas de correo disponibles.
post /merchants/{merchantId}/emails/templates
Crear una plantilla de correo.
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/"
}
}
]
}
get /merchants/{merchantId}/emails/templates
Listado de plantillas de correo disponibles.
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.jsonHTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "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 plantilla.
Actualizar plantilla de correo.
Borrar una plantilla de correo.
get /merchants/{merchantId}/emails/templates/{templateId}
Obtener detalle de la plantilla.
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/"
}
}
]
}
patch /merchants/{merchantId}/emails/templates/{templateId}
Actualizar plantilla de correo.
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/"
}
}
]
}
delete /merchants/{merchantId}/emails/templates/{templateId}
Borrar una plantilla de correo.
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/"
}
}
]
}
Crear una entidad.
Listar las entidades.
post /merchants/{merchantId}/entities
Crear una entidad.
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/"
}
}
]
}
get /merchants/{merchantId}/entities
Listar las entidades.
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/"
}
}
]
}
Actualizar entidad.
Obtener detalle de la entidad.
Borrar una entidad.
patch /merchants/{merchantId}/entities/{entityId}
Actualizar entidad.
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/"
}
}
]
}
get /merchants/{merchantId}/entities/{entityId}
Obtener detalle de la entidad.
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/"
}
}
]
}
delete /merchants/{merchantId}/entities/{entityId}
Borrar una entidad.
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/"
}
}
]
}
Listar las reservas asociadas al centro/entidad.
get /merchants/{merchantId}/entities/{entityId}/reservations
Listar las reservas asociadas al centro/entidad.
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/"
}
}
]
}
Listar los recurso items asociados a una entidad / centro.
get /merchants/{merchantId}/entities/{entityId}/resources/items
Listar los recurso items asociados a una entidad / centro.
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/"
}
}
]
}
Añadir horario a un centro de trabajo.
Listar los horarios de un centro de trabajo.
post /merchants/{merchantId}/entities/{entityId}/schedules
Añadir horario a un centro de trabajo.
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/"
}
}
]
}
get /merchants/{merchantId}/entities/{entityId}/schedules
Listar los horarios de un centro de trabajo.
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/"
}
}
]
}
Actualizar horario.
Obtener detalle del horario.
Borrar un horario.
patch /merchants/{merchantId}/entities/{entityId}/schedules/{scheduleId}
Actualizar horario.
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/"
}
}
]
}
get /merchants/{merchantId}/entities/{entityId}/schedules/{scheduleId}
Obtener detalle del horario.
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/"
}
}
]
}
delete /merchants/{merchantId}/entities/{entityId}/schedules/{scheduleId}
Borrar un horario.
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/"
}
}
]
}
Listar los eventos.
get /merchants/{merchantId}/events
Listar los eventos.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- sortField: (string)
Posibles valores permitidos -> startDate, finishDate.
Example:
startDate - sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC - 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 - search: (string)
Búsqueda por nombre.
Example:
bienestar - 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 ACTIVE, INACTIVE)
Status del evento.
Example:
ACTIVE - dateFrom: (string)
Filtrar por fecha
startDate, finishDateen formato Y-m-d (DESDE).Example:
2021-03-12 - dateTo: (string)
Filtrar por fecha
startDate, finishDateen formato Y-m-d (HASTA).Example:
2021-03-14
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/"
}
}
]
}
Listar las categorías de evento.
get /merchants/{merchantId}/events/categories
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/"
}
}
]
}
Obtener detalle de una categoría.
get /merchants/{merchantId}/events/categories/{categoryId}
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/"
}
}
]
}
Obtener detalle de un evento.
get /merchants/{merchantId}/events/{eventId}
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/"
}
}
]
}
Obtener los productos asociados al evento.
get /merchants/{merchantId}/events/{eventId}/products
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,
"lastPrice": 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/"
}
}
]
}
Crea un registro de asociación de un evento con un producto.
Borrar un registro de asociación de un evento con un producto.
post /merchants/{merchantId}/events/{eventId}/products/{productId}/variants/{variantId}
Crea un registro de asociación de un evento con un producto.
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/"
}
}
]
}
delete /merchants/{merchantId}/events/{eventId}/products/{productId}/variants/{variantId}
Borrar un registro de asociación de un evento con un producto.
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/"
}
}
]
}
Crear una entrada a un evento GRATIS.
post /merchants/{merchantId}/events/{eventId}/tickets
Crear una entrada a un evento GRATIS.
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/"
}
}
]
}
Listar el conteo de entradas vendidas y adquiridas por código promocional.
get /merchants/{merchantId}/events/{eventId}/tickets/sells
Listar el conteo de entradas vendidas y adquiridas por código promocional.
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/"
}
}
]
}
Borrar un ticket de evento.
delete /merchants/{merchantId}/events/{eventId}/tickets/{UUID}
Borrar un ticket de evento.
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/"
}
}
]
}
Descarga ticket de evento en PDF.
get /merchants/{merchantId}/events/{eventId}/tickets/{UUID}/cards/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/"
}
}
]
}
Validar el ticket de evento.
get /merchants/{merchantId}/events/{eventId}/tickets/{UUID}/validates
Validar el ticket de evento.
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/"
}
}
]
}
Crear una zona asociada al evento.
Listado de las zonas ordenadas alfabéticamente.
post /merchants/{merchantId}/events/{eventId}/zones
Crear una zona asociada al evento.
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/"
}
}
]
}
get /merchants/{merchantId}/events/{eventId}/zones
Listado de las zonas ordenadas alfabéticamente.
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/"
}
}
]
}
Obtener detalle de una zona.
Actualizar zona.
Borrar una zona.
get /merchants/{merchantId}/events/{eventId}/zones/{zoneId}
Obtener detalle de una zona.
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/"
}
}
]
}
patch /merchants/{merchantId}/events/{eventId}/zones/{zoneId}
Actualizar zona.
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/"
}
}
]
}
delete /merchants/{merchantId}/events/{eventId}/zones/{zoneId}
Borrar una zona.
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/"
}
}
]
}
Crear un nuevo campo.
Listado de los campos ordenados alfabéticamente.
post /merchants/{merchantId}/fields
Crear un nuevo campo.
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/"
}
}
]
}
get /merchants/{merchantId}/fields
Listado de los campos ordenados alfabéticamente.
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/"
}
}
]
}
Obtener detalle de un campo.
Actualizar campo.
Borrar un campo.
get /merchants/{merchantId}/fields/{fieldId}
Obtener detalle de un campo.
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/"
}
}
]
}
patch /merchants/{merchantId}/fields/{fieldId}
Actualizar campo.
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/"
}
}
]
}
delete /merchants/{merchantId}/fields/{fieldId}
Borrar un campo.
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/"
}
}
]
}
Añadir una opción al campo del formulario dinámico.
Listado de las opciones del campo.
post /merchants/{merchantId}/fields/{fieldId}/options
Añadir una opción al campo del formulario dinámico.
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/"
}
}
]
}
get /merchants/{merchantId}/fields/{fieldId}/options
Listado de las opciones del campo.
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/"
}
}
]
}
Actualizar opción de un campo de formulario dinámico.
Borrar una opción de un campo del formulario dinámico y devuelve listado actualizado.
patch /merchants/{merchantId}/fields/{fieldId}/options/{optionId}
Actualizar opción de un campo de formulario dinámico.
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/"
}
}
]
}
delete /merchants/{merchantId}/fields/{fieldId}/options/{optionId}
Borrar una opción de un campo del formulario dinámico y devuelve listado actualizado.
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/"
}
}
]
}
Crear un nuevo formulario dinámico.
Listado de los formularios dinámicos.
post /merchants/{merchantId}/forms
Crear un nuevo formulario dinámico.
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/"
}
}
]
}
get /merchants/{merchantId}/forms
Listado de los formularios dinámicos.
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/"
}
}
]
}
Listado de los formularios dinámicos.
get /merchants/{merchantId}/forms/fields
Listado de los formularios dinámicos.
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/"
}
}
]
}
Obtener detalle de un formulario dinámico.
Actualizar nombre de formulario dinámico.
Borrar un formulario dinámico.
get /merchants/{merchantId}/forms/{formId}
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/"
}
}
]
}
patch /merchants/{merchantId}/forms/{formId}
Actualizar nombre de formulario dinámico.
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/"
}
}
]
}
delete /merchants/{merchantId}/forms/{formId}
Borrar un formulario dinámico.
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/"
}
}
]
}
Crear un nuevo campo y asociarlo al formulario.
Listado de los campos asociados al formulario.
post /merchants/{merchantId}/forms/{formId}/fields
Crear un nuevo campo y asociarlo al formulario.
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/"
}
}
]
}
get /merchants/{merchantId}/forms/{formId}/fields
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
Asociar campo al formulario, especificando posición y si es requerido.
Desasociar campo al formulario.