On this page:
https://api.premepay.com/stores/:id/products/:id
| Parameter | Type | Description | Required |
|---|---|---|---|
name |
string | Product's name | Yes |
description |
string | Description | No |
unitPrice |
decimal | Unit price | No |
currency |
string | Currency | No |
shippable |
boolean | Physical product or not | No |
unitLabel |
string | Label Description | No |
status |
string | Product Registration Status (Active, Disabled, Deleted) | No |
url |
string | Internet | No |
metadata |
dictionary<key, value> | Used to save miscellaneous information in dictionary format <key, value> | No |
packageDimension |
object | No | |
height |
decimal | Height | |
length |
decimal | Length | |
weight |
decimal | Weight | |
width |
decimal | Width | |
images |
array<object> | ||
encodedFile |
data:application/pdf;base64,base64code | File in base64 format | No |
description |
string | Brief description of the Product image | No |
<aside> 💡 Important: This endpoint only updates Product data and adds new images. For an image already registered, it is necessary to delete it and upload the new desired image. Learn more at DELETE - Delete product image.
</aside>
<aside> 💡 Detail: You can associate up to 5 images per Product.
</aside>
This is an example of what your request to authenticate might look like.
If your request is successful, you will receive the return of the updated Product object.
If your request has invalid creation parameters - for example, specifying an invalid field or value - you may receive an error response. Below is the complete list of possible error responses:
Related Content
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Create product
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - Get product list
</aside>
