Skip to main content
GET
/
api
/
v4.0
/
integrations
/
coupons
/
{lockReference}
cURL
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/coupons/{lockReference} \
  --header 'apikey: <api-key>'
{
  "lockReference": "<string>",
  "customerId": "<string>",
  "lockedCoupons": [
    {
      "code": "<string>",
      "lockedAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Lock Details

This API retrieves details of locked coupons using the lock reference. This is useful for checking the status and details of coupons that have been previously locked for a customer.

Path Parameters

lockReference
string
required
Unique identifier for the locked coupons to retrieve details for.

Response

lockReference
string
The lock reference ID.
customerId
string
Customer ID associated with the locked coupons.
lockedCoupons
array
Array of locked coupon details.
lockedCoupons[].code
string
The locked coupon code.
lockedCoupons[].lockedAt
string
Timestamp when the coupon was locked.
lockedCoupons[].expiresAt
string
Timestamp when the lock expires.

Authorizations

apikey
string
header
required

Path Parameters

lockReference
string
required

Response

200 - application/json

Lock details retrieved successfully

lockReference
string
customerId
string
lockedCoupons
object[]