Vales de regalo
El endpoint de bonos o cupones regalo permite consultar, crear, modificar y eliminar información relacionada con los vales de regalo de su eCommerce y gestionar tanto códigos generales como los específicos por usuario. Los Códigos generales son cupones vinculados a un código alfanumérico. Los Códigos específicos por usuario son cupones vinculados a un usuario, a código alfanumérico o ambos. Si existe código se deberá introducir en algún paso del proceso de compra para activar el saldo. Si está vinculado a usuario, el cupón se visualizará en el apartado Bonos de la ficha de usuario del Backoffice y su saldo se activará automáticamente en cuanto ese usuario se identifique para realizar un pedido. El cupón puede ser usado en diferentes compras hasta que se agote su saldo o se caduque.
</> GET / vouchersDevuelve la información de los cupones regalo.
</> POST / vouchersCreación de un vale de regalo.
</> PUT / vouchers/{id}Edición del cupón regalo indicado.
</> DELETE / vouchers/{id}Elimina el cupón regalo indicado.
GET /vouchers
Descripción
Devuelve la información de los cupones regalo.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/vouchers
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| fields | Opcional | string | |
| Lista de campos a devolver. | |||
| page | Opcional | 1 | numeric |
| Nº de página solicitada. | |||
| perPage | Opcional | 100 | numeric |
| Cantidad de elementos por página. | |||
| sort | Opcional | expirationDate.desc | string |
| Variable de ordenación. | |||
| type | Opcional | 1 | numeric |
| Devuelve cupones del tipo indicado. Valores permitidos: 1 - Todos, 2 - Cupones con códigos de tipo general, 3 - Cupones con códigos específicos de usuario. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"CURSORS": {
"NEXT" :"http://api.logicommerce.net/v1/vouchers?page=2&perPage=100",
"PREVIOUS" :""
},
"ITEMS" : 1000,
"PAGERPARAMETERS": {
"PAGE" : 1,
"PERPAGE" : 100
},
"VOUCHERS": [
{
"AVAILABLEBALANCE" : 23,
"CODE" :"S4FY6UHJ",
"CURRENCY" :"EUR",
"ID" : 234566,
"USER": {
"ID" : 123,
"PID" :"abc"
},
"expirationDate" :"2015-03-11"
}
]
}
POST /vouchers
Descripción
Creación de un vale de regalo. Para generar un Código general es necesario informar del código alfanumérico. Para generar un Código específico por usuario es necesario informar sobre el identificador de usuario como mínimo, siendo el código alfanumérico opcional en este caso.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/vouchers
Parámetros de entrada JSON
{ "vouchers": { "availableBalance":numeric, "code":string, "currencyCode":string, "user": { "id":numeric, "pId":string }, "currencyId": numeric "expirationDate": datetime "pId": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| vouchers | Obligatorio | struct | |
| Bloque de información del cupón regalo o bono. | |||
| vouchers/availableBalance | Obligatorio | numeric | |
| Indica el saldo disponible del bono. | |||
| vouchers/code | Opcional | string | |
| Indica el código alfanumérico que identifica al bono. | |||
| vouchers/currencyCode | Obligatorio | string | |
| Código de la moneda en formato ISO 4217. | |||
| vouchers/currencyId | Obligatorio | numeric | |
| vouchers/expirationDate | Opcional | datetime | |
| Fecha de caducidad del bono. | |||
| vouchers/pId | Opcional | string | |
| vouchers/user | Opcional | struct | |
| Bloque de información del usuario registrado al que se quiere vincular el cupón. | |||
| vouchers/user/id | Opcional | 0 | numeric |
| Identificador interno del usuario. Opcional en caso que se use identificador público. | |||
| vouchers/user/pId | Opcional | string | |
| Identificador público del usuario. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"AVAILABLEBALANCE" : 23,
"CODE" :"S4FY6UHJ",
"CURRENCY" :"EUR",
"ID" : 234566,
"USER": {
"ID" : 123,
"PID" :"abc"
},
"expirationDate" :"2015-03-11"
}
PUT /vouchers/{id}
Descripción
Edición del cupón regalo indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/vouchers/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
Parámetros de entrada JSON
{ "vouchers": { "availableBalance":numeric, "currencyCode":string, "user": { "id":numeric, "pId":string }, "currencyId": numeric "code": string "expirationDate": datetime "pId": string } } |
Variables JSON:
| Variable | R/O | Valor por defecto | Tipo |
| vouchers | Obligatorio | struct | |
| Bloque de información del cupón regalo o bono. | |||
| vouchers/availableBalance | Opcional | numeric | |
| Indica el saldo disponible del bono. | |||
| vouchers/code | Opcional | string | |
| Indica el código alfanumérico que identifica al bono. | |||
| vouchers/currencyCode | Obligatorio | string | |
| Código de la moneda en formato ISO 4217. | |||
| vouchers/currencyId | Obligatorio | numeric | |
| vouchers/expirationDate | Opcional | datetime | |
| Fecha de caducidad del bono. | |||
| vouchers/pId | Opcional | string | |
| vouchers/user | Opcional | struct | |
| Bloque de información del usuario registrado al que se quiere vincular el cupón. | |||
| vouchers/user/id | Opcional | 0 | numeric |
| Identificador interno del usuario. Opcional en caso que se use identificador público. | |||
| vouchers/user/pId | Opcional | string | |
| Identificador público del usuario. Opcional en caso que se use identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"AVAILABLEBALANCE" : 23,
"CODE" :"S4FY6UHJ",
"CURRENCY" :"EUR",
"ID" : 234566,
"USER": {
"ID" : 123,
"PID" :"abc"
},
"expirationDate" :"2015-03-11"
}
DELETE /vouchers/{id}
Descripción
Elimina el cupón regalo indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/vouchers/1
Parámetros de entrada URL
| Variable | R/O | Valor por defecto | Tipo |
| id | Obligatorio | numeric | |
| Identificador interno. | |||
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 13456
}