# Models

## The Activity-activity.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Activity-activity.read":{"type":"object","description":"An activity is an event that has happened to a contact, such as a booking, purchase, or interaction. Activities track the history of a contact and can trigger automations or workflows. Each activity is associated with a contact and has a type, source, and date. Some activities may also have a booking, order, or gift card associated with them.","properties":{"id":{"readOnly":true,"type":"integer"},"contact":{"type":"integer"},"happenedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Booking","Checked in","Checked out","Purchase","Shopify order","Golf reservation","Table reservation","Gift card registered","Added gift card to Apple Wallet","Viewed partner offer","Clicked partner offer link","Added partner offer to Apple wallet","Added partner offer to Google wallet","Membership started","Changed tier","Membership cancelled","Added membership card to Apple Wallet","Login","Connected to wifi","Contact merged in","Referral invite created","Referral invite completed"]},"source":{"type":"string"},"booking":{"anyOf":[{"$ref":"#/components/schemas/Booking-activity.read"},{"type":"null"}]},"externalReference":{"type":["string","null"]},"purchase":{"type":["string","null"],"format":"iri-reference"},"spend":{"description":"The amount of money spent, in the smallest currency unit. For example 100 would be equal to £1.00.","default":0,"type":"integer"},"giftCard":{"type":["string","null"],"format":"iri-reference"},"currencyCode":{"type":["string","null"]},"referralInvite":{"type":["string","null"],"format":"iri-reference"},"golfReservation":{"anyOf":[{"$ref":"#/components/schemas/Golf.reservation-activity.read"},{"type":"null"}]},"tableReservation":{"anyOf":[{"$ref":"#/components/schemas/Table.reservation-activity.read"},{"type":"null"}]}}},"Booking-activity.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}},"Golf.reservation-activity.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"holes":{"type":"integer"},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"origin":{"description":"The source of the golf reservation, e.g. the booking system or channel through which it was made.","type":"string"},"originReference":{"description":"The ID or reference in the origin platform of the golf reservation, e.g. the booking system or channel reference.","default":"","type":"string"},"customerBookingReference":{"description":"The reference given to the customer for the golf reservation.","default":"","type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"courseId":{"default":"","type":"string"},"courseName":{"default":"","type":"string"}}},"Table.reservation-activity.read":{"type":"object","description":"Represents a dining reservation made by a contact with details about the reservation, such as the party size, status, and any notes.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"notes":{"type":"string"},"partySize":{"type":"integer"},"status":{"type":"string"},"origin":{"type":"string"},"originReference":{"type":"string"},"customerBookingReference":{"type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"}}}}}}
```

## The Activity-activity.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Activity-activity.write":{"type":"object","description":"An activity is an event that has happened to a contact, such as a booking, purchase, or interaction. Activities track the history of a contact and can trigger automations or workflows. Each activity is associated with a contact and has a type, source, and date. Some activities may also have a booking, order, or gift card associated with them.","properties":{"id":{"readOnly":true,"type":"integer"},"contact":{"type":"integer"},"happenedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Booking","Checked in","Checked out","Purchase","Shopify order","Golf reservation","Table reservation","Gift card registered","Added gift card to Apple Wallet","Viewed partner offer","Clicked partner offer link","Added partner offer to Apple wallet","Added partner offer to Google wallet","Membership started","Changed tier","Membership cancelled","Added membership card to Apple Wallet","Login","Connected to wifi","Contact merged in","Referral invite created","Referral invite completed"]},"source":{"type":"string"},"booking":{"anyOf":[{"$ref":"#/components/schemas/Booking-activity.write"},{"type":"null"}]},"externalReference":{"type":["string","null"]},"purchase":{"type":["string","null"],"format":"iri-reference"},"spend":{"description":"The amount of money spent, in the smallest currency unit. For example 100 would be equal to £1.00.","default":0,"type":"integer"},"giftCard":{"type":["string","null"],"format":"iri-reference"},"currencyCode":{"type":["string","null"]},"referralInvite":{"type":["string","null"],"format":"iri-reference"},"golfReservation":{"anyOf":[{"$ref":"#/components/schemas/Golf.reservation-activity.write"},{"type":"null"}]},"tableReservation":{"anyOf":[{"$ref":"#/components/schemas/Table.reservation-activity.write"},{"type":"null"}]}}},"Booking-activity.write":{"type":"object","description":"A booking, sometimes called a reservation, is a stay associated with a contact.","properties":{"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}},"Golf.reservation-activity.write":{"type":"object","properties":{"holes":{"type":"integer"},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"origin":{"description":"The source of the golf reservation, e.g. the booking system or channel through which it was made.","type":"string"},"originReference":{"description":"The ID or reference in the origin platform of the golf reservation, e.g. the booking system or channel reference.","default":"","type":"string"},"customerBookingReference":{"description":"The reference given to the customer for the golf reservation.","default":"","type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"courseId":{"default":"","type":"string"},"courseName":{"default":"","type":"string"}}},"Table.reservation-activity.write":{"type":"object","description":"Represents a dining reservation made by a contact with details about the reservation, such as the party size, status, and any notes.","properties":{"notes":{"type":"string"},"partySize":{"type":"integer"},"status":{"type":"string"},"origin":{"type":"string"},"originReference":{"type":"string"},"customerBookingReference":{"type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"}}}}}}
```

