Create one contact address

post

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/addresses

Request

Path Parameters
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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    First additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    Second additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    Third additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    Fourth Additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    Fifth additional address attribute for the flexible supplier address format.
  • Title: Addressee
    Maximum Length: 360
    Addressee of the supplier address.
  • Title: Address Line 1
    Maximum Length: 240
    First line of the supplier address.
  • Title: Address Line 2
    Maximum Length: 240
    Second line of the supplier address.
  • Title: Address Line 3
    Maximum Length: 240
    Third line of the supplier address.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth line of the supplier address.
  • Title: Address Name
    Maximum Length: 240
    Name of the supplier address that is associated to the supplier contact.
  • Title: Ordering
    Maximum Length: 255
    Contains 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.
  • Title: Remit to
    Maximum Length: 255
    Contains 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.
  • Title: RFQ or Bidding
    Maximum Length: 255
    Contains 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.
  • Title: Building
    Maximum Length: 240
    Building of the supplier address.
  • Title: City or Locality
    Maximum Length: 60
    City of the supplier address.
  • Title: Country
    Maximum Length: 80
    Country of the supplier address.
  • Title: Country Code
    Maximum Length: 2
    Abbreviation that identifies the country where the supplier address is located.
  • Title: County
    Maximum Length: 60
    County of the supplier address.
  • Flexfields for Supplier Address
    Title: Flexfields for Supplier Address
    The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
  • Title: Email
    Maximum Length: 320
    Email for the supplier address.
  • Title: Fax Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the fax of the supplier address.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax of the supplier address.
  • Title: Fax
    Maximum Length: 40
    Fax of the supplier address.
  • Title: Floor
    Maximum Length: 40
    Floor number of the supplier address.
  • Title: Global Location Number
    Maximum Length: 40
    Global location number of the supplier address.
  • Title: Inactive Date
    Date when the supplier address is no longer active.
  • Title: Language
    Maximum Length: 255
    Language of the supplier address.
  • Title: Language
    Maximum Length: 4
    Abbreviation that identifies the language of the supplier address.
  • Title: Phone Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for phone of the supplier address.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the phone of the supplier address.
  • Title: Phone Extension
    Maximum Length: 20
    Phone extension of the supplier address.
  • Title: Phone
    Maximum Length: 40
    Phone number of the supplier address.
  • Title: Phonetic Address Line
    Maximum Length: 560
    Phonetic, Japanese kana, or Chinese kanji representation of the address lines.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the supplier address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    Four digit extension to the postal code of the supplier address.
  • Title: Province
    Maximum Length: 60
    Province of the supplier address.
  • Title: State or Region
    Maximum Length: 60
    State of the supplier address.
Nested Schema : Flexfields for Supplier Address
Type: array
Title: Flexfields for Supplier Address
The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
Show Source
Nested Schema : suppliers-addresses-DFF-item-post-request
Type: object
Show Source
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 : suppliers-addresses-item-response
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    First additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    Second additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    Third additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    Fourth Additional address attribute for the flexible supplier address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    Fifth additional address attribute for the flexible supplier address format.
  • Title: Addressee
    Maximum Length: 360
    Addressee of the supplier address.
  • Title: Address Line 1
    Maximum Length: 240
    First line of the supplier address.
  • Title: Address Line 2
    Maximum Length: 240
    Second line of the supplier address.
  • Title: Address Line 3
    Maximum Length: 240
    Third line of the supplier address.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth line of the supplier address.
  • Title: Address Name
    Maximum Length: 240
    Name of the supplier address that is associated to the supplier contact.
  • Title: Ordering
    Maximum Length: 255
    Contains 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.
  • Title: Remit to
    Maximum Length: 255
    Contains 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.
  • Title: RFQ or Bidding
    Maximum Length: 255
    Contains 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.
  • Title: Building
    Maximum Length: 240
    Building of the supplier address.
  • Title: City or Locality
    Maximum Length: 60
    City of the supplier address.
  • Title: Country
    Maximum Length: 80
    Country of the supplier address.
  • Title: Country Code
    Maximum Length: 2
    Abbreviation that identifies the country where the supplier address is located.
  • Title: County
    Maximum Length: 60
    County of the supplier address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the supplier record.
  • Title: Creation Date
    Read Only: true
    Date when the user created the supplier record.
  • Flexfields for Supplier Address
    Title: Flexfields for Supplier Address
    The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
  • Title: Email
    Maximum Length: 320
    Email for the supplier address.
  • Title: Fax Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for the fax of the supplier address.
  • Title: Fax Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the fax of the supplier address.
  • Title: Fax
    Maximum Length: 40
    Fax of the supplier address.
  • Title: Floor
    Maximum Length: 40
    Floor number of the supplier address.
  • Title: Global Location Number
    Maximum Length: 40
    Global location number of the supplier address.
  • Title: Inactive Date
    Date when the supplier address is no longer active.
  • Title: Language
    Maximum Length: 255
    Language of the supplier address.
  • Title: Language
    Maximum Length: 4
    Abbreviation that identifies the language of the supplier address.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the supplier record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the supplier record.
  • Links
  • Title: Phone Area Code
    Maximum Length: 20
    Abbreviation that identifies the area for phone of the supplier address.
  • Title: Phone Country Code
    Maximum Length: 10
    Abbreviation that identifies the country for the phone of the supplier address.
  • Title: Phone Extension
    Maximum Length: 20
    Phone extension of the supplier address.
  • Title: Phone
    Maximum Length: 40
    Phone number of the supplier address.
  • Title: Phonetic Address Line
    Maximum Length: 560
    Phonetic, Japanese kana, or Chinese kanji representation of the address lines.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the supplier address.
  • Title: Postal Plus 4 Code
    Maximum Length: 20
    Four digit extension to the postal code of the supplier address.
  • Title: Province
    Maximum Length: 60
    Province of the supplier address.
  • Title: State or Region
    Maximum Length: 60
    State of the supplier address.
  • Title: Status
    Read Only: true
    Maximum Length: 255
    Status of the supplier address.
  • Read Only: true
    Value that uniquely identifies the supplier address that is associated to the supplier contact.
Nested Schema : Flexfields for Supplier Address
Type: array
Title: Flexfields for Supplier Address
The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
Show Source
Nested Schema : suppliers-addresses-DFF-item-response
Type: object
Show Source
Back to Top

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"
        }
    ]
}

Back to Top