Product management.
Create product
Create product.
The page API REST Tip does not exist.
1. Request
POST /<api-version>/products.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Request Body
New product attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| name | x | string | - | Product name |
| templateId | x | string | - | Product default template. |
| public | boolean | false | True if product is visible to other users. | |
| description | string | null | Products description |
The page Spacer does not exist.
3. Response Status
The page API HTTP Response - Get does not exist.
4. Response Body
The string ID of a created product.
5. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
product |
x | object | - |
Products details to create |
| →name | x | string | - | Product name |
| →templateId | x | string | - | Product default template. |
| →public | boolean | false | True if product is visible to other users. | |
| →description | string | null | Product description |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
x | string | - |
Created product ID |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get product details
Get product information by the ID.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/product/<productId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
productId |
x | string | - |
Product Id. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Product attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | x | string | - | Product Id. |
| name | x | string | - | Product name |
| templateId | x | string | - | Product default template. |
| public | x | boolean | - | True if product is visible to other users. |
| description | string | null | Product description |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client. | |
|
productId |
x | string | - |
Product id. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client. | |
|
result |
object | null |
Product details. |
|
| →name | x | string | - | Product name. |
| →templateId | x | string | - | Product default template. |
| →public | x | boolean | - | True if product is visible to other users. |
| →description | string | null | Product description. |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get products
Obtain list of products.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/products.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Array with products information:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | x | string | - | Product Id. |
| name | x | string | - | Product name |
| templateId | x | string | - | Product default template. |
| public | x | boolean | - | True if product is visible to other users. |
| description | string | null | Product description |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client. | |
|
result |
array | null |
Products array. |
|
| →name | x | string | - | Product name. |
| →templateId | x | string | - | Product default template. |
| →public | x | boolean | - | True if product is visible to other users. |
| →description | string | null | Product description. |
3. Example
The page API Mosquitto does not exist.
Request
Response
Delete product
Delete product by ID.
The page API REST Tip does not exist.
1. Resource URL
DELETE /<api-version>/products/<productId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
productId |
x | string | - |
Product Id. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Update does not exist.
3. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
productId |
x | string | - |
Product Id. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request |
3. Example
The page API Mosquitto does not exist.
Request
Response
Page: Serial Numbers