## The Activity-activity.write.jsonMergePatch object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Activity-activity.write.jsonMergePatch":{"type":"object","description":"An activity is an event that has happened to a contact, such as a booking, purchase, or interaction. Activities track the history of a contact and can trigger automations or workflows. Each activity is associated with a contact and has a type, source, and date. Some activities may also have a booking, order, or gift card associated with them.","properties":{"id":{"readOnly":true,"type":"integer"},"contact":{"type":"integer"},"happenedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Booking","Checked in","Checked out","Purchase","Shopify order","Golf reservation","Table reservation","Gift card registered","Added gift card to Apple Wallet","Viewed partner offer","Clicked partner offer link","Added partner offer to Apple wallet","Added partner offer to Google wallet","Membership started","Changed tier","Membership cancelled","Added membership card to Apple Wallet","Login","Connected to wifi","Contact merged in","Referral invite created","Referral invite completed"]},"source":{"type":"string"},"booking":{"anyOf":[{"$ref":"#/components/schemas/Booking-activity.write"},{"type":"null"}]},"externalReference":{"type":["string","null"]},"purchase":{"type":["string","null"],"format":"iri-reference"},"spend":{"description":"The amount of money spent, in the smallest currency unit. For example 100 would be equal to £1.00.","default":0,"type":"integer"},"giftCard":{"type":["string","null"],"format":"iri-reference"},"currencyCode":{"type":["string","null"]},"referralInvite":{"type":["string","null"],"format":"iri-reference"},"golfReservation":{"anyOf":[{"$ref":"#/components/schemas/Golf.reservation-activity.write"},{"type":"null"}]},"tableReservation":{"anyOf":[{"$ref":"#/components/schemas/Table.reservation-activity.write"},{"type":"null"}]}}},"Booking-activity.write":{"type":"object","description":"A booking, sometimes called a reservation, is a stay associated with a contact.","properties":{"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}},"Golf.reservation-activity.write":{"type":"object","properties":{"holes":{"type":"integer"},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"origin":{"description":"The source of the golf reservation, e.g. the booking system or channel through which it was made.","type":"string"},"originReference":{"description":"The ID or reference in the origin platform of the golf reservation, e.g. the booking system or channel reference.","default":"","type":"string"},"customerBookingReference":{"description":"The reference given to the customer for the golf reservation.","default":"","type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"courseId":{"default":"","type":"string"},"courseName":{"default":"","type":"string"}}},"Table.reservation-activity.write":{"type":"object","description":"Represents a dining reservation made by a contact with details about the reservation, such as the party size, status, and any notes.","properties":{"notes":{"type":"string"},"partySize":{"type":"integer"},"status":{"type":"string"},"origin":{"type":"string"},"originReference":{"type":"string"},"customerBookingReference":{"type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"}}}}}}
```

## The Balance-balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Balance-balance.read":{"type":"object","description":"A balance represents an individual change to the overall balance of a stored credit account, similar to a line on your bank statement.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Activation","Adjustment","Expired","Redeemed","Unredeemed","Refunded","Refund failed","Chargeback","Chargeback reversed","Reactivation","Topup"]},"amount":{"type":"integer"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location-balance.read"},{"type":"null"}]},"happenedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"reversed":{"anyOf":[{"$ref":"#/components/schemas/Balance-balance.read"},{"type":"null"}]},"mewsPayment":{"anyOf":[{"$ref":"#/components/schemas/MewsPayment-balance.read"},{"type":"null"}]},"storedCreditAccount":{"type":"integer"}}},"Location-balance.read":{"type":"object"},"MewsPayment-balance.read":{"type":"object"}}}}
```

## The Balance-giftcard.read\_balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Balance-giftcard.read_balance.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Activation","Adjustment","Expired","Redeemed","Unredeemed","Refunded","Refund failed","Chargeback","Chargeback reversed","Reactivation","Topup"]},"amount":{"type":"integer"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location-giftcard.read_balance.read"},{"type":"null"}]},"happenedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"reversed":{"anyOf":[{"$ref":"#/components/schemas/Balance-giftcard.read_balance.read"},{"type":"null"}]},"mewsPayment":{"anyOf":[{"$ref":"#/components/schemas/MewsPayment-giftcard.read_balance.read"},{"type":"null"}]},"storedCreditAccount":{"type":"integer"}}},"Location-giftcard.read_balance.read":{"type":"object"},"MewsPayment-giftcard.read_balance.read":{"type":"object"}}}}
```

## The Booking-activity.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Booking-activity.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}}}}}
```

## The Booking-activity.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Booking-activity.write":{"type":"object","description":"A booking, sometimes called a reservation, is a stay associated with a contact.","properties":{"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}}}}}
```

## The Booking-booking.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Booking-booking.read":{"type":"object","description":"A booking, sometimes called a reservation, is a stay associated with a contact.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}}}}}
```

## The Booking-booking.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Booking-booking.write":{"type":"object","description":"A booking, sometimes called a reservation, is a stay associated with a contact.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"checkIn":{"type":"string","format":"date-time"},"checkOut":{"type":"string","format":"date-time"},"numberOfGuests":{"type":"integer"},"roomType":{"type":["string","null"]},"roomName":{"type":["string","null"]},"externalReference":{"type":["string","null"]},"total":{"type":"integer"},"currencyCode":{"type":"string"},"customerReference":{"type":"string"},"purpose":{"type":"string"},"channelNumber":{"type":["string","null"]},"origin":{"type":"string"},"direct":{"default":false,"type":"boolean"},"status":{"type":"string","enum":["Inquired","Confirmed","Started","Processed","Canceled","Optional","Requested"]}}}}}}
```

## The Bundle-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Bundle-product.read":{"type":"object"}}}}
```

## The Code-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Code-product.read":{"type":"object"}}}}
```

## The ConstraintViolation object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}}}
```

## The ConstraintViolation.jsonld object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ConstraintViolation.jsonld":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}}}}
```

## The Contact-contact.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Contact-contact.read":{"type":"object","description":"A contact represents a person or organisation that interacts with the system. Contacts can have multiple associated addresses, payment methods, and activities. Contacts are used to track interactions, purchases, and other activities within the system.","properties":{"id":{"readOnly":true,"type":"integer"},"emailAddress":{"format":"email","type":["string","null"]},"dob":{"type":["string","null"],"format":"date-time"},"phoneNumber":{"type":["string","null"]},"organisation":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"referralInvites":{"type":"array","items":{"type":"integer"}},"firstName":{"default":"","type":"string"},"lastName":{"default":"","type":"string"},"name":{"default":"","type":"string"},"phoneNumberCountryCode":{"type":["string","null"]},"timezone":{"default":"Europe/London","type":"string"},"totalSpend":{"default":0,"type":"integer"},"recency":{"type":["integer","null"]},"frequency":{"type":["integer","null"]},"monetary":{"type":["integer","null"]},"lastInteractedAt":{"type":"string","format":"date-time"},"customFieldValues":{"type":"array","items":{"$ref":"#/components/schemas/ContactCustomFieldValue-contact.read"}},"totalOrders":{"default":0,"type":"integer"},"redactedAt":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag-contact.read"},"readOnly":true}}},"ContactCustomFieldValue-contact.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"customFieldDefinition":{"type":"integer"},"value":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"displayValue":{"readOnly":true,"description":"Get display value for UI presentation.","type":["string","null"]}}},"Tag-contact.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"},"systemDefined":{"default":false,"type":"boolean"}},"required":["name"]}}}}
```

