Issuances

GET 
/client/users/:correlation_id/issuances

Retrieve the list of issuances provided to member accounts. Currently, these issuances consist of vouchers only.

Query Parameters

You can add query parameters to provide query information at the end of the request URL and refine your search.

Key	Value	Default	Notes/Examples
from	Timestamp in epoch format, value is a variable: {{from}}	Current date	Ex.: /offers?from=1553544407000
to	Timestamp in epoch format, value is a variable: {{to}}	Expiry date	Ex: /offers?to=1663544407000
limit	Limit to number of results returned: value is a variable: {{limit}}	20	Ex: /offers?limit=20
until	Number of days	Current date	Ex.: /offers?from=1553544407000&until=10
locale	String	N/A	en-CA or fr-CA. Ex.: /offers?locale="en-CA"
maxResults	Maximum number of results returned	20	If the number > 100, then the API returns the first 100. Ex.: /offers?maxResults=5
type	Type of issuance	String	Currently "voucher" only
businessUnit	The BU with which the issuance is associated	String	Ex: /offers?businessUnit=BUYCO
from	Timestamp in epoch format	Number	N/A
status	Status of the issuance	Enum: "AVAILABLE", "REDEEMED", "EXPIRED"

Note: Mass offers do not show up from using this call.

Request

Body

This request does not have a body.

Response

Attribute	Definition	Format	Notes
accountID	Unique identifier of the account affected by the issuance.	String
metadataType	The type of metadata for this transaction.	String: "ISSUANCE"
issuanceType	The type of issuance.	String: "VOUCHER"	Currently, only "VOUCHER", values may be added in future.
businessUnit	The name of the business unit to which this issuance is relevant.	String
issuanceCode	A short description of the issuance.	String
issuedDate	The date of the issuance in ISO 8601 format.	String
issuedDateEpoch	The date of the issuance in epoch format.	Number	Date/time stamp in milliseconds
expiryDate	The date the issuance expires in ISO 8601 format.	String
expiryDateEpoch	The date the issuance expires in epoch format.	Number	Date/time stamp in milliseconds
redemptionDate	The date the issuance was redeemedin ISO 8601 format.	String
redemptionDateEpoch	The date the issuance was redeemed in epoch format.	Number	Date/time stamp in milliseconds
status	The current status of the issuance.	Enum: "AVAILABLE", "EXPIRED", "REDEEMED"
rewardType	The type of reward used for the issuance.	Enum: "POINTS", "DOLLARS"
rewardValue	The numeric value of the issuance.	Number
extendedData	Additional data related to the issuance.	Object
notes	Additional information about the issuance in very short form.	String	Only alphanumeric characters and symbols symbols allowed, 3-128 characters

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	from value must be within last 1 year from today's date	INVALID_REQUEST	from value must be within the last 1 year from today's date

Request

Responses

200

200 - All Issuances Returned

Response Headers

Date
Example: Thu, 21 May 2020 03:56:11 GMT
Content-Length
Example: 2926
Connection
Example: keep-alive
x-amzn-RequestId
Example: 49af928e-a4e9-4df9-a28b-999dabe09acb
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
x-amz-apigw-id
Example: M3RKMGktIAMF2Fg=
cache-control
Example: no-cache, no-store, must-revalidate
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-5ec5fbda-abbf0c0c0dbf6ef1550673b7;Sampled=0

400

400 - Invalid Status Param

Response Headers

Date
Example: Wed, 15 Feb 2023 18:47:17 GMT
Content-Length
Example: 116
Connection
Example: keep-alive
x-amzn-RequestId
Example: 44ee719b-184d-49d5-892a-a0a888a24ec4
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
MCK-APPID
Example: ES-CB-V1
MCK-MSGID
Example: mck-970cbdb5-164e-4609-aba9-5f884c5ed670
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000; includeSubDomains; preload
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
MCK-MSGTIMESTAMP
Example: February 15th 2023, 6:47:17
x-amz-apigw-id
Example: AZNMXHHSIAMFQoQ=
cache-control
Example: no-cache, no-store, must-revalidate
MCK_CORRELATIONID
Example: CORRELATION_ID_NOT_PROVIDED_IN_REQUEST
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-63ed28b5-7a2281957a263a1c2d5c0466;Sampled=0