Developer Portal
Breadcrumbs

Deletion & Deactivation of Product

Activation & Deactivation of Product

The product status is controlled by the active flag, which determines whether a product is available for operations. Deactivating a product does not delete it from Mailship; it remains in the system but is unavailable for use.


Activate Product

Sets the product flag active to true.


Request structure

Endpoint:

PUT /api/product/activate/{id}

URL (prod):

https://app.mailship.eu/api/product/activate/{id}

Headers:

Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

None (this request does not require a body).

Request Example (cURL):

curl --location --request PUT "https://app.mailship.eu/api/product/activate/8235e453-c520-47e6-b36c-67a93ecbbf8f" \
--header "Authorization: Bearer {{token}}"

Path parameter:

Parameter

Type

Required

Description

id

string

The unique product identifier. Example: 8235e453-c520-47e6-b36c-67a93ecbbf8f

 

Response

If successful, the API returns 204 No Content.

See more details in the API Doc.



Deactivate Product

Sets the product flag active to false.


Request structure

Endpoint:

PUT /api/product/deactivate/{id}

URL (prod):

https://app.mailship.eu/api/product/deactivate/{id}

Headers:

Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

None (this request does not require a body).

Request Example (cURL):

curl --location --request PUT "https://app.mailship.eu/api/product/deactivate/8235e453-c520-47e6-b36c-67a93ecbbf8f" \
--header "Authorization: Bearer {{token}}"

Path parameter:

Parameter

Type

Required

Description

id

string

The unique product identifier. Example: 8235e453-c520-47e6-b36c-67a93ecbbf8f

 

Response

If successful, the API returns 204 No Content.

See more details in the API Doc.



Activate multiple Products

Sets the active flag of multiple products to true.


Request structure

Endpoint:

PUT /api/product/activate

URL (prod):

https://app.mailship.eu/api/product/activate

Headers:

Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

An array of product IDs for activation.

Request body example:

curl --location --request PUT "https://app.mailship.eu/api/product/activate" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data "{
  \"products\": [
    \"53a5b136-4adf-49ef-8c04-c2a9de54855e\",
    \"411b4c0e-342e-4c83-873f-001393a34f73\",
    \"692b9e15-5b28-47af-86a9-250caf007668\"
  ]
}"


Response

If successful, the API returns 204 No Content.

See more details in the API Doc.



Deactivate multiple Products

Sets the active flag of multiple products to false.


Request structure

Endpoint:

PUT /api/product/deactivate

URL (prod):

https://app.mailship.eu/api/product/deactivate

Headers:

Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Request body:

An array of product IDs for deactivation.

Request body Example:

curl --location --request PUT "https://app.mailship.eu/api/product/deactivate" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data "{
  \"products\": [
    \"53a5b136-4adf-49ef-8c04-c2a9de54855e\",
    \"411b4c0e-342e-4c83-873f-001393a34f73\",
    \"692b9e15-5b28-47af-86a9-250caf007668\"
  ]
}"


Response

If successful, the API returns 204 No Content.

See more details in the API Doc.



Delete Product & Delete multiple Products

A product can only be deleted from Mailship if:

  • It has never been used in stock advice or expedition.

  • It has no recorded movements or stock history.


If you need to delete a product, please contact our customer support team.