GET api/CustomerWebhook/GetCustomerGroupDetails?customerId={customerId}&customerProvince={customerProvince}&fsa={fsa}

Request Information

URI Parameters

Name	Type	Additional information
customerId	integer	Required
customerProvince	string	Default value is
fsa	string	Default value is

Body Parameters

BigCommerceResponseOfCustomer

Name	Type	Additional information
Data	Customer	None.
DataArray	Collection of Customer	None.
Meta	Object	None.
Results	Object	None.
Errors	Object	None.
StatusCode	integer	None.
Exception	Exception	None.

Request Formats

application/json, text/json

Sample:

{
  "Data": {
    "email": "sample string 1",
    "first_name": "sample string 2",
    "last_name": "sample string 3",
    "company": "sample string 4",
    "phone": "sample string 5",
    "registration_ip_address": "sample string 6",
    "notes": "sample string 7",
    "tax_exempt_category": "sample string 8",
    "customer_group_id": 1,
    "id": 1,
    "date_modified": "sample string 9",
    "date_created": "sample string 10",
    "address_count": 1,
    "attribute_count": 1,
    "authentication": {
      "force_password_reset": true,
      "new_password": "sample string 2"
    },
    "addresses": [
      {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company": "sample string 3",
        "address1": "sample string 4",
        "address2": "sample string 5",
        "city": "sample string 6",
        "state_or_province": "sample string 7",
        "postal_code": "sample string 8",
        "country_code": "sample string 9",
        "phone": "sample string 10",
        "address_type": "sample string 11",
        "customer_id": 1,
        "id": 1,
        "country": "sample string 12",
        "form_fields": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "customer_id": 3
          },
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "customer_id": 3
          }
        ]
      },
      {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "company": "sample string 3",
        "address1": "sample string 4",
        "address2": "sample string 5",
        "city": "sample string 6",
        "state_or_province": "sample string 7",
        "postal_code": "sample string 8",
        "country_code": "sample string 9",
        "phone": "sample string 10",
        "address_type": "sample string 11",
        "customer_id": 1,
        "id": 1,
        "country": "sample string 12",
        "form_fields": [
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "customer_id": 3
          },
          {
            "name": "sample string 1",
            "value": "sample string 2",
            "customer_id": 3
          }
        ]
      }
    ],
    "attributes": [
      {
        "attribute_id": 1,
        "attribute_value": "sample string 1",
        "value": "sample string 2",
        "customer_id": 1
      },
      {
        "attribute_id": 1,
        "attribute_value": "sample string 1",
        "value": "sample string 2",
        "customer_id": 1
      }
    ],
    "form_fields": [
      {
        "name": "sample string 1",
        "value": "sample string 2",
        "customer_id": 3
      },
      {
        "name": "sample string 1",
        "value": "sample string 2",
        "customer_id": 3
      }
    ],
    "store_credit_amounts": [
      {
        "amount": 1.0
      },
      {
        "amount": 1.0
      }
    ],
    "accepts_product_review_abandoned_cart_emails": true,
    "origin_channel_id": 1,
    "channel_ids": [
      1,
      1
    ]
  },
  "DataArray": [
    {
      "email": "sample string 1",
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "company": "sample string 4",
      "phone": "sample string 5",
      "registration_ip_address": "sample string 6",
      "notes": "sample string 7",
      "tax_exempt_category": "sample string 8",
      "customer_group_id": 1,
      "id": 1,
      "date_modified": "sample string 9",
      "date_created": "sample string 10",
      "address_count": 1,
      "attribute_count": 1,
      "authentication": {
        "force_password_reset": true,
        "new_password": "sample string 2"
      },
      "addresses": [
        {
          "first_name": "sample string 1",
          "last_name": "sample string 2",
          "company": "sample string 3",
          "address1": "sample string 4",
          "address2": "sample string 5",
          "city": "sample string 6",
          "state_or_province": "sample string 7",
          "postal_code": "sample string 8",
          "country_code": "sample string 9",
          "phone": "sample string 10",
          "address_type": "sample string 11",
          "customer_id": 1,
          "id": 1,
          "country": "sample string 12",
          "form_fields": [
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            },
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            }
          ]
        },
        {
          "first_name": "sample string 1",
          "last_name": "sample string 2",
          "company": "sample string 3",
          "address1": "sample string 4",
          "address2": "sample string 5",
          "city": "sample string 6",
          "state_or_province": "sample string 7",
          "postal_code": "sample string 8",
          "country_code": "sample string 9",
          "phone": "sample string 10",
          "address_type": "sample string 11",
          "customer_id": 1,
          "id": 1,
          "country": "sample string 12",
          "form_fields": [
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            },
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            }
          ]
        }
      ],
      "attributes": [
        {
          "attribute_id": 1,
          "attribute_value": "sample string 1",
          "value": "sample string 2",
          "customer_id": 1
        },
        {
          "attribute_id": 1,
          "attribute_value": "sample string 1",
          "value": "sample string 2",
          "customer_id": 1
        }
      ],
      "form_fields": [
        {
          "name": "sample string 1",
          "value": "sample string 2",
          "customer_id": 3
        },
        {
          "name": "sample string 1",
          "value": "sample string 2",
          "customer_id": 3
        }
      ],
      "store_credit_amounts": [
        {
          "amount": 1.0
        },
        {
          "amount": 1.0
        }
      ],
      "accepts_product_review_abandoned_cart_emails": true,
      "origin_channel_id": 1,
      "channel_ids": [
        1,
        1
      ]
    },
    {
      "email": "sample string 1",
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "company": "sample string 4",
      "phone": "sample string 5",
      "registration_ip_address": "sample string 6",
      "notes": "sample string 7",
      "tax_exempt_category": "sample string 8",
      "customer_group_id": 1,
      "id": 1,
      "date_modified": "sample string 9",
      "date_created": "sample string 10",
      "address_count": 1,
      "attribute_count": 1,
      "authentication": {
        "force_password_reset": true,
        "new_password": "sample string 2"
      },
      "addresses": [
        {
          "first_name": "sample string 1",
          "last_name": "sample string 2",
          "company": "sample string 3",
          "address1": "sample string 4",
          "address2": "sample string 5",
          "city": "sample string 6",
          "state_or_province": "sample string 7",
          "postal_code": "sample string 8",
          "country_code": "sample string 9",
          "phone": "sample string 10",
          "address_type": "sample string 11",
          "customer_id": 1,
          "id": 1,
          "country": "sample string 12",
          "form_fields": [
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            },
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            }
          ]
        },
        {
          "first_name": "sample string 1",
          "last_name": "sample string 2",
          "company": "sample string 3",
          "address1": "sample string 4",
          "address2": "sample string 5",
          "city": "sample string 6",
          "state_or_province": "sample string 7",
          "postal_code": "sample string 8",
          "country_code": "sample string 9",
          "phone": "sample string 10",
          "address_type": "sample string 11",
          "customer_id": 1,
          "id": 1,
          "country": "sample string 12",
          "form_fields": [
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            },
            {
              "name": "sample string 1",
              "value": "sample string 2",
              "customer_id": 3
            }
          ]
        }
      ],
      "attributes": [
        {
          "attribute_id": 1,
          "attribute_value": "sample string 1",
          "value": "sample string 2",
          "customer_id": 1
        },
        {
          "attribute_id": 1,
          "attribute_value": "sample string 1",
          "value": "sample string 2",
          "customer_id": 1
        }
      ],
      "form_fields": [
        {
          "name": "sample string 1",
          "value": "sample string 2",
          "customer_id": 3
        },
        {
          "name": "sample string 1",
          "value": "sample string 2",
          "customer_id": 3
        }
      ],
      "store_credit_amounts": [
        {
          "amount": 1.0
        },
        {
          "amount": 1.0
        }
      ],
      "accepts_product_review_abandoned_cart_emails": true,
      "origin_channel_id": 1,
      "channel_ids": [
        1,
        1
      ]
    }
  ],
  "Meta": {},
  "Results": {},
  "Errors": {},
  "StatusCode": 4,
  "Exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:

<BigCommerceResponseOfCustomergXSasaIy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.Api.BigCommerce.Models">
  <Data>
    <AbandonedCartEmail>true</AbandonedCartEmail>
    <AddressCount>1</AddressCount>
    <Addresses>
      <CustomerAddress>
        <address1>sample string 4</address1>
        <address2>sample string 5</address2>
        <address_type>sample string 11</address_type>
        <city>sample string 6</city>
        <company>sample string 3</company>
        <country>sample string 12</country>
        <country_code>sample string 9</country_code>
        <customer_id>1</customer_id>
        <first_name>sample string 1</first_name>
        <form_fields>
          <FormField>
            <CustomerId>3</CustomerId>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </FormField>
          <FormField>
            <CustomerId>3</CustomerId>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </FormField>
        </form_fields>
        <id>1</id>
        <last_name>sample string 2</last_name>
        <phone>sample string 10</phone>
        <postal_code>sample string 8</postal_code>
        <state_or_province>sample string 7</state_or_province>
      </CustomerAddress>
      <CustomerAddress>
        <address1>sample string 4</address1>
        <address2>sample string 5</address2>
        <address_type>sample string 11</address_type>
        <city>sample string 6</city>
        <company>sample string 3</company>
        <country>sample string 12</country>
        <country_code>sample string 9</country_code>
        <customer_id>1</customer_id>
        <first_name>sample string 1</first_name>
        <form_fields>
          <FormField>
            <CustomerId>3</CustomerId>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </FormField>
          <FormField>
            <CustomerId>3</CustomerId>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </FormField>
        </form_fields>
        <id>1</id>
        <last_name>sample string 2</last_name>
        <phone>sample string 10</phone>
        <postal_code>sample string 8</postal_code>
        <state_or_province>sample string 7</state_or_province>
      </CustomerAddress>
    </Addresses>
    <AttributeCount>1</AttributeCount>
    <Attributes>
      <CustomerAttribute>
        <AttributeId>1</AttributeId>
        <AttributeValue>sample string 1</AttributeValue>
        <CustomerId>1</CustomerId>
        <Value>sample string 2</Value>
      </CustomerAttribute>
      <CustomerAttribute>
        <AttributeId>1</AttributeId>
        <AttributeValue>sample string 1</AttributeValue>
        <CustomerId>1</CustomerId>
        <Value>sample string 2</Value>
      </CustomerAttribute>
    </Attributes>
    <Authentication>
      <force_password_reset>true</force_password_reset>
      <new_password>sample string 2</new_password>
    </Authentication>
    <ChannelIds xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>1</d3p1:int>
    </ChannelIds>
    <Company>sample string 4</Company>
    <CustomerGroupID>1</CustomerGroupID>
    <DateCreated>sample string 10</DateCreated>
    <DateModified>sample string 9</DateModified>
    <Email>sample string 1</Email>
    <FirstName>sample string 2</FirstName>
    <FormFields>
      <FormField>
        <CustomerId>3</CustomerId>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </FormField>
      <FormField>
        <CustomerId>3</CustomerId>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </FormField>
    </FormFields>
    <Id>1</Id>
    <LastName>sample string 3</LastName>
    <Notes>sample string 7</Notes>
    <OriginChannelId>1</OriginChannelId>
    <Phone>sample string 5</Phone>
    <RegistrationIPAddress>sample string 6</RegistrationIPAddress>
    <StoreCreditAmounts>
      <StoreCreditAmount>
        <amount>1</amount>
      </StoreCreditAmount>
      <StoreCreditAmount>
        <amount>1</amount>
      </StoreCreditAmount>
    </StoreCreditAmounts>
    <TaxExemptCategory>sample string 8</TaxExemptCategory>
  </Data>
  <DataArray>
    <Customer>
      <AbandonedCartEmail>true</AbandonedCartEmail>
      <AddressCount>1</AddressCount>
      <Addresses>
        <CustomerAddress>
          <address1>sample string 4</address1>
          <address2>sample string 5</address2>
          <address_type>sample string 11</address_type>
          <city>sample string 6</city>
          <company>sample string 3</company>
          <country>sample string 12</country>
          <country_code>sample string 9</country_code>
          <customer_id>1</customer_id>
          <first_name>sample string 1</first_name>
          <form_fields>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
          </form_fields>
          <id>1</id>
          <last_name>sample string 2</last_name>
          <phone>sample string 10</phone>
          <postal_code>sample string 8</postal_code>
          <state_or_province>sample string 7</state_or_province>
        </CustomerAddress>
        <CustomerAddress>
          <address1>sample string 4</address1>
          <address2>sample string 5</address2>
          <address_type>sample string 11</address_type>
          <city>sample string 6</city>
          <company>sample string 3</company>
          <country>sample string 12</country>
          <country_code>sample string 9</country_code>
          <customer_id>1</customer_id>
          <first_name>sample string 1</first_name>
          <form_fields>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
          </form_fields>
          <id>1</id>
          <last_name>sample string 2</last_name>
          <phone>sample string 10</phone>
          <postal_code>sample string 8</postal_code>
          <state_or_province>sample string 7</state_or_province>
        </CustomerAddress>
      </Addresses>
      <AttributeCount>1</AttributeCount>
      <Attributes>
        <CustomerAttribute>
          <AttributeId>1</AttributeId>
          <AttributeValue>sample string 1</AttributeValue>
          <CustomerId>1</CustomerId>
          <Value>sample string 2</Value>
        </CustomerAttribute>
        <CustomerAttribute>
          <AttributeId>1</AttributeId>
          <AttributeValue>sample string 1</AttributeValue>
          <CustomerId>1</CustomerId>
          <Value>sample string 2</Value>
        </CustomerAttribute>
      </Attributes>
      <Authentication>
        <force_password_reset>true</force_password_reset>
        <new_password>sample string 2</new_password>
      </Authentication>
      <ChannelIds xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>1</d4p1:int>
      </ChannelIds>
      <Company>sample string 4</Company>
      <CustomerGroupID>1</CustomerGroupID>
      <DateCreated>sample string 10</DateCreated>
      <DateModified>sample string 9</DateModified>
      <Email>sample string 1</Email>
      <FirstName>sample string 2</FirstName>
      <FormFields>
        <FormField>
          <CustomerId>3</CustomerId>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FormField>
        <FormField>
          <CustomerId>3</CustomerId>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FormField>
      </FormFields>
      <Id>1</Id>
      <LastName>sample string 3</LastName>
      <Notes>sample string 7</Notes>
      <OriginChannelId>1</OriginChannelId>
      <Phone>sample string 5</Phone>
      <RegistrationIPAddress>sample string 6</RegistrationIPAddress>
      <StoreCreditAmounts>
        <StoreCreditAmount>
          <amount>1</amount>
        </StoreCreditAmount>
        <StoreCreditAmount>
          <amount>1</amount>
        </StoreCreditAmount>
      </StoreCreditAmounts>
      <TaxExemptCategory>sample string 8</TaxExemptCategory>
    </Customer>
    <Customer>
      <AbandonedCartEmail>true</AbandonedCartEmail>
      <AddressCount>1</AddressCount>
      <Addresses>
        <CustomerAddress>
          <address1>sample string 4</address1>
          <address2>sample string 5</address2>
          <address_type>sample string 11</address_type>
          <city>sample string 6</city>
          <company>sample string 3</company>
          <country>sample string 12</country>
          <country_code>sample string 9</country_code>
          <customer_id>1</customer_id>
          <first_name>sample string 1</first_name>
          <form_fields>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
          </form_fields>
          <id>1</id>
          <last_name>sample string 2</last_name>
          <phone>sample string 10</phone>
          <postal_code>sample string 8</postal_code>
          <state_or_province>sample string 7</state_or_province>
        </CustomerAddress>
        <CustomerAddress>
          <address1>sample string 4</address1>
          <address2>sample string 5</address2>
          <address_type>sample string 11</address_type>
          <city>sample string 6</city>
          <company>sample string 3</company>
          <country>sample string 12</country>
          <country_code>sample string 9</country_code>
          <customer_id>1</customer_id>
          <first_name>sample string 1</first_name>
          <form_fields>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
            <FormField>
              <CustomerId>3</CustomerId>
              <Name>sample string 1</Name>
              <Value>sample string 2</Value>
            </FormField>
          </form_fields>
          <id>1</id>
          <last_name>sample string 2</last_name>
          <phone>sample string 10</phone>
          <postal_code>sample string 8</postal_code>
          <state_or_province>sample string 7</state_or_province>
        </CustomerAddress>
      </Addresses>
      <AttributeCount>1</AttributeCount>
      <Attributes>
        <CustomerAttribute>
          <AttributeId>1</AttributeId>
          <AttributeValue>sample string 1</AttributeValue>
          <CustomerId>1</CustomerId>
          <Value>sample string 2</Value>
        </CustomerAttribute>
        <CustomerAttribute>
          <AttributeId>1</AttributeId>
          <AttributeValue>sample string 1</AttributeValue>
          <CustomerId>1</CustomerId>
          <Value>sample string 2</Value>
        </CustomerAttribute>
      </Attributes>
      <Authentication>
        <force_password_reset>true</force_password_reset>
        <new_password>sample string 2</new_password>
      </Authentication>
      <ChannelIds xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>1</d4p1:int>
      </ChannelIds>
      <Company>sample string 4</Company>
      <CustomerGroupID>1</CustomerGroupID>
      <DateCreated>sample string 10</DateCreated>
      <DateModified>sample string 9</DateModified>
      <Email>sample string 1</Email>
      <FirstName>sample string 2</FirstName>
      <FormFields>
        <FormField>
          <CustomerId>3</CustomerId>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FormField>
        <FormField>
          <CustomerId>3</CustomerId>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </FormField>
      </FormFields>
      <Id>1</Id>
      <LastName>sample string 3</LastName>
      <Notes>sample string 7</Notes>
      <OriginChannelId>1</OriginChannelId>
      <Phone>sample string 5</Phone>
      <RegistrationIPAddress>sample string 6</RegistrationIPAddress>
      <StoreCreditAmounts>
        <StoreCreditAmount>
          <amount>1</amount>
        </StoreCreditAmount>
        <StoreCreditAmount>
          <amount>1</amount>
        </StoreCreditAmount>
      </StoreCreditAmounts>
      <TaxExemptCategory>sample string 8</TaxExemptCategory>
    </Customer>
  </DataArray>
  <Errors />
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <Meta />
  <Results />
  <StatusCode>4</StatusCode>
</BigCommerceResponseOfCustomergXSasaIy>

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 'BigCommerceResponse`1'.

Response Information

Resource Description

CustomerGroupDetails

Name	Type	Additional information
customer_group_id	integer	None.
customer_group_type	string	None.
customer_group_name	string	None.

Response Formats

application/json, text/json

Sample:

{
  "customer_group_id": 1,
  "customer_group_type": "sample string 2",
  "customer_group_name": "sample string 3"
}

application/xml, text/xml

Sample:

<CustomerGroupDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.Api.BigCommerce.Models">
  <CustomerGroupId>1</CustomerGroupId>
  <CustomerGroupName>sample string 3</CustomerGroupName>
  <CustomerGroupType>sample string 2</CustomerGroupType>
</CustomerGroupDetails>