## The Contact-contact.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Contact-contact.write":{"type":"object","description":"A contact represents a person or organisation that interacts with the system. Contacts can have multiple associated addresses, payment methods, and activities. Contacts are used to track interactions, purchases, and other activities within the system.","properties":{"id":{"readOnly":true,"type":"integer"},"emailAddress":{"format":"email","type":["string","null"]},"dob":{"type":["string","null"],"format":"date-time"},"phoneNumber":{"type":["string","null"]},"organisation":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"firstName":{"default":"","type":"string"},"lastName":{"default":"","type":"string"},"name":{"default":"","type":"string"},"phoneNumberCountryCode":{"type":["string","null"]},"timezone":{"default":"Europe/London","type":"string"},"totalSpend":{"default":0,"type":"integer"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag-contact.write"}},"recency":{"type":["integer","null"]},"frequency":{"type":["integer","null"]},"monetary":{"type":["integer","null"]},"lastInteractedAt":{"type":"string","format":"date-time"},"customFieldValues":{"type":"array","items":{"$ref":"#/components/schemas/ContactCustomFieldValue-contact.write"}},"totalOrders":{"default":0,"type":"integer"},"redactedAt":{"type":["string","null"],"format":"date-time"}}},"ContactTag-contact.write":{"type":"object"},"ContactCustomFieldValue-contact.write":{"type":"object","properties":{"value":{"type":["string","null"]}}}}}}
```

## The ContactAddress-order.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ContactAddress-order.read":{"type":"object"}}}}
```

## The ContactCustomFieldValue-contact.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ContactCustomFieldValue-contact.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"customFieldDefinition":{"type":"integer"},"value":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"displayValue":{"readOnly":true,"description":"Get display value for UI presentation.","type":["string","null"]}}}}}}
```

## The ContactCustomFieldValue-contact.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ContactCustomFieldValue-contact.write":{"type":"object","properties":{"value":{"type":["string","null"]}}}}}}
```

## The ContactPaymentMethod-contact\_payment\_method.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ContactPaymentMethod-contact_payment_method.read":{"type":"object","description":"Represents a payment method associated with a contact.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gateway":{"type":"string"},"type":{"type":"string","enum":["card","bacs_debit","sepa_debit","stripe_link"]},"cardBrand":{"type":["string","null"]},"cardLast4":{"type":["string","null"]},"cardExpMonth":{"type":["integer","null"]},"cardExpYear":{"type":["integer","null"]},"gatewayId":{"type":"string"},"bacsLast4":{"type":["string","null"]},"bacsSortCode":{"type":["string","null"]},"first":{"default":false,"type":"boolean"},"bankName":{"default":"","type":"string"},"status":{"type":"string","enum":["Active","Deleted","Pending","Failed","Expired","Cancelled"]}}}}}}
```

## The ContactTag-contact.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ContactTag-contact.write":{"type":"object"}}}}
```

## The DeliveryMethodZoneRate-line.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"DeliveryMethodZoneRate-line.read":{"type":"object"}}}}
```

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["number","null"],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}}}}}
```

## The Error.jsonld object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Error.jsonld":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["number","null"],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}}}}
```

## The Gift.card-giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Gift.card-giftcard.read":{"type":"object","description":"A gift card is identified by its unique code, and has a balance that can be redeemed depending on the status. It may have terms and conditions that apply to its use.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"contact":{"description":"An optional contact that the gift card is registered to.","type":["string","null"],"format":"iri-reference"},"status":{"type":"string","enum":["Chargeback","Expired","Fraudulent","Not yet valid","Partially redeemed","Redeemed","Refunded","Valid","Grace period"]},"expiresAt":{"type":["string","null"],"format":"date-time"},"gracePeriodExpiresAt":{"type":["string","null"],"format":"date-time"},"validFrom":{"type":"string","format":"date-time"},"partiallyRedeemable":{"default":true,"type":"boolean"},"name":{"type":"string"},"topupable":{"default":false,"type":"boolean"},"terms":{"default":"","type":"string"},"selectedOptions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardSelectedOption-giftcard.read"}},"recipientDescription":{"default":"","type":"string"},"usingRecipientDescription":{"default":false,"type":"boolean"},"description":{"default":"","type":"string"},"personalMessage":{"default":"","type":["string","null"]},"class":{"type":"string","enum":["Standard","Monetary","Configurable"]},"redeemInstructions":{"default":"","type":["string","null"]},"lastRedeemedAt":{"type":["string","null"],"format":"date-time"},"purchaserName":{"default":"","type":"string"},"deliveryName":{"default":"","type":"string"},"latestEmailDeliveryStatus":{"type":["string","null"],"enum":["Processed","Dropped","Delivered","Deferred","Bounced","Blocked","Opened","Clicked","Reported as spam","Unsubscribed","Group unsubscribed","Group resubscribed",null]},"additionalLocations":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardLocation-giftcard.read"}}}},"GiftCardSelectedOption-giftcard.read":{"type":"object"},"GiftCardLocation-giftcard.read":{"type":"object"}}}}
```

## The Gift.card-storedcreditaccount.read\_giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Gift.card-storedcreditaccount.read_giftcard.read":{"type":"object","description":"A gift card is identified by its unique code, and has a balance that can be redeemed depending on the status. It may have terms and conditions that apply to its use.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"contact":{"description":"An optional contact that the gift card is registered to.","type":["string","null"],"format":"iri-reference"},"status":{"type":"string","enum":["Chargeback","Expired","Fraudulent","Not yet valid","Partially redeemed","Redeemed","Refunded","Valid","Grace period"]},"expiresAt":{"type":["string","null"],"format":"date-time"},"gracePeriodExpiresAt":{"type":["string","null"],"format":"date-time"},"validFrom":{"type":"string","format":"date-time"},"partiallyRedeemable":{"default":true,"type":"boolean"},"name":{"type":"string"},"topupable":{"default":false,"type":"boolean"},"terms":{"default":"","type":"string"},"selectedOptions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardSelectedOption-storedcreditaccount.read_giftcard.read"}},"recipientDescription":{"default":"","type":"string"},"usingRecipientDescription":{"default":false,"type":"boolean"},"description":{"default":"","type":"string"},"personalMessage":{"default":"","type":["string","null"]},"class":{"type":"string","enum":["Standard","Monetary","Configurable"]},"redeemInstructions":{"default":"","type":["string","null"]},"lastRedeemedAt":{"type":["string","null"],"format":"date-time"},"purchaserName":{"default":"","type":"string"},"deliveryName":{"default":"","type":"string"},"latestEmailDeliveryStatus":{"type":["string","null"],"enum":["Processed","Dropped","Delivered","Deferred","Bounced","Blocked","Opened","Clicked","Reported as spam","Unsubscribed","Group unsubscribed","Group resubscribed",null]},"additionalLocations":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardLocation-storedcreditaccount.read_giftcard.read"}}}},"GiftCardSelectedOption-storedcreditaccount.read_giftcard.read":{"type":"object"},"GiftCardLocation-storedcreditaccount.read_giftcard.read":{"type":"object"}}}}
```

## The Gift.card.IssueGiftCardInput-giftcard.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Gift.card.IssueGiftCardInput-giftcard.write":{"type":"object","description":"A gift card is identified by its unique code, and has a balance that can be redeemed depending on the status. It may have terms and conditions that apply to its use.","properties":{"productVariantId":{"type":["integer","null"]},"storeId":{"type":"integer"},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"terms":{"type":["string","null"]},"contactId":{"type":["integer","null"]},"amount":{"minimum":0,"type":["integer","null"]},"personalMessage":{"type":["string","null"]},"currencyCode":{"minLength":3,"maxLength":3,"type":["string","null"]},"code":{"type":["string","null"]}},"required":["storeId"]}}}}
```

