Guides
API References
- Payment Request
- Recurring Billing
- Charges
- Payout
- Account
- Orders
- Products
- Product Category
- Customers
- Staffs
- Invoice
- Webhook Events
- Static QR Codes
- Notifications
- Terminal
Products
Update the roduct
This endpoint allows you to update the product.
POST
/
v1
/
products
/
{product_id}
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/products/{product_id} \
--header 'Content-Type: multipart/form-data' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--form 'name=Product Beanie' \
--form 'description=<string>' \
--form 'headline=<string>' \
--form quantity=1 \
--form quantity_alert_level=1 \
--form currency=sgd \
--form price=123 \
--form 'category_ids=[
"9a12fab0-d282-4437-9460-c3d26662d11a"
]' \
--form is_manageable=1 \
--form is_pinned=0 \
--form product_weight=123 \
--form delivery_method_required=true \
--form 'existing_variation=[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 123,
"quantity": 123,
"quantity_alert_level": 123,
"product_variation_weight": 123,
"variation_value_1": "<string>",
"variation_value_2": "<string>",
"variation_value_3": "<string>"
}
]' \
--form 'images=[
{}
]' \
--form publish=1 \
--form '_method=<string>'
{
"id": "9a12fab4-d112-48af-9d6b-050d650b0a25",
"business_id": "9130c422-bf97-4bd1-b370-07a3a6f40708",
"category_id": [
"9a12fab0-d282-4437-9460-c3d26662d11a"
],
"name": "Beanie",
"headline": null,
"description": "<p>Stylish hat suitable for the winter.</p>",
"currency": "SGD",
"price": 15,
"price_display": "SGD 15.00",
"price_stored": 1500,
"tax_id": null,
"is_manageable": 1,
"is_pinned": false,
"status": "published",
"product_weight": 250,
"delivery_method_required": true,
"has_variations": true,
"is_shopify": false,
"product_url": "<string>",
"variations_count": 2,
"variations": [
{
"id": "9a12fab4-d998-44ea-ad11-8753be88a1c9",
"stock_keeping_unit": null,
"description": "Medium",
"weight": null,
"length": null,
"width": null,
"depth": null,
"price": 18,
"price_display": "SGD 18.00",
"price_stored": 1800,
"quantity": 150,
"quantity_alert_level": 10,
"product_variation_weight": 250,
"variation_value_1": "Medium",
"variation_value_2": null,
"variation_value_3": null
},
{
"id": "9a12fab4-dd20-4f8f-9e74-de28629f863a",
"stock_keeping_unit": null,
"description": "Large",
"weight": null,
"length": null,
"width": null,
"depth": null,
"price": 20,
"price_display": "SGD 20.00",
"price_stored": 2000,
"quantity": 148,
"quantity_alert_level": 10,
"product_variation_weight": 255,
"variation_value_1": "Large",
"variation_value_2": null,
"variation_value_3": null
}
],
"variation_key_1": "Size",
"variation_key_2": null,
"variation_key_3": null,
"images": [
{
"id": "9a12fab6-1e76-448e-8c45-e84e2e38f294",
"caption": "Beanie",
"url": "<string>",
"other_dimensions": [
{
"size": "icon",
"path": "<string>"
},
{
"size": "large",
"path": "<string>"
},
{
"size": "small",
"path": "<string>"
},
{
"size": "medium",
"path": "<string>"
},
{
"size": "thumbnail",
"path": "<string>"
}
]
}
],
"is_published": true,
"created_at": "2023-09-07T13:04:22+08:00",
"updated_at": "2023-09-18T14:36:54+08:00",
"starts_at": null,
"ends_at": null
}
Headers
Example:
"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"
Path Parameters
Body
multipart/form-data
Response
200
application/json
200
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.sandbox.hit-pay.com/v1/products/{product_id} \
--header 'Content-Type: multipart/form-data' \
--header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
--form 'name=Product Beanie' \
--form 'description=<string>' \
--form 'headline=<string>' \
--form quantity=1 \
--form quantity_alert_level=1 \
--form currency=sgd \
--form price=123 \
--form 'category_ids=[
"9a12fab0-d282-4437-9460-c3d26662d11a"
]' \
--form is_manageable=1 \
--form is_pinned=0 \
--form product_weight=123 \
--form delivery_method_required=true \
--form 'existing_variation=[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 123,
"quantity": 123,
"quantity_alert_level": 123,
"product_variation_weight": 123,
"variation_value_1": "<string>",
"variation_value_2": "<string>",
"variation_value_3": "<string>"
}
]' \
--form 'images=[
{}
]' \
--form publish=1 \
--form '_method=<string>'
{
"id": "9a12fab4-d112-48af-9d6b-050d650b0a25",
"business_id": "9130c422-bf97-4bd1-b370-07a3a6f40708",
"category_id": [
"9a12fab0-d282-4437-9460-c3d26662d11a"
],
"name": "Beanie",
"headline": null,
"description": "<p>Stylish hat suitable for the winter.</p>",
"currency": "SGD",
"price": 15,
"price_display": "SGD 15.00",
"price_stored": 1500,
"tax_id": null,
"is_manageable": 1,
"is_pinned": false,
"status": "published",
"product_weight": 250,
"delivery_method_required": true,
"has_variations": true,
"is_shopify": false,
"product_url": "<string>",
"variations_count": 2,
"variations": [
{
"id": "9a12fab4-d998-44ea-ad11-8753be88a1c9",
"stock_keeping_unit": null,
"description": "Medium",
"weight": null,
"length": null,
"width": null,
"depth": null,
"price": 18,
"price_display": "SGD 18.00",
"price_stored": 1800,
"quantity": 150,
"quantity_alert_level": 10,
"product_variation_weight": 250,
"variation_value_1": "Medium",
"variation_value_2": null,
"variation_value_3": null
},
{
"id": "9a12fab4-dd20-4f8f-9e74-de28629f863a",
"stock_keeping_unit": null,
"description": "Large",
"weight": null,
"length": null,
"width": null,
"depth": null,
"price": 20,
"price_display": "SGD 20.00",
"price_stored": 2000,
"quantity": 148,
"quantity_alert_level": 10,
"product_variation_weight": 255,
"variation_value_1": "Large",
"variation_value_2": null,
"variation_value_3": null
}
],
"variation_key_1": "Size",
"variation_key_2": null,
"variation_key_3": null,
"images": [
{
"id": "9a12fab6-1e76-448e-8c45-e84e2e38f294",
"caption": "Beanie",
"url": "<string>",
"other_dimensions": [
{
"size": "icon",
"path": "<string>"
},
{
"size": "large",
"path": "<string>"
},
{
"size": "small",
"path": "<string>"
},
{
"size": "medium",
"path": "<string>"
},
{
"size": "thumbnail",
"path": "<string>"
}
]
}
],
"is_published": true,
"created_at": "2023-09-07T13:04:22+08:00",
"updated_at": "2023-09-18T14:36:54+08:00",
"starts_at": null,
"ends_at": null
}
Assistant
Responses are generated using AI and may contain mistakes.