On this page:
https://api.premepay.com/v1/stores/:id/products
Follow the route to requisition and create a new product to use in your sales. It is possible to sell your products individually or associate them with Subscription Plans.
| Parameter | Type | Description | Required |
|---|---|---|---|
name |
string | Product name | Yes |
description |
string | Description | No |
unitPrice |
decimal | Unit price | No |
currency |
string | Currency | No |
shippable |
boolean | If deliverable/physical | 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> 💡 Detail: You can associate up to 5 images per Product at the time of registration.
</aside>
This is an example of how your request to register a product should look like.
This is the answer for cases where your request is successful.
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/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" width="40px" /> DELETE - Delete 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 products list
</aside>
