POST middleware/pickup/options

Request Information

URI Parameters

None.

Body Parameters

PickupOptionsRequest
NameDescriptionTypeAdditional information
search_area

SearchArea

None.

items

Collection of PickupItem

None.

Request Formats

application/json, text/json

Sample:
{
  "search_area": {
    "coordinates": {
      "latitude": 1.1,
      "longitude": 2.1
    },
    "radius": {
      "value": 1,
      "unit": "sample string 2"
    }
  },
  "items": [
    {
      "variant_id": 1,
      "quantity": 2
    },
    {
      "variant_id": 1,
      "quantity": 2
    }
  ]
}

application/xml, text/xml

Sample:
<PickupOptionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.Api.BigCommerce.Models">
  <items>
    <PickupItem>
      <quantity>2</quantity>
      <variantId>1</variantId>
    </PickupItem>
    <PickupItem>
      <quantity>2</quantity>
      <variantId>1</variantId>
    </PickupItem>
  </items>
  <searchArea>
    <coordinates>
      <latitude>1.1</latitude>
      <longitude>2.1</longitude>
    </coordinates>
    <radius>
      <unit>sample string 2</unit>
      <value>1</value>
    </radius>
  </searchArea>
</PickupOptionsRequest>

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.