Postal Address GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/contact-service/postal-address/{ID-SET}

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

This resource allows you to request postal addresses by ID.

Note: the ID set in the request URI is mandatory. It is not possible to get all postal addresses in a single call.

Example 1

Fetch the postal address with ID 109.

Request URI

/postal-address/109

Response

{
	"response": [
		{
			"addressId": 109,
			"contactId": 200,
			"addressLine1": "Brightpearl, First Floor",
			"addressLine2": "New Bond House",
			"addressLine3": "Bond Street",
			"addressLine4": "Bristol",
			"postalCode": "BS2 9AG",
			"countryIsoCode": "GBR",
			"countryIsoCode2": "GB",
			"countryId": 222
		}
	]
}

Example 2

Fetch the portal addresses with IDs in the range 100-120.

Request URI

/postal-address/100-120/

Response

{
	"response": [
		{
			"addressId": 106,
			"contactId": 4,
			"addressLine1": "Tour Eiffel",
			"addressLine2": "Champ de Mars",
			"addressLine3": "Paris ",
			"postalCode": "75007",
			"countryIsoCode": "FRA",
			"countryIsoCode2": "FR",
			"countryId": 222
		},
		{
			"addressId": 109,
			"contactId": 200,
			"addressLine1": "Brightpearl, First Floor",
			"addressLine2": "New Bond House",
			"addressLine3": "Bond Street",
			"addressLine4": "Bristol",
			"postalCode": "BS2 9AG",
			"countryIsoCode": "GBR",
			"countryIsoCode2": "GB",
			"countryId": 222
		},
		{
			"addressId": 110,
			"contactId": 201,
			"postalCode": "BS1 2GB",
			"countryIsoCode": "GBR",
			"countryIsoCode2": "GB",
			"countryId": 222
		},
		{
			"addressId": 116,
			"contactId": 206,
			"addressLine1": "Englischer Garten",
			"addressLine3": "Munich",
			"postalCode": "80331",
			"countryIsoCode": "DEU",
			"countryIsoCode2": "DE",
			"countryId": 222
		}
	]
}