Trendsic Platform Service

<back to all web services

ProductsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET/v1/Products/{UserID}
GET,POST,PUT,DELETE,OPTIONS/v1/Products/
ProductsRequest Parameters:
NameParameterData TypeRequiredDescription
UserIDpathGuidNo
ProductsbodyList<Product>No
Product Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ProductNameformstringNo
ProductTypeIDformbyteNo
UnitPriceformdecimalNo
DescriptionformstringNo
ImageURLformstringNo
ImageKeyformstringNo
SpecialSaleTextformstringNo
ShipPriceformdecimalNo
SalePriceformdecimalNo
UIDformGuidNo
ProductCategoryformbyteNo
ProductSubCategoryformbyteNo
ProductWeightformdecimalNo
FreightMarkupPercentformdecimalNo
FreightMarkUpAmountformdecimalNo
PointValueformdecimalNo
IsActiveformboolNo
StripeProductIdformstringNo
ProductsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProductsformList<Product>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	]
}