1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Addresses

Update an address

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}

Request

Path Parameters
  • The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
  • The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
  • Address Locales
    Title: Address Locales
    The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
  • Address Purposes
    Title: Address Purposes
    The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
  • Title: Type
    The type of address.
  • Title: Building
    Maximum Length: 240
    The building name or number in the address.
  • The formatted address.
  • Title: City
    Maximum Length: 60
    The city in the address.
  • Title: CLLI Code
    Maximum Length: 60
    The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the address.
  • Default Value: 0
    The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
  • Title: Corporate Currency
    Maximum Length: 15
    The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Country
    Maximum Length: 2
    The country code of the address. Review the list of country codes using the Manage Geographies task.
  • Title: County
    Maximum Length: 60
    The county of the address.
  • Default Value: HZ_WS
    The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
  • Title: Created by Application
    Maximum Length: 30
    The user who created the module.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency Code
    Maximum Length: 15
    The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Validated Date
    The date when the address was last validated.
  • Title: Description
    Maximum Length: 2000
    The description of the location.
  • Title: Contact Preferences
    Default Value: false
    Indicates whether the address should not be used for mailing.
  • Title: Don't Validate
    Maximum Length: 1
    Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The D-U-N-S number of the business location.
  • The date when the address becomes active.
  • Title: End Date
    The date after which the address becomes inactive.
  • Title: Floor
    Maximum Length: 40
    The floor number of the address.
  • Title: House Type
    Maximum Length: 30
    The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Latitude
    The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
  • Title: Location Directions
    Maximum Length: 640
    The directions to the address location.
  • Title: Location ID
    The unique identifier for the location.
  • Title: Longitude
    The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
  • Title: Mail Stop
    Maximum Length: 60
    The user-defined code that indicates a mail drop point within the organization.
  • The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Title: Party ID
    The unique identifier of the account associated with the address.
  • Title: Party Number
    The unique alternate identifier for the account associated with the address. Inactive records can't be updated.
  • Title: Site Name
    Maximum Length: 240
    User-defined name for the address.
  • Title: Party Source System
    The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
  • Title: Party Source System Reference Value
    The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code for the address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.
  • Title: Province
    Maximum Length: 60
    The province of the address.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
  • The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
  • Title: State
    Maximum Length: 60
    The state of the address.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.
  • Title: Validated
    Maximum Length: 1
    Default Value: false
    Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
  • Title: Validation Status
    Maximum Length: 30
    The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type: array
Title: Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type: array
Title: Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Address Element Attribute 1
    Maximum Length: 150
    The additional address element 1 to support flexible address format in local language.
  • Title: Address Element Attribute 2
    Maximum Length: 150
    The additional address element 2 to support flexible address format in local language.
  • Title: Address Element Attribute 3
    Maximum Length: 150
    The additional address element 3 to support flexible address format in local language.
  • Title: Address Element Attribute 4
    Maximum Length: 150
    The additional address element 4 to support flexible address format in local language.
  • Title: Address Element Attribute 5
    Maximum Length: 150
    The additional address element 5 to support flexible address format in local language.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the address in the local language.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the address in the local language.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the address in the local language.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the address in the local language.
  • Title: Building
    Maximum Length: 240
    The specific building name or number at a given address in local language.
  • Title: City
    Maximum Length: 60
    The specific name of the city in local language.
  • Title: County
    Maximum Length: 60
    The specific name of the county in local language.
  • Title: Floor
    Maximum Length: 240
    The specific floor number at a given address or a particular building when building number is provided in local language.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code in local language.
  • Title: Province
    Maximum Length: 60
    The name of the province in local language.
  • The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Title: State
    Maximum Length: 60
    The name of the State in the local language.
  • Title: Transliteration Language
    Maximum Length: 4
    Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : schema
