| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET | /v1/Products/{UserID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Products/ |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserID | path | Guid | No | |
| Products | body | List<Product> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| ProductName | form | string | No | |
| ProductTypeID | form | byte | No | |
| UnitPrice | form | decimal | No | |
| Description | form | string | No | |
| ImageURL | form | string | No | |
| ImageKey | form | string | No | |
| SpecialSaleText | form | string | No | |
| ShipPrice | form | decimal | No | |
| SalePrice | form | decimal | No | |
| UID | form | Guid | No | |
| ProductCategory | form | byte | No | |
| ProductSubCategory | form | byte | No | |
| ProductWeight | form | decimal | No | |
| FreightMarkupPercent | form | decimal | No | |
| FreightMarkUpAmount | form | decimal | No | |
| PointValue | form | decimal | No | |
| IsActive | form | bool | No | |
| StripeProductId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Products | form | List<Product> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Products/ HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
UserID: 00000000000000000000000000000000,
Products:
[
{
ID: 0,
ProductName: String,
ProductTypeID: 0,
UnitPrice: 0,
Description: String,
ImageURL: String,
ImageKey: String,
SpecialSaleText: String,
ShipPrice: 0,
SalePrice: 0,
UID: 00000000000000000000000000000000,
ProductCategory: 0,
ProductSubCategory: 0,
ProductWeight: 0,
FreightMarkupPercent: 0,
FreightMarkUpAmount: 0,
PointValue: 0,
IsActive: False,
StripeProductId: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Products:
[
{
ID: 0,
ProductName: String,
ProductTypeID: 0,
UnitPrice: 0,
Description: String,
ImageURL: String,
ImageKey: String,
SpecialSaleText: String,
ShipPrice: 0,
SalePrice: 0,
UID: 00000000000000000000000000000000,
ProductCategory: 0,
ProductSubCategory: 0,
ProductWeight: 0,
FreightMarkupPercent: 0,
FreightMarkUpAmount: 0,
PointValue: 0,
IsActive: False,
StripeProductId: String
}
]
}