POST api/AddressWebhook/UpdateCustomerGroup?updateAddress={updateAddress}&requestId={requestId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
updateAddress

boolean

Default value is True

requestId

integer

Default value is 0

Body Parameters

AddressWebhookInput
NameDescriptionTypeAdditional information
scope

string

None.

store_id

string

None.

data

CustomerData

None.

hash

string

None.

created_at

integer

None.

producer

string

None.

Request Formats

application/json, text/json

Sample:
{
  "scope": "sample string 1",
  "store_id": "sample string 2",
  "data": {
    "type": "sample string 1",
    "id": 2,
    "address": {
      "customer_id": 1
    }
  },
  "hash": "sample string 3",
  "created_at": 4,
  "producer": "sample string 5"
}

application/xml, text/xml

Sample:
<AddressWebhookInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.Api.BigCommerce.Models">
  <CreatedAt>4</CreatedAt>
  <Data>
    <Address>
      <CustomerId>1</CustomerId>
    </Address>
    <Id>2</Id>
    <Type>sample string 1</Type>
  </Data>
  <Hash>sample string 3</Hash>
  <Producer>sample string 5</Producer>
  <Scope>sample string 1</Scope>
  <StoreId>sample string 2</StoreId>
</AddressWebhookInput>

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

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>