Skip to content

DELETE   /merchants/{merchantId}

Delete a merchant by ID

Soft deletes a specific merchant by its ID (marks as closed)

Authentication Required

Authorization: Bearer {token}   header string

This header is required to access this endpoint

Required Parameters

merchantId   path integer

The ID of the merchant to delete

Optional Parameters

Click here to view an exhaustive list of all available parameters
x-account-id   header string

The account ID for the request

Try it out

Loading...

Output:

Responses

Description

Merchant deleted successfully

{
"message": "Merchant deleted successfully"
}

References

#/components/parameters/xAccountIdHeader

in: header
name: x-account-id
schema:
type: string
description: The account ID for the request
required: false

Route Source Code

Check out the source code for this route entrypoint here: /merchants/[merchantId]/route.ts

Or the swagger.yaml spec this documentation was generated from: /merchants/swagger.yaml