Delete Product Category

The Payiano Delete Product Category endpoint is used when you no longer need a category. For example, if you stop selling children’s clothing, you can use this endpoint to remove the 'Children’s Clothing' category. It’s like removing a shelf in your store that you don’t need anymore. This helps keep your product categories tidy and relevant to what you’re selling now.

DELETE/product_categories/{id}
Sandbox: https://api.payiano.dev/v1/product_categories/{id}
Live: https://api.payiano.com/v1/product_categories/{id}
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission product_categories_delete
Request
Request body schema:
application/json
Path parameters:
id
required
Type: ulid
Length: 26

The unique ID assigned to each product category which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every product category. This ULID is automatically created by our system and is used to uniquely identify and track each product category in our database.

Query parameters:
identify_by
Type: enum|null
Possible values:
[ "id", "reference_id" ]

This attribute specifies which identifier is being used to interact with a resource in the Payiano API. It helps the system understand how to identify resource when processing API requests. By default, the identify_by attribute is set to id, so you only need to specify it if you're using a different identifier.

force_delete
Type: boolean
Default: false

This attribute determines the deletion method to be applied to the product category delete in the database. When the value is set to true, it indicates that the product category should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the product category is not physically removed from the database. With Soft Delete it's still possible to restore the product category record.

Response
200
Response schema:
application/json
Response body:
status
Type: boolean

This value indicates whether the product category delete was successful or not.

Response sample:
1
{ 2 "status": true 3}