Search Addresses with Multiple Filters

POST

https://api-b2b.bigcommerce.com/api/v2/companies/:companyId/addresses/searches

POST

/api/v2/companies/:companyId/addresses/searches

curl -X POST https://api-b2b.bigcommerce.com/api/v2/companies/123/addresses/searches \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Search Addresses

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

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.

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[…]

Path parameters

companyIdstringRequired

The unique numeric ID of the Company account.

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

messagestringOptional

codedoubleOptionalDefaults to 200

dataobjectOptional