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/
"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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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"}]}