GET api/delivery/searchproducts

Search for products.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchTerm		string	None.
barcodeNumber		string	None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfListOfSearchedProduct

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	Collection of SearchedProduct	None.
Errors	Dictionary of string [key] and Collection of string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "success": true,
  "statusCode": 100,
  "data": [
    {
      "containerNoun": "sample string 1",
      "openNoun": "sample string 2",
      "productId": 3,
      "productName": "sample string 4",
      "categoryId": 5,
      "category": "sample string 6",
      "barcodeNumbers": {
        "1": "sample string 1"
      },
      "volume": "sample string 8",
      "unitId": 9,
      "unitMetric": "sample string 10",
      "packaged": true,
      "quantityPerPackage": 12,
      "sites": {
        "1": "sample string 1"
      },
      "suppliers": {
        "1": "sample string 1"
      },
      "tags": "sample string 13",
      "requiresVat": true,
      "weighedOnDelivery": true,
      "storageUrl": "sample string 14"
    },
    {
      "containerNoun": "sample string 1",
      "openNoun": "sample string 2",
      "productId": 3,
      "productName": "sample string 4",
      "categoryId": 5,
      "category": "sample string 6",
      "barcodeNumbers": {
        "1": "sample string 1"
      },
      "volume": "sample string 8",
      "unitId": 9,
      "unitMetric": "sample string 10",
      "packaged": true,
      "quantityPerPackage": 12,
      "sites": {
        "1": "sample string 1"
      },
      "suppliers": {
        "1": "sample string 1"
      },
      "tags": "sample string 13",
      "requiresVat": true,
      "weighedOnDelivery": true,
      "storageUrl": "sample string 14"
    }
  ],
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfArrayOfSearchedProductvhWbQmEI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response.Delivery">
    <d2p1:SearchedProduct>
      <d2p1:BarcodeId>1</d2p1:BarcodeId>
      <d2p1:BarcodeNumber>sample string 7</d2p1:BarcodeNumber>
      <d2p1:BarcodeNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
      </d2p1:BarcodeNumbers>
      <d2p1:Category>sample string 6</d2p1:Category>
      <d2p1:Category_Id>5</d2p1:Category_Id>
      <d2p1:ImageUrl>sample string 14</d2p1:ImageUrl>
      <d2p1:Packaged>true</d2p1:Packaged>
      <d2p1:Product_Id>3</d2p1:Product_Id>
      <d2p1:Product_Name>sample string 4</d2p1:Product_Name>
      <d2p1:Quantity_Per_Package>12</d2p1:Quantity_Per_Package>
      <d2p1:RequiresVat>true</d2p1:RequiresVat>
      <d2p1:Site_Id>1</d2p1:Site_Id>
      <d2p1:Site_Name>sample string 16</d2p1:Site_Name>
      <d2p1:Sites xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
      </d2p1:Sites>
      <d2p1:Supplier_Id>1</d2p1:Supplier_Id>
      <d2p1:Supplier_Name>sample string 15</d2p1:Supplier_Name>
      <d2p1:Suppliers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
      </d2p1:Suppliers>
      <d2p1:Tags>sample string 13</d2p1:Tags>
      <d2p1:Unit_Id>9</d2p1:Unit_Id>
      <d2p1:Unit_Metric>sample string 10</d2p1:Unit_Metric>
      <d2p1:Volume>sample string 8</d2p1:Volume>
      <d2p1:WeighedOnDelivery>true</d2p1:WeighedOnDelivery>
      <d2p1:Container_Noun>sample string 1</d2p1:Container_Noun>
      <d2p1:Open_Noun>sample string 2</d2p1:Open_Noun>
    </d2p1:SearchedProduct>
    <d2p1:SearchedProduct>
      <d2p1:BarcodeId>1</d2p1:BarcodeId>
      <d2p1:BarcodeNumber>sample string 7</d2p1:BarcodeNumber>
      <d2p1:BarcodeNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
      </d2p1:BarcodeNumbers>
      <d2p1:Category>sample string 6</d2p1:Category>
      <d2p1:Category_Id>5</d2p1:Category_Id>
      <d2p1:ImageUrl>sample string 14</d2p1:ImageUrl>
      <d2p1:Packaged>true</d2p1:Packaged>
      <d2p1:Product_Id>3</d2p1:Product_Id>
      <d2p1:Product_Name>sample string 4</d2p1:Product_Name>
      <d2p1:Quantity_Per_Package>12</d2p1:Quantity_Per_Package>
      <d2p1:RequiresVat>true</d2p1:RequiresVat>
      <d2p1:Site_Id>1</d2p1:Site_Id>
      <d2p1:Site_Name>sample string 16</d2p1:Site_Name>
      <d2p1:Sites xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
      </d2p1:Sites>
      <d2p1:Supplier_Id>1</d2p1:Supplier_Id>
      <d2p1:Supplier_Name>sample string 15</d2p1:Supplier_Name>
      <d2p1:Suppliers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
          <d4p1:Key>1</d4p1:Key>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:KeyValueOfNullableOfintstringRDHGY3MA>
      </d2p1:Suppliers>
      <d2p1:Tags>sample string 13</d2p1:Tags>
      <d2p1:Unit_Id>9</d2p1:Unit_Id>
      <d2p1:Unit_Metric>sample string 10</d2p1:Unit_Metric>
      <d2p1:Volume>sample string 8</d2p1:Volume>
      <d2p1:WeighedOnDelivery>true</d2p1:WeighedOnDelivery>
      <d2p1:Container_Noun>sample string 1</d2p1:Container_Noun>
      <d2p1:Open_Noun>sample string 2</d2p1:Open_Noun>
    </d2p1:SearchedProduct>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>sample string 1</Message>
  <StatusCode>Continue</StatusCode>
  <Success>true</Success>
</ResponseOfArrayOfSearchedProductvhWbQmEI>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Success"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

Continue
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Container_Noun"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Open_Noun"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Product_Id"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Product_Name"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Category_Id"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Category"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].BarcodeNumbers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].BarcodeNumbers[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].BarcodeNumber"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].BarcodeId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Volume"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Unit_Id"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Unit_Metric"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Packaged"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Quantity_Per_Package"

12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Sites[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Sites[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Suppliers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Suppliers[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Tags"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].RequiresVat"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].WeighedOnDelivery"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].ImageUrl"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Supplier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Supplier_Name"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Site_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Site_Name"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Container_Noun"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Open_Noun"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Product_Id"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Product_Name"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Category_Id"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Category"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].BarcodeNumbers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].BarcodeNumbers[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].BarcodeNumber"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].BarcodeId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Volume"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Unit_Id"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Unit_Metric"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Packaged"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Quantity_Per_Package"

12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Sites[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Sites[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Suppliers[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Suppliers[0].Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Tags"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].RequiresVat"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].WeighedOnDelivery"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].ImageUrl"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Supplier_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Supplier_Name"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Site_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Site_Name"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--