Skip to main content

PosoffersService

A list of all methods in the PosoffersService service. Click on the method name to view detailed information about that method.

MethodsDescription
PosOfferGetAllPosOffersByKeyAsyncGet all POS offers for a contact. Expired, redeemed and available. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.
PosOfferGetAvailablePosOffersByKeyAsyncGet all available POS offers for a contact. Expired and redeemed offers are excluded. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.
PosOfferGetAllPosOffersByContactTypeAndKeyAsyncGet all POS offers for a contact. Expired, redeemed and available. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.
PosOfferGetAvailablePosOffersByContactTypeAndKeyAsyncGet all available POS offers for a contact. Expired and redeemed offers are excluded. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.
PosOfferGetAllPosOffersForContactAsyncGet all POS offers for a contact. Expired, redeemed and available. The result can be paginated, using the offset and count query parameters. Note: expiresOn is obsolete and is always null
PosOfferGetAvailablePosOffersForContactAsyncGet all available POS offers for a contact. Expired and redeemed offers are excluded. The result can be paginated, using the offset and count query parameters.
PosOfferRedeemAsyncRedeems a POS offer for a Contact using the internal Contact Id
PosOfferRedeemByKeyAsyncRedeems a POS offer for a Contact using the key for the contact type Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.
PosOfferRedeemByContactTypeAndKeyAsyncRedeems a POS offer for a Contact using the key for the contact type Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

PosOfferGetAllPosOffersByKeyAsync

Get all POS offers for a contact. Expired, redeemed and available. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

  • HTTP Method: GET
  • Endpoint: /api/v2/contacts/bykey/{keyValue}/posoffers/all

Parameters

NameTypeRequiredDescription
keyValuestringKey value, e.g. ssn, externalId, memberNumber, phone number etc.

Return Type

PagedResultOfAllLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferGetAllPosOffersByKeyAsync("keyValue");

Console.WriteLine(response);

PosOfferGetAvailablePosOffersByKeyAsync

Get all available POS offers for a contact. Expired and redeemed offers are excluded. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

  • HTTP Method: GET
  • Endpoint: /api/v2/contacts/bykey/{keyValue}/posoffers/available

Parameters

NameTypeRequiredDescription
keyValuestringKey value, e.g. ssn, externalId, memberNumber, phone number etc.

Return Type

PagedResultOfAvailableLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferGetAvailablePosOffersByKeyAsync("keyValue");

Console.WriteLine(response);

PosOfferGetAllPosOffersByContactTypeAndKeyAsync

Get all POS offers for a contact. Expired, redeemed and available. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

  • HTTP Method: GET
  • Endpoint: /api/v2/contacts/{contactType}/bykey/{keyValue}/posoffers/all

Parameters

NameTypeRequiredDescription
keyValuestringKey value, e.g. ssn, externalId, memberNumber, phone number etc.
contactTypestringContact type, e.g. "member".

Return Type

PagedResultOfAllLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferGetAllPosOffersByContactTypeAndKeyAsync("keyValue", "contactType");

Console.WriteLine(response);

PosOfferGetAvailablePosOffersByContactTypeAndKeyAsync

Get all available POS offers for a contact. Expired and redeemed offers are excluded. Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

  • HTTP Method: GET
  • Endpoint: /api/v2/contacts/{contactType}/bykey/{keyValue}/posoffers/available

Parameters

NameTypeRequiredDescription
keyValuestringKey value, e.g. ssn, externalId, memberNumber, phone number etc.
contactTypestringContact type, e.g. "member".

Return Type

PagedResultOfAvailableLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferGetAvailablePosOffersByContactTypeAndKeyAsync("keyValue", "contactType");

Console.WriteLine(response);

PosOfferGetAllPosOffersForContactAsync

Get all POS offers for a contact. Expired, redeemed and available. The result can be paginated, using the offset and count query parameters. Note: expiresOn is obsolete and is always null

  • HTTP Method: GET
  • Endpoint: /api/v2/contacts/{contactId}/posoffers/all

Parameters

NameTypeRequiredDescription
contactIdstringContact identifier (GUID).
offsetlongThe first item to retrieve. (Default value 0)
countlongThe max number of items to retrieve. (Default value 100)

Return Type

PagedResultOfAllLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferGetAllPosOffersForContactAsync("contactId", 2, 7);

Console.WriteLine(response);

PosOfferGetAvailablePosOffersForContactAsync

Get all available POS offers for a contact. Expired and redeemed offers are excluded. The result can be paginated, using the offset and count query parameters.

  • HTTP Method: GET
  • Endpoint: /api/v2/contacts/{contactId}/posoffers/available

Parameters

NameTypeRequiredDescription
contactIdstringContact identifier (GUID).
offsetlongThe first item to retrieve. (Default value 0)
countlongThe max number of items to retrieve. (Default value 100)

Return Type

PagedResultOfAvailableLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferGetAvailablePosOffersForContactAsync("contactId", 3, 0);

Console.WriteLine(response);

PosOfferRedeemAsync

Redeems a POS offer for a Contact using the internal Contact Id

  • HTTP Method: POST
  • Endpoint: /api/v2/contacts/{contactId}/posoffers/{id}/redeem

Parameters

NameTypeRequiredDescription
idstringThe id returned from the get operation (GUID)
contactIdstringContact identifier (GUID).

Return Type

RedeemedLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferRedeemAsync("id", "contactId");

Console.WriteLine(response);

PosOfferRedeemByKeyAsync

Redeems a POS offer for a Contact using the key for the contact type Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

  • HTTP Method: POST
  • Endpoint: /api/v2/contacts/bykey/{keyValue}/posoffers/{id}/redeem

Parameters

NameTypeRequiredDescription
idstringThe id returned from the get operation (GUID)
keyValuestringKey value, e.g. ssn, externalId, memberNumber, phone number etc.

Return Type

RedeemedLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferRedeemByKeyAsync("id", "keyValue");

Console.WriteLine(response);

PosOfferRedeemByContactTypeAndKeyAsync

Redeems a POS offer for a Contact using the key for the contact type Finds the contact by using a key value other than Contact Id. This can only be used for contact types with exactly ONE key. The contact key attribute is configured for each Voyado instance.

  • HTTP Method: POST
  • Endpoint: /api/v2/contacts/{contactType}/bykey/{keyValue}/posoffers/{id}/redeem

Parameters

NameTypeRequiredDescription
idstringThe id returned from the get operation (GUID)
keyValuestringKey value, e.g. ssn, externalId, memberNumber, phone number etc.
contactTypestringContact type, e.g. "member" or "contact".

Return Type

RedeemedLoyaltyBarClaimModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Posoffers.PosOfferRedeemByContactTypeAndKeyAsync("id", "keyValue", "contactType");

Console.WriteLine(response);

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →