POST {opco}/api/v1/Product/Inventory/Search

Request Information

URI Parameters

Name	Description	Type	Additional information
opco		string	None.

Body Parameters

ProductAvailabilityRequest

Name	Description	Type	Additional information
ProductIdentifier		Collection of ProductSearchIdentifier	None.
BranchId		Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "productIdentifier": [
    {
      "type": 0,
      "search": "sample string 1"
    },
    {
      "type": 0,
      "search": "sample string 1"
    }
  ],
  "branchId": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ProductAvailabilityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Product.v1">
  <BranchId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BranchId>
  <ProductIdentifier>
    <ProductSearchIdentifier>
      <Search>sample string 1</Search>
      <Type>ProductId</Type>
    </ProductSearchIdentifier>
    <ProductSearchIdentifier>
      <Search>sample string 1</Search>
      <Type>ProductId</Type>
    </ProductSearchIdentifier>
  </ProductIdentifier>
</ProductAvailabilityRequest>

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 'ProductAvailabilityRequest'.

Response Information

Resource Description

Collection of ProductAvailabilityInfo

Name	Type	Additional information
Id	string	None.
ProductId	string	None.
BranchAvailabilities	Collection of BranchAvailability	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "sample string 1",
    "productId": "sample string 2",
    "branchAvailabilities": [
      {
        "branchId": "sample string 1",
        "available": 2,
        "unitOfMeasure": {
          "unitCode": "sample string 1",
          "baseQuantity": 2,
          "isPricingOnly": true
        }
      },
      {
        "branchId": "sample string 1",
        "available": 2,
        "unitOfMeasure": {
          "unitCode": "sample string 1",
          "baseQuantity": 2,
          "isPricingOnly": true
        }
      }
    ]
  },
  {
    "id": "sample string 1",
    "productId": "sample string 2",
    "branchAvailabilities": [
      {
        "branchId": "sample string 1",
        "available": 2,
        "unitOfMeasure": {
          "unitCode": "sample string 1",
          "baseQuantity": 2,
          "isPricingOnly": true
        }
      },
      {
        "branchId": "sample string 1",
        "available": 2,
        "unitOfMeasure": {
          "unitCode": "sample string 1",
          "baseQuantity": 2,
          "isPricingOnly": true
        }
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfProductAvailabilityInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Product.v1">
  <ProductAvailabilityInfo>
    <BranchAvailabilities xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Product">
      <d3p1:BranchAvailability>
        <d3p1:Available>2</d3p1:Available>
        <d3p1:BranchId>sample string 1</d3p1:BranchId>
        <d3p1:UnitOfMeasure xmlns:d5p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Generic">
          <d5p1:BaseQuantity>2</d5p1:BaseQuantity>
          <d5p1:IsPricingOnly>true</d5p1:IsPricingOnly>
          <d5p1:UnitCode>sample string 1</d5p1:UnitCode>
        </d3p1:UnitOfMeasure>
      </d3p1:BranchAvailability>
      <d3p1:BranchAvailability>
        <d3p1:Available>2</d3p1:Available>
        <d3p1:BranchId>sample string 1</d3p1:BranchId>
        <d3p1:UnitOfMeasure xmlns:d5p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Generic">
          <d5p1:BaseQuantity>2</d5p1:BaseQuantity>
          <d5p1:IsPricingOnly>true</d5p1:IsPricingOnly>
          <d5p1:UnitCode>sample string 1</d5p1:UnitCode>
        </d3p1:UnitOfMeasure>
      </d3p1:BranchAvailability>
    </BranchAvailabilities>
    <Id>sample string 1</Id>
    <ProductId>sample string 2</ProductId>
  </ProductAvailabilityInfo>
  <ProductAvailabilityInfo>
    <BranchAvailabilities xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Product">
      <d3p1:BranchAvailability>
        <d3p1:Available>2</d3p1:Available>
        <d3p1:BranchId>sample string 1</d3p1:BranchId>
        <d3p1:UnitOfMeasure xmlns:d5p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Generic">
          <d5p1:BaseQuantity>2</d5p1:BaseQuantity>
          <d5p1:IsPricingOnly>true</d5p1:IsPricingOnly>
          <d5p1:UnitCode>sample string 1</d5p1:UnitCode>
        </d3p1:UnitOfMeasure>
      </d3p1:BranchAvailability>
      <d3p1:BranchAvailability>
        <d3p1:Available>2</d3p1:Available>
        <d3p1:BranchId>sample string 1</d3p1:BranchId>
        <d3p1:UnitOfMeasure xmlns:d5p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Generic">
          <d5p1:BaseQuantity>2</d5p1:BaseQuantity>
          <d5p1:IsPricingOnly>true</d5p1:IsPricingOnly>
          <d5p1:UnitCode>sample string 1</d5p1:UnitCode>
        </d3p1:UnitOfMeasure>
      </d3p1:BranchAvailability>
    </BranchAvailabilities>
    <Id>sample string 1</Id>
    <ProductId>sample string 2</ProductId>
  </ProductAvailabilityInfo>
</ArrayOfProductAvailabilityInfo>