Search Addresses with Multiple Filters | BigCommerce Developer Center

import requests
url = "https://api-b2b.bigcommerce.com/api/v2/companies/companyId/addresses/searches"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "code": 200,
  "data": {
    "list": [
      {
        "addressId": "27",
        "addressLine1": "512 Bluebonnet Lane",
        "addressLine2": "Building 2",
        "city": "Austin",
        "country": {
          "countryName": "United States",
          "countryCode": "US"
        },
        "extraFields": [
          {
            "fieldName": "Company Tax Code",
            "fieldValue": "Code G"
          }
        ],
        "firstName": "Marie",
        "isBilling": "0",
        "isDefaultBilling": "0",
        "isDefaultShipping": "0",
        "isShipping": "1",
        "label": "Austin Warehouse",
        "lastName": "Curie",
        "phoneNumber": "8001234567",
        "state": {
          "stateName": "Texas",
          "stateCode": "TX"
        },
        "zipCode": "78726"
      }
    ],
    "defaultAddressIds": {
      "shippingAddressId": "17",
      "billingAddressId": "76"
    },
    "pagination": {
      "totalCount": 175,
      "offset": 0,
      "limit": 10
    }
  },
  "message": "Success"
}

Equivalent Storefront GraphQL API Query: addresses. For more information, see the GraphQL Playground.

Returns one or more Company addresses based on the filter parameters. You can use this to make refined searches, such as locating a particular address by its label or viewing all addresses in a specific country. Equivalent Storefront GraphQL API Query: `addresses`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) section[...]

Path parameters

companyIdstringRequired

Request

This endpoint expects an object.

filtersobjectOptional

offsetdoubleOptional

Pagination offset for the results.

limitdoubleOptional

Pagination limit for the results.

qstringOptional

The search string for the request. Its value determines the results returned by the request.

Response

codedoubleDefaults to 200

dataobject

messagestringDefaults to SUCCESS