POST api/Products/Puddles

Module : Product; ADINA-7533 This method is called to get puddle information for stock availability

Request Information

URI Parameters

None.

Body Parameters

PuddleRequestEntity
NameDescriptionTypeAdditional information
productId

string

None.

postalCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "productId": "sample string 1",
  "postalCode": "sample string 2"
}

application/xml, text/xml

Sample:
<PuddleRequestEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <postalCode>sample string 2</postalCode>
  <productId>sample string 1</productId>
</PuddleRequestEntity>

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

Response Information

Resource Description

PuddlesEntity
NameDescriptionTypeAdditional information
RingPuddle

Collection of PuddlesInventoryLocationQty

None.

National

integer

None.

Message

string

None.

WebApiIsSuccess

boolean

None.

WebApiResponseMessage

string

None.

WebApiErrorCode

string

None.

error_description

string

None.

CookieData

Collection of AppCookie

None.

Response Formats

application/json, text/json

Sample:
{
  "RingPuddle": [
    {
      "location": "sample string 1",
      "Qty": 2
    },
    {
      "location": "sample string 1",
      "Qty": 2
    }
  ],
  "National": 1,
  "Message": "sample string 2",
  "WebApiIsSuccess": true,
  "WebApiResponseMessage": "sample string 4",
  "WebApiErrorCode": "sample string 5",
  "error_description": "sample string 6",
  "CookieData": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "NameValue": "sample string 3",
      "ExpiryDateTime": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<PuddlesEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adi.BusinessEntities">
  <CookieData>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
    <AppCookie>
      <ExpiryDateTime>sample string 4</ExpiryDateTime>
      <Name>sample string 1</Name>
      <NameValue>sample string 3</NameValue>
      <Value>sample string 2</Value>
    </AppCookie>
  </CookieData>
  <Message>sample string 2</Message>
  <WebApiErrorCode>sample string 5</WebApiErrorCode>
  <WebApiIsSuccess>true</WebApiIsSuccess>
  <WebApiResponseMessage>sample string 4</WebApiResponseMessage>
  <error_description>sample string 6</error_description>
  <National>1</National>
  <RingPuddle>
    <PuddlesInventoryLocationQty>
      <Qty>2</Qty>
      <location>sample string 1</location>
    </PuddlesInventoryLocationQty>
    <PuddlesInventoryLocationQty>
      <Qty>2</Qty>
      <location>sample string 1</location>
    </PuddlesInventoryLocationQty>
  </RingPuddle>
</PuddlesEntity>