POST api/GetItems

Request Information

URI Parameters

None.

Body Parameters

ApiRequest
NameDescriptionTypeAdditional information
Where

Collection of Dictionary of string [key] and Object [value]

None.

Company

string

None.

Environment

string

None.

EndPoint

string

None.

Scope

string

None.

Type

string

None.

Arguments

Collection of Dictionary of string [key] and Object [value]

None.

IsArray

boolean

None.

TypedFilters

Collection of Filter

None.

Request Formats

application/json, text/json

Sample:
{
  "Where": [
    {
      "sample string 1": {},
      "sample string 3": {}
    },
    {
      "sample string 1": {},
      "sample string 3": {}
    }
  ],
  "Company": "sample string 1",
  "Environment": "sample string 2",
  "EndPoint": "sample string 3",
  "Scope": "sample string 4",
  "Type": "sample string 5",
  "Arguments": [
    {
      "sample string 1": {},
      "sample string 3": {}
    },
    {
      "sample string 1": {},
      "sample string 3": {}
    }
  ],
  "IsArray": false,
  "TypedFilters": [
    {
      "CustomCheckTag": "sample string 1",
      "AnswerValue": "sample string 2"
    },
    {
      "CustomCheckTag": "sample string 1",
      "AnswerValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DFV_BC">
  <Arguments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
  </Arguments>
  <Company>sample string 1</Company>
  <EndPoint>sample string 3</EndPoint>
  <Environment>sample string 2</Environment>
  <Scope>sample string 4</Scope>
  <Type>sample string 5</Type>
  <Where xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
    <d2p1:ArrayOfKeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
      <d2p1:KeyValueOfstringanyType>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value />
      </d2p1:KeyValueOfstringanyType>
    </d2p1:ArrayOfKeyValueOfstringanyType>
  </Where>
</ApiRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Items
NameDescriptionTypeAdditional information
No.

string

None.

Description

string

None.

Base Unit of Measure

string

None.

Alt. Unit of Measure Code

string

None.

Sales Unit of Measure

string

None.

HOR Item Status

string

None.

Blocked

boolean

None.

Net Weight

decimal number

None.

Type

integer

None.

Item Category Code

string

None.

HOR Minimum Sales Order Qty

integer

None.

HOR Pieces for Package

integer

None.

Replenishment System

integer

None.

Production BOM No.

string

None.

Routing No.

string

None.

HOR Question Model

string

None.

Item Variants

Collection of ItemVariant

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "No.": "sample string 1",
    "Description": "sample string 2",
    "Base Unit of Measure": "sample string 3",
    "Alt. Unit of Measure Code": "sample string 4",
    "Sales Unit of Measure": "sample string 5",
    "HOR Item Status": "sample string 6",
    "Blocked": true,
    "Net Weight": 8.1,
    "Type": 9,
    "Item Category Code": "sample string 10",
    "HOR Minimum Sales Order Qty": 11,
    "HOR Pieces for Package": 12,
    "Replenishment System": 13,
    "Production BOM No.": "sample string 14",
    "Routing No.": "sample string 15",
    "HOR Question Model": "sample string 16",
    "Item Variants": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Description 2": "sample string 3",
        "HOR Production BOM No.": "sample string 4",
        "HOR Routing No.": "sample string 5",
        "HOR Variant Status": 6,
        "HOR Question Model": "sample string 7",
        "Variant Attributes": [
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          },
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          }
        ]
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Description 2": "sample string 3",
        "HOR Production BOM No.": "sample string 4",
        "HOR Routing No.": "sample string 5",
        "HOR Variant Status": 6,
        "HOR Question Model": "sample string 7",
        "Variant Attributes": [
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          },
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          }
        ]
      }
    ]
  },
  {
    "No.": "sample string 1",
    "Description": "sample string 2",
    "Base Unit of Measure": "sample string 3",
    "Alt. Unit of Measure Code": "sample string 4",
    "Sales Unit of Measure": "sample string 5",
    "HOR Item Status": "sample string 6",
    "Blocked": true,
    "Net Weight": 8.1,
    "Type": 9,
    "Item Category Code": "sample string 10",
    "HOR Minimum Sales Order Qty": 11,
    "HOR Pieces for Package": 12,
    "Replenishment System": 13,
    "Production BOM No.": "sample string 14",
    "Routing No.": "sample string 15",
    "HOR Question Model": "sample string 16",
    "Item Variants": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Description 2": "sample string 3",
        "HOR Production BOM No.": "sample string 4",
        "HOR Routing No.": "sample string 5",
        "HOR Variant Status": 6,
        "HOR Question Model": "sample string 7",
        "Variant Attributes": [
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          },
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          }
        ]
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Description 2": "sample string 3",
        "HOR Production BOM No.": "sample string 4",
        "HOR Routing No.": "sample string 5",
        "HOR Variant Status": 6,
        "HOR Question Model": "sample string 7",
        "Variant Attributes": [
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          },
          {
            "Question Code": "sample string 1",
            "Description": "sample string 2",
            "Answers Type": 3,
            "Answers Multiple": true,
            "Multiple Answers": [
              "sample string 1",
              "sample string 2"
            ],
            "Answers Code": "sample string 5",
            "Answers Text": "sample string 6",
            "Answers Boolean": true,
            "Answers Decimal": 8.1,
            "Answers Obbligatory": true
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfItems xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BCCONNECTOR.Models">
  <Items>
    <AltUnitOfMeasureCode>sample string 4</AltUnitOfMeasureCode>
    <BaseUnitOfMeasure>sample string 3</BaseUnitOfMeasure>
    <Blocked>true</Blocked>
    <Description>sample string 2</Description>
    <HORItemStatus>sample string 6</HORItemStatus>
    <HORMinimumSalesOrderQty>11</HORMinimumSalesOrderQty>
    <HORPiecesForPackage>12</HORPiecesForPackage>
    <HORQuestionModel>sample string 16</HORQuestionModel>
    <ItemCategoryCode>sample string 10</ItemCategoryCode>
    <ItemVariants>
      <ItemVariant>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Description2>sample string 3</Description2>
        <HORProductionBOMNo>sample string 4</HORProductionBOMNo>
        <HORQuestionModel>sample string 7</HORQuestionModel>
        <HORRoutingNo>sample string 5</HORRoutingNo>
        <HORVariantStatus>6</HORVariantStatus>
        <VariantAttributes>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
        </VariantAttributes>
      </ItemVariant>
      <ItemVariant>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Description2>sample string 3</Description2>
        <HORProductionBOMNo>sample string 4</HORProductionBOMNo>
        <HORQuestionModel>sample string 7</HORQuestionModel>
        <HORRoutingNo>sample string 5</HORRoutingNo>
        <HORVariantStatus>6</HORVariantStatus>
        <VariantAttributes>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
        </VariantAttributes>
      </ItemVariant>
    </ItemVariants>
    <NetWeight>8.1</NetWeight>
    <No>sample string 1</No>
    <ProductionBOMNo>sample string 14</ProductionBOMNo>
    <ReplenishmentSystem>13</ReplenishmentSystem>
    <RoutingNo>sample string 15</RoutingNo>
    <SalesUnitOfMeasure>sample string 5</SalesUnitOfMeasure>
    <Type>9</Type>
  </Items>
  <Items>
    <AltUnitOfMeasureCode>sample string 4</AltUnitOfMeasureCode>
    <BaseUnitOfMeasure>sample string 3</BaseUnitOfMeasure>
    <Blocked>true</Blocked>
    <Description>sample string 2</Description>
    <HORItemStatus>sample string 6</HORItemStatus>
    <HORMinimumSalesOrderQty>11</HORMinimumSalesOrderQty>
    <HORPiecesForPackage>12</HORPiecesForPackage>
    <HORQuestionModel>sample string 16</HORQuestionModel>
    <ItemCategoryCode>sample string 10</ItemCategoryCode>
    <ItemVariants>
      <ItemVariant>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Description2>sample string 3</Description2>
        <HORProductionBOMNo>sample string 4</HORProductionBOMNo>
        <HORQuestionModel>sample string 7</HORQuestionModel>
        <HORRoutingNo>sample string 5</HORRoutingNo>
        <HORVariantStatus>6</HORVariantStatus>
        <VariantAttributes>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
        </VariantAttributes>
      </ItemVariant>
      <ItemVariant>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Description2>sample string 3</Description2>
        <HORProductionBOMNo>sample string 4</HORProductionBOMNo>
        <HORQuestionModel>sample string 7</HORQuestionModel>
        <HORRoutingNo>sample string 5</HORRoutingNo>
        <HORVariantStatus>6</HORVariantStatus>
        <VariantAttributes>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
          <VariantAttribute>
            <AnswersBoolean>true</AnswersBoolean>
            <AnswersCode>sample string 5</AnswersCode>
            <AnswersDecimal>8.1</AnswersDecimal>
            <AnswersMultiple>true</AnswersMultiple>
            <AnswersObbligatory>true</AnswersObbligatory>
            <AnswersText>sample string 6</AnswersText>
            <AnswersType>3</AnswersType>
            <Description>sample string 2</Description>
            <MultipleAnswers xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </MultipleAnswers>
            <QuestionCode>sample string 1</QuestionCode>
          </VariantAttribute>
        </VariantAttributes>
      </ItemVariant>
    </ItemVariants>
    <NetWeight>8.1</NetWeight>
    <No>sample string 1</No>
    <ProductionBOMNo>sample string 14</ProductionBOMNo>
    <ReplenishmentSystem>13</ReplenishmentSystem>
    <RoutingNo>sample string 15</RoutingNo>
    <SalesUnitOfMeasure>sample string 5</SalesUnitOfMeasure>
    <Type>9</Type>
  </Items>
</ArrayOfItems>