## The GiftCardLocation-giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"GiftCardLocation-giftcard.read":{"type":"object"}}}}
```

## The GiftCardLocation-storedcreditaccount.read\_giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"GiftCardLocation-storedcreditaccount.read_giftcard.read":{"type":"object"}}}}
```

## The GiftCardSelectedOption-giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"GiftCardSelectedOption-giftcard.read":{"type":"object"}}}}
```

## The GiftCardSelectedOption-storedcreditaccount.read\_giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"GiftCardSelectedOption-storedcreditaccount.read_giftcard.read":{"type":"object"}}}}
```

## The Golf.reservation object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Golf.reservation":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"holes":{"type":"integer"},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"activity":{"type":"integer"},"origin":{"description":"The source of the golf reservation, e.g. the booking system or channel through which it was made.","type":"string"},"originReference":{"description":"The ID or reference in the origin platform of the golf reservation, e.g. the booking system or channel reference.","default":"","type":"string"},"customerBookingReference":{"description":"The reference given to the customer for the golf reservation.","default":"","type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"courseId":{"default":"","type":"string"},"courseName":{"default":"","type":"string"}}}}}}
```

## The Golf.reservation-activity.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Golf.reservation-activity.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"holes":{"type":"integer"},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"origin":{"description":"The source of the golf reservation, e.g. the booking system or channel through which it was made.","type":"string"},"originReference":{"description":"The ID or reference in the origin platform of the golf reservation, e.g. the booking system or channel reference.","default":"","type":"string"},"customerBookingReference":{"description":"The reference given to the customer for the golf reservation.","default":"","type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"courseId":{"default":"","type":"string"},"courseName":{"default":"","type":"string"}}}}}}
```

## The Golf.reservation-activity.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Golf.reservation-activity.write":{"type":"object","properties":{"holes":{"type":"integer"},"status":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"origin":{"description":"The source of the golf reservation, e.g. the booking system or channel through which it was made.","type":"string"},"originReference":{"description":"The ID or reference in the origin platform of the golf reservation, e.g. the booking system or channel reference.","default":"","type":"string"},"customerBookingReference":{"description":"The reference given to the customer for the golf reservation.","default":"","type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"courseId":{"default":"","type":"string"},"courseName":{"default":"","type":"string"}}}}}}
```

## The Location-balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Location-balance.read":{"type":"object"}}}}
```

## The Location-giftcard.read\_balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Location-giftcard.read_balance.read":{"type":"object"}}}}
```

## The Location-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Location-product.read":{"type":"object"}}}}
```

## The Location-store.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Location-store.read":{"type":"object"}}}}
```

## The Member-read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Member-read":{"type":"object","description":"A member is a contact that has registered an account on the platform.","properties":{"type":{"default":"Individual","type":"string","enum":["Individual","Organization"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"contact":{"type":"integer"}}}}}}
```

## The MewsPayment-balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"MewsPayment-balance.read":{"type":"object"}}}}
```

## The MewsPayment-giftcard.read\_balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"MewsPayment-giftcard.read_balance.read":{"type":"object"}}}}
```

## The Order-order.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Order-order.read":{"type":"object","description":"An order is a purchase made by a customer, a purchase is made up of one or more lines and each line represents a gift card, product, or membership purchased by a customer.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"customerFirstName":{"default":"","type":["string","null"]},"customerLastName":{"default":"","type":["string","null"]},"customerName":{"default":"","type":["string","null"]},"currencyCode":{"type":"string"},"dispatchStatus":{"type":"string","enum":["Outstanding","Packed","Dispatched","Cancelled","Scheduled","Failed"]},"subtotal":{"type":"integer"},"total":{"type":"integer"},"deliveryAmount":{"type":"integer"},"deliveryMethodName":{"type":["string","null"]},"channel":{"type":"string"},"discountAmount":{"type":"integer"},"deliveryName":{"default":"","type":"string"},"deliveryAddressLine1":{"default":"","type":"string"},"deliveryAddressLine2":{"default":"","type":"string"},"deliveryAddressCity":{"default":"","type":"string"},"deliveryAddressCounty":{"default":"","type":"string"},"deliveryAddressPostcode":{"default":"","type":"string"},"deliveryAddressCountry":{"default":"","type":"string"},"billingAddressLine1":{"default":"","type":"string"},"billingAddressLine2":{"default":"","type":"string"},"billingAddressCity":{"default":"","type":"string"},"billingAddressCounty":{"default":"","type":"string"},"billingAddressPostcode":{"default":"","type":"string"},"billingAddressCountry":{"default":"","type":"string"},"phoneNumber":{"default":"","type":"string"},"billingContact":{"type":["string","null"],"format":"iri-reference"},"customerEmailAddress":{"default":"","type":"string"},"paymentStatus":{"type":"string","enum":["Pending","Completed","Refunded","Chargeback","Cancelled","Partially Refunded"]},"deliveryContact":{"type":["string","null"],"format":"iri-reference"},"billingContactAddress":{"anyOf":[{"$ref":"#/components/schemas/ContactAddress-order.read"},{"type":"null"}]},"deliveryContactAddress":{"anyOf":[{"$ref":"#/components/schemas/ContactAddress-order.read"},{"type":"null"}]},"uuid":{"type":"string","format":"uuid"},"emailToRecipient":{"type":"boolean"},"recipientEmailAddress":{"type":"string"},"scheduledDeliveryAt":{"type":["string","null"],"format":"date-time"},"discountCodes":{"type":"array","items":{"$ref":"#/components/schemas/OrderDiscountCode-order.read"}},"user":{"anyOf":[{"$ref":"#/components/schemas/User-order.read"},{"type":"null"}]},"paymentMethod":{"type":"string","enum":["Gateway","Offline","Complimentary","Free","Setup future payment"]},"offlinePaymentMethod":{"default":"","type":["string","null"]},"complimentaryReason":{"default":"","type":["string","null"]},"recipientFirstName":{"default":"","type":"string"},"recipientLastName":{"default":"","type":"string"},"gateway":{"type":"string"},"transaction":{"type":"integer"},"type":{"type":"string","enum":["Gift Card","Subscription"]},"deliveryMethodType":{"type":"string"},"processingFee":{"default":0,"type":"integer"},"userAgent":{"type":["string","null"]},"browserInfo":{"type":["string","null"]},"ipAddress":{"type":["string","null"]},"latestReceiptEmailDeliveryStatus":{"type":["string","null"],"enum":["Processed","Dropped","Delivered","Deferred","Bounced","Blocked","Opened","Clicked","Reported as spam","Unsubscribed","Group unsubscribed","Group resubscribed",null]}}},"ContactAddress-order.read":{"type":"object"},"OrderDiscountCode-order.read":{"type":"object"},"User-order.read":{"type":"object"}}}}
```

## The OrderDiscountCode-line.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrderDiscountCode-line.read":{"type":"object"}}}}
```

