Paymish Docs
Update product details
- Paymish
- Products
Recommended workflow
1
Authenticate first and inject a valid bearer token or secret key before calling the endpoint.
2
Validate the input data, identifiers, and account state in your application before making the request.
3
Send the PUT request from your backend using the required headers and the expected content type (application/json).
4
Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.
Implementation notes
- Validate the request payload on your backend before sending it, especially the 18 documented body fields.
- Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.
Request Body
Content type: application/json
productId
required
string
The ID of the product to update
Example:
123
productName
required
string
The name of the product
Example:
Updated Product Name
productDescription
required
string
The description of the product
Example:
This is an updated product description.
productPrice
required
string
The price of the product
Example:
150.00
quantityType
required
string
The type of quantity (Limited/Unlimited)
Example:
Limited
quantityStock
required
number
Quantity in stock
Example:
50
minOrder
required
number
Minimum order quantity
Example:
1
maxOrder
required
number
Maximum order quantity
Example:
10
lowStockAlert
required
boolean
Indicates if low stock alerts are enabled
Example:
True
notifyStock
required
number
The stock level at which notifications should be sent
Example:
5
shareableUrl
required
string
The URL that can be shared for the product
Example:
https://example.com/product/123
productBackgroundColor
required
string
The background color for the product
Example:
#FFFFFF
deliveryAddress
required
string
Delivery address option (Disabled/Required)
Example:
Required
deliveryNote
required
string
Delivery note option (Disabled/Required/Optional)
Example:
Optional
redirectAfterPaymentLink
required
string
The link to redirect after payment
Example:
https://example.com/thank-you
successMessage
required
string
The success message to show after the payment
Example:
Thank you for your purchase!
sendNotification
required
string
Notification setting for the product
Example:
email
isActive
required
boolean
Indicates if the product is active
Example:
True
Responses
200
Product details updated successfully
400
Bad request
Expected Outcomes
200
Success example
Product details updated successfully
Representative Response
{
"message": "Product details updated successfully."
}
400
Failure example
Bad request
Representative Error
{
"error": "Bad request"
}
After the response:
- Log the Paymish reference or request context returned by the API so support teams can trace the call later.
- Retry only when the failure is safe to repeat; otherwise correct the payload or auth state first.
- Store enough internal metadata to match the API response back to your order, payout, case, or checkout record.
Language Notes
Python
Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.
Node.js
Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.
PHP
Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.
cURL
Use cURL for smoke testing and debugging, then move the final logic into your backend service code.
Code Examples
Python
import requests
headers = {
"Authorization": "Bearer YOUR_SECRET_KEY",
"Content-Type": "application/json",
}
payload = {
"productId": "123",
"productName": "Updated Product Name",
"productDescription": "This is an updated product description.",
"productPrice": "150.00",
"quantityType": "Limited"
}
response = requests.put(
"https://api.paymish.com/api/payment-service/external/v1/products/update-product-details",
headers=headers,
json=payload,
)
data = response.json()
print(data)
Node.js
const axios = require("axios");
const response = await axios({
method: "put",
url: "https://api.paymish.com/api/payment-service/external/v1/products/update-product-details",
headers: {
Authorization: "Bearer YOUR_SECRET_KEY",
"Content-Type": "application/json",
},
data: {
"productId": "123",
"productName": "Updated Product Name",
"productDescription": "This is an updated product description.",
"productPrice": "150.00",
"quantityType": "Limited"
}
});
console.log(response.data);
cURL
curl https://api.paymish.com/api/payment-service/external/v1/products/update-product-details \
-X PUT \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "productId": "123", "productName": "Updated Product Name", "productDescription": "This is an updated product description.", "productPrice": "150.00", "quantityType": "Limited" }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/payment-service/external/v1/products/update-product-details");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer YOUR_SECRET_KEY",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"productId" => "123",
"productName" => "Updated Product Name",
"productDescription" => "This is an updated product description.",
"productPrice" => "150.00",
"quantityType" => "Limited",
]));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);