Postal Address POST

URI

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

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

Description

This resource allows you to create new postal addresses.

Things to note:

  • addressLine1 is required.
  • You can either specify a country using the Brightpearl countryId or the country's 3 character ISO code using countryIsoCode.

Field Listing:

Field Name Field Description
addressLine1 First line of the address. Maps to Street.
addressLine2 Second line of the address. Maps to Suburb.
addressLine3 Third line of the address. Maps to City.
addressLine4 Fourth line of the address. Maps to State.
postalCode Zip or postal code.
countryIsoCode ISO code of the country for this address. Use either this field, or countryId.
countryId Brightpearl country ID for the address. Use either this, or countryIsoCode.

Example 1

Creating a new postal address using country ISO code.

Request URI

/postal-address/

Request body

{
	"addressLine1": "Brightpearl, First Floor",
	"addressLine2": "New Bond House",
	"addressLine3": "Bond Street",
	"addressLine4": "Bristol",
	"postalCode": "BS2 9AG",
	"countryIsoCode": "GBR"
}

Response

{
	"response": 123
}

Example 2

Creating a new postal address using country ID.

Request URI

/postal-address/

Request body

{
	"addressLine1": "Brightpearl, First Floor",
	"addressLine2": "New Bond House",
	"addressLine3": "Bond Street",
	"addressLine4": "Bristol",
	"postalCode": "BS2 9AG",
	"countryId": 222
}

Response

{
	"response": 124
}

Example 3

Creating a new postal address using bare minimum data.

Request URI

/postal-address/

Request body

{
	"addressLine1": "23B Park Street",
	"postalCode": "BS1 4GH"
}

Response

{
	"response": 125
}