With this API, you can view, add, edit, and delete products in a project.
Reading.
Allows you to view the created products in the project.
GET https://api.smartsender.com/v1/products
Main parameters:
Name | Description | Validation |
|---|---|---|
page | Requested Page | Minimum value 1 |
limitation | Amount of data to display per page | Minimum value 1, maximum 20 |
In case of a successful response, you will receive the following:
{
"cursor": Cursor,
"collection": Product[]
}
Answer description:
Creation.
Allows you to create a product in a project.
POST https://api.smartsender.com/v1/products
Main parameters:
Name | Description | Validation |
|---|---|---|
name | Name | Unique within the project |
labels | Label ID array |
|
essences | Array of type ProductEssence without temporary values | At least 1 |
paymentSystems | Array of payment systems identifiers |
|
categoryId | Category ID |
|
If successful, get the newly created Product object.
Update.
Allows you to update the selected product in the project.
PUT https://api.smartsender.com/v1/products/{productId}
Main parameters:
Name | Description | Validation |
|---|---|---|
name | Name | Unique within the project |
labels | Label ID array |
|
essences | Array of type ProductEssence without temporary values | At least 1 |
paymentSystems | Array of payment systems identifiers |
|
categoryId | Category ID |
|
If successful, get the newly created Product object.
Deletion.
Allows you to remove an existing product.
DELETE https://api.smartsender.com/v1/products/{productId}
In case of a successful response, you will receive the following:
{
"state": true
}