## The OrderDiscountCode-order.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrderDiscountCode-order.read":{"type":"object"}}}}
```

## The OrderLine-line.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrderLine-line.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"attachedOrder":{"type":"integer"},"variant":{"type":["string","null"],"format":"iri-reference"},"name":{"type":"string"},"type":{"type":"string"},"total":{"type":"integer"},"orderLineTypeVoucher":{"anyOf":[{"$ref":"#/components/schemas/OrderLineTypeVoucher-line.read"},{"type":"null"}]},"discount_amount":{"type":"integer"},"subtotal":{"type":"integer"},"taxTotal":{"default":0,"type":"integer"},"taxRate":{"type":["string","null"]},"refunded":{"default":false,"type":"boolean"},"description":{"default":"","type":"string"},"personalMessage":{"default":"","type":["string","null"]},"selectedOptions":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineSelectedOption-line.read"}},"discountCodes":{"type":"array","items":{"$ref":"#/components/schemas/OrderDiscountCode-line.read"}},"recurringProduct":{"anyOf":[{"$ref":"#/components/schemas/OrderLineTypeRecurringProduct-line.read"},{"type":"null"}]},"deliveryMethodZoneRate":{"anyOf":[{"$ref":"#/components/schemas/DeliveryMethodZoneRate-line.read"},{"type":"null"}]}}},"OrderLineTypeVoucher-line.read":{"type":"object"},"OrderLineSelectedOption-line.read":{"type":"object"},"OrderDiscountCode-line.read":{"type":"object"},"OrderLineTypeRecurringProduct-line.read":{"type":"object"},"DeliveryMethodZoneRate-line.read":{"type":"object"}}}}
```

## The OrderLineSelectedOption-line.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrderLineSelectedOption-line.read":{"type":"object"}}}}
```

## The OrderLineTypeRecurringProduct-line.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrderLineTypeRecurringProduct-line.read":{"type":"object"}}}}
```

## The OrderLineTypeVoucher-line.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrderLineTypeVoucher-line.read":{"type":"object"}}}}
```

## The Organisation-read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Organisation-read":{"type":"object","description":"The organisation is the top-level entity registered and using Glu.","properties":{"id":{"readOnly":true,"type":"integer"},"hashId":{"type":"string"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"status":{"default":"active","type":"string"}}}}}}
```

## The OrganisationPaymentGateway-store.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"OrganisationPaymentGateway-store.read":{"type":"object"}}}}
```

## The Payment-read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Payment-read":{"type":"object"}}}}
```

## The Product-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Product-product.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"uuid":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["Voucher","Physical","RecurringProduct","ReferralProgram"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"description":{"default":"","type":["string","null"]},"status":{"default":"Active","type":"string","enum":["Draft","Active","Scheduled","Expired","Deleted"]},"permalink":{"type":"string"},"images":{"type":"array","items":{"type":["string","null"]}},"store":{"type":"integer"},"productTypePhysical":{"anyOf":[{"$ref":"#/components/schemas/ProductTypePhysical-product.read"},{"type":"null"}]},"voucher":{"anyOf":[{"$ref":"#/components/schemas/Voucher-product.read"},{"type":"null"}]},"referralProgram":{"type":["string","null"],"format":"iri-reference"},"productConfigurableOptions":{"type":"array","items":{"$ref":"#/components/schemas/ProductConfigurableOption-product.read"}},"PriceSuffix":{"default":"","type":"string"},"bundle":{"anyOf":[{"$ref":"#/components/schemas/Bundle-product.read"},{"type":"null"}]},"scheduledFrom":{"type":["string","null"],"format":"date-time"},"scheduledTo":{"type":["string","null"],"format":"date-time"},"codes":{"type":"array","items":{"$ref":"#/components/schemas/Code-product.read"}},"variants":{"type":"array","items":{"type":"integer"}},"deleted":{"default":false,"type":"boolean"},"deletedAt":{"type":["string","null"],"format":"date-time"},"location":{"type":"array","items":{"$ref":"#/components/schemas/Location-product.read"}},"allLocations":{"default":true,"type":"boolean"},"visibility":{"default":"Public","type":"string","enum":["Public","Direct Link"]},"recurringProduct":{"anyOf":[{"$ref":"#/components/schemas/RecurringProduct-product.read"},{"type":"null"}]},"productCategories":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory-product.read"}},"minimumPricing":{"type":"array","items":{"$ref":"#/components/schemas/ProductMinimumPrice-product.read"}}}},"ProductTypePhysical-product.read":{"type":"object"},"Voucher-product.read":{"type":"object"},"ProductConfigurableOption-product.read":{"type":"object"},"Bundle-product.read":{"type":"object"},"Code-product.read":{"type":"object"},"Location-product.read":{"type":"object"},"RecurringProduct-product.read":{"type":"object"},"ProductCategory-product.read":{"type":"object"},"ProductMinimumPrice-product.read":{"type":"object"}}}}
```

## The ProductCategory-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductCategory-product.read":{"type":"object"}}}}
```

