Nessa área encontraremos os métodos disponibilizados na plataforma CORE para haver a gestão de vales-compra por sistemas externos onde poderá realizar a criação de vale, gestão de saldo, captura, exclusão de vale compras.

Url de acesso: /v1/Profile/API.svc/web/

Criar/Atualizar Vale Compras

SaveGiftCertificate

/v1/Profile/API.svc/web/SaveGiftCertificate

Parâmetros de entrada Tipo Descrição
GiftCertificateID GUID Identificação do vale-compra
CustomerID Int Identificação do cliente
Amount Decimal Valor do vale
ExpirationDate Data Data de expiração do vale compras. Padrão timestamp
IsActive Bool  
WebSiteID Int Canal
WebSiteGroupID Int Grupo de canais
Email String Email do cliente 
{
  "GiftCertificateID": "string",
  "CustomerID": 0,
  "Amount": 0,
  "ExpirationDate": "/Date(1540868400000)/",
  "IsActive": true,
  "WebSiteID": 0,
  "WebSiteGroupID": 0,
  "Email": "string"
}

Atualização: O parâmetro GiftCertificateID deve ser informado somente em caso de atualização de um vale já existente, caso contrário esse parâmetro não é informado na Request. Além disso, passamos ou WebSiteID ou WebSiteGroupID para criação ou edição do vale. Não é possível atualizar o valor do vale-compra.

Consultar Vale

GetGiftCertificate

/v1/Profile/API.svc/web/GetGiftCertificate

Método usado para buscar um registro de um determinado vale-compra.

Parâmetro de entrada Tipo Descrição
GUID GUID  

Request:

23584153-767c-4c30-ac94-c44de809a7f1

Response

{
  "Amount": 490,
  "AmountClaimed": 0,
  "Code": "680997AB-D",
  "CustomerID": 252515,
  "Email": "[email protected]",
  "ExpirationDate": null,
  "GiftCertificateID": "23584153-767c-4c30-ac94-c44de809a7f1",
  "IsActive": true,
  "WebSiteGroupID": 1,
  "WebSiteID": null
}
Parâmetros de saída Tipo Descrição
Amout Int Saldo
AmountClaimed   Saldo Utilizado
Code String  
CustomerID Int Identificação do cliente
Email String E-mail do cliente
ExpirationDate    
GiftCertificateID GUID  
IsActive Bool  
WebSiteGroupID String Grupo de Canais
WebSiteID String Canal

Consultar Vale-Compra

SearchGiftCertificate

/v1/Profile/API.svc/web/SearchGiftCertificate

Parâmetros de entrada Tipo Descrição
PageIndex Int Página a ser buscada, o padrão é 0 (zero)
PageSize Int Quantidade por página
Where String Parâmetro da Busca.
OrderBy String Ordenação da busca 
{
  "Page": {
    "PageIndex": 0,
    "PageSize": 0
  },
  "Where": "String",
  "OrderBy": "String"
}

A busca no parâmetro Where pode ser por CustomerID, E-mail, por exemplo:

"Where": "Email == “[email protected]”

Response Exemplo

{
  "Errors": [],
  "IsValid": true,
  "Page": {
    "ErrorMessage": null,
    "Index": 0,
    "PageCount": 0,
    "PageSize": 10,
    "RecordCount": 4
  },
  "Result": [
    {
      "Amount": 20,
      "AmountClaimed": 0,
      "Code": "F3DF4D39-E",
      "CustomerID": 252493,
      "Email": "[email protected]",
      "ExpirationDate": null,
      "GiftCertificateID": "ce6fdf39-9eb1-496b-abeb-5c5d6ffcec88",
      "IsActive": true,
      "WebSiteGroupID": null,
      "WebSiteID": null
    },
    {
      "Amount": 50,
      "AmountClaimed": 0,
      "Code": "012D4AEA-8",
      "CustomerID": 252493,
      "Email": "[email protected]",
      "ExpirationDate": "/Date(1516932000000-0200)/",
      "GiftCertificateID": "7db0539d-c942-45cf-9623-f8673f4ce85b",
      "IsActive": true,
      "WebSiteGroupID": 1,
      "WebSiteID": null
    }
  ]
}

Capturar

CaptureGiftCertificate

/v1/Profile/API.svc/web/CaptureGiftCertificate

Método usado para consumir um determinado valor do saldo de vale-compra de um cliente.

Parâmetros de entrada Tipo Descrição
CustomerID Int identificação do cliente
DocumentNumber String CPF do cliente
IntegrationID String  
Email String E-mail do cliente
GiftCertificateAmount Int Valor a ser descontado do vale
WebSiteID Int Canais
WebSiteGroupID Int grupo de canais 
{
  "CustomerID": 0,
  "DocumentNumber": "string",
  "IntegrationID": "string",
  "Email": "string",
  "GiftCertificateAmount": 0,
  "WebSiteID": 0,
  "WebSiteGroupID": 0
}

Balance

GetGiftCertificateBalance

/v1/Profile/API.svc/web/GetGiftCertificateBalance

Parâmetros de entrada Tipo Descrição
CustomerID Int Código do cliente.
DocumentNumber String CPF do Cliente
IntegrationID String  
Email String E-mail do cliente 
{
  "CustomerID": 0,
  "DocumentNumber": "string",
  "IntegrationID": "string",
  "Email": "string"
}

Nesse caso não se faz necessário informar todos os parâmetros, e sim, somente um deles para buscar a informação.

Delete

DeleteGiftCertificate

/v1/Profile/API.svc/web/DeleteGiftCertificate

07a4dc7d-50c6-4875-980f-4ab946e0b936
Parâmetros de entrada Tipo Descrição
GUID GUID  
  • Sem rótulos