Skip to main content
GET
/
api
/
v4.0
/
integrations
/
locks
/
{lockReference}
cURL
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/locks/{lockReference} \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "customerId": "<string>",
  "isUsed": true,
  "usedAt": "2023-11-07T05:31:56Z",
  "isExpired": true,
  "expiredAt": "2023-11-07T05:31:56Z",
  "coupons": [
    {
      "code": "<string>",
      "type": "shipping",
      "value": 123,
      "usageLimit": 123,
      "limitPerCustomer": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "expiryDate": "2023-11-07T05:31:56Z",
      "capping": 123,
      "minReward": 123,
      "minOrderValue": 123,
      "entitledProductIds": [
        "<string>"
      ],
      "entitledVariantIds": [
        "<string>"
      ],
      "entitledCollectionIds": [
        "<string>"
      ],
      "entitledMerchantIds": [
        "<string>"
      ],
      "combinesWith": {
        "orderDiscounts": true,
        "productDiscounts": true,
        "shippingDiscounts": true
      }
    }
  ]
}
This API gets the details of the provided {lockReference} in Gameball.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

Path Parameters

​
lockReference
string
required

The lock reference identifier to get its details.

Response

200 - application/json

Lock details retrieved successfully

​
customerId
string

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

​
isUsed
boolean

Indicates whether the provided lock is marked as used or not by the customer.

​
usedAt
string<date-time>

The date and time when the provided lock was marked as used.

​
isExpired
boolean

Indicates whether the provided lock is marked as expired or not.

​
expiredAt
string<date-time>

The date and time when the provided lock was marked as expired.

​
coupons
object[]

The coupon details that are associated with the provided lock reference.