## The ProductConfigurableOption-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductConfigurableOption-product.read":{"type":"object"}}}}
```

## The ProductConfigurableOption-variant.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductConfigurableOption-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"}}}}}}
```

## The ProductConfigurableOptionValue-variant.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductConfigurableOptionValue-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"product_configurable_option":{"$ref":"#/components/schemas/ProductConfigurableOption-variant.read"},"name":{"type":"string"}}},"ProductConfigurableOption-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"}}}}}}
```

## The ProductMinimumPrice-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductMinimumPrice-product.read":{"type":"object"}}}}
```

## The ProductTypePhysical-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductTypePhysical-product.read":{"type":"object"}}}}
```

## The ProductVariant-variant.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductVariant-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"selectedOptions":{"type":"array","items":{"$ref":"#/components/schemas/ProductConfigurableOptionValue-variant.read"}},"pricing":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariantPricing-variant.read"}},"deleted":{"default":false,"type":"boolean"},"deletedAt":{"type":["string","null"],"format":"date-time"},"stockQuantity":{"type":["integer","null"]},"chargeTax":{"default":true,"type":"boolean"}}},"ProductConfigurableOptionValue-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"product_configurable_option":{"$ref":"#/components/schemas/ProductConfigurableOption-variant.read"},"name":{"type":"string"}}},"ProductConfigurableOption-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"}}},"ProductVariantPricing-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"price":{"type":"integer"},"storeCurrency":{"$ref":"#/components/schemas/StoreCurrency-variant.read"}}},"StoreCurrency-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"currencyCode":{"type":"string"}}}}}}
```

## The ProductVariantPricing-variant.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"ProductVariantPricing-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"price":{"type":"integer"},"storeCurrency":{"$ref":"#/components/schemas/StoreCurrency-variant.read"}}},"StoreCurrency-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"currencyCode":{"type":"string"}}}}}}
```

## The RecurringProduct-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"RecurringProduct-product.read":{"type":"object"}}}}
```

## The RecurringProductTierPricing-subscription.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"RecurringProductTierPricing-subscription.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"monthlyPrice":{"type":"integer"},"yearlyPrice":{"type":"integer"},"storeCurrency":{"$ref":"#/components/schemas/StoreCurrency-subscription.read"},"orderUnitPrice":{"default":0,"type":"integer"}}},"StoreCurrency-subscription.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"currencyCode":{"type":"string"}}}}}}
```

## The Referral.programs-referral.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Referral.programs-referral.read":{"type":"object","description":"A referral program defines the rules and rewards for customers referring others to purchase a product. Each referral program is associated with a specific product and can have its own unique terms, incentives, and sharing content.","properties":{"id":{"readOnly":true,"type":"integer"},"product":{"type":"integer"},"terms":{"type":["string","null"]},"incentiveDiscountAmount":{"type":["integer","null"]},"incentiveDiscountType":{"default":"FixedAmount","type":["string","null"],"enum":["FixedAmount","Percentage",null]},"shareTitle":{"type":"string"},"shareText":{"type":"string"},"shareUrl":{"type":"string"},"tags":{"type":"array","items":{"type":"integer"}},"inviteEmailSubject":{"default":"","type":"string"},"inviteEmailContent":{"default":"","type":"string"},"inviteEmailDelay":{"minimum":0,"exclusiveMinimum":0,"default":0,"type":"integer"},"newContactsOnly":{"type":"boolean"}}}}}}
```

## The Refund-read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Refund-read":{"type":"object"}}}}
```

## The Store-store.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Store-store.read":{"type":"object","description":"A store is a location where products, gifts, memberships can be purchased.","properties":{"id":{"readOnly":true,"type":"integer"},"organisation":{"type":"integer"},"name":{"type":"string"},"status":{"default":"Draft","type":"string","enum":["Draft","Active","Closed"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"domain":{"description":"The glu.io subdomain for the store, e.g. \"my-store\" for \"my-store.glu.io\". This is used to generate links to the store and must be unique across all stores.","type":"string"},"aliasDomain":{"anyOf":[{"$ref":"#/components/schemas/StoreAliasDomain-store.read"},{"type":"null"}]},"defaultVoucherTerms":{"default":"","type":"string"},"paymentGateway":{"anyOf":[{"$ref":"#/components/schemas/OrganisationPaymentGateway-store.read"},{"type":"null"}]},"hasValidFrom":{"default":false,"type":"boolean"},"validFromPeriod":{"type":["string","null"],"enum":["Days","Months","Years","Fixed",null]},"validFromLength":{"type":["integer","null"]},"validFromFixedDate":{"description":"The fixed start date for vouchers. This is used if the validity period is based on a fixed date rather than a length of time.","type":["string","null"],"format":"date-time"},"validityPeriod":{"default":"Years","type":"string","enum":["Days","Months","Years","Fixed"]},"validityLength":{"description":"Combined with the validityPeriod field, this defines the length of time vouchers are valid for. For example if validityPeriod is set to \"Months\" and this field is set to 6, vouchers will be valid for 6 months from the date they are issued.","default":1,"type":"integer"},"validityFixedDate":{"description":"The fixed expiration date for vouchers. This is used if the validity period is based on a fixed date rather than a length of time.","type":["string","null"],"format":"date-time"},"termsUrl":{"description":"A full URL to the terms and conditions for the store. This should link to a page that outlines the terms and conditions for using the store, including any rules around purchasing, returns, and refunds.","default":"","type":"string"},"privacyUrl":{"description":"A full URL to the privacy policy for the store. This should link to a page that outlines how customer data is collected, used, and protected when using the store.","default":"","type":"string"},"contactUrl":{"description":"A full URL to a page that provides contact information and support options for customers.","default":"","type":"string"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location-store.read"}},"mainWebsiteUrl":{"description":"The full URL back to your own website. This is used in various places such as the header and footer of the store, and can be used to link back to your main website from the store.","default":"","type":"string"},"businessDescription":{"default":"","type":"string"},"type":{"type":"string","enum":["Gift Card","Membership"]},"redirectOnSingleProduct":{"default":true,"type":"boolean"},"qrCodeMode":{"default":"Code","type":"string","enum":["Code","Redeem URL","Register URL"]},"notifyEmailAddresses":{"type":"array","items":{"type":["string","null"]}},"processingFee":{"default":0,"type":"integer"},"processingFeeLabel":{"default":"","type":"string"},"processingFeeEnabled":{"default":false,"type":"boolean"},"defaultVoucherRedeemInstructions":{"default":"","type":"string"},"timezone":{"default":"Europe/London","type":["string","null"]},"language":{"default":"en","type":["string","null"]},"giftCardsExpire":{"default":true,"type":"boolean"},"locale":{"default":"en_GB","type":"string"},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/StoreCurrency-store.read"}},"displayName":{"default":"","type":"string"}}},"StoreAliasDomain-store.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"domain":{"type":"string"}}},"OrganisationPaymentGateway-store.read":{"type":"object"},"Location-store.read":{"type":"object"},"StoreCurrency-store.read":{"type":"object","properties":{"currencyCode":{"type":"string"}}}}}}
```

