POST api/v1/UKSMProduct

UKSM Specific - Allows updating/adding of Caliq products
API_Key required in header

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
Code	Unique part number	string	Required Max length: 25
Description	Short product description	string	Required Max length: 80
ProductType	APAC, DROPSHIP or UKSM	string	Required Max length: 10
Active		boolean	Required
RunningDown		boolean	Required
UnitWeightKG		decimal number	Required
CountryOfOrigin	ISO2 Code	string	Max length: 2
CommodityCode		string	Max length: 12
VATRate	VAT Rate applicable to this item	decimal number	Required
SupplierAccNo	Suppliers account number	string	Required Max length: 10
SupplierPart	Suppliers part number - may be blank	string	Required Max length: 40
SupplierDesc	Suppliers description - may be blank	string	Max length: 50
SupplierMOQ	Suppliers min order qty	integer	None.
SupplierMultiple	Suppliers order multiple	integer	None.
Price_Supplier	The unit standard supplier purchase price in supplier currency	decimal number	Required
Price_Trade	The unit standard trade sell price in GBP	decimal number	Required
Price_Retail	The unit standard retail sell price in GBP	decimal number	Required
SeasonalDescription	Seasonality description - may be blank	string	Max length: 30
BuyerGroup	Buying Group - may be blank	string	Max length: 30
ProductGroup1	ProductGroup1 description - mandatory	string	Required Max length: 40
ProductGroup2	ProductGroup2 description	string	Max length: 40
ProductGroup3	ProductGroup4 description	string	Max length: 40
ProductGroup4	ProductGroup4 description	string	Max length: 40

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "Code": "sample string 2",
  "Description": "sample string 3",
  "ProductType": "sample string 4",
  "Active": true,
  "RunningDown": true,
  "UnitWeightKG": 7.0,
  "CountryOfOrigin": "sample string 8",
  "CommodityCode": "sample string 9",
  "VATRate": 10.0,
  "SupplierAccNo": "sample string 11",
  "SupplierPart": "sample string 12",
  "SupplierDesc": "sample string 13",
  "SupplierMOQ": 14,
  "SupplierMultiple": 15,
  "Price_Supplier": 16.1,
  "Price_Trade": 17.1,
  "Price_Retail": 18.1,
  "SeasonalDescription": "sample string 19",
  "BuyerGroup": "sample string 20",
  "ProductGroup1": "sample string 21",
  "ProductGroup2": "sample string 22",
  "ProductGroup3": "sample string 23",
  "ProductGroup4": "sample string 24"
}

application/xml, text/xml

Sample:

<UKSMProductParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <Code>sample string 2</Code>
  <Description>sample string 3</Description>
  <ProductType>sample string 4</ProductType>
  <Active>true</Active>
  <RunningDown>true</RunningDown>
  <UnitWeightKG>7</UnitWeightKG>
  <CountryOfOrigin>sample string 8</CountryOfOrigin>
  <CommodityCode>sample string 9</CommodityCode>
  <VATRate>10</VATRate>
  <SupplierAccNo>sample string 11</SupplierAccNo>
  <SupplierPart>sample string 12</SupplierPart>
  <SupplierDesc>sample string 13</SupplierDesc>
  <SupplierMOQ>14</SupplierMOQ>
  <SupplierMultiple>15</SupplierMultiple>
  <Price_Supplier>16.1</Price_Supplier>
  <Price_Trade>17.1</Price_Trade>
  <Price_Retail>18.1</Price_Retail>
  <SeasonalDescription>sample string 19</SeasonalDescription>
  <BuyerGroup>sample string 20</BuyerGroup>
  <ProductGroup1>sample string 21</ProductGroup1>
  <ProductGroup2>sample string 22</ProductGroup2>
  <ProductGroup3>sample string 23</ProductGroup3>
  <ProductGroup4>sample string 24</ProductGroup4>
</UKSMProductParams>

Response Information

Resource Description

UKSMProductResults

Name	Description	Type	Additional information
UKSMProductData		UKSMProductData	None.

Response Formats

application/json, text/json

Sample:

{
  "UKSMProductData": {
    "OK": true,
    "ProductID": 2,
    "Message": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<UKSMProductResults xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UKSMProductData>
    <OK>true</OK>
    <ProductID>2</ProductID>
    <Message>sample string 3</Message>
  </UKSMProductData>
</UKSMProductResults>