| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET | /v1/Products/{UserID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Products/ |
"use strict";
export class Product {
/** @param {{ID?:number,ProductName?:string,ProductTypeID?:number,UnitPrice?:number,Description?:string,ImageURL?:string,ImageKey?:string,SpecialSaleText?:string,ShipPrice?:number,SalePrice?:number,UID?:string,ProductCategory?:number,ProductSubCategory?:number,ProductWeight?:number,FreightMarkupPercent?:number,FreightMarkUpAmount?:number,PointValue?:number,IsActive?:boolean,StripeProductId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ID;
/** @type {string} */
ProductName;
/** @type {number} */
ProductTypeID;
/** @type {number} */
UnitPrice;
/** @type {string} */
Description;
/** @type {string} */
ImageURL;
/** @type {string} */
ImageKey;
/** @type {string} */
SpecialSaleText;
/** @type {number} */
ShipPrice;
/** @type {number} */
SalePrice;
/** @type {string} */
UID;
/** @type {number} */
ProductCategory;
/** @type {number} */
ProductSubCategory;
/** @type {number} */
ProductWeight;
/** @type {number} */
FreightMarkupPercent;
/** @type {number} */
FreightMarkUpAmount;
/** @type {number} */
PointValue;
/** @type {boolean} */
IsActive;
/** @type {string} */
StripeProductId;
}
export class ProductsResponse {
/** @param {{ResponseStatus?:ResponseStatus,Products?:Product[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Product[]} */
Products = [];
}
export class ProductsRequest {
/** @param {{UserID?:string,Products?:Product[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
UserID;
/** @type {Product[]} */
Products = [];
}
JavaScript ProductsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<ProductsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Products>
<Product>
<Description>String</Description>
<FreightMarkUpAmount>0</FreightMarkUpAmount>
<FreightMarkupPercent>0</FreightMarkupPercent>
<ID>0</ID>
<ImageKey>String</ImageKey>
<ImageURL>String</ImageURL>
<IsActive>false</IsActive>
<PointValue>0</PointValue>
<ProductCategory>0</ProductCategory>
<ProductName>String</ProductName>
<ProductSubCategory>0</ProductSubCategory>
<ProductTypeID>0</ProductTypeID>
<ProductWeight>0</ProductWeight>
<SalePrice>0</SalePrice>
<ShipPrice>0</ShipPrice>
<SpecialSaleText>String</SpecialSaleText>
<StripeProductId>String</StripeProductId>
<UID>00000000-0000-0000-0000-000000000000</UID>
<UnitPrice>0</UnitPrice>
</Product>
</Products>
<UserID>00000000-0000-0000-0000-000000000000</UserID>
</ProductsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Products>
<Product>
<Description>String</Description>
<FreightMarkUpAmount>0</FreightMarkUpAmount>
<FreightMarkupPercent>0</FreightMarkupPercent>
<ID>0</ID>
<ImageKey>String</ImageKey>
<ImageURL>String</ImageURL>
<IsActive>false</IsActive>
<PointValue>0</PointValue>
<ProductCategory>0</ProductCategory>
<ProductName>String</ProductName>
<ProductSubCategory>0</ProductSubCategory>
<ProductTypeID>0</ProductTypeID>
<ProductWeight>0</ProductWeight>
<SalePrice>0</SalePrice>
<ShipPrice>0</ShipPrice>
<SpecialSaleText>String</SpecialSaleText>
<StripeProductId>String</StripeProductId>
<UID>00000000-0000-0000-0000-000000000000</UID>
<UnitPrice>0</UnitPrice>
</Product>
</Products>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ProductsResponse>