Reliefs Docs
Management APIProducts

Update a product draft

Partially updates a product draft — name, description, price, and/or availability. Only specified fields are modified. Requires a management API key (`mk_`).

PATCH
/api/v1/management/restaurants/{restaurantId}/products/{productId}/draft

Authorization

ManagementApiKey
X-Api-Key<token>

Management API key — starts with mk_. Generate one from your dashboard.

In: header

Path Parameters

restaurantId*string

Restaurant ID

Formatuuid
productId*string

Product ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/management/restaurants/497f6eca-6276-4993-bfeb-53cbbbba6f08/products/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "data": {    "product": {      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "restaurantId": "4607f331-b75a-4fe3-8172-582c6c390256",      "parentProductId": "1ffe8af3-a0f6-480d-b0be-350ab24a5fb9",      "publishedVersionId": "9786f1b1-ef7e-4f6a-94c4-c8eb67e924eb",      "nameKey": "string",      "descriptionKey": "string",      "price": 0,      "available": true,      "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",      "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",      "status": "draft",      "notes": "string",      "draftCreatedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "isDraft": true  }}

Get the draft of a product

Returns the draft version of a product. Uses the product ID to find the associated draft. For published products, looks up the draft via the published version. For new (unpublished) products, the product ID is the draft ID. Returns 404 if no draft exists. Requires a management API key (`mk_`).

Delete a product draft

Deletes the draft of a product and cleans up associated resources (images, scans that differ from the published version). Uses the product ID to find the associated draft. The published product is not affected. Requires a management API key (`mk_`).