TrellisDevelopers
API reference

Clubs

List clubs

GET
/club

Commerce7-compatible club records backed by the durable club domain.

Query Parameters

q?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "clubs": [    {      "id": "string",      "title": "string",      "type": "Traditional",      "content": "string",      "publishDate": "2019-08-24T14:15:22Z",      "slug": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "seo": {        "title": "string",        "description": "string"      },      "webStatus": "Available",      "adminStatus": "Available"    }  ],  "total": 0}

Create club

POST
/club

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "slug": "string"  }'
{  "id": "string",  "title": "string",  "type": "Traditional",  "content": "string",  "publishDate": "2019-08-24T14:15:22Z",  "slug": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "seo": {    "title": "string",    "description": "string"  },  "webStatus": "Available",  "adminStatus": "Available"}

Retrieve club

GET
/club/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "title": "string",  "type": "Traditional",  "content": "string",  "publishDate": "2019-08-24T14:15:22Z",  "slug": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "seo": {    "title": "string",    "description": "string"  },  "webStatus": "Available",  "adminStatus": "Available"}

Delete club

DELETE
/club/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/club/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
Empty

Update club

PUT
/club/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "title": "string",  "type": "Traditional",  "content": "string",  "publishDate": "2019-08-24T14:15:22Z",  "slug": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "seo": {    "title": "string",    "description": "string"  },  "webStatus": "Available",  "adminStatus": "Available"}

List clubs (alias)

GET
/clubs

Commerce7-compatible club records backed by the durable club domain.

Query Parameters

q?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/clubs" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "clubs": [    {      "id": "string",      "title": "string",      "type": "Traditional",      "content": "string",      "publishDate": "2019-08-24T14:15:22Z",      "slug": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "seo": {        "title": "string",        "description": "string"      },      "webStatus": "Available",      "adminStatus": "Available"    }  ],  "total": 0}

Create a club (alias)

POST
/clubs

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/clubs" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "slug": "string"  }'
{  "id": "string",  "title": "string",  "type": "Traditional",  "content": "string",  "publishDate": "2019-08-24T14:15:22Z",  "slug": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "seo": {    "title": "string",    "description": "string"  },  "webStatus": "Available",  "adminStatus": "Available"}

Retrieve a club (alias)

GET
/clubs/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/clubs/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "title": "string",  "type": "Traditional",  "content": "string",  "publishDate": "2019-08-24T14:15:22Z",  "slug": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "seo": {    "title": "string",    "description": "string"  },  "webStatus": "Available",  "adminStatus": "Available"}

Delete a club (alias)

DELETE
/clubs/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/clubs/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
Empty

Update a club (alias)

PUT
/clubs/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/clubs/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "title": "string",  "type": "Traditional",  "content": "string",  "publishDate": "2019-08-24T14:15:22Z",  "slug": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "seo": {    "title": "string",    "description": "string"  },  "webStatus": "Available",  "adminStatus": "Available"}

List club memberships

GET
/club-membership

Commerce7-compatible memberships backed by the durable club domain.

Query Parameters

q?string
clubId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-membership" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "clubMemberships": [    {      "status": "Active",      "id": "string",      "customerId": "string",      "clubId": "string",      "billToCustomerAddressId": "string",      "orderDeliveryMethod": "Pickup",      "shipToCustomerAddressId": "string",      "customerCreditCardId": "string",      "providerCustomerId": "string",      "providerPaymentMethodId": "string",      "signupDate": "2019-08-24T14:15:22Z",      "cancelDate": "2019-08-24T14:15:22Z",      "lastProcessedDate": "2019-08-24T14:15:22Z",      "currentNumberOfShipments": 0,      "subscriptionTemplateId": "string",      "nextProcessDate": "2019-08-24T14:15:22Z",      "cadenceOverride": {        "unit": "week",        "count": 1      },      "holdUntil": "2019-08-24T14:15:22Z",      "holdReason": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "customer": null,      "club": {        "id": "string",        "title": "string",        "type": "Traditional",        "content": "string",        "publishDate": "2019-08-24T14:15:22Z",        "slug": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "seo": {          "title": "string",          "description": "string"        },        "webStatus": "Available",        "adminStatus": "Available"      },      "onHolds": [        null      ],      "subscription": {        "frequency": "string",        "nextProcessDate": "2019-08-24T14:15:22Z"      }    }  ],  "total": 0}

Create club membership

POST
/club-membership

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-membership" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "customerId": "string",    "clubId": "string",    "billToCustomerAddressId": "string",    "orderDeliveryMethod": "Pickup",    "shipToCustomerAddressId": "string",    "customerCreditCardId": "string",    "signupDate": "2019-08-24T14:15:22Z",    "cancelDate": "2019-08-24T14:15:22Z"  }'
{  "status": "Active",  "id": "string",  "customerId": "string",  "clubId": "string",  "billToCustomerAddressId": "string",  "orderDeliveryMethod": "Pickup",  "shipToCustomerAddressId": "string",  "customerCreditCardId": "string",  "providerCustomerId": "string",  "providerPaymentMethodId": "string",  "signupDate": "2019-08-24T14:15:22Z",  "cancelDate": "2019-08-24T14:15:22Z",  "lastProcessedDate": "2019-08-24T14:15:22Z",  "currentNumberOfShipments": 0,  "subscriptionTemplateId": "string",  "nextProcessDate": "2019-08-24T14:15:22Z",  "cadenceOverride": {    "unit": "week",    "count": 1  },  "holdUntil": "2019-08-24T14:15:22Z",  "holdReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "customer": null,  "club": {    "id": "string",    "title": "string",    "type": "Traditional",    "content": "string",    "publishDate": "2019-08-24T14:15:22Z",    "slug": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "seo": {      "title": "string",      "description": "string"    },    "webStatus": "Available",    "adminStatus": "Available"  },  "onHolds": [    null  ],  "subscription": {    "frequency": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }}

Retrieve club membership

GET
/club-membership/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-membership/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "status": "Active",  "id": "string",  "customerId": "string",  "clubId": "string",  "billToCustomerAddressId": "string",  "orderDeliveryMethod": "Pickup",  "shipToCustomerAddressId": "string",  "customerCreditCardId": "string",  "providerCustomerId": "string",  "providerPaymentMethodId": "string",  "signupDate": "2019-08-24T14:15:22Z",  "cancelDate": "2019-08-24T14:15:22Z",  "lastProcessedDate": "2019-08-24T14:15:22Z",  "currentNumberOfShipments": 0,  "subscriptionTemplateId": "string",  "nextProcessDate": "2019-08-24T14:15:22Z",  "cadenceOverride": {    "unit": "week",    "count": 1  },  "holdUntil": "2019-08-24T14:15:22Z",  "holdReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "customer": null,  "club": {    "id": "string",    "title": "string",    "type": "Traditional",    "content": "string",    "publishDate": "2019-08-24T14:15:22Z",    "slug": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "seo": {      "title": "string",      "description": "string"    },    "webStatus": "Available",    "adminStatus": "Available"  },  "onHolds": [    null  ],  "subscription": {    "frequency": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }}

Delete club membership

DELETE
/club-membership/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/club-membership/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
Empty

Update club membership

PUT
/club-membership/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club-membership/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "Active",  "id": "string",  "customerId": "string",  "clubId": "string",  "billToCustomerAddressId": "string",  "orderDeliveryMethod": "Pickup",  "shipToCustomerAddressId": "string",  "customerCreditCardId": "string",  "providerCustomerId": "string",  "providerPaymentMethodId": "string",  "signupDate": "2019-08-24T14:15:22Z",  "cancelDate": "2019-08-24T14:15:22Z",  "lastProcessedDate": "2019-08-24T14:15:22Z",  "currentNumberOfShipments": 0,  "subscriptionTemplateId": "string",  "nextProcessDate": "2019-08-24T14:15:22Z",  "cadenceOverride": {    "unit": "week",    "count": 1  },  "holdUntil": "2019-08-24T14:15:22Z",  "holdReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "customer": null,  "club": {    "id": "string",    "title": "string",    "type": "Traditional",    "content": "string",    "publishDate": "2019-08-24T14:15:22Z",    "slug": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "seo": {      "title": "string",      "description": "string"    },    "webStatus": "Available",    "adminStatus": "Available"  },  "onHolds": [    null  ],  "subscription": {    "frequency": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }}

Apply annual or manual club loyalty benefits

POST
/club-membership/{id}/loyalty-benefits/apply

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-membership/string/loyalty-benefits/apply" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "trigger": "annual",    "idempotencyKey": "stringst"  }'
null

List club memberships (alias)

GET
/club-memberships

Commerce7-compatible memberships backed by the durable club domain.

Query Parameters

q?string
clubId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-memberships" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "clubMemberships": [    {      "status": "Active",      "id": "string",      "customerId": "string",      "clubId": "string",      "billToCustomerAddressId": "string",      "orderDeliveryMethod": "Pickup",      "shipToCustomerAddressId": "string",      "customerCreditCardId": "string",      "providerCustomerId": "string",      "providerPaymentMethodId": "string",      "signupDate": "2019-08-24T14:15:22Z",      "cancelDate": "2019-08-24T14:15:22Z",      "lastProcessedDate": "2019-08-24T14:15:22Z",      "currentNumberOfShipments": 0,      "subscriptionTemplateId": "string",      "nextProcessDate": "2019-08-24T14:15:22Z",      "cadenceOverride": {        "unit": "week",        "count": 1      },      "holdUntil": "2019-08-24T14:15:22Z",      "holdReason": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "customer": null,      "club": {        "id": "string",        "title": "string",        "type": "Traditional",        "content": "string",        "publishDate": "2019-08-24T14:15:22Z",        "slug": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "seo": {          "title": "string",          "description": "string"        },        "webStatus": "Available",        "adminStatus": "Available"      },      "onHolds": [        null      ],      "subscription": {        "frequency": "string",        "nextProcessDate": "2019-08-24T14:15:22Z"      }    }  ],  "total": 0}

Create a club membership (alias)

POST
/club-memberships

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-memberships" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "customerId": "string",    "clubId": "string",    "billToCustomerAddressId": "string",    "orderDeliveryMethod": "Pickup",    "shipToCustomerAddressId": "string",    "customerCreditCardId": "string",    "signupDate": "2019-08-24T14:15:22Z",    "cancelDate": "2019-08-24T14:15:22Z"  }'
{  "status": "Active",  "id": "string",  "customerId": "string",  "clubId": "string",  "billToCustomerAddressId": "string",  "orderDeliveryMethod": "Pickup",  "shipToCustomerAddressId": "string",  "customerCreditCardId": "string",  "providerCustomerId": "string",  "providerPaymentMethodId": "string",  "signupDate": "2019-08-24T14:15:22Z",  "cancelDate": "2019-08-24T14:15:22Z",  "lastProcessedDate": "2019-08-24T14:15:22Z",  "currentNumberOfShipments": 0,  "subscriptionTemplateId": "string",  "nextProcessDate": "2019-08-24T14:15:22Z",  "cadenceOverride": {    "unit": "week",    "count": 1  },  "holdUntil": "2019-08-24T14:15:22Z",  "holdReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "customer": null,  "club": {    "id": "string",    "title": "string",    "type": "Traditional",    "content": "string",    "publishDate": "2019-08-24T14:15:22Z",    "slug": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "seo": {      "title": "string",      "description": "string"    },    "webStatus": "Available",    "adminStatus": "Available"  },  "onHolds": [    null  ],  "subscription": {    "frequency": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }}

Retrieve a club membership (alias)

GET
/club-memberships/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-memberships/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "status": "Active",  "id": "string",  "customerId": "string",  "clubId": "string",  "billToCustomerAddressId": "string",  "orderDeliveryMethod": "Pickup",  "shipToCustomerAddressId": "string",  "customerCreditCardId": "string",  "providerCustomerId": "string",  "providerPaymentMethodId": "string",  "signupDate": "2019-08-24T14:15:22Z",  "cancelDate": "2019-08-24T14:15:22Z",  "lastProcessedDate": "2019-08-24T14:15:22Z",  "currentNumberOfShipments": 0,  "subscriptionTemplateId": "string",  "nextProcessDate": "2019-08-24T14:15:22Z",  "cadenceOverride": {    "unit": "week",    "count": 1  },  "holdUntil": "2019-08-24T14:15:22Z",  "holdReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "customer": null,  "club": {    "id": "string",    "title": "string",    "type": "Traditional",    "content": "string",    "publishDate": "2019-08-24T14:15:22Z",    "slug": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "seo": {      "title": "string",      "description": "string"    },    "webStatus": "Available",    "adminStatus": "Available"  },  "onHolds": [    null  ],  "subscription": {    "frequency": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }}

Delete a club membership (alias)

DELETE
/club-memberships/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/club-memberships/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
Empty

Update a club membership (alias)

PUT
/club-memberships/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club-memberships/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "Active",  "id": "string",  "customerId": "string",  "clubId": "string",  "billToCustomerAddressId": "string",  "orderDeliveryMethod": "Pickup",  "shipToCustomerAddressId": "string",  "customerCreditCardId": "string",  "providerCustomerId": "string",  "providerPaymentMethodId": "string",  "signupDate": "2019-08-24T14:15:22Z",  "cancelDate": "2019-08-24T14:15:22Z",  "lastProcessedDate": "2019-08-24T14:15:22Z",  "currentNumberOfShipments": 0,  "subscriptionTemplateId": "string",  "nextProcessDate": "2019-08-24T14:15:22Z",  "cadenceOverride": {    "unit": "week",    "count": 1  },  "holdUntil": "2019-08-24T14:15:22Z",  "holdReason": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "customer": null,  "club": {    "id": "string",    "title": "string",    "type": "Traditional",    "content": "string",    "publishDate": "2019-08-24T14:15:22Z",    "slug": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "seo": {      "title": "string",      "description": "string"    },    "webStatus": "Available",    "adminStatus": "Available"  },  "onHolds": [    null  ],  "subscription": {    "frequency": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }}

Apply annual or manual club loyalty benefits (alias)

POST
/club-memberships/{id}/loyalty-benefits/apply

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-memberships/string/loyalty-benefits/apply" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "trigger": "annual",    "idempotencyKey": "stringst"  }'
null

List club benefits

GET
/club-benefits

Query Parameters

clubId?string

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-benefits" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "benefits": [    {      "id": "string",      "clubId": "string",      "title": "string",      "description": "string",      "kind": "percent_discount",      "channel": "all",      "percentOffBps": 1,      "amountOff": 1,      "loyaltyPoints": 1,      "loyaltyMultiplier": 1,      "loyaltyRewardId": "string",      "grantCadence": "signup",      "locationIds": [        "string"      ],      "active": true,      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create a club benefit

POST
/club/{id}/benefits

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club/string/benefits" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "kind": "percent_discount"  }'
{  "id": "string",  "clubId": "string",  "title": "string",  "description": "string",  "kind": "percent_discount",  "channel": "all",  "percentOffBps": 1,  "amountOff": 1,  "loyaltyPoints": 1,  "loyaltyMultiplier": 1,  "loyaltyRewardId": "string",  "grantCadence": "signup",  "locationIds": [    "string"  ],  "active": true,  "startsAt": "2019-08-24T14:15:22Z",  "endsAt": "2019-08-24T14:15:22Z",  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a club benefit

DELETE
/club-benefits/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

curl -X DELETE "https://example.com/club-benefits/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
Empty

Update a club benefit

PUT
/club-benefits/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club-benefits/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "clubId": "string",  "title": "string",  "description": "string",  "kind": "percent_discount",  "channel": "all",  "percentOffBps": 1,  "amountOff": 1,  "loyaltyPoints": 1,  "loyaltyMultiplier": 1,  "loyaltyRewardId": "string",  "grantCadence": "signup",  "locationIds": [    "string"  ],  "active": true,  "startsAt": "2019-08-24T14:15:22Z",  "endsAt": "2019-08-24T14:15:22Z",  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Resolve active club benefits for POS or online checkout

GET
/club-benefits/resolve

Returns effective benefits in one tenant-scoped query so POS and storefront clients do not poll or fan out by membership.

Query Parameters

customerId*string
Length1 <= length
locationId?string
Length1 <= length
channel?||
asOf?string
Formatdate-time

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-benefits/resolve?customerId=string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "entitlements": [    {      "id": "string",      "clubId": "string",      "title": "string",      "description": "string",      "kind": "percent_discount",      "channel": "all",      "percentOffBps": 1,      "amountOff": 1,      "loyaltyPoints": 1,      "loyaltyMultiplier": 1,      "loyaltyRewardId": "string",      "grantCadence": "signup",      "locationIds": [        "string"      ],      "active": true,      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "membershipId": "string",      "customerId": "string",      "clubTitle": "string"    }  ],  "total": 0,  "resolvedAt": "2019-08-24T14:15:22Z"}

Resolve active benefits for a club membership

GET
/club-membership/{id}/benefits

Path Parameters

id*string
Length1 <= length

Query Parameters

locationId?string
Length1 <= length
channel?||
asOf?string
Formatdate-time

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-membership/string/benefits" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "entitlements": [    {      "id": "string",      "clubId": "string",      "title": "string",      "description": "string",      "kind": "percent_discount",      "channel": "all",      "percentOffBps": 1,      "amountOff": 1,      "loyaltyPoints": 1,      "loyaltyMultiplier": 1,      "loyaltyRewardId": "string",      "grantCadence": "signup",      "locationIds": [        "string"      ],      "active": true,      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "membershipId": "string",      "customerId": "string",      "clubTitle": "string"    }  ],  "total": 0,  "resolvedAt": "2019-08-24T14:15:22Z"}

List traditional club releases

GET
/club/{id}/releases

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club/string/releases" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "releases": [    {      "id": "string",      "clubId": "string",      "title": "string",      "status": "planning",      "locationId": "string",      "processDate": "2019-08-24T14:15:22Z",      "customizationDeadline": "2019-08-24T14:15:22Z",      "activatedAt": "2019-08-24T14:15:22Z",      "processingStartedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "archivedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create traditional club release

POST
/club/{id}/releases

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club/string/releases" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "locationId": "string",    "processDate": "2019-08-24T14:15:22Z"  }'
{  "id": "string",  "clubId": "string",  "title": "string",  "status": "planning",  "locationId": "string",  "processDate": "2019-08-24T14:15:22Z",  "customizationDeadline": "2019-08-24T14:15:22Z",  "activatedAt": "2019-08-24T14:15:22Z",  "processingStartedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "archivedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a traditional club release

GET
/club-releases/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-releases/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "clubId": "string",  "title": "string",  "status": "planning",  "locationId": "string",  "processDate": "2019-08-24T14:15:22Z",  "customizationDeadline": "2019-08-24T14:15:22Z",  "activatedAt": "2019-08-24T14:15:22Z",  "processingStartedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "archivedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update a traditional club release

PUT
/club-releases/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club-releases/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "clubId": "string",  "title": "string",  "status": "planning",  "locationId": "string",  "processDate": "2019-08-24T14:15:22Z",  "customizationDeadline": "2019-08-24T14:15:22Z",  "activatedAt": "2019-08-24T14:15:22Z",  "processingStartedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "archivedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List club release products

GET
/club-releases/{id}/products

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-releases/string/products" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "products": [    {      "id": "string",      "releaseId": "string",      "productId": "string",      "sku": "string",      "title": "string",      "quantity": 1,      "minimumQuantity": 0,      "maximumQuantity": 0,      "unitPrice": 0,      "taxRateBps": 0,      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Add or replace a club release product

POST
/club-releases/{id}/products

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-releases/string/products" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "productId": "string",    "quantity": 1  }'
{  "id": "string",  "releaseId": "string",  "productId": "string",  "sku": "string",  "title": "string",  "quantity": 1,  "minimumQuantity": 0,  "maximumQuantity": 0,  "unitPrice": 0,  "taxRateBps": 0,  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Build member shipment drafts and reserve inventory

POST
/club-releases/{id}/build

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X POST "https://example.com/club-releases/string/build" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "release": {    "id": "string",    "clubId": "string",    "title": "string",    "status": "planning",    "locationId": "string",    "processDate": "2019-08-24T14:15:22Z",    "customizationDeadline": "2019-08-24T14:15:22Z",    "activatedAt": "2019-08-24T14:15:22Z",    "processingStartedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "archivedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "createdShipments": [    {      "id": "string",      "releaseId": "string",      "membershipId": "string",      "status": "draft",      "orderId": "string",      "paymentIntentId": "string",      "providerPaymentIntentId": "string",      "subtotal": 0,      "taxTotal": 0,      "total": 0,      "processingAttempts": 0,      "declineCode": "string",      "declineMessage": "string",      "lastAttemptedAt": "2019-08-24T14:15:22Z",      "processedAt": "2019-08-24T14:15:22Z",      "skippedAt": "2019-08-24T14:15:22Z",      "skipReason": "string",      "subscriptionTemplateId": "string",      "scheduledFor": "2019-08-24T14:15:22Z",      "pickupStatus": "not_applicable",      "pickupReadyAt": "2019-08-24T14:15:22Z",      "pickedUpAt": "2019-08-24T14:15:22Z",      "pickedUpByStaffUserId": "string",      "refundedAt": "2019-08-24T14:15:22Z",      "refundId": "string",      "refundedSubtotal": 0,      "refundedTaxTotal": 0,      "refundedTotal": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "items": [        {          "id": "string",          "releaseProductId": "string",          "productId": "string",          "sku": "string",          "title": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ]    }  ],  "totalShipments": 0}

Activate a club release

POST
/club-releases/{id}/activate

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X POST "https://example.com/club-releases/string/activate" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "clubId": "string",  "title": "string",  "status": "planning",  "locationId": "string",  "processDate": "2019-08-24T14:15:22Z",  "customizationDeadline": "2019-08-24T14:15:22Z",  "activatedAt": "2019-08-24T14:15:22Z",  "processingStartedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "archivedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Process all ready or declined shipments idempotently

POST
/club-releases/{id}/process

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-releases/string/process" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string"  }'
{  "release": {    "id": "string",    "clubId": "string",    "title": "string",    "status": "planning",    "locationId": "string",    "processDate": "2019-08-24T14:15:22Z",    "customizationDeadline": "2019-08-24T14:15:22Z",    "activatedAt": "2019-08-24T14:15:22Z",    "processingStartedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "archivedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "shipments": [    {      "id": "string",      "releaseId": "string",      "membershipId": "string",      "status": "draft",      "orderId": "string",      "paymentIntentId": "string",      "providerPaymentIntentId": "string",      "subtotal": 0,      "taxTotal": 0,      "total": 0,      "processingAttempts": 0,      "declineCode": "string",      "declineMessage": "string",      "lastAttemptedAt": "2019-08-24T14:15:22Z",      "processedAt": "2019-08-24T14:15:22Z",      "skippedAt": "2019-08-24T14:15:22Z",      "skipReason": "string",      "subscriptionTemplateId": "string",      "scheduledFor": "2019-08-24T14:15:22Z",      "pickupStatus": "not_applicable",      "pickupReadyAt": "2019-08-24T14:15:22Z",      "pickedUpAt": "2019-08-24T14:15:22Z",      "pickedUpByStaffUserId": "string",      "refundedAt": "2019-08-24T14:15:22Z",      "refundId": "string",      "refundedSubtotal": 0,      "refundedTaxTotal": 0,      "refundedTotal": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "items": [        {          "id": "string",          "releaseProductId": "string",          "productId": "string",          "sku": "string",          "title": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ]    }  ]}

List member shipment drafts for a release

GET
/club-releases/{id}/shipments

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-releases/string/shipments" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "shipments": [    {      "id": "string",      "releaseId": "string",      "membershipId": "string",      "status": "draft",      "orderId": "string",      "paymentIntentId": "string",      "providerPaymentIntentId": "string",      "subtotal": 0,      "taxTotal": 0,      "total": 0,      "processingAttempts": 0,      "declineCode": "string",      "declineMessage": "string",      "lastAttemptedAt": "2019-08-24T14:15:22Z",      "processedAt": "2019-08-24T14:15:22Z",      "skippedAt": "2019-08-24T14:15:22Z",      "skipReason": "string",      "subscriptionTemplateId": "string",      "scheduledFor": "2019-08-24T14:15:22Z",      "pickupStatus": "not_applicable",      "pickupReadyAt": "2019-08-24T14:15:22Z",      "pickedUpAt": "2019-08-24T14:15:22Z",      "pickedUpByStaffUserId": "string",      "refundedAt": "2019-08-24T14:15:22Z",      "refundId": "string",      "refundedSubtotal": 0,      "refundedTaxTotal": 0,      "refundedTotal": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "items": [        {          "id": "string",          "releaseProductId": "string",          "productId": "string",          "sku": "string",          "title": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ]    }  ],  "total": 0}

Get a member shipment draft

GET
/club-shipments/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-shipments/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "id": "string",  "releaseId": "string",  "membershipId": "string",  "status": "draft",  "orderId": "string",  "paymentIntentId": "string",  "providerPaymentIntentId": "string",  "subtotal": 0,  "taxTotal": 0,  "total": 0,  "processingAttempts": 0,  "declineCode": "string",  "declineMessage": "string",  "lastAttemptedAt": "2019-08-24T14:15:22Z",  "processedAt": "2019-08-24T14:15:22Z",  "skippedAt": "2019-08-24T14:15:22Z",  "skipReason": "string",  "subscriptionTemplateId": "string",  "scheduledFor": "2019-08-24T14:15:22Z",  "pickupStatus": "not_applicable",  "pickupReadyAt": "2019-08-24T14:15:22Z",  "pickedUpAt": "2019-08-24T14:15:22Z",  "pickedUpByStaffUserId": "string",  "refundedAt": "2019-08-24T14:15:22Z",  "refundId": "string",  "refundedSubtotal": 0,  "refundedTaxTotal": 0,  "refundedTotal": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "items": [    {      "id": "string",      "releaseProductId": "string",      "productId": "string",      "sku": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Customize a member shipment

PUT
/club-shipments/{id}/items

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club-shipments/string/items" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "productId": "string",        "quantity": 1      }    ]  }'
{  "id": "string",  "releaseId": "string",  "membershipId": "string",  "status": "draft",  "orderId": "string",  "paymentIntentId": "string",  "providerPaymentIntentId": "string",  "subtotal": 0,  "taxTotal": 0,  "total": 0,  "processingAttempts": 0,  "declineCode": "string",  "declineMessage": "string",  "lastAttemptedAt": "2019-08-24T14:15:22Z",  "processedAt": "2019-08-24T14:15:22Z",  "skippedAt": "2019-08-24T14:15:22Z",  "skipReason": "string",  "subscriptionTemplateId": "string",  "scheduledFor": "2019-08-24T14:15:22Z",  "pickupStatus": "not_applicable",  "pickupReadyAt": "2019-08-24T14:15:22Z",  "pickedUpAt": "2019-08-24T14:15:22Z",  "pickedUpByStaffUserId": "string",  "refundedAt": "2019-08-24T14:15:22Z",  "refundId": "string",  "refundedSubtotal": 0,  "refundedTaxTotal": 0,  "refundedTotal": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "items": [    {      "id": "string",      "releaseProductId": "string",      "productId": "string",      "sku": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Retry a declined member shipment

POST
/club-shipments/{id}/retry

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-shipments/string/retry" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string"  }'
{  "id": "string",  "releaseId": "string",  "membershipId": "string",  "status": "draft",  "orderId": "string",  "paymentIntentId": "string",  "providerPaymentIntentId": "string",  "subtotal": 0,  "taxTotal": 0,  "total": 0,  "processingAttempts": 0,  "declineCode": "string",  "declineMessage": "string",  "lastAttemptedAt": "2019-08-24T14:15:22Z",  "processedAt": "2019-08-24T14:15:22Z",  "skippedAt": "2019-08-24T14:15:22Z",  "skipReason": "string",  "subscriptionTemplateId": "string",  "scheduledFor": "2019-08-24T14:15:22Z",  "pickupStatus": "not_applicable",  "pickupReadyAt": "2019-08-24T14:15:22Z",  "pickedUpAt": "2019-08-24T14:15:22Z",  "pickedUpByStaffUserId": "string",  "refundedAt": "2019-08-24T14:15:22Z",  "refundId": "string",  "refundedSubtotal": 0,  "refundedTaxTotal": 0,  "refundedTotal": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "items": [    {      "id": "string",      "releaseProductId": "string",      "productId": "string",      "sku": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Skip a member shipment and release its inventory

POST
/club-shipments/{id}/skip

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-shipments/string/skip" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{  "id": "string",  "releaseId": "string",  "membershipId": "string",  "status": "draft",  "orderId": "string",  "paymentIntentId": "string",  "providerPaymentIntentId": "string",  "subtotal": 0,  "taxTotal": 0,  "total": 0,  "processingAttempts": 0,  "declineCode": "string",  "declineMessage": "string",  "lastAttemptedAt": "2019-08-24T14:15:22Z",  "processedAt": "2019-08-24T14:15:22Z",  "skippedAt": "2019-08-24T14:15:22Z",  "skipReason": "string",  "subscriptionTemplateId": "string",  "scheduledFor": "2019-08-24T14:15:22Z",  "pickupStatus": "not_applicable",  "pickupReadyAt": "2019-08-24T14:15:22Z",  "pickedUpAt": "2019-08-24T14:15:22Z",  "pickedUpByStaffUserId": "string",  "refundedAt": "2019-08-24T14:15:22Z",  "refundId": "string",  "refundedSubtotal": 0,  "refundedTaxTotal": 0,  "refundedTotal": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "items": [    {      "id": "string",      "releaseProductId": "string",      "productId": "string",      "sku": "string",      "title": "string",      "quantity": 1,      "unitPrice": 0,      "taxRateBps": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

List subscription club templates

GET
/club/{id}/subscription-templates

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club/string/subscription-templates" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "templates": [    {      "id": "string",      "clubId": "string",      "title": "string",      "status": "active",      "locationId": "string",      "cadenceUnit": "week",      "cadenceCount": 1,      "customizationLeadDays": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Create a subscription club template

POST
/club/{id}/subscription-templates

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club/string/subscription-templates" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "locationId": "string",    "cadenceUnit": "week"  }'
{  "id": "string",  "clubId": "string",  "title": "string",  "status": "active",  "locationId": "string",  "cadenceUnit": "week",  "cadenceCount": 1,  "customizationLeadDays": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Add or replace a subscription template product

POST
/club-subscription-templates/{id}/products

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-subscription-templates/string/products" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "productId": "string",    "quantity": 1  }'
{  "id": "string",  "templateId": "string",  "productId": "string",  "sku": "string",  "title": "string",  "quantity": 1,  "minimumQuantity": 0,  "maximumQuantity": 0,  "unitPrice": 0,  "taxRateBps": 0,  "sortOrder": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Set member-specific subscription cadence

PUT
/club-membership/{id}/subscription-schedule

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/club-membership/string/subscription-schedule" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "templateId": "string",    "nextProcessDate": "2019-08-24T14:15:22Z"  }'
null

Generate a release for due subscription members

POST
/club-subscription-templates/{id}/generate-release

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-subscription-templates/string/generate-release" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "processDate": "2019-08-24T14:15:22Z"  }'
{  "template": {    "id": "string",    "clubId": "string",    "title": "string",    "status": "active",    "locationId": "string",    "cadenceUnit": "week",    "cadenceCount": 1,    "customizationLeadDays": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "release": {    "id": "string",    "clubId": "string",    "title": "string",    "status": "planning",    "locationId": "string",    "processDate": "2019-08-24T14:15:22Z",    "customizationDeadline": "2019-08-24T14:15:22Z",    "activatedAt": "2019-08-24T14:15:22Z",    "processingStartedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "archivedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "shipments": [    {      "id": "string",      "releaseId": "string",      "membershipId": "string",      "status": "draft",      "orderId": "string",      "paymentIntentId": "string",      "providerPaymentIntentId": "string",      "subtotal": 0,      "taxTotal": 0,      "total": 0,      "processingAttempts": 0,      "declineCode": "string",      "declineMessage": "string",      "lastAttemptedAt": "2019-08-24T14:15:22Z",      "processedAt": "2019-08-24T14:15:22Z",      "skippedAt": "2019-08-24T14:15:22Z",      "skipReason": "string",      "subscriptionTemplateId": "string",      "scheduledFor": "2019-08-24T14:15:22Z",      "pickupStatus": "not_applicable",      "pickupReadyAt": "2019-08-24T14:15:22Z",      "pickedUpAt": "2019-08-24T14:15:22Z",      "pickedUpByStaffUserId": "string",      "refundedAt": "2019-08-24T14:15:22Z",      "refundId": "string",      "refundedSubtotal": 0,      "refundedTaxTotal": 0,      "refundedTotal": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "items": [        {          "id": "string",          "releaseProductId": "string",          "productId": "string",          "sku": "string",          "title": "string",          "quantity": 1,          "unitPrice": 0,          "taxRateBps": 0,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ]    }  ]}

List club release reminder jobs

GET
/club-releases/{id}/reminders

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-releases/string/reminders" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "jobs": [    null  ],  "total": 0}

Schedule idempotent club release reminder jobs

POST
/club-releases/{id}/reminders

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-releases/string/reminders" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "daysBefore": [      0    ],    "channel": "email",    "reminderType": "customization_open"  }'
{  "jobs": [    null  ],  "total": 0}

Fully or partially refund paid club shipment items

POST
/club-shipments/{id}/refund

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-shipments/string/refund" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string",    "reason": "string"  }'
null

Re-drive a failed club provider payment reversal

POST
/club-payment-reversals/{id}/redrive

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-payment-reversals/string/redrive" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string"  }'
null

List persisted RMAs for a club shipment

GET
/club-shipments/{id}/rmas

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-shipments/string/rmas" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "rmas": [    null  ],  "total": 0}

Authorize physical returns for club shipment items

POST
/club-shipments/{id}/rmas

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/club-shipments/string/rmas" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string",    "reason": "string",    "items": [      {        "shipmentItemId": "string",        "quantity": 1      }    ]  }'
null

Retrieve an RMA with its immutable event history

GET
/club-rmas/{id}

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-rmas/string" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
null

Receive all or part of the authorized items on an RMA

POST
/club-rmas/{id}/receive

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-rmas/string/receive" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string"  }'
null

Cancel an RMA before any return quantity is received

POST
/club-rmas/{id}/cancel

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-rmas/string/cancel" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string"  }'
null

Inspect a received RMA item and assign its disposition

POST
/club-rmas/{id}/inspections

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/club-rmas/string/inspections" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string",    "shipmentItemId": "string",    "quantity": 1,    "disposition": "restock"  }'
null

List return labels and carrier tracking history for an RMA

GET
/club-rmas/{id}/return-labels

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-rmas/string/return-labels" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
null

Persist a carrier return label for an RMA

POST
/club-rmas/{id}/return-labels

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/club-rmas/string/return-labels" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "idempotencyKey": "string",    "carrier": "string",    "trackingNumber": "string",    "labelUrl": "http://example.com"  }'
null

Append an idempotent carrier tracking event

POST
/club-return-labels/{id}/tracking-events

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/club-return-labels/string/tracking-events" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "providerEventId": "string",    "status": "pre_transit",    "occurredAt": "2019-08-24T14:15:22Z"  }'
null

Ingest an idempotent provider card-updater event

POST
/club-card-updater/events

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/club-card-updater/events" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "provider": "string",    "providerEventId": "string",    "eventType": "payment_method.updated",    "membershipId": "string"  }'
null

Receive a signed provider card-updater callback

POST
/club-card-updater/providers/{provider}/events

Path Parameters

provider*string
Length1 <= length <= 64

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

x-club-updater-timestamp?string
x-club-updater-signature?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/club-card-updater/providers/string/events" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{    "providerEventId": "string",    "eventType": "payment_method.updated",    "membershipId": "string"  }'
null

List card-updater outcomes for a club membership

GET
/club-memberships/{id}/card-updater-events

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-memberships/string/card-updater-events" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
null

List immutable sale and reversal facts for a club shipment

GET
/club-shipments/{id}/financial-facts

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-shipments/string/financial-facts" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "facts": [    null  ],  "total": 0}

Record a pickup lifecycle event

POST
/club-shipments/{id}/pickup/{status}

Path Parameters

id*string
status*|||

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/club-shipments/string/pickup/ready" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123" \  -H "Content-Type: application/json" \  -d '{}'
null

List pickup lifecycle events

GET
/club-shipments/{id}/pickup-events

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-shipments/string/pickup-events" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "events": [    null  ],  "total": 0}

List immutable shipment processing history

GET
/club-shipments/{id}/audit

Path Parameters

id*string
Length1 <= length

Header Parameters

x-tenant-id?string

Selects the tenant by id. When both tenant headers are omitted, the server falls back to the configured default tenant slug.

x-tenant-slug?string

Selects the tenant by slug. Use this when you know the tenant slug instead of the tenant id.

x-location-id?string

Adds a location scope to the request for location-aware reads, writes, and audit entries.

x-auth-provider?"hexclave"

Test-only Hexclave provider identifier used with x-auth-user-id when trusted identity headers are explicitly enabled. Production clients must use a Hexclave bearer token.

Value in

  • "hexclave"
x-auth-user-id?string

Temporary auth subject used to resolve the acting staff user through the staff auth identity mapping.

Response Body

application/json

curl -X GET "https://example.com/club-shipments/string/audit" \  -H "x-tenant-id: tenant-local" \  -H "x-tenant-slug: trellis-local" \  -H "x-location-id: loc-tasting-room" \  -H "x-auth-provider: hexclave" \  -H "x-auth-user-id: user_abc123"
{  "attempts": [    null  ],  "events": [    null  ]}

Apps

Previous Page

Platform

Next Page