Type: object
Show Source
  • Title: Comments
    Maximum Length: 2000
    The user comments for the address purpose.
  • Maximum Length: 30
    Default Value: HZ_WS
    The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
  • Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
  • Title: To Date
    The date on which the address purpose is no longer valid.
  • Title: Primary
    Maximum Length: 1
    Default Value: N
    Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
  • The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
  • The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : accounts-Address-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : accounts-Address-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : accounts-Address-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : accounts-Address-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : accounts-Address-item-response
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address.
  • Read Only: true
    The unique identifier of the address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
  • Address Locales
    Title: Address Locales
    The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
  • Title: Site Number
    Maximum Length: 30
    The alternate key identifier of the address that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
  • Address Purposes
    Title: Address Purposes
    The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
  • Title: Type
    The type of address.
  • Title: Building
    Maximum Length: 240
    The building name or number in the address.
  • The formatted address.
  • Title: City
    Maximum Length: 60
    The city in the address.
  • Title: CLLI Code
    Maximum Length: 60
    The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the address.
  • Default Value: 0
    The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
  • Title: Corporate Currency
    Maximum Length: 15
    The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Country
    Maximum Length: 2
    The country code of the address. Review the list of country codes using the Manage Geographies task.
  • Title: County
    Maximum Length: 60
    The county of the address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the account record.
  • Default Value: HZ_WS
    The application module that created the address record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
  • Title: Created by Application
    Maximum Length: 30
    The user who created the module.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency Code
    Maximum Length: 15
    The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Validated Date
    The date when the address was last validated.
  • Title: Description
    Maximum Length: 2000
    The description of the location.
  • Title: Contact Preferences
    Default Value: false
    Indicates whether the address should not be used for mailing.
  • Title: Don't Validate
    Maximum Length: 1
    Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The D-U-N-S number of the business location.
  • The date when the address becomes active.
  • Title: End Date
    The date after which the address becomes inactive.
  • Title: Floor
    Maximum Length: 40
    The floor number of the address.
  • Title: Address
    Read Only: true
    The formatted version of the address.
  • Title: Formatted Address 1
    Read Only: true
    The formatted address of the contact address record.
  • Title: Address
    Read Only: true
    The formatted multiline version of the address.
  • Title: Address
    Read Only: true
    The formatted address in multiline of the contact address record.
  • Title: House Type
    Maximum Length: 30
    The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Title: Latitude
    The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
  • Links
  • Title: Location Directions
    Maximum Length: 640
    The directions to the address location.
  • Title: Location ID
    The unique identifier for the location.
  • Title: Longitude
    The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
  • Title: Mail Stop
    Maximum Length: 60
    The user-defined code that indicates a mail drop point within the organization.
  • The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Title: Party ID
    The unique identifier of the account associated with the address.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The name of the party.
  • Title: Party Number
    The unique alternate identifier for the account associated with the address. Inactive records can't be updated.
  • Title: Site Name
    Maximum Length: 240
    User-defined name for the address.
  • Title: Party Source System
    The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
  • Title: Party Source System Reference Value
    The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
  • Title: Unique Party Name
    Read Only: true
    Maximum Length: 900
    The unique party name of the party record.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code for the address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.
  • Title: Province
    Maximum Length: 60
    The province of the address.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
  • The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
  • Read Only: true
    Maximum Length: 255
    The name of the table that holds the record data and is referenced to manage source system reference.
  • Read Only: true
    Maximum Length: 255
    Default Value: HZ_PARTIES
    The name of the table that holds the party record data and is referenced to manage source system reference.
  • Title: Start Date
    The date when the address becomes active.
  • Title: State
    Maximum Length: 60
    The state of the address.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.
  • Title: Validated
    Maximum Length: 1
    Default Value: false
    Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
  • Read Only: true
    The date when the validation becomes active. The value is internally set by system during address cleansing.
  • Title: Validation Status
    Maximum Length: 30
    The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type: array
Title: Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Address Purposes
Type: array
Title: Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-Address-AddressLocale-item-response
Type: object
Show Source
  • Title: Address Element Attribute 1
    Maximum Length: 150
    The additional address element 1 to support flexible address format in local language.
  • Title: Address Element Attribute 2
    Maximum Length: 150
    The additional address element 2 to support flexible address format in local language.
  • Title: Address Element Attribute 3
    Maximum Length: 150
    The additional address element 3 to support flexible address format in local language.
  • Title: Address Element Attribute 4
    Maximum Length: 150
    The additional address element 4 to support flexible address format in local language.
  • Title: Address Element Attribute 5
    Maximum Length: 150
    The additional address element 5 to support flexible address format in local language.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the address in the local language.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the address in the local language.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the address in the local language.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the address in the local language.
  • Title: Site Number
    Read Only: true
    Maximum Length: 30
    The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.
  • Title: Building
    Maximum Length: 240
    The specific building name or number at a given address in local language.
  • Title: City
    Maximum Length: 60
    The specific name of the city in local language.
  • Title: Country
    Read Only: true
    Maximum Length: 2
    The specific name of the country in local language.
  • Title: County
    Maximum Length: 60
    The specific name of the county in local language.
  • Read Only: true
    Maximum Length: 64
    The user who created the address locale record.
  • Read Only: true
    The date and time when the address locale record was created.
  • Title: Floor
    Maximum Length: 240
    The specific floor number at a given address or a particular building when building number is provided in local language.
  • Read Only: true
    The formatted read only version of the locale address.
  • Read Only: true
    The date and time when the address locale was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the address locale record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the address locale record.
  • Links
  • The unique identifier of the location record.
  • Read Only: true
    The unique identifier of the location locale record.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code in local language.
  • Title: Province
    Maximum Length: 60
    The name of the province in local language.
  • The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Title: State
    Maximum Length: 60
    The name of the State in the local language.
  • Title: Transliteration Language
    Maximum Length: 4
    Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : accounts-Address-AddressPurpose-item-response
