curl --request PATCH \
--url https://api.cashful.africa/api/canary/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"sku": "PROD-001"
}
}
'{
"id": "product_001",
"merchantId": "merchant_456",
"name": "Airtime",
"description": "Mobile phone airtime",
"amount": 5000,
"currency": "ZAR",
"active": true,
"imageId": "file_abc123xyz",
"imageUrl": "https://my-bucket.s3.af-south-1.amazonaws.com/merchant_123/1736951234567-a1b2c3-airtime.png",
"metadata": {
"category": "telecom",
"provider": "vodacom"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}Updates a product’s name, description, or metadata
curl --request PATCH \
--url https://api.cashful.africa/api/canary/products/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": {
"sku": "PROD-001"
}
}
'{
"id": "product_001",
"merchantId": "merchant_456",
"name": "Airtime",
"description": "Mobile phone airtime",
"amount": 5000,
"currency": "ZAR",
"active": true,
"imageId": "file_abc123xyz",
"imageUrl": "https://my-bucket.s3.af-south-1.amazonaws.com/merchant_123/1736951234567-a1b2c3-airtime.png",
"metadata": {
"category": "telecom",
"provider": "vodacom"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The unique identifier of the product
Product update details
Optional custom metadata
{ "sku": "PROD-001" }The name of the product
A description of the product
The price of the product in the smallest currency unit
Whether the product is active
The ID of the product image file
Product updated successfully
Unique identifier
{ "sku": "PROD-001" }The ID of the product image file
The public URL of the product image