POST api/Invoice/SearchForProduct

Request Information

URI Parameters

None.

Body Parameters

InvoiceProductSearchModel
NameDescriptionTypeAdditional information
PartnerID

required: identifies the integration gateway

integer

None.

SKU

string

None.

Name

string

None.

Type

string

None.

Brand

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PartnerID": 1,
  "SKU": "sample string 2",
  "Name": "sample string 3",
  "Type": "sample string 4",
  "Brand": "sample string 5"
}

application/xml, text/xml

Sample:
<InvoiceProductSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO">
  <Brand>sample string 5</Brand>
  <Name>sample string 3</Name>
  <PartnerID>1</PartnerID>
  <SKU>sample string 2</SKU>
  <Type>sample string 4</Type>
</InvoiceProductSearchModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of InvoiceProductModel
NameDescriptionTypeAdditional information
ID

integer

None.

PartnerID

integer

None.

ExternalKey

string

None.

ExternalProductID

string

None.

SKU

string

None.

UnitPrice

decimal number

None.

UnitPrice_IncludingTax

decimal number

None.

Name

string

None.

Description

string

None.

Brand

string

None.

VariantID

string

None.

ManufacturerSKU

string

None.

SystemSKU

string

None.

UPC

string

None.

LinkedGear

Collection of InvoiceProductToGearLinkModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "PartnerID": 2,
    "ExternalKey": "sample string 3",
    "ExternalProductID": "sample string 4",
    "SKU": "sample string 5",
    "UnitPrice": 6.1,
    "UnitPrice_IncludingTax": 7.1,
    "Name": "sample string 8",
    "Description": "sample string 9",
    "Brand": "sample string 10",
    "VariantID": "sample string 11",
    "ManufacturerSKU": "sample string 12",
    "SystemSKU": "sample string 13",
    "UPC": "sample string 14",
    "LinkedGear": [
      {
        "ID": 1,
        "InvoiceProductID": 2,
        "GearTypeID": 3,
        "GearType": "sample string 4",
        "IsService": true,
        "IsReplacement": true
      },
      {
        "ID": 1,
        "InvoiceProductID": 2,
        "GearTypeID": 3,
        "GearType": "sample string 4",
        "IsService": true,
        "IsReplacement": true
      }
    ]
  },
  {
    "ID": 1,
    "PartnerID": 2,
    "ExternalKey": "sample string 3",
    "ExternalProductID": "sample string 4",
    "SKU": "sample string 5",
    "UnitPrice": 6.1,
    "UnitPrice_IncludingTax": 7.1,
    "Name": "sample string 8",
    "Description": "sample string 9",
    "Brand": "sample string 10",
    "VariantID": "sample string 11",
    "ManufacturerSKU": "sample string 12",
    "SystemSKU": "sample string 13",
    "UPC": "sample string 14",
    "LinkedGear": [
      {
        "ID": 1,
        "InvoiceProductID": 2,
        "GearTypeID": 3,
        "GearType": "sample string 4",
        "IsService": true,
        "IsReplacement": true
      },
      {
        "ID": 1,
        "InvoiceProductID": 2,
        "GearTypeID": 3,
        "GearType": "sample string 4",
        "IsService": true,
        "IsReplacement": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfInvoiceProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO">
  <InvoiceProductModel>
    <Brand>sample string 10</Brand>
    <Description>sample string 9</Description>
    <ExternalKey>sample string 3</ExternalKey>
    <ExternalProductID>sample string 4</ExternalProductID>
    <ID>1</ID>
    <LinkedGear>
      <InvoiceProductToGearLinkModel>
        <GearType>sample string 4</GearType>
        <GearTypeID>3</GearTypeID>
        <ID>1</ID>
        <InvoiceProductID>2</InvoiceProductID>
        <IsReplacement>true</IsReplacement>
        <IsService>true</IsService>
      </InvoiceProductToGearLinkModel>
      <InvoiceProductToGearLinkModel>
        <GearType>sample string 4</GearType>
        <GearTypeID>3</GearTypeID>
        <ID>1</ID>
        <InvoiceProductID>2</InvoiceProductID>
        <IsReplacement>true</IsReplacement>
        <IsService>true</IsService>
      </InvoiceProductToGearLinkModel>
    </LinkedGear>
    <ManufacturerSKU>sample string 12</ManufacturerSKU>
    <Name>sample string 8</Name>
    <PartnerID>2</PartnerID>
    <SKU>sample string 5</SKU>
    <SystemSKU>sample string 13</SystemSKU>
    <UPC>sample string 14</UPC>
    <UnitPrice>6.1</UnitPrice>
    <UnitPrice_IncludingTax>7.1</UnitPrice_IncludingTax>
    <VariantID>sample string 11</VariantID>
  </InvoiceProductModel>
  <InvoiceProductModel>
    <Brand>sample string 10</Brand>
    <Description>sample string 9</Description>
    <ExternalKey>sample string 3</ExternalKey>
    <ExternalProductID>sample string 4</ExternalProductID>
    <ID>1</ID>
    <LinkedGear>
      <InvoiceProductToGearLinkModel>
        <GearType>sample string 4</GearType>
        <GearTypeID>3</GearTypeID>
        <ID>1</ID>
        <InvoiceProductID>2</InvoiceProductID>
        <IsReplacement>true</IsReplacement>
        <IsService>true</IsService>
      </InvoiceProductToGearLinkModel>
      <InvoiceProductToGearLinkModel>
        <GearType>sample string 4</GearType>
        <GearTypeID>3</GearTypeID>
        <ID>1</ID>
        <InvoiceProductID>2</InvoiceProductID>
        <IsReplacement>true</IsReplacement>
        <IsService>true</IsService>
      </InvoiceProductToGearLinkModel>
    </LinkedGear>
    <ManufacturerSKU>sample string 12</ManufacturerSKU>
    <Name>sample string 8</Name>
    <PartnerID>2</PartnerID>
    <SKU>sample string 5</SKU>
    <SystemSKU>sample string 13</SystemSKU>
    <UPC>sample string 14</UPC>
    <UnitPrice>6.1</UnitPrice>
    <UnitPrice_IncludingTax>7.1</UnitPrice_IncludingTax>
    <VariantID>sample string 11</VariantID>
  </InvoiceProductModel>
</ArrayOfInvoiceProductModel>