Type: object
Show Source
  • The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
  • Title: Site Number
    Read Only: true
    Maximum Length: 30
    The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
  • Read Only: true
    The unique identifier of the address purpose.
  • Title: Comments
    Maximum Length: 2000
    The user comments for the address purpose.
  • Read Only: true
    Maximum Length: 64
    The user who created the address purpose record.
  • Maximum Length: 30
    Default Value: HZ_WS
    The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
  • Read Only: true
    The date and time when the address purpose record was created.
  • Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
  • Title: To Date
    The date on which the address purpose is no longer valid.
  • Read Only: true
    The date and time when the address purpose was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the address purpose record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the address purpose record.
  • Links
  • Title: Primary
    Maximum Length: 1
    Default Value: N
    Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
  • Title: Purpose
    Maximum Length: 30
    The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
  • The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Title: From Date
    The date from which the address purpose is valid.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : accounts-Address-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function associated with the smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-Address-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : accounts-Address-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : accounts-Address-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Links
AddressLocale
Parameters:
  • AddressNumber: $request.path.AddressNumber
  • PartyNumber: $request.path.PartyNumber
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
AddressPurpose
Parameters:
  • AddressNumber: $request.path.AddressNumber
  • PartyNumber: $request.path.PartyNumber
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
CountriesLOV
Parameters:
  • finder: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The list of values indicating the country of the address, such as US and UK.

The following properties are defined on the LOV link relation:
  • Source Attribute: Country; Target Attribute: TerritoryCode
  • Display Attribute: TerritoryShortName
FuseTypeLookupVA
Parameters:
  • finder: LookupTypeTagFinder%3BBindLookupType%3DPARTY_SITE_USE_CODE%2CBindTag%3DSALES_CLOUD
The following properties are defined on the LOV link relation:
  • Source Attribute: AddressType; Target Attribute: LookupCode
  • Display Attribute: Meaning
HouseTypeLookupLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
The list of values indicating the house type of the address, such as House Boat and Trailer.

The following properties are defined on the LOV link relation:
  • Source Attribute: HouseType; Target Attribute: LookupCode
  • Display Attribute: Meaning
PartySiteEO_setCurrentOverallPrimaryFlag
Parameters:
  • AddressNumber: $request.path.AddressNumber
  • PartyNumber: $request.path.PartyNumber
PartySiteEO_setCurrentPrimaryFlag
Parameters:
  • AddressNumber: $request.path.AddressNumber
  • PartyNumber: $request.path.PartyNumber
smartActions
Parameters:
  • AddressNumber: $request.path.AddressNumber
  • PartyNumber: $request.path.PartyNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Back to Top

Examples

The following example shows how to update an address by submitting a patch request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_262783/child/Address/CDRM_100005

Example of Request Body

The following shows an example of the request body in JSON format.

{
   "Address" : [ {
      "AddressLine1" : "800 oracle parkway",
      "City" : "Redwood Shores",
      "State" : "CA",
      "Country" : "US"
      }  ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
   "PartyId" : 300100046354520,
   "PartyNumber" : "CDRM_262783",
   "AddressId" : 300100046354531,
   "AddressNumber" : "CDRM_100005",
   "CreatedByModule" : "HZ_WS",
   "FormattedAddress" : "800 oracle parkway, REDWOOD SHORES, CA",
   "FormattedMultilineAddress" : "700 oracle parkway, REDWOOD SHORES, CA",
   "AddressLine1" : "800 oracle parkway",   
   "City" : "Redwood Shores",
   "Country" : "US",
   "State" : "CA",
   ...  
}
Back to Top