Delete Product Brand

The Payiano delete product brand endpoint facilitates the removal of brands that no longer align with a business's strategic direction, product portfolio, or market presence. This capability is important for keeping the brand portfolio relevant and focused, ensuring that only those brands that contribute to the business's goals and meet customer needs are maintained. By allowing for the tidying of the brand catalog, businesses can avoid diluting their brand equity and can concentrate resources on nurturing and growing brands with the greatest potential for success.

DELETE/product_brands/{id}

Sandbox: https://api.payiano.dev/v1/product_brands/{id}

Live: https://api.payiano.com/v1/product_brands/{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_brands_delete

Request

Request body schema:

application/json

Path parameters:

required

Type: ulid

Length: 26

The unique ID assigned to each product brand 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 brand. This ULID is automatically created by our system and is used to uniquely identify and track each product brand 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 brand delete in the database. When the value is set to true, it indicates that the product brand 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 brand is not physically removed from the database. With Soft Delete it's still possible to restore the product brand record.

Response

200

Response schema:

application/json

Response body:

status

Type: boolean

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

Response sample:

1
{ 2 "status": true 3}