GuideLab API
Products

Partially update a product

Partially update a product's flags such as isHidden, isActive, or sortOrder. Supports action-based toggles (toggleHidden, toggleActive) or direct field updates.

PATCH
/products/{id}

Partially update a product's flags such as isHidden, isActive, or sortOrder. Supports action-based toggles (toggleHidden, toggleActive) or direct field updates.

Authorization

__Secure-guidelab-prod.session_token<token>

Production session cookie set for the guidelab.co domain by Better Auth

In: cookie

Path Parameters

id*string

Product ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/products/550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{}'
{  "product": {    "id": "string",    "labId": "string",    "categoryId": "string",    "standardId": "string",    "treatmentPhaseId": "string",    "name": "string",    "sku": "string",    "description": "string",    "defaultPrice": "string",    "cogs": "string",    "pricingUnit": "string",    "turnaroundDays": 0,    "weight": "string",    "minTeethCount": 0,    "maxTeethCount": 0,    "shadeEnabled": true,    "implantSpecRequired": true,    "archSelection": "string",    "bothArchesOnly": true,    "hideOdontogram": true,    "odontogramMode": "string",    "configuratorType": "single_page",    "quantityEnabled": true,    "autoAddToCart": true,    "upfrontPayment": true,    "isHidden": true,    "useProgressBar": true,    "fulfillmentMode": "physical",    "isActive": true,    "sortOrder": 0,    "laboratoryCode": "string",    "laboratoryDescription": "string",    "imageKey": "string",    "triggerRules": null,    "treatmentPhaseName": "string",    "treatmentPhaseSortOrder": 0,    "treatmentPhaseStartPolicy": "string",    "treatmentPhaseLeadTimeDays": 0,    "createdAt": "string",    "updatedAt": "string"  }}
Empty
Empty
Empty
Empty

List recent custom field templates GET

Return up to 100 of the most recently added custom field templates across the authenticated lab's products, deduped by (label, fieldType). Used by the product editor's Quick Add picker.

Update a product PUT

Update an existing product's properties, materials, file requirements, inventory requirements, and custom fields. File requirements referenced by existing files are soft-deleted (archived) rather than permanently removed.