POST product/availability?customerNumber={customerNumber}

Product availability returns quantity available given a list of warehouse numbers and item numbers

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

string

None.

Body Parameters

ProductAvailabilityRequest
NameDescriptionTypeAdditional information
CustomerNumber

Your ScanSource customer number

string

None.

Warehouses

Specifies warehouses 1710 - North America 2510 - Europe

Collection of string

Required

ItemNumbers

Specifies the item numbers to get availability Item number can be ScanSource item number, Vendor item number or SAP material number

Collection of string

Required

PartNumberType

Part number type

PartNumberType

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerNumber": "sample string 1",
  "Warehouses": [
    "sample string 1",
    "sample string 2"
  ],
  "ItemNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "PartNumberType": 0
}

application/xml, text/xml

Sample:
<ProductAvailabilityRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerNumber>sample string 1</CustomerNumber>
  <Warehouses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Warehouses>
  <ItemNumbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ItemNumbers>
  <PartNumberType>Unknown</PartNumberType>
</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

ProductAvailabilityResponse
NameDescriptionTypeAdditional information
items

List of items

Collection of ProductAvailabilityItem

None.

Response Formats

application/json, text/json

Sample:
{
  "items": [
    {
      "Warehouse": "sample string 1",
      "MaterialNumber": "sample string 2",
      "QuantityAvailable": 3,
      "ErrorFlag": true,
      "ErrorDescription": "sample string 5"
    },
    {
      "Warehouse": "sample string 1",
      "MaterialNumber": "sample string 2",
      "QuantityAvailable": 3,
      "ErrorFlag": true,
      "ErrorDescription": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<ProductAvailabilityResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <items>
    <ProductAvailabilityItem>
      <Warehouse>sample string 1</Warehouse>
      <MaterialNumber>sample string 2</MaterialNumber>
      <QuantityAvailable>3</QuantityAvailable>
      <ErrorFlag>true</ErrorFlag>
      <ErrorDescription>sample string 5</ErrorDescription>
    </ProductAvailabilityItem>
    <ProductAvailabilityItem>
      <Warehouse>sample string 1</Warehouse>
      <MaterialNumber>sample string 2</MaterialNumber>
      <QuantityAvailable>3</QuantityAvailable>
      <ErrorFlag>true</ErrorFlag>
      <ErrorDescription>sample string 5</ErrorDescription>
    </ProductAvailabilityItem>
  </items>
</ProductAvailabilityResponse>