Get A Company Address

Deprecated

GET

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

GET

/api/v2/io/companies/:companyId/addresses/:addressId

$ curl https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/addresses/addressId \
>      -H "authToken: <apiKey>"

1 {
2   "code": 200,
3   "data": {
4     "addressId": "6",
5     "addressLine1": "123 Main Street",
6     "addressLine2": "Blvd",
7     "channelId": "1",
8     "channelName": "test",
9     "city": "Austin",
10     "country": {
11       "countryCode": "US",
12       "countryName": "United States"
13     },
14     "firstName": "Jane",
15     "isBilling": true,
16     "isDefaultBilling": true,
17     "isDefaultShipping": true,
18     "isShipping": true,
19     "lastName": "Doe",
20     "phoneNumber": "11111111111",
21     "state": {
22       "stateCode": "TX",
23       "stateName": "Texas"
24     },
25     "zipCode": "78751"
26   },
27   "message": "SUCCESS"
28 }

Get an address for a company

Authentication

authTokenstring

API Key authentication via header

Path parameters

addressIdstringRequired

companyIdstringRequired

Response

Response success

codedoubleOptional

Response status code

dataobjectOptional

Response data

messagestringOptional

Response message

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors