Save order requirements settings

PUT/api/unstable/configs/order-requirements

Replaces the order requirements configuration for the current workspace.

Request Body

application/json

enabled*boolean

Whether order requirements are enabled globally.

Exampletrue

templates*array<>

Configured requirement templates.

Example

[
  {
    "id": "tmpl_123",
    "key": "purchase_order",
    "title": "Purchase order",
    "description": "Ask the customer for the purchase order before confirming the sale.",
    "enabled": true
  }
]

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/unstable/configs/order-requirements" \  -H "Content-Type: application/json" \  -d '{    "enabled": true,    "templates": [      {        "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
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Save order requirements settings

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`