company/{companyId}/addresses

Retrieve company addresses for the given company.

Request

path Parameters

companyId

required

integer

query Parameters

searchCriteria[filterGroups][0][filters][0][field]	string Field
searchCriteria[filterGroups][0][filters][0][value]	string Value
searchCriteria[filterGroups][0][filters][0][conditionType]	string Condition type
searchCriteria[sortOrders][0][field]	string Sorting field.
searchCriteria[sortOrders][0][direction]	string Sorting direction.
searchCriteria[pageSize]	integer Page size.
searchCriteria[currentPage]	integer Current page.

Responses

200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

get/V1/company/{companyId}/addresses

Response samples

200
401
500
default

{"items": [{"city": "string",
"company": "string",
"company_address_id": 0,
"company_id": 0,
"country_id": "string",
"custom_attributes": [{"attribute_code": "string",
"value": "string"
}
],
"extension_attributes": { },
"fax": "string",
"firstname": "string",
"increment_id": "string",
"lastname": "string",
"middlename": "string",
"nickname": "string",
"postcode": "string",
"prefix": "string",
"region": {"extension_attributes": { },
"region": "string",
"region_code": "string",
"region_id": 0
},
"region_id": 0,
"street": ["string"
],
"suffix": "string",
"telephone": "string",
"type": 0,
"vat_id": "string",
"vat_is_valid": 0,
"vat_request_date": "string",
"vat_request_id": "string",
"vat_request_success": 0
}
],
"search_criteria": {"current_page": 0,
"filter_groups": [{"filters": [{"condition_type": "string",
"field": "string",
"value": "string"
}
]
}
],
"page_size": 0,
"sort_orders": [{"direction": "string",
"field": "string"
}
]
},
"total_count": 0
}

➔ Next to company/{parentId}/relations