Create an address
post
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Request
Path Parameters
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
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
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update. -
AddressType: string
Title:
Type
The lookup code for the type of address, such as billing address, shipping address etc. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code of the address associated with the contact. 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 of the address. Review the list of countries using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
The module that created the address record. -
CurcyConvRateType: string
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. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. 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. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the partner associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
SourceSystem: string
The identifier of the record from external source system.
-
SourceSystemReferenceValue: string
The name of the external source system.
-
State: string
Title:
State
Maximum Length:60
The state of the address. -
ValidatedFlag: boolean
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.
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 : partners-addresses-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the address. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update. -
AddressType: string
Title:
Type
The lookup code for the type of address, such as billing address, shipping address etc. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code of the address associated with the contact. 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 of the address. Review the list of countries using the Manage Geographies task. -
CountryName: string
Read Only:
true
The name of the country of the partner company. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
The module that created the address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
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. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. 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. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiline version of the address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the partner associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
SourceSystem: string
The identifier of the record from external source system.
-
SourceSystemReferenceValue: string
The name of the external source system.
-
State: string
Title:
State
Maximum Length:60
The state of the address. -
ValidatedFlag: boolean
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.
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: