TrellisDevelopers
API reference

Coupons

List coupons

GET
/coupon

Exact Commerce7 parity for the Coupons API.

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/coupon" \  -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"
{  "coupons": [    {      "id": "string",      "code": "string",      "title": "string",      "actionMessage": "string",      "usageLimitType": "string",      "usageLimit": 0,      "appliesTo": "string",      "appliesToObjectIds": [        "string"      ],      "productDiscountType": "string",      "productDiscount": 0,      "shippingDiscountType": "string",      "shippingDiscount": 0,      "startDate": "string",      "endDate": "string",      "status": "string",      "minimumCartAmount": 0,      "availableTo": "string",      "availableToObjectIds": [        "string"      ],      "combinability": "combinable",      "requiresManagerApproval": true,      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "maxDiscountAmount": 0,      "createdAt": "string",      "updatedAt": "string",      "promotionSets": [        null      ]    }  ],  "total": 0}

Create coupon

POST
/coupon

Exact Commerce7 parity for the Coupons API.

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/coupon" \  -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"  }'
{  "id": "string",  "code": "string",  "title": "string",  "actionMessage": "string",  "usageLimitType": "string",  "usageLimit": 0,  "appliesTo": "string",  "appliesToObjectIds": [    "string"  ],  "productDiscountType": "string",  "productDiscount": 0,  "shippingDiscountType": "string",  "shippingDiscount": 0,  "startDate": "string",  "endDate": "string",  "status": "string",  "minimumCartAmount": 0,  "availableTo": "string",  "availableToObjectIds": [    "string"  ],  "combinability": "combinable",  "requiresManagerApproval": true,  "excludesServiceCharges": true,  "serviceChargeInteraction": "pre_discount",  "maxDiscountAmount": 0,  "createdAt": "string",  "updatedAt": "string",  "promotionSets": [    null  ]}

Retrieve coupon

GET
/coupon/{id}

Exact Commerce7 parity for the Coupons API.

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/coupon/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",  "code": "string",  "title": "string",  "actionMessage": "string",  "usageLimitType": "string",  "usageLimit": 0,  "appliesTo": "string",  "appliesToObjectIds": [    "string"  ],  "productDiscountType": "string",  "productDiscount": 0,  "shippingDiscountType": "string",  "shippingDiscount": 0,  "startDate": "string",  "endDate": "string",  "status": "string",  "minimumCartAmount": 0,  "availableTo": "string",  "availableToObjectIds": [    "string"  ],  "combinability": "combinable",  "requiresManagerApproval": true,  "excludesServiceCharges": true,  "serviceChargeInteraction": "pre_discount",  "maxDiscountAmount": 0,  "createdAt": "string",  "updatedAt": "string",  "promotionSets": [    null  ]}

Delete coupon

DELETE
/coupon/{id}

Exact Commerce7 parity for the Coupons API.

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/coupon/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 coupon

PUT
/coupon/{id}

Exact Commerce7 parity for the Coupons API.

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/coupon/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",  "code": "string",  "title": "string",  "actionMessage": "string",  "usageLimitType": "string",  "usageLimit": 0,  "appliesTo": "string",  "appliesToObjectIds": [    "string"  ],  "productDiscountType": "string",  "productDiscount": 0,  "shippingDiscountType": "string",  "shippingDiscount": 0,  "startDate": "string",  "endDate": "string",  "status": "string",  "minimumCartAmount": 0,  "availableTo": "string",  "availableToObjectIds": [    "string"  ],  "combinability": "combinable",  "requiresManagerApproval": true,  "excludesServiceCharges": true,  "serviceChargeInteraction": "pre_discount",  "maxDiscountAmount": 0,  "createdAt": "string",  "updatedAt": "string",  "promotionSets": [    null  ]}

List coupons

GET
/coupons

Exact Commerce7 parity for the Coupons API.

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/coupons" \  -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"
{  "coupons": [    {      "id": "string",      "code": "string",      "title": "string",      "actionMessage": "string",      "usageLimitType": "string",      "usageLimit": 0,      "appliesTo": "string",      "appliesToObjectIds": [        "string"      ],      "productDiscountType": "string",      "productDiscount": 0,      "shippingDiscountType": "string",      "shippingDiscount": 0,      "startDate": "string",      "endDate": "string",      "status": "string",      "minimumCartAmount": 0,      "availableTo": "string",      "availableToObjectIds": [        "string"      ],      "combinability": "combinable",      "requiresManagerApproval": true,      "excludesServiceCharges": true,      "serviceChargeInteraction": "pre_discount",      "maxDiscountAmount": 0,      "createdAt": "string",      "updatedAt": "string",      "promotionSets": [        null      ]    }  ],  "total": 0}

Create coupon

POST
/coupons

Exact Commerce7 parity for the Coupons API.

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/coupons" \  -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"  }'
{  "id": "string",  "code": "string",  "title": "string",  "actionMessage": "string",  "usageLimitType": "string",  "usageLimit": 0,  "appliesTo": "string",  "appliesToObjectIds": [    "string"  ],  "productDiscountType": "string",  "productDiscount": 0,  "shippingDiscountType": "string",  "shippingDiscount": 0,  "startDate": "string",  "endDate": "string",  "status": "string",  "minimumCartAmount": 0,  "availableTo": "string",  "availableToObjectIds": [    "string"  ],  "combinability": "combinable",  "requiresManagerApproval": true,  "excludesServiceCharges": true,  "serviceChargeInteraction": "pre_discount",  "maxDiscountAmount": 0,  "createdAt": "string",  "updatedAt": "string",  "promotionSets": [    null  ]}

Retrieve coupon

GET
/coupons/{id}

Exact Commerce7 parity for the Coupons API.

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/coupons/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",  "code": "string",  "title": "string",  "actionMessage": "string",  "usageLimitType": "string",  "usageLimit": 0,  "appliesTo": "string",  "appliesToObjectIds": [    "string"  ],  "productDiscountType": "string",  "productDiscount": 0,  "shippingDiscountType": "string",  "shippingDiscount": 0,  "startDate": "string",  "endDate": "string",  "status": "string",  "minimumCartAmount": 0,  "availableTo": "string",  "availableToObjectIds": [    "string"  ],  "combinability": "combinable",  "requiresManagerApproval": true,  "excludesServiceCharges": true,  "serviceChargeInteraction": "pre_discount",  "maxDiscountAmount": 0,  "createdAt": "string",  "updatedAt": "string",  "promotionSets": [    null  ]}

Delete coupon

DELETE
/coupons/{id}

Exact Commerce7 parity for the Coupons API.

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/coupons/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 coupon

PUT
/coupons/{id}

Exact Commerce7 parity for the Coupons API.

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/coupons/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",  "code": "string",  "title": "string",  "actionMessage": "string",  "usageLimitType": "string",  "usageLimit": 0,  "appliesTo": "string",  "appliesToObjectIds": [    "string"  ],  "productDiscountType": "string",  "productDiscount": 0,  "shippingDiscountType": "string",  "shippingDiscount": 0,  "startDate": "string",  "endDate": "string",  "status": "string",  "minimumCartAmount": 0,  "availableTo": "string",  "availableToObjectIds": [    "string"  ],  "combinability": "combinable",  "requiresManagerApproval": true,  "excludesServiceCharges": true,  "serviceChargeInteraction": "pre_discount",  "maxDiscountAmount": 0,  "createdAt": "string",  "updatedAt": "string",  "promotionSets": [    null  ]}

Collections

Previous Page

Customers

Next Page