Partially update address

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

externalIdstring^\S+$required

External id of the address that is globally unique across the provided address data

Example:"ADDR12345"

businessPartnerNumberstring

Number of the business partner related to this address (e.g. customer number)

Example:"BP12345"

parentBusinessPartnerNumberstring

Number of the parent business partner of this address (e.g. customer number)

Example:"PBP12345"

typestring

Type of the address

Enum:"shippingAddress""billingAddress"

Example:"shippingAddress"

addressOrdernumber

Order of the address (in case there’s several addresses of the same type)

Example:1

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"CLIENT123"

globalLocationNumberstring

13-digit Global Location Number (GLN) used for unique location identification in B2B transactions

Example:"1234567890123"

companyNamestring^[\S ]*\S[\S ]*$

Name of the company associated with the address

Example:"Acme Corporation"

nameAlternative1string

Alternative name of the company (e.g. trade name or local language)

Example:"Acme Corp."

nameAlternative2string

Alternative name of the company

Example:"Acme Inc."

nameAlternative3string

Alternative name of the company

Example:"Acme Ltd."

nameAlternative4string

Alternative name of the company

Example:"Acme GmbH"

streetstring

Street and street number where the address is located

Example:"123 Main St"

addressAdditionalstring

Additional address data (e.g. building, entrance, apartment, or suite)

Example:"Building A, Suite 101"

postcodestring

Postcode where the address is located

Example:"12345"

citystring

City where the address is located

Example:"Berlin"

postOfficeBoxstring

Post office box number, if used instead of street address

Example:"PO Box 123"

countryCodestring or null(CountryCode)

Two letter country code as defined in ISO 3166-1 alpha-2

Enum:"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

Example:"DE"

regionstring

Region, state, or province of the address (e.g. "CA" for California or "BE" for Berlin)

Example:"BE"

transportationZonestring

Code identifying the transportation or logistics zone relevant for shipping or route planning

Example:"TZ123"

phoneNumberstring

Phone number of the location or contact point

Example:"+491234567890"

faxNumberstring

Fax number of the location or contact point

Example:"+491234567891"

emailstring

Email address associated with the location or contact point

Example:"contact@acme.com"

validFromstring, (date)

Start date from which the address is considered valid (format: YYYY-MM-DD)

Example:"2023-01-01"

validTostring, (date)

End date until which the address is considered valid (format: YYYY-MM-DD)

Example:"2023-12-31"

isDefaultboolean

Indicator whether this address is the default for the given type (e.g., default ship-to address)

Example:true

latitudenumber

Geographical latitude coordinate of the address (in decimal degrees)

Example:52.520008

longitudenumber

Geographical longitude coordinate of the address (in decimal degrees)

Example:13.404954

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/enrichment/addresses/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "externalId": "ADDR12345",
    "businessPartnerNumber": "BP12345",
    "parentBusinessPartnerNumber": "PBP12345",
    "type": "shippingAddress",
    "addressOrder": 1,
    "externalClientId": "CLIENT123",
    "globalLocationNumber": "1234567890123",
    "companyName": "Acme Corporation",
    "nameAlternative1": "Acme Corp.",
    "nameAlternative2": "Acme Inc.",
    "nameAlternative3": "Acme Ltd.",
    "nameAlternative4": "Acme GmbH",
    "street": "123 Main St",
    "addressAdditional": "Building A, Suite 101",
    "postcode": "12345",
    "city": "Berlin",
    "postOfficeBox": "PO Box 123",
    "countryCode": "DE",
    "region": "BE",
    "transportationZone": "TZ123",
    "phoneNumber": "+491234567890",
    "faxNumber": "+491234567891",
    "email": "contact@acme.com",
    "validFrom": "2023-01-01",
    "validTo": "2023-12-31",
    "isDefault": true,
    "latitude": 52.520008,
    "longitude": 13.404954,
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully updated

Bodyapplication/json

externalIdstring^\S+$required

External id of the address that is globally unique across the provided address data

