ConnectCloud Developers

Deactivate a transaction type (tenant:settings:write)

DELETE /api/trade/v1/sales/transaction-types/{code}

Module: Trade · operationId: deactivateTransactionType · Tag: Transaction types · Auth: access token (Authorization: Bearer <accessToken>)

Sets isActive to false; existing transactions keep their type, new ones of this type are refused.

Parameters

Name In Type Required Description
code path string yes Type code (upper-cased when stored).

Responses

  • 200 Deactivated (application/json)
  • 401 No valid session or bearer token (no body).
  • 403 Missing permission, no active tenant in the token, or a missing CSRF token on a cookie write. (application/json)
  • 404 Not found in the tenant. (application/json)

Fields of the 200 answer:

  • status (string, required): Outcome of the request.

Example 200 answer:

{
  "status": "deactivated"
}

Example request

curl -X DELETE 'https://api.mbcom.cloud/api/trade/v1/sales/transaction-types/RETURN' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI