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/
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ProductsRequest
    {
        public UUID UserID = null;
        public ArrayList<Product> Products = new ArrayList<Product>();
        
        public UUID getUserID() { return UserID; }
        public ProductsRequest setUserID(UUID value) { this.UserID = value; return this; }
        public ArrayList<Product> getProducts() { return Products; }
        public ProductsRequest setProducts(ArrayList<Product> value) { this.Products = value; return this; }
    }

    public static class Product
    {
        public Integer ID = null;
        public String ProductName = null;
        public Short ProductTypeID = null;
        public BigDecimal UnitPrice = null;
        public String Description = null;
        public String ImageURL = null;
        public String ImageKey = null;
        public String SpecialSaleText = null;
        public BigDecimal ShipPrice = null;
        public BigDecimal SalePrice = null;
        public UUID UID = null;
        public Short ProductCategory = null;
        public Short ProductSubCategory = null;
        public BigDecimal ProductWeight = null;
        public BigDecimal FreightMarkupPercent = null;
        public BigDecimal FreightMarkUpAmount = null;
        public BigDecimal PointValue = null;
        public Boolean IsActive = null;
        public String StripeProductId = null;
        
        public Integer getId() { return ID; }
        public Product setId(Integer value) { this.ID = value; return this; }
        public String getProductName() { return ProductName; }
        public Product setProductName(String value) { this.ProductName = value; return this; }
        public Short getProductTypeID() { return ProductTypeID; }
        public Product setProductTypeID(Short value) { this.ProductTypeID = value; return this; }
        public BigDecimal getUnitPrice() { return UnitPrice; }
        public Product setUnitPrice(BigDecimal value) { this.UnitPrice = value; return this; }
        public String getDescription() { return Description; }
        public Product setDescription(String value) { this.Description = value; return this; }
        public String getImageURL() { return ImageURL; }
        public Product setImageURL(String value) { this.ImageURL = value; return this; }
        public String getImageKey() { return ImageKey; }
        public Product setImageKey(String value) { this.ImageKey = value; return this; }
        public String getSpecialSaleText() { return SpecialSaleText; }
        public Product setSpecialSaleText(String value) { this.SpecialSaleText = value; return this; }
        public BigDecimal getShipPrice() { return ShipPrice; }
        public Product setShipPrice(BigDecimal value) { this.ShipPrice = value; return this; }
        public BigDecimal getSalePrice() { return SalePrice; }
        public Product setSalePrice(BigDecimal value) { this.SalePrice = value; return this; }
        public UUID getUid() { return UID; }
        public Product setUid(UUID value) { this.UID = value; return this; }
        public Short getProductCategory() { return ProductCategory; }
        public Product setProductCategory(Short value) { this.ProductCategory = value; return this; }
        public Short getProductSubCategory() { return ProductSubCategory; }
        public Product setProductSubCategory(Short value) { this.ProductSubCategory = value; return this; }
        public BigDecimal getProductWeight() { return ProductWeight; }
        public Product setProductWeight(BigDecimal value) { this.ProductWeight = value; return this; }
        public BigDecimal getFreightMarkupPercent() { return FreightMarkupPercent; }
        public Product setFreightMarkupPercent(BigDecimal value) { this.FreightMarkupPercent = value; return this; }
        public BigDecimal getFreightMarkUpAmount() { return FreightMarkUpAmount; }
        public Product setFreightMarkUpAmount(BigDecimal value) { this.FreightMarkUpAmount = value; return this; }
        public BigDecimal getPointValue() { return PointValue; }
        public Product setPointValue(BigDecimal value) { this.PointValue = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public Product setIsActive(Boolean value) { this.IsActive = value; return this; }
        public String getStripeProductId() { return StripeProductId; }
        public Product setStripeProductId(String value) { this.StripeProductId = value; return this; }
    }

    public static class ProductsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<Product> Products = new ArrayList<Product>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ProductsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<Product> getProducts() { return Products; }
        public ProductsResponse setProducts(ArrayList<Product> value) { this.Products = value; return this; }
    }

}

Java ProductsRequest DTOs

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

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