Example:"ADDR12345"

businessPartnerNumberstring

Number of the business partner related to this address (e.g. customer number)

Example:"BP12345"

parentBusinessPartnerNumberstring

Number of the parent business partner of this address (e.g. customer number)

Example:"PBP12345"

typestring

Type of the address

Enum:"shippingAddress""billingAddress"

Example:"shippingAddress"

addressOrdernumber

Order of the address (in case there’s several addresses of the same type)

Example:1

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"CLIENT123"

globalLocationNumberstring

13-digit Global Location Number (GLN) used for unique location identification in B2B transactions

Example:"1234567890123"

companyNamestring^[\S ]*\S[\S ]*$

Name of the company associated with the address

Example:"Acme Corporation"

nameAlternative1string

Alternative name of the company (e.g. trade name or local language)

Example:"Acme Corp."

nameAlternative2string

Alternative name of the company

Example:"Acme Inc."

nameAlternative3string

Alternative name of the company

Example:"Acme Ltd."

nameAlternative4string

Alternative name of the company

Example:"Acme GmbH"

streetstring

Street and street number where the address is located

Example:"123 Main St"

addressAdditionalstring

Additional address data (e.g. building, entrance, apartment, or suite)

Example:"Building A, Suite 101"

postcodestring

Postcode where the address is located

Example:"12345"

citystring

City where the address is located

Example:"Berlin"

postOfficeBoxstring

Post office box number, if used instead of street address

Example:"PO Box 123"

countryCodestring or null(CountryCode)

Two letter country code as defined in ISO 3166-1 alpha-2

Enum:"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

Example:"DE"

regionstring

Region, state, or province of the address (e.g. "CA" for California or "BE" for Berlin)

Example:"BE"

transportationZonestring

Code identifying the transportation or logistics zone relevant for shipping or route planning

Example:"TZ123"

phoneNumberstring

Phone number of the location or contact point

Example:"+491234567890"

faxNumberstring

Fax number of the location or contact point

Example:"+491234567891"

emailstring

Email address associated with the location or contact point

Example:"contact@acme.com"

validFromstring, (date)

Start date from which the address is considered valid (format: YYYY-MM-DD)

Example:"2023-01-01"

validTostring, (date)

End date until which the address is considered valid (format: YYYY-MM-DD)

Example:"2023-12-31"

isDefaultboolean

Indicator whether this address is the default for the given type (e.g., default ship-to address)

Example:true

latitudenumber

Geographical latitude coordinate of the address (in decimal degrees)

Example:52.520008

longitudenumber

Geographical longitude coordinate of the address (in decimal degrees)

Example:13.404954

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

Response

{
  "externalId": "ADDR12345",
  "businessPartnerNumber": "BP12345",
  "parentBusinessPartnerNumber": "PBP12345",
  "type": "shippingAddress",
  "addressOrder": 1,
  "externalClientId": "CLIENT123",
  "globalLocationNumber": "1234567890123",
  "companyName": "Acme Corporation",
  "nameAlternative1": "Acme Corp.",
  "nameAlternative2": "Acme Inc.",
  "nameAlternative3": "Acme Ltd.",
  "nameAlternative4": "Acme GmbH",
  "street": "123 Main St",
  "addressAdditional": "Building A, Suite 101",
  "postcode": "12345",
  "city": "Berlin",
  "postOfficeBox": "PO Box 123",
  "countryCode": "DE",
  "region": "BE",
  "transportationZone": "TZ123",
  "phoneNumber": "+491234567890",
  "faxNumber": "+491234567891",
  "email": "contact@acme.com",
  "validFrom": "2023-01-01",
  "validTo": "2023-12-31",
  "isDefault": true,
  "latitude": 52.520008,
  "longitude": 13.404954,
  "customFields": {
    "property1": "string",
    "property2": "string"
  },
  "customMetadata": {
    "someTopLevelProperty": "value1",
    "someNestedProperty": { … },
    "someArrayProperty": [ … ]
  }
}