Create one contact address
post
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/addresses
Request
Path Parameters
-
SupplierId(required): integer(int64)
Value that uniquely identifies the supplier.
Header Parameters
-
Metadata-Context: string
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: string
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: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AdditionalAddressAttribute1: string
Title:
Additional Address Element 1Maximum Length:150First additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute2: string
Title:
Additional Address Element 2Maximum Length:150Second additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute3: string
Title:
Additional Address Element 3Maximum Length:150Third additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute4: string
Title:
Additional Address Element 4Maximum Length:150Fourth Additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute5: string
Title:
Additional Address Element 5Maximum Length:150Fifth additional address attribute for the flexible supplier address format. -
Addressee: string
Title:
AddresseeMaximum Length:360Addressee of the supplier address. -
AddressLine1: string
Title:
Address Line 1Maximum Length:240First line of the supplier address. -
AddressLine2: string
Title:
Address Line 2Maximum Length:240Second line of the supplier address. -
AddressLine3: string
Title:
Address Line 3Maximum Length:240Third line of the supplier address. -
AddressLine4: string
Title:
Address Line 4Maximum Length:240Fourth line of the supplier address. -
AddressName: string
Title:
Address NameMaximum Length:240Name of the supplier address that is associated to the supplier contact. -
AddressPurposeOrderingFlag: boolean
Title:
OrderingMaximum Length:255Contains one of the following values: true or false. If true, then you can use the supplier address for ordering. If false, then you cannot use this address. The default value is false. -
AddressPurposeRemitToFlag: boolean
Title:
Remit toMaximum Length:255Contains one of the following values: true or false. If true, then you can use the supplier address to send payment. If false, then you cannot use this address. The default value is false. -
AddressPurposeRFQOrBiddingFlag: boolean
Title:
RFQ or BiddingMaximum Length:255Contains one of the following values: true or false. If true, then you can use the supplier address for request for proposal or bidding. If false, then you cannot use this address. The default value is false. -
Building: string
Title:
BuildingMaximum Length:240Building of the supplier address. -
City: string
Title:
City or LocalityMaximum Length:60City of the supplier address. -
Country: string
Title:
CountryMaximum Length:80Country of the supplier address. -
CountryCode(required): string
Title:
Country CodeMaximum Length:2Abbreviation that identifies the country where the supplier address is located. -
County: string
Title:
CountyMaximum Length:60County of the supplier address. -
DFF: array
Flexfields for Supplier Address
Title:
Flexfields for Supplier AddressThe Flexfields for Supplier Address resource manages supplier address descriptive flexfields. -
Email(required): string
Title:
EmailMaximum Length:320Email for the supplier address. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:20Abbreviation that identifies the area for the fax of the supplier address. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:10Abbreviation that identifies the country for the fax of the supplier address. -
FaxNumber: string
Title:
FaxMaximum Length:40Fax of the supplier address. -
FloorNumber: string
Title:
FloorMaximum Length:40Floor number of the supplier address. -
GlobalLocationNumber: string
Title:
Global Location NumberMaximum Length:40Global location number of the supplier address. -
InactiveDate: string
(date)
Title:
Inactive DateDate when the supplier address is no longer active. -
Language: string
Title:
LanguageMaximum Length:255Language of the supplier address. -
LanguageCode: string
Title:
LanguageMaximum Length:4Abbreviation that identifies the language of the supplier address. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:20Abbreviation that identifies the area for phone of the supplier address. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Abbreviation that identifies the country for the phone of the supplier address. -
PhoneExtension: string
Title:
Phone ExtensionMaximum Length:20Phone extension of the supplier address. -
PhoneNumber: string
Title:
PhoneMaximum Length:40Phone number of the supplier address. -
PhoneticAddress: string
Title:
Phonetic Address LineMaximum Length:560Phonetic, Japanese kana, or Chinese kanji representation of the address lines. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the supplier address. -
PostalCodeExtension: string
Title:
Postal Plus 4 CodeMaximum Length:20Four digit extension to the postal code of the supplier address. -
Province: string
Title:
ProvinceMaximum Length:60Province of the supplier address. -
State: string
Title:
State or RegionMaximum Length:60State of the supplier address.
Nested Schema : Flexfields for Supplier Address
Type:
arrayTitle:
Flexfields for Supplier AddressThe Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
Show Source
Nested Schema : suppliers-addresses-DFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Enter Party Site InformationMaximum Length:30Descriptive flexfield context name for supplier sites. -
__FLEX_Context_DisplayValue: string
Title:
Enter Party Site InformationDescriptive flexfield context display value for supplier sites.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : suppliers-addresses-item-response
Type:
Show Source
object-
AdditionalAddressAttribute1: string
Title:
Additional Address Element 1Maximum Length:150First additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute2: string
Title:
Additional Address Element 2Maximum Length:150Second additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute3: string
Title:
Additional Address Element 3Maximum Length:150Third additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute4: string
Title:
Additional Address Element 4Maximum Length:150Fourth Additional address attribute for the flexible supplier address format. -
AdditionalAddressAttribute5: string
Title:
Additional Address Element 5Maximum Length:150Fifth additional address attribute for the flexible supplier address format. -
Addressee: string
Title:
AddresseeMaximum Length:360Addressee of the supplier address. -
AddressLine1: string
Title:
Address Line 1Maximum Length:240First line of the supplier address. -
AddressLine2: string
Title:
Address Line 2Maximum Length:240Second line of the supplier address. -
AddressLine3: string
Title:
Address Line 3Maximum Length:240Third line of the supplier address. -
AddressLine4: string
Title:
Address Line 4Maximum Length:240Fourth line of the supplier address. -
AddressName: string
Title:
Address NameMaximum Length:240Name of the supplier address that is associated to the supplier contact. -
AddressPartyNumber: string
Title:
Site NumberRead Only:trueMaximum Length:30Number that identifies the supplier. -
AddressPurposeOrderingFlag: boolean
Title:
OrderingMaximum Length:255Contains one of the following values: true or false. If true, then you can use the supplier address for ordering. If false, then you cannot use this address. The default value is false. -
AddressPurposeRemitToFlag: boolean
Title:
Remit toMaximum Length:255Contains one of the following values: true or false. If true, then you can use the supplier address to send payment. If false, then you cannot use this address. The default value is false. -
AddressPurposeRFQOrBiddingFlag: boolean
Title:
RFQ or BiddingMaximum Length:255Contains one of the following values: true or false. If true, then you can use the supplier address for request for proposal or bidding. If false, then you cannot use this address. The default value is false. -
Building: string
Title:
BuildingMaximum Length:240Building of the supplier address. -
City: string
Title:
City or LocalityMaximum Length:60City of the supplier address. -
Country: string
Title:
CountryMaximum Length:80Country of the supplier address. -
CountryCode: string
Title:
Country CodeMaximum Length:2Abbreviation that identifies the country where the supplier address is located. -
County: string
Title:
CountyMaximum Length:60County of the supplier address. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the supplier record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the supplier record. -
DFF: array
Flexfields for Supplier Address
Title:
Flexfields for Supplier AddressThe Flexfields for Supplier Address resource manages supplier address descriptive flexfields. -
Email: string
Title:
EmailMaximum Length:320Email for the supplier address. -
FaxAreaCode: string
Title:
Fax Area CodeMaximum Length:20Abbreviation that identifies the area for the fax of the supplier address. -
FaxCountryCode: string
Title:
Fax Country CodeMaximum Length:10Abbreviation that identifies the country for the fax of the supplier address. -
FaxNumber: string
Title:
FaxMaximum Length:40Fax of the supplier address. -
FloorNumber: string
Title:
FloorMaximum Length:40Floor number of the supplier address. -
FormattedAddress: string
Title:
AddressRead Only:trueName of the supplier address. -
GlobalLocationNumber: string
Title:
Global Location NumberMaximum Length:40Global location number of the supplier address. -
InactiveDate: string
(date)
Title:
Inactive DateDate when the supplier address is no longer active. -
Language: string
Title:
LanguageMaximum Length:255Language of the supplier address. -
LanguageCode: string
Title:
LanguageMaximum Length:4Abbreviation that identifies the language of the supplier address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when the user most recently updated the supplier record. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who most recently updated the supplier record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:20Abbreviation that identifies the area for phone of the supplier address. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10Abbreviation that identifies the country for the phone of the supplier address. -
PhoneExtension: string
Title:
Phone ExtensionMaximum Length:20Phone extension of the supplier address. -
PhoneNumber: string
Title:
PhoneMaximum Length:40Phone number of the supplier address. -
PhoneticAddress: string
Title:
Phonetic Address LineMaximum Length:560Phonetic, Japanese kana, or Chinese kanji representation of the address lines. -
PostalCode: string
Title:
Postal CodeMaximum Length:60Postal code of the supplier address. -
PostalCodeExtension: string
Title:
Postal Plus 4 CodeMaximum Length:20Four digit extension to the postal code of the supplier address. -
Province: string
Title:
ProvinceMaximum Length:60Province of the supplier address. -
State: string
Title:
State or RegionMaximum Length:60State of the supplier address. -
Status: string
Title:
StatusRead Only:trueMaximum Length:255Status of the supplier address. -
SupplierAddressId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier address that is associated to the supplier contact.
Nested Schema : Flexfields for Supplier Address
Type:
arrayTitle:
Flexfields for Supplier AddressThe Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : suppliers-addresses-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Enter Party Site InformationMaximum Length:30Descriptive flexfield context name for supplier sites. -
__FLEX_Context_DisplayValue: string
Title:
Enter Party Site InformationDescriptive flexfield context display value for supplier sites. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartySiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier address.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- DFF
-
Parameters:
- SupplierAddressId:
$request.path.SupplierAddressId - SupplierId:
$request.path.SupplierId
The Flexfields for Supplier Address resource manages supplier address descriptive flexfields. - SupplierAddressId:
Examples
This example describes how to create a supplier address.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/addresses"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"AddressName": "Headquarter",
"Country": "United States",
"AddressLine1": "Example Road",
"City": "Redwood City",
"State": "CA",
"PostalCode": "94065",
"AddressPurposeOrderingFlag": true,
"AddressPurposeRemitToFlag": true,
"AddressPurposeRFQOrBiddingFlag": false
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"SupplierAddressId": 300100176689658,
"AddressName": "Headquarter",
"CountryCode": "US",
"Country": "United States",
"AddressLine1": "Example Road",
"AddressLine2": null,
"AddressLine3": null,
"AddressLine4": null,
"City": "Redwood City",
"State": "CA",
"PostalCode": "94065",
"PostalCodeExtension": null,
"Province": null,
"County": null,
"Building": null,
"FloorNumber": null,
"PhoneticAddress": null,
"LanguageCode": null,
"Language": null,
"Addressee": null,
"GlobalLocationNumber": null,
"AdditionalAddressAttribute1": null,
"AdditionalAddressAttribute2": null,
"AdditionalAddressAttribute3": null,
"AdditionalAddressAttribute4": null,
"AdditionalAddressAttribute5": null,
"AddressPurposeOrderingFlag": true,
"AddressPurposeRemitToFlag": true,
"AddressPurposeRFQOrBiddingFlag": false,
"PhoneCountryCode": null,
"PhoneAreaCode": null,
"PhoneNumber": null,
"PhoneExtension": null,
"FaxCountryCode": null,
"FaxAreaCode": null,
"FaxNumber": null,
"Email": null,
"InactiveDate": "4712-12-31",
"Status": "ACTIVE",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/addresses/300100176689658",
"name": "addresses",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000008770400000008737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E0002000000017371007E0002000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000971007E000971007E000978"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/addresses/300100176689658",
"name": "addresses",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652",
"name": "suppliers",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/addresses/300100176689658/lov/LanguageLookup",
"name": "LanguageLookup",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/addresses/300100176689658/lov/CountryLookup",
"name": "CountryLookup",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/suppliers/300100176689652/child/addresses/300100176689658/child/DFF",
"name": "DFF",
"kind": "collection"
}
]
}