## The StoreAliasDomain-store.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"StoreAliasDomain-store.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"domain":{"type":"string"}}}}}}
```

## The StoreCurrency-store.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"StoreCurrency-store.read":{"type":"object","properties":{"currencyCode":{"type":"string"}}}}}}
```

## The StoreCurrency-subscription.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"StoreCurrency-subscription.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"currencyCode":{"type":"string"}}}}}}
```

## The StoreCurrency-variant.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"StoreCurrency-variant.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"currencyCode":{"type":"string"}}}}}}
```

## The Stored.credit.accounts-balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Stored.credit.accounts-balance.read":{"type":"object","description":"A stored credit account contains all balance changes.","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/Balance-balance.read"}}}},"Balance-balance.read":{"type":"object","description":"A balance represents an individual change to the overall balance of a stored credit account, similar to a line on your bank statement.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Activation","Adjustment","Expired","Redeemed","Unredeemed","Refunded","Refund failed","Chargeback","Chargeback reversed","Reactivation","Topup"]},"amount":{"type":"integer"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location-balance.read"},{"type":"null"}]},"happenedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"reversed":{"anyOf":[{"$ref":"#/components/schemas/Balance-balance.read"},{"type":"null"}]},"mewsPayment":{"anyOf":[{"$ref":"#/components/schemas/MewsPayment-balance.read"},{"type":"null"}]},"storedCreditAccount":{"type":"integer"}}},"Location-balance.read":{"type":"object"},"MewsPayment-balance.read":{"type":"object"}}}}
```

## The Stored.credit.accounts-storedcreditaccount.read\_giftcard.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Stored.credit.accounts-storedcreditaccount.read_giftcard.read":{"type":"object","description":"A stored credit account contains all balance changes.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"contact":{"type":["string","null"],"format":"iri-reference"},"giftCard":{"anyOf":[{"$ref":"#/components/schemas/Gift.card-storedcreditaccount.read_giftcard.read"},{"type":"null"}]},"balances":{"type":"array","items":{"type":"integer"}},"attachedMember":{"type":["string","null"],"format":"iri-reference"},"type":{"type":"string","enum":["Gift Card","Member Credit"]},"currencyCode":{"type":"string"},"currentBalance":{"type":["integer","null"]},"startingBalance":{"type":["integer","null"]},"code":{"readOnly":true,"type":"string"}}},"Gift.card-storedcreditaccount.read_giftcard.read":{"type":"object","description":"A gift card is identified by its unique code, and has a balance that can be redeemed depending on the status. It may have terms and conditions that apply to its use.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"contact":{"description":"An optional contact that the gift card is registered to.","type":["string","null"],"format":"iri-reference"},"status":{"type":"string","enum":["Chargeback","Expired","Fraudulent","Not yet valid","Partially redeemed","Redeemed","Refunded","Valid","Grace period"]},"expiresAt":{"type":["string","null"],"format":"date-time"},"gracePeriodExpiresAt":{"type":["string","null"],"format":"date-time"},"validFrom":{"type":"string","format":"date-time"},"partiallyRedeemable":{"default":true,"type":"boolean"},"name":{"type":"string"},"topupable":{"default":false,"type":"boolean"},"terms":{"default":"","type":"string"},"selectedOptions":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardSelectedOption-storedcreditaccount.read_giftcard.read"}},"recipientDescription":{"default":"","type":"string"},"usingRecipientDescription":{"default":false,"type":"boolean"},"description":{"default":"","type":"string"},"personalMessage":{"default":"","type":["string","null"]},"class":{"type":"string","enum":["Standard","Monetary","Configurable"]},"redeemInstructions":{"default":"","type":["string","null"]},"lastRedeemedAt":{"type":["string","null"],"format":"date-time"},"purchaserName":{"default":"","type":"string"},"deliveryName":{"default":"","type":"string"},"latestEmailDeliveryStatus":{"type":["string","null"],"enum":["Processed","Dropped","Delivered","Deferred","Bounced","Blocked","Opened","Clicked","Reported as spam","Unsubscribed","Group unsubscribed","Group resubscribed",null]},"additionalLocations":{"type":"array","items":{"$ref":"#/components/schemas/GiftCardLocation-storedcreditaccount.read_giftcard.read"}}}},"GiftCardSelectedOption-storedcreditaccount.read_giftcard.read":{"type":"object"},"GiftCardLocation-storedcreditaccount.read_giftcard.read":{"type":"object"}}}}
```

## The Stored.credit.accounts.Balance-giftcard.read\_balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Stored.credit.accounts.Balance-giftcard.read_balance.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Activation","Adjustment","Expired","Redeemed","Unredeemed","Refunded","Refund failed","Chargeback","Chargeback reversed","Reactivation","Topup"]},"amount":{"type":"integer"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location-giftcard.read_balance.read"},{"type":"null"}]},"happenedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"reversed":{"anyOf":[{"$ref":"#/components/schemas/Balance-giftcard.read_balance.read"},{"type":"null"}]},"mewsPayment":{"anyOf":[{"$ref":"#/components/schemas/MewsPayment-giftcard.read_balance.read"},{"type":"null"}]},"storedCreditAccount":{"type":"integer"}}},"Location-giftcard.read_balance.read":{"type":"object"},"Balance-giftcard.read_balance.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["Activation","Adjustment","Expired","Redeemed","Unredeemed","Refunded","Refund failed","Chargeback","Chargeback reversed","Reactivation","Topup"]},"amount":{"type":"integer"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location-giftcard.read_balance.read"},{"type":"null"}]},"happenedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":["string","null"],"format":"date-time"},"reversed":{"anyOf":[{"$ref":"#/components/schemas/Balance-giftcard.read_balance.read"},{"type":"null"}]},"mewsPayment":{"anyOf":[{"$ref":"#/components/schemas/MewsPayment-giftcard.read_balance.read"},{"type":"null"}]},"storedCreditAccount":{"type":"integer"}}},"MewsPayment-giftcard.read_balance.read":{"type":"object"}}}}
```

## The Stored.credit.accounts.GiftCardRedeemInput-giftcard.write\_balance.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Stored.credit.accounts.GiftCardRedeemInput-giftcard.write_balance.read":{"type":"object","required":["amount"],"properties":{"amount":{"minimum":0,"exclusiveMinimum":0,"type":"integer"},"location":{"type":["integer","null"]},"currency":{"type":"string"}}}}}}
```

