POST api/store/configuration/{locationId}

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required

Body Parameters

StoreConfiguration

Name	Description	Type	Additional information
LocationId		integer	None.
Sections		Collection of PageSection	None.

Request Formats

application/json, text/json

Sample:

{
  "LocationId": 1,
  "Sections": [
    {
      "Type": 0,
      "Parameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "Type": 0,
      "Parameters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<StoreConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <LocationId>1</LocationId>
  <Sections>
    <PageSection>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Parameters>
      <Type>ProductCollection</Type>
    </PageSection>
    <PageSection>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Parameters>
      <Type>ProductCollection</Type>
    </PageSection>
  </Sections>
</StoreConfiguration>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/05/20 14:14:07",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>