Set product document technical specifications flag

Updates whether a product document should be treated as technical specifications.

PATCH/api/products/{productId}/documents/{fileId}/tech-specs

Updates whether a product document should be treated as technical specifications.

Path Parameters

productId*string

Product identifier.

Example"prod_123"

fileId*string

File identifier.

Example"file_123"

Request Body

application/json

Request payload for Set product document technical specifications flag.

TypeScript Definitions

Use the request body type in TypeScript.

value*boolean

Whether the document should be flagged as a technical specification.

Exampletrue

Response Body

`application/json`

curl -X PATCH "https://example.com/api/products/prod_123/documents/file_123/tech-specs" \  -H "Content-Type: application/json" \  -d '{    "value": true  }'

{  "success": true}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Set product document technical specifications flag

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`