Plaam 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/"
}
}
]
}
Crea una especialidad.
Obtener las especialidades.
post /merchants/{merchantId}/academics/specialties
Crea una especialidad.
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": "Machine learning"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Machine learning",
"merchantId": "80",
"creationDate": "2021-10-20T12:40:23Z",
"lastUpdateDate": "2021-10-20T12:40:23Z",
"specialtyId": 2
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by oauth_2_0
Headers
- Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Query Parameters
- access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.
HTTP status code 401
Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
HTTP status code 403
Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/academics/specialties
Obtener las especialidades.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Buscar por
name
.Example:
Machine
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Machine learning",
"merchantId": "80",
"creationDate": "2021-10-20T12:40:23Z",
"lastUpdateDate": "2021-10-20T12:40:23Z",
"specialtyId": 2
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de especialidad.
Actualizar especialidad.
Borrar especialidad.
get /merchants/{merchantId}/academics/specialties/{specialtyId}
Obtener detalle de especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- specialtyId: required(integer)
Identificador único de la especialidad.
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": "Machine learning",
"merchantId": "80",
"creationDate": "2021-10-20T12:40:23Z",
"lastUpdateDate": "2021-10-20T12:40:23Z",
"specialtyId": 2
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by oauth_2_0
Headers
- Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Query Parameters
- access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.
HTTP status code 401
Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
HTTP status code 403
Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/academics/specialties/{specialtyId}
Actualizar especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- specialtyId: required(integer)
Identificador único de la especialidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Machine learning"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 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}/academics/specialties/{specialtyId}
Borrar especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- specialtyId: required(integer)
Identificador único de la especialidad.
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 universidad.
Obtener las universidades.
post /merchants/{merchantId}/academics/universities
Crea una universidad.
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:
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"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": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 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}/academics/universities
Obtener las universidades.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
- search: (string)
Buscar por
name, email, rector, phone
.Example:
Javier Oviedo
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 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 universidad.
Actualizar universidad.
Borrar universidad.
get /merchants/{merchantId}/academics/universities/{universityId}
Obtener detalle de universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
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": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 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/"
}
}
]
}
patch /merchants/{merchantId}/academics/universities/{universityId}
Actualizar universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
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",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"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": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 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}/academics/universities/{universityId}
Borrar universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
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 escuela.
Obtener las escuelas.
post /merchants/{merchantId}/academics/universities/{universityId}/schools
Crea una escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "14040333",
"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": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 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}/academics/universities/{universityId}/schools
Obtener las escuelas.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
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
- search: (string)
Buscar por
name, email
.Example:
Instituto
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 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 escuela.
Actualizar escuela.
Borrar escuela.
get /merchants/{merchantId}/academics/universities/{universityId}/schools/{schoolId}
Obtener detalle de escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
- schoolId: required(integer)
Identificador único de la escuela.
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": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 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}/academics/universities/{universityId}/schools/{schoolId}
Actualizar escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
- schoolId: required(integer)
Identificador único de la escuela.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "14040333",
"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": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 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}/academics/universities/{universityId}/schools/{schoolId}
Borrar escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
- schoolId: required(integer)
Identificador único de la escuela.
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/"
}
}
]
}
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",
"type": "ASSOCIATION",
"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",
"type": "ASSOCIATION",
"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",
"type": "ASSOCIATION",
"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/"
}
}
]
}
Crear red social para autor de blog.
Listar las redes sociales de autor de blog.
post /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks
Crear red social para autor de blog.
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
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK"
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"merchantId": "87",
"creationDate": "2021-01-29T15:06:07Z",
"lastUpdateDate": "2021-01-29T15:06:07Z",
"networkId": 13
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.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/authors/{authorId}/socials/networks
Listar las redes sociales de autor de blog.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
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.
Example:
ACTIVE
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"merchantId": "87",
"creationDate": "2021-01-29T15:06:07Z",
"lastUpdateDate": "2021-01-29T15:06:07Z",
"networkId": 13
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de la red social.
Actualizar red social.
Borrar una red social.
get /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks/{networkId}
Obtener detalle de la red social.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
- networkId: required(integer)
Identificador único de la red social.
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": [
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"merchantId": "87",
"creationDate": "2021-01-29T15:06:07Z",
"lastUpdateDate": "2021-01-29T15:06:07Z",
"networkId": 13
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks/{networkId}
Actualizar red social.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
- networkId: required(integer)
Identificador único de la red social.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK"
}
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": [
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"merchantId": "87",
"creationDate": "2021-01-29T15:06:07Z",
"lastUpdateDate": "2021-01-29T15:06:07Z",
"networkId": 13
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.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/authors/{authorId}/socials/networks/{networkId}
Borrar una red social.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
- networkId: required(integer)
Identificador único de la red social.
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 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
- inUse: (boolean)
Filtrar por las que están en uso en algún post, true para las que si, false para las que no.
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": "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/"
}
}
]
}
Envio de correos masivos a los clientes seleccionados, se envia el subject, y el body del mensaje, tambien se puede enviar una template para el envío.
post /merchants/{merchantId}/clients/emails
Envio de correos masivos a los clientes seleccionados, se envia el subject, y el body del mensaje, tambien se puede enviar una template para el envío.
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":"Cumpleañeros del Mes",
"clientIds": ["245","324"],
"body": "Feliz Cumpleaños a todos",
"emailTemplateId": 5
}
HTTP status code 204
Se envían correos 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/"
}
}
]
}
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/"
}
}
]
}
Crear una orden por cada clientId recibido.
post /merchants/{merchantId}/clients/orders
Crear una orden por cada clientId recibido.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Body
Media type: application/json
Example:
{
"clientIds": [
68
],
"items": [{
"productId": 637527,
"variantId": 95336,
"quantity": 3
}]
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "POST/recurso",
"result": [{
"userId": 0,
"merchantId": "80",
"clientId": 179641,
"clientIp": "127.0.0.1",
"amount": 70670,
"irpf": 0,
"status": "CREATED",
"type": "BRICK",
"deliveryId": null,
"serieId": 18,
"number": 61,
"date": "2022-02-14",
"notes": null,
"creationDate": "2022-02-14T18:27:01Z",
"lastUpdateDate": "2022-02-14T18:27:12Z",
"orderId": 2520,
"code": "P61",
"items": [{
"orderId": 2520,
"variantId": 95336,
"productId": 637527,
"typeId": null,
"serialId": null,
"code": "",
"quantity": 4,
"price": 1998,
"discount": 0,
"customDiscount": "0.00",
"iva": "21.00",
"name": "Camiseta ICOIIG",
"description": "Aquí va la descripción larga del producto",
"dataJson": null,
"formJson": null,
"type": "MERCHANDISE",
"unitType": "UNIT",
"unitName": "unidad",
"currency": "EUR",
"creationDate": "2022-02-14T18:27:05Z",
"lastUpdateDate": "2022-02-14T18:27:10Z",
"itemId": 4297,
"imagesURL": [
"https://plataforma.staging.plaam.com/modulos/e-commerce/archivos/80/20220211144524_cam-roja"
],
"options": [],
"slug": "camiseta-icoiig"
},
{
"orderId": 2520,
"variantId": 95339,
"productId": 637529,
"typeId": null,
"serialId": null,
"code": "",
"quantity": 14,
"price": 4477,
"discount": 0,
"customDiscount": "0.00",
"iva": "21.00",
"name": "Agenda 2022",
"description": null,
"dataJson": null,
"formJson": null,
"type": "MERCHANDISE",
"unitType": "UNIT",
"unitName": "unidad",
"currency": "EUR",
"creationDate": "2022-02-14T18:27:08Z",
"lastUpdateDate": "2022-02-14T18:27:11Z",
"itemId": 4298,
"imagesURL": [
"https://plataforma.staging.plaam.com/modulos/e-commerce/archivos/80/variantes/20220214191831_agenda.jpeg"
],
"options": [],
"slug": "agenda-2022"
}
]
},
{
"userId": 0,
"merchantId": "80",
"clientId": 179752,
"clientIp": "127.0.0.1",
"amount": 70670,
"irpf": 0,
"status": "CREATED",
"type": "BRICK",
"deliveryId": null,
"serieId": 18,
"number": 62,
"date": "2022-02-14",
"notes": null,
"creationDate": "2022-02-14T18:27:13Z",
"lastUpdateDate": "2022-02-14T18:27:26Z",
"orderId": 2521,
"code": "P62",
"items": [{
"orderId": 2521,
"variantId": 95336,
"productId": 637527,
"typeId": null,
"serialId": null,
"code": "",
"quantity": 4,
"price": 1998,
"discount": 0,
"customDiscount": "0.00",
"iva": "21.00",
"name": "Camiseta ICOIIG",
"description": "Aquí va la descripción larga del producto",
"dataJson": null,
"formJson": null,
"type": "MERCHANDISE",
"unitType": "UNIT",
"unitName": "unidad",
"currency": "EUR",
"creationDate": "2022-02-14T18:27:17Z",
"lastUpdateDate": "2022-02-14T18:27:24Z",
"itemId": 4299,
"imagesURL": [
"https://plataforma.staging.plaam.com/modulos/e-commerce/archivos/80/20220211144524_cam-roja"
],
"options": [],
"slug": "camiseta-icoiig"
},
{
"orderId": 2521,
"variantId": 95339,
"productId": 637529,
"typeId": null,
"serialId": null,
"code": "",
"quantity": 14,
"price": 4477,
"discount": 0,
"customDiscount": "0.00",
"iva": "21.00",
"name": "Agenda 2022",
"description": null,
"dataJson": null,
"formJson": null,
"type": "MERCHANDISE",
"unitType": "UNIT",
"unitName": "unidad",
"currency": "EUR",
"creationDate": "2022-02-14T18:27:22Z",
"lastUpdateDate": "2022-02-14T18:27:25Z",
"itemId": 4300,
"imagesURL": [
"https://plataforma.staging.plaam.com/modulos/e-commerce/archivos/80/variantes/20220214191831_agenda.jpeg"
],
"options": [],
"slug": "agenda-2022"
}
]
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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/"
}
}
]
}
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/"
}
}
]
}
Cambiar el estado de los cargos bancarios recibidos en el request.
post /merchants/{merchantId}/consignments/{consignmentId}/banks/charges/{chargeId}/returns
Cambiar el estado de los cargos bancarios recibidos en el request.
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
Body
Media type: application/json
Example:
{
"chargeIds": [71, 93, 15]
}
HTTP status code 204
Se envia correo 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/"
}
}
]
}
Exportar a Excel de acuerdo a los filtros enviados y enviar por correo.
post /merchants/{merchantId}/consignments/{consignmentId}/excel
Exportar a Excel de acuerdo a los filtros enviados y enviar por correo.
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:
{
"email": "correo@example.net"
}
HTTP status code 204
Se envia correo 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/"
}
}
]
}
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/"
}
}
]
}
Crea un perfil de contratante.
Obtener los perfiles de contratante.
post /merchants/{merchantId}/contractors/profiles
Crea un perfil de contratante.
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:
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"storageId": "43b87512-e5fc-42a2-a74e-68115e7a6cb9"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles
Obtener los perfiles de contratante.
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
- sortField: (string)
Posibles valores permitidos -> status, id, position, date.
Example:
status
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- status: (one of ACTIVE, CREATED, INACTIVE)
Status del cargo.
Example:
ACTIVE
- type: (one of PRODUCT, CATEGORY, SIMPLE_PAGE, COLLECTION, CUSTOM, BLOG, NEWS, BRAND, EVENT, GROUP)
Status del cargo.
Example:
ACTIVE
- internal: (boolean)
Internal.
Example:
false
- local: (boolean)
Local.
Example:
false
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "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 perfil.
Actualizar un perfil de contratante.
Borrar un perfil de contratante.
get /merchants/{merchantId}/contractors/profiles/{profileId}
Obtener detalle del perfil.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
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": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "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}/contractors/profiles/{profileId}
Actualizar un perfil de contratante.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"storageId": "43b87512-e5fc-42a2-a74e-68115e7a6cb9"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles/{profileId}
Borrar un perfil de contratante.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
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.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/contractors/profiles/{profileId}/descriptions
Crea una nueva descripción.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
HTTP status code 201
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles/{profileId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
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",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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.
Eliminar registro en el idioma enviado.
post /merchants/{merchantId}/contractors/profiles/{profileId}/descriptions/{language}
Crea una nueva descripción en el idioma recibido.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
HTTP status code 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}/contractors/profiles/{profileId}/descriptions/{language}
Eliminar registro en el idioma enviado.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- 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/"
}
}
]
}
Cargar ficheros múltiples con su descripción.
patch /merchants/{merchantId}/contractors/profiles/{profileId}/files
Cargar ficheros múltiples con su descripción.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"files": [
{
"storageId": "81a2184f-4bdc-4723-ac0d-6291cbc1b533",
"descriptions": [
{
"language": "ES",
"name": "Primero"
},
{
"language": "EN",
"name": "First"
}
]
},
{
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"descriptions": [
{
"language": "EN",
"name": "Second"
},
{
"language": "ES",
"name": "Segundo"
}
]
}
]
}
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": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
HTTP status code 401
Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
HTTP status code 403
Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Borrar fichero.
delete /merchants/{merchantId}/contractors/profiles/{profileId}/files/{fileId}
Borrar fichero.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- fileId: required(integer)
Identificador único del fichero.
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": [
{
"position": 1,
"status": "ACTIVE",
"internal": true,
"local": false,
"type": "BRAND",
"typeId": 1571,
"date": "2021-01-01",
"buttonAction": "/information",
"url": "https://www.plaam.com",
"recordNumber": "123",
"recordStatusId": 1,
"merchantId": "57",
"creationDate": "2021-07-15T12:52:10Z",
"lastUpdateDate": "2021-07-15T12:52:10Z",
"profileId": 1,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/57/contractor/profiles/1/images/laravel.png",
"typeName": "",
"typeSlug": "",
"descriptions": [
{
"language": "es",
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
],
"files": []
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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 fichero.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/contractors/profiles/{profileId}/files/{fileId}/descriptions
Crea una nueva descripción asociada al fichero.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- fileId: required(integer)
Identificador único del fichero.
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"
}
HTTP status code 201
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre",
"language": "es"
},
{
"name": "Name",
"language": "en"
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles/{profileId}/files/{fileId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- fileId: required(integer)
Identificador único del fichero.
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": 2,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre",
"language": "es"
},
{
"name": "Name",
"language": "en"
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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/{merchantId}/contractors/profiles/{profileId}/files/{fileId}/descriptions/{language} patch delete
Actualizar una descripción dado el idioma.
Eliminar registro en el idioma enviado.
patch /merchants/{merchantId}/contractors/profiles/{profileId}/files/{fileId}/descriptions/{language}
Actualizar una descripción dado el idioma.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- fileId: required(integer)
Identificador único del fichero.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"title": "Título de elemento",
"description": "Descripción o subtítulo",
"buttonName": "+ INFORMACION"
}
HTTP status code 200
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre",
"language": "es"
},
{
"name": "Name",
"language": "en"
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles/{profileId}/files/{fileId}/descriptions/{language}
Eliminar registro en el idioma enviado.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
- fileId: required(integer)
Identificador único del fichero.
- 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 perfil de contratante.
delete /merchants/{merchantId}/contractors/profiles/{profileId}/images
Borrar imagen del perfil de contratante.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- profileId: required(integer)
Identificador único del perfil de contratante.
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 un status.
Obtener los status del perfil de contratante.
post /merchants/{merchantId}/contractors/profiles/status
Crear un status.
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:
{
"status": "ACTIVE",
"descriptions": [
{
"language": "es",
"name": "Test"
}
]
}
HTTP status code 201
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"merchantId": "57",
"creationDate": "2021-07-15T12:44:43Z",
"lastUpdateDate": "2021-07-15T12:44:43Z",
"statusId": 1,
"descriptions": [
{
"name": "Test",
"language": "es"
}
]
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles/status
Obtener los status del perfil de contratante.
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
- inUse: (boolean)
Filtrar por las que están en uso en perfil del contratante, true para las que si, false para las que no.
Example:
true
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"merchantId": "57",
"creationDate": "2021-07-15T12:44:43Z",
"lastUpdateDate": "2021-07-15T12:44:43Z",
"statusId": 1,
"descriptions": [
{
"name": "Test",
"language": "es"
}
]
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "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 status.
Actualizar un status.
Borrar un status de perfil de contratante.
get /merchants/{merchantId}/contractors/profiles/status/{statusId}
Obtener detalle de un status.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- statusId: required(integer)
Identificador único del status.
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": [
{
"status": "ACTIVE",
"merchantId": "57",
"creationDate": "2021-07-15T12:44:43Z",
"lastUpdateDate": "2021-07-15T12:44:43Z",
"statusId": 1,
"descriptions": [
{
"name": "Test",
"language": "es"
}
]
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "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}/contractors/profiles/status/{statusId}
Actualizar un status.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- statusId: required(integer)
Identificador único del status.
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",
"descriptions": [
{
"language": "es",
"name": "Test"
}
]
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"merchantId": "57",
"creationDate": "2021-07-15T12:44:43Z",
"lastUpdateDate": "2021-07-15T12:44:43Z",
"statusId": 1,
"descriptions": [
{
"name": "Test",
"language": "es"
}
]
}
],
"links": null
}
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "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}/contractors/profiles/status/{statusId}
Borrar un status de perfil de contratante.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- statusId: required(integer)
Identificador único del status.
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/"
}
}
]
}
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",
"status": "ACTIVE",
"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": [
{
"type": "IN",
"subject": "Hola",
"clientId": 207130,
"merchantId": "79",
"serieId": 14,
"date": "2022-02-18",
"number": 5,
"status": "ACTIVE",
"code": "WEB/0005/2022",
"creationDate": "2022-02-18T16:49:42Z",
"lastUpdateDate": "2022-02-18T16:49:45Z",
"documentId": 459,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n.jpg",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n-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
date
en formato Y-m-d (DESDE).Example:
2021-03-12
- dateTo: (string)
Filtrar por fecha
date
en 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:
IN
- status: (string)
Filtrar por
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": [
{
"type": "IN",
"subject": "Hola",
"clientId": 207130,
"merchantId": "79",
"serieId": 14,
"date": "2022-02-18",
"number": 5,
"status": "ACTIVE",
"code": "WEB/0005/2022",
"creationDate": "2022-02-18T16:49:42Z",
"lastUpdateDate": "2022-02-18T16:49:45Z",
"documentId": 459,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n.jpg",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n-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": [
{
"type": "IN",
"subject": "Hola",
"clientId": 207130,
"merchantId": "79",
"serieId": 14,
"date": "2022-02-18",
"number": 5,
"status": "ACTIVE",
"code": "WEB/0005/2022",
"creationDate": "2022-02-18T16:49:42Z",
"lastUpdateDate": "2022-02-18T16:49:45Z",
"documentId": 459,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n.jpg",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n-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",
"status": "ACTIVE",
"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": [
{
"type": "IN",
"subject": "Hola",
"clientId": 207130,
"merchantId": "79",
"serieId": 14,
"date": "2022-02-18",
"number": 5,
"status": "ACTIVE",
"code": "WEB/0005/2022",
"creationDate": "2022-02-18T16:49:42Z",
"lastUpdateDate": "2022-02-18T16:49:45Z",
"documentId": 459,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n.jpg",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n-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": [
{
"type": "IN",
"subject": "Hola",
"clientId": 207130,
"merchantId": "79",
"serieId": 14,
"date": "2022-02-18",
"number": 5,
"status": "ACTIVE",
"code": "WEB/0005/2022",
"creationDate": "2022-02-18T16:49:42Z",
"lastUpdateDate": "2022-02-18T16:49:45Z",
"documentId": 459,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n.jpg",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n-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/"
}
}
]
}
Agregar visitas de participantes de documento.
post /merchants/{merchantId}/documents/{documentId}/participants/visits
Agregar visitas de 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:
{
"sessionUserId": 124
}
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",
"type": "IN",
"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",
"type": "IN",
"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
- type: (string)
Filtrar por
type
.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": [
{
"merchantId": 20,
"prefix": "DS2021",
"type": "IN",
"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",
"type": "IN",
"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",
"type": "IN",
"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",
"type": "IN",
"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/"
}
}
]
}
Subir un documento de forma pública.
post /merchants/{merchantId}/documents/publics
Subir un documento de forma pública.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
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",
"firstName": "Jorge",
"lastName": "Samaniego",
"email": "guez_95ii@hotmail.com",
"document": "0706409687",
"documentType": "DNI",
"gender": "MALE",
"birthday": "1995-07-29",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0",
"recaptcha": "03AGdBq27h7E41JsQHArb1Ln2ciyb21NcDFwM2rZc_25q_G1mu6PkTDe65XukNT6J9FknlTQN8gshGoDTV4v5RVhb5_V121GML1l0wnqg7ALnBqPJAqJyDn5JbKmSyLK9zhW-1EY-U1ZsAeiKTmSnDutIC27l9vMLL8eiuxjm4Dqvj3RkY4uAoolV2jUydqT_eYH1WAVWVMOlVdQABgpdtJ5QXjQGvl4fFDhlguo4wb1xXqkQb0E0yb9AX-3llbWu6YJ77dEGUQC9uQ74VZDV-CUFVxol1fMFW--EF3E"
}
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": [
{
"type": "IN",
"subject": "Hola",
"clientId": 207130,
"merchantId": "79",
"serieId": 14,
"date": "2022-02-18",
"number": 5,
"status": "ACTIVE",
"code": "WEB/0005/2022",
"creationDate": "2022-02-18T16:49:42Z",
"lastUpdateDate": "2022-02-18T16:49:45Z",
"documentId": 459,
"fileUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n.jpg",
"voucherUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/79/documents/14/2022/259354551_325729739366393_443727873799687595_n-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/"
}
}
]
}
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.json
HTTP status code 400
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
Body
Media type: application/json
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
HTTP status code 401
Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
HTTP status code 403
Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
Body
Media type: application/json
Type: any
Example:
{
"errors": [
{
"code": "E0004",
"title": "A required field is missing.",
"detail": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
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