---
title: "GET /api/v4.0/integrations/locks/{lockReference}"
method: GET
path: "/api/v4.0/integrations/locks/{lockReference}"
---

# GET /api/v4.0/integrations/locks/{lockReference}

`GET /api/v4.0/integrations/locks/{lockReference}`

This API gets the details of the provided {lockReference} in Gameball.

## Path parameters

- `lockReference` string, required

## Response `200`

Lock details retrieved successfully

- object
  - `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` Coupon[] — The coupon details that are associated with the provided lock reference.
    - `code` string — The generated coupon code that the customer will use.
    - `type` 'shipping' | 'fixed' | 'percentage' | 'product' | 'percentage-fees' | 'fixed-cashback' | 'percentage-cashback' — Type of the coupon, such as fixed amount, percentage discount, free shipping, cashback or product-specific coupon.
    - `value` number — The monetary value or percentage value of the coupon, depending on its type.
    - `usageLimit` number — The total number of times the coupon can be used across all customers.
    - `limitPerCustomer` number — The number of times a single customer can use the coupon.
    - `startDate` string, date-time — The date and time when the coupon becomes valid and can be used.
    - `expiryDate` string, date-time — The date and time when the coupon will expire and no longer be valid.
    - `capping` number — The maximum discount or value cap that the coupon can offer, even if the discount calculation exceeds this value.
    - `minReward` number — Specifies the minimum discount value a customer is guaranteed to receive when using a percentage-based discount coupon.
    - `minOrderValue` number — The minimum order value required for the coupon to be applied.
    - `entitledProductIds` string[] — A list of product IDs that are eligible for the coupon.
    - `entitledVariantIds` string[] — A list of product variant IDs that are eligible for the coupon.
    - `entitledCollectionIds` string[] — A list of collection IDs that are eligible for the coupon.
    - `entitledMerchantIds` string[] — A list of merchant external IDs that are eligible to redeem the coupon.
    - `combinesWith` object
      - `orderDiscounts` boolean — Indicates if the coupon can be combined with order-level discounts.
      - `productDiscounts` boolean — Indicates if the coupon can be combined with product-specific discounts.
      - `shippingDiscounts` boolean — Indicates if the coupon can be combined with shipping discounts.

## Changes

- **2026-01-04** `d41638533261` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/gameballers/apis/gameball-api/changes/api/v4.0/integrations/locks/:lockReference/get.md)

---

[API](https://skmtc.dev/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.dev/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gameballers/gameball-api/revisions/d41638533261/schema)