List order templates

POST/api/orders/templates/query

Returns the order templates available to the current workspace user.

Request Body

application/json

Request payload for List order templates.

query?|

Free-text query applied to order templates.

showOnlyMyTemplates?|

Whether to return only templates owned by the current user.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/orders/templates/query" \  -H "Content-Type: application/json" \  -d '{}'

[
  {
    "id": "ord_tpl_123",
    "number": "TPL-1024",
    "createdAt": "string",
    "updatedAt": "string",
    "itemsCount": 0,
    "templateVisibility": "workspace",
    "templateOwnerId": "wu_123",
    "templateName": "Pump quote template",
    "note": "string"
  }
]

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

{
  "_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."
}

List order templates

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`