Create a primary address
post
/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress
Request
Path Parameters
-
PartyNumber(required): string
The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The addressee of the primary address. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. The AddressNumber is auto-generated when the contact is created, and is not required to be in the request payload when creating a contact. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified during creating the contact, then it is automatically generated using a list of accepted values from the profile option ZCA_PUID_PREFIX, and concatenated with an internally generated unique sequence number. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the addresses. 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. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county element of Address. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates if the primary address was deleted. If the value is True, then the primary address is deleted. The default value is False. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location of the address. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building mentioned 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. -
Latitude: number
Title:
Latitude
Used to store latitude information for the location for spatial proximity and containment purposes. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
The unique identifier for this location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
LocationSourceSystem: string
The name of source system for the location record.
-
LocationSourceSystemReferenceValue: string
The unique source system identifier value.
-
LocationStatusFlag: boolean
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
Used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. 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.
-
ObjectVersionNumberPartySite: integer
(int32)
The internal version number for the party site object. 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.
-
OverallPrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address. -
PartyId: integer
(int64)
The unique Identifier of the contact to which the primary address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
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 of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The 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.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : contacts-PrimaryAddress-item-response
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The addressee of the primary address. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. The AddressNumber is auto-generated when the contact is created, and is not required to be in the request payload when creating a contact. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified during creating the contact, then it is automatically generated using a list of accepted values from the profile option ZCA_PUID_PREFIX, and concatenated with an internally generated unique sequence number. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the addresses. 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. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county element of Address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the address record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates if the primary address was deleted. If the value is True, then the primary address is deleted. The default value is False. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location of the address. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address information. -
FormattedMultiLineAddress: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building mentioned 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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the address data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the address record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the address record. -
Latitude: number
Title:
Latitude
Used to store latitude information for the location for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
The unique identifier for this location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
LocationSourceSystem: string
The name of source system for the location record.
-
LocationSourceSystemReferenceValue: string
The unique source system identifier value.
-
LocationStatusFlag: boolean
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
Used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. 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.
-
ObjectVersionNumberPartySite: integer
(int32)
The internal version number for the party site object. 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.
-
OverallPrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address. -
PartyId: integer
(int64)
The unique Identifier of the contact to which the primary address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
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 of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The 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.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
- finder:
- HouseTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
- finder: