TrellisDevelopers
API reference

Products

List products

GET
/product

Exact Commerce7-style product list path.

Query Parameters

q?string
updatedAt?string
webStatus?string
adminStatus?string
collectionId?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/product" \  -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",      "title": "string",      "subTitle": "string",      "image": "string",      "type": "string",      "departmentId": "string",      "vendorId": "string",      "teaser": "string",      "content": "string",      "webStatus": "Available",      "adminStatus": "Available",      "slug": "string",      "metaData": {        "property1": null,        "property2": null      },      "productTemplateId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "images": [        {          "id": "string",          "src": "string",          "sortOrder": 0        }      ],      "bundleItems": [        null      ],      "variants": [        {          "id": "string",          "title": "string",          "sku": "string",          "upcCode": "string",          "volumeInML": 0,          "costOfGood": 0,          "price": 0,          "comparePrice": 0,          "bottleDeposit": 0,          "sortOrder": 0,          "hasInventory": true,          "inventoryPolicy": "string",          "hasShipping": true,          "taxType": "string",          "weight": 0,          "inventory": [            {              "reserveCount": 0,              "allocatedCount": 0,              "productVariantId": "string",              "inventoryLocationId": "string",              "availableForSaleCount": 0            }          ]        }      ],      "security": {        "availableTo": "string"      }    }  ],  "total": 0}

Create product

POST
/product

Exact Commerce7-style product creation path.

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/product" \  -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",    "type": "string",    "variants": [      {        "title": "string",        "sku": "string",        "price": 0      }    ]  }'
{  "id": "string",  "title": "string",  "subTitle": "string",  "image": "string",  "type": "string",  "departmentId": "string",  "vendorId": "string",  "teaser": "string",  "content": "string",  "webStatus": "Available",  "adminStatus": "Available",  "slug": "string",  "metaData": {    "property1": null,    "property2": null  },  "productTemplateId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "images": [    {      "id": "string",      "src": "string",      "sortOrder": 0    }  ],  "bundleItems": [    null  ],  "variants": [    {      "id": "string",      "title": "string",      "sku": "string",      "upcCode": "string",      "volumeInML": 0,      "costOfGood": 0,      "price": 0,      "comparePrice": 0,      "bottleDeposit": 0,      "sortOrder": 0,      "hasInventory": true,      "inventoryPolicy": "string",      "hasShipping": true,      "taxType": "string",      "weight": 0,      "inventory": [        {          "reserveCount": 0,          "allocatedCount": 0,          "productVariantId": "string",          "inventoryLocationId": "string",          "availableForSaleCount": 0        }      ]    }  ],  "security": {    "availableTo": "string"  }}

Retrieve product

GET
/product/{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/product/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",  "subTitle": "string",  "image": "string",  "type": "string",  "departmentId": "string",  "vendorId": "string",  "teaser": "string",  "content": "string",  "webStatus": "Available",  "adminStatus": "Available",  "slug": "string",  "metaData": {    "property1": null,    "property2": null  },  "productTemplateId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "images": [    {      "id": "string",      "src": "string",      "sortOrder": 0    }  ],  "bundleItems": [    null  ],  "variants": [    {      "id": "string",      "title": "string",      "sku": "string",      "upcCode": "string",      "volumeInML": 0,      "costOfGood": 0,      "price": 0,      "comparePrice": 0,      "bottleDeposit": 0,      "sortOrder": 0,      "hasInventory": true,      "inventoryPolicy": "string",      "hasShipping": true,      "taxType": "string",      "weight": 0,      "inventory": [        {          "reserveCount": 0,          "allocatedCount": 0,          "productVariantId": "string",          "inventoryLocationId": "string",          "availableForSaleCount": 0        }      ]    }  ],  "security": {    "availableTo": "string"  }}

Delete product

DELETE
/product/{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/product/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 product

PUT
/product/{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/product/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",  "subTitle": "string",  "image": "string",  "type": "string",  "departmentId": "string",  "vendorId": "string",  "teaser": "string",  "content": "string",  "webStatus": "Available",  "adminStatus": "Available",  "slug": "string",  "metaData": {    "property1": null,    "property2": null  },  "productTemplateId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "images": [    {      "id": "string",      "src": "string",      "sortOrder": 0    }  ],  "bundleItems": [    null  ],  "variants": [    {      "id": "string",      "title": "string",      "sku": "string",      "upcCode": "string",      "volumeInML": 0,      "costOfGood": 0,      "price": 0,      "comparePrice": 0,      "bottleDeposit": 0,      "sortOrder": 0,      "hasInventory": true,      "inventoryPolicy": "string",      "hasShipping": true,      "taxType": "string",      "weight": 0,      "inventory": [        {          "reserveCount": 0,          "allocatedCount": 0,          "productVariantId": "string",          "inventoryLocationId": "string",          "availableForSaleCount": 0        }      ]    }  ],  "security": {    "availableTo": "string"  }}

List wine appellations

GET
/wine-appellation

Commerce7 exact parity for the wine appellations reference list. Returns the standard appellation collection and total count.

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/wine-appellation" \  -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"
{  "wineAppellations": [    {      "id": "string",      "countryCode": "st",      "region": "string",      "appellation": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

List wine varietals

GET
/wine-varietal

Commerce7 exact parity for the wine varietals reference list. Returns the standard varietal collection and total count.

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/wine-varietal" \  -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"
{  "wineVarietals": [    {      "id": "string",      "type": "string",      "varietal": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Payments

Previous Page

Promotions

Next Page