POST {opco}/api/v1/Customer/{customerId}/ProductInventory

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

string

Required

opco

string

None.

Body Parameters

Collection of ProductInquiry
NameDescriptionTypeAdditional information
ProductId

integer

None.

CustomerPartNumber

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "productId": 1,
    "customerPartNumber": "sample string 1"
  },
  {
    "productId": 1,
    "customerPartNumber": "sample string 1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProductInquiry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Controllers.v1">
  <ProductInquiry>
    <CustomerPartNumber>sample string 1</CustomerPartNumber>
    <ProductId>1</ProductId>
  </ProductInquiry>
  <ProductInquiry>
    <CustomerPartNumber>sample string 1</CustomerPartNumber>
    <ProductId>1</ProductId>
  </ProductInquiry>
</ArrayOfProductInquiry>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IEnumerable`1'.

Response Information

Resource Description

Collection of CustomerProductInventory
NameDescriptionTypeAdditional information
CustomerPartNumber

string

None.

ProductId

integer

None.

ProductDescription

string

None.

CustomerLastCountedQuantity

decimal number

None.

CustomerLastCountDate

string

None.

Category

string

None.

MinimumQuantity

decimal number

None.

MaximumQuantity

decimal number

None.

AvailableDate

string

None.

QuantityAvailable

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "customerPartNumber": "sample string 1",
    "productId": 2,
    "productDescription": "sample string 3",
    "customerLastCountedQuantity": 4.0,
    "customerLastCountDate": "sample string 5",
    "category": "sample string 6",
    "minimumQuantity": 7.0,
    "maximumQuantity": 8.0,
    "availableDate": "sample string 9",
    "quantityAvailable": 10.0
  },
  {
    "customerPartNumber": "sample string 1",
    "productId": 2,
    "productDescription": "sample string 3",
    "customerLastCountedQuantity": 4.0,
    "customerLastCountDate": "sample string 5",
    "category": "sample string 6",
    "minimumQuantity": 7.0,
    "maximumQuantity": 8.0,
    "availableDate": "sample string 9",
    "quantityAvailable": 10.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomerProductInventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Controllers.v1">
  <CustomerProductInventory>
    <AvailableDate>sample string 9</AvailableDate>
    <Category>sample string 6</Category>
    <CustomerLastCountDate>sample string 5</CustomerLastCountDate>
    <CustomerLastCountedQuantity>4</CustomerLastCountedQuantity>
    <CustomerPartNumber>sample string 1</CustomerPartNumber>
    <MaximumQuantity>8</MaximumQuantity>
    <MinimumQuantity>7</MinimumQuantity>
    <ProductDescription>sample string 3</ProductDescription>
    <ProductId>2</ProductId>
    <QuantityAvailable>10</QuantityAvailable>
  </CustomerProductInventory>
  <CustomerProductInventory>
    <AvailableDate>sample string 9</AvailableDate>
    <Category>sample string 6</Category>
    <CustomerLastCountDate>sample string 5</CustomerLastCountDate>
    <CustomerLastCountedQuantity>4</CustomerLastCountedQuantity>
    <CustomerPartNumber>sample string 1</CustomerPartNumber>
    <MaximumQuantity>8</MaximumQuantity>
    <MinimumQuantity>7</MinimumQuantity>
    <ProductDescription>sample string 3</ProductDescription>
    <ProductId>2</ProductId>
    <QuantityAvailable>10</QuantityAvailable>
  </CustomerProductInventory>
</ArrayOfCustomerProductInventory>