## The Subscription-subscription.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Subscription-subscription.read":{"type":"object","description":"A subscription represents a contact's membership in a recurring product, such as a loyalty programme or membership tier.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":["string","null"],"format":"date-time"},"contact":{"type":"integer"},"status":{"type":"string","enum":["Active","Inactive","Pending","Cancelled","Trial"]},"cancelAt":{"type":["string","null"],"format":"date-time"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"product":{"type":"integer"},"pricing":{"anyOf":[{"$ref":"#/components/schemas/RecurringProductTierPricing-subscription.read"},{"type":"null"}]},"pricingPeriod":{"type":["string","null"],"enum":["Monthly","Yearly",null]},"paymentsStartedAt":{"type":["string","null"],"format":"date-time"},"tierId":{"readOnly":true,"type":["integer","null"]},"storedCreditAccountId":{"readOnly":true,"type":["integer","null"]}}},"RecurringProductTierPricing-subscription.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"monthlyPrice":{"type":"integer"},"yearlyPrice":{"type":"integer"},"storeCurrency":{"$ref":"#/components/schemas/StoreCurrency-subscription.read"},"orderUnitPrice":{"default":0,"type":"integer"}}},"StoreCurrency-subscription.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"currencyCode":{"type":"string"}}}}}}
```

## The Table.reservation object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Table.reservation":{"type":"object","description":"Represents a dining reservation made by a contact with details about the reservation, such as the party size, status, and any notes.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"notes":{"type":"string"},"partySize":{"type":"integer"},"status":{"type":"string"},"activity":{"type":"integer"},"origin":{"type":"string"},"originReference":{"type":"string"},"customerBookingReference":{"type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"}}}}}}
```

## The Table.reservation-activity.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Table.reservation-activity.read":{"type":"object","description":"Represents a dining reservation made by a contact with details about the reservation, such as the party size, status, and any notes.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"notes":{"type":"string"},"partySize":{"type":"integer"},"status":{"type":"string"},"origin":{"type":"string"},"originReference":{"type":"string"},"customerBookingReference":{"type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"}}}}}}
```

## The Table.reservation-activity.write object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Table.reservation-activity.write":{"type":"object","description":"Represents a dining reservation made by a contact with details about the reservation, such as the party size, status, and any notes.","properties":{"notes":{"type":"string"},"partySize":{"type":"integer"},"status":{"type":"string"},"origin":{"type":"string"},"originReference":{"type":"string"},"customerBookingReference":{"type":"string"},"cancelledAt":{"type":["string","null"],"format":"date-time"}}}}}}
```

## The Tag-contact.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Tag-contact.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"integer"},"name":{"type":"string"},"systemDefined":{"default":false,"type":"boolean"}},"required":["name"]}}}}
```

## The Tag-tag.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Tag-tag.read":{"type":"object","description":"Tags are assigned to contacts to help organize and segment them. Tags can be used to create targeted marketing campaigns, personalize communication, and gain insights into customer behavior. Each tag belongs to an organisation and has a name, some tags are system defined and cannot be modified or assigned manually.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"systemDefined":{"default":false,"type":"boolean"}},"required":["name"]}}}}
```

## The Transaction-read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Transaction-read":{"type":"object","description":"A transaction is associated to an order and represents the movement of money.","properties":{"id":{"readOnly":true,"type":"integer"},"amount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gateway":{"type":"string"},"gatewayReference":{"default":"","type":"string"},"type":{"type":"string","enum":["Payment","Refund","Refund Failure","Chargeback","Chargeback Reversal"]},"currencyCode":{"type":"string"},"card_type":{"default":"","type":["string","null"]},"card_number":{"default":"","type":["string","null"]},"attachedOrder":{"type":"integer"},"refund":{"anyOf":[{"$ref":"#/components/schemas/Refund-read"},{"type":"null"}]},"failedRefund":{"anyOf":[{"$ref":"#/components/schemas/Refund-read"},{"type":"null"}]},"payment":{"anyOf":[{"$ref":"#/components/schemas/Payment-read"},{"type":"null"}]}}},"Refund-read":{"type":"object"},"Payment-read":{"type":"object"}}}}
```

## The User-order.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"User-order.read":{"type":"object"}}}}
```

## The Voucher-product.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Voucher-product.read":{"type":"object"}}}}
```

## The Workflow-workflow\.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"Workflow-workflow.read":{"type":"object","description":"A workflow is an automated sequence of actions that can be triggered by various events. Workflows can be used to automate tasks such as sending emails, updating contact information, or triggering other actions based on customer behavior.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"status":{"default":"Draft","type":"string","enum":["Draft","Active"]},"startingTriggerType":{"type":["string","null"],"enum":["customer_created","gift_card_purchased","order_created","contact_created","member_created","subscription_created","referral_completed","booking_created","booking_status_changed","webhook","date_anniversary",null]}}}}}}
```

## The WorkflowRun-workflow\_run.read object

```json
{"openapi":"3.1.0","info":{"title":"Glu","version":"1.0.0"},"components":{"schemas":{"WorkflowRun-workflow_run.read":{"type":"object","description":"A workflow run represents an execution instance of a workflow. It contains the execution history, status, and any errors that occurred during the run.","properties":{"id":{"readOnly":true,"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"},"status":{"default":"running","type":"string","enum":["running","completed","failed","paused"]},"context":{"type":"array","items":{"type":["string","null"]}},"executedNodes":{"type":"array","items":{"type":"string"}},"errorMessage":{"type":["string","null"]},"triggerData":{"type":["string","null"]},"workflowId":{"readOnly":true,"type":["integer","null"]},"workflowName":{"readOnly":true,"type":["string","null"]}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://glu.gitbook.io/docs/api-reference/organisation-api/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.