GET api/Product?APIKey={APIKey}&ClientId={ClientId}&ProductCode={ProductCode}&CustomColumns={CustomColumns}

Request Information

URI Parameters

Name	Type	Additional information
APIKey	string	Required
ClientId	string	Required
ProductCode	string	Required
CustomColumns	string	Default value is

Body Parameters

None.

Response Information

Resource Description

ProductRequest

Name	Description	Type	Additional information
Product		Product	None.

Response Formats

application/json, text/json

Sample:

{
  "Product": {
    "Id": "2245bc78-a38d-4592-afbf-6fe708a73b57",
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Company": "sample string 4",
    "Description": "sample string 5",
    "Taxable": true,
    "ApplyFreight": true,
    "MemberPrice": 8.0,
    "NonMemberPrice": 9.0,
    "ProductType": 1,
    "WebCategory": "sample string 10",
    "Custom": {
      "Attribute": [
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        },
        {
          "Type": 0,
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3"
        }
      ]
    },
    "Prices": {
      "Price": [
        {
          "Name": "sample string 1",
          "Valueminimum": 2.0,
          "Valuemaximum": 3.0,
          "Startdate": "2024-11-21T11:20:27.4701821+00:00",
          "Enddate": "2024-11-21T11:20:27.4701821+00:00",
          "Pricepercent": 6.0
        },
        {
          "Name": "sample string 1",
          "Valueminimum": 2.0,
          "Valuemaximum": 3.0,
          "Startdate": "2024-11-21T11:20:27.4701821+00:00",
          "Enddate": "2024-11-21T11:20:27.4701821+00:00",
          "Pricepercent": 6.0
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<ProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Product">
  <Product>
    <ApplyFreight>true</ApplyFreight>
    <Code>sample string 2</Code>
    <Company>sample string 4</Company>
    <Custom>
      <Attribute xmlns:d4p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity">
        <d4p1:Attribute>
          <d4p1:FormattedValue>sample string 3</d4p1:FormattedValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Type>text</d4p1:Type>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Attribute>
        <d4p1:Attribute>
          <d4p1:FormattedValue>sample string 3</d4p1:FormattedValue>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Type>text</d4p1:Type>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Attribute>
      </Attribute>
    </Custom>
    <Description>sample string 5</Description>
    <Id>2245bc78-a38d-4592-afbf-6fe708a73b57</Id>
    <MemberPrice>8</MemberPrice>
    <Name>sample string 3</Name>
    <NonMemberPrice>9</NonMemberPrice>
    <Prices xmlns:d3p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.Event">
      <d3p1:Price>
        <d3p1:Price>
          <d3p1:Enddate>2024-11-21T11:20:27.4701821+00:00</d3p1:Enddate>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Pricepercent>6</d3p1:Pricepercent>
          <d3p1:Startdate>2024-11-21T11:20:27.4701821+00:00</d3p1:Startdate>
          <d3p1:Valuemaximum>3</d3p1:Valuemaximum>
          <d3p1:Valueminimum>2</d3p1:Valueminimum>
        </d3p1:Price>
        <d3p1:Price>
          <d3p1:Enddate>2024-11-21T11:20:27.4701821+00:00</d3p1:Enddate>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Pricepercent>6</d3p1:Pricepercent>
          <d3p1:Startdate>2024-11-21T11:20:27.4701821+00:00</d3p1:Startdate>
          <d3p1:Valuemaximum>3</d3p1:Valuemaximum>
          <d3p1:Valueminimum>2</d3p1:Valueminimum>
        </d3p1:Price>
      </d3p1:Price>
    </Prices>
    <ProductType>SalesInventory</ProductType>
    <Taxable>true</Taxable>
    <WebCategory>sample string 10</WebCategory>
  </Product>
</ProductRequest>