Add order requirement template

POST/api/configs/order-requirements/templates

Creates a new order requirement template.

Request Body

application/json

Request payload for Add order requirement template.

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Template identifier.

Example"tmpl_123"

key*string

Stable requirement key.

Example"purchase_order"

title*string

Requirement title shown to users.

Example"Purchase order"

description*string

Requirement help text.

Example"Ask the customer for the purchase order before confirming the sale."

enabled*boolean

Whether the template is active.

Exampletrue

Response Body

`application/json`

curl -X POST "https://example.com/api/configs/order-requirements/templates" \  -H "Content-Type: application/json" \  -d '{    "id": "tmpl_123",    "key": "purchase_order",    "title": "Purchase order",    "description": "Ask the customer for the purchase order before confirming the sale.",    "enabled": 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."}

Add order requirement template

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`