Search Company Addresses

GET

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

GET

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

curl -G https://api-b2b.bigcommerce.com/api/v2/companies/123/addresses/searches \
     -H "Authorization: Bearer <token>" \
     -d limit=10 \
     -d offset=0

200Retrieved

{
  "message": "string",
  "code": 200,
  "data": {
    "addressBookStatus": "string",
    "defaultAddress": {
      "companyId": "123456",
      "companyName": "Great Buys",
      "companyAddress": "512 Bluebonnet Lane, Building 2",
      "companyCity": "Austin",
      "companyState": "Texas",
      "companyStateCode": "TX",
      "companyZipCode": "78726",
      "companyCountry": "United States",
      "companyCountryCode": "US",
      "firstName": "Marie",
      "lastName": "Curie",
      "phoneNumber": "8001234567",
      "label": "Austin Warehouse"
    },
    "list": [
      {
        "companyId": "123456",
        "companyName": "Great Buys",
        "companyAddress": "512 Bluebonnet Lane, Building 2",
        "companyCity": "Austin",
        "companyState": "Texas",
        "companyStateCode": "TX",
        "companyZipCode": "78726",
        "companyCountry": "United States",
        "companyCountryCode": "US",
        "firstName": "Marie",
        "lastName": "Curie",
        "phoneNumber": "8001234567",
        "label": "Austin Warehouse"
      }
    ],
    "pagination": {
      "totalCount": 175,
      "offset": 0,
      "limit": 10
    }
  }
}

Returns all addresses associated with a Company account that match the query string q.

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.

Query parameters

qstringOptional

The search string for the request.

limitstringRequired

The total number of items per page of the response.

offsetstringRequired

The number of items to skip before the current page of the response.

Response

messagestringOptional

codedoubleOptionalDefaults to 200

dataobjectOptional