REST API for Oracle Fusion Cloud Procurement

Get one address

get

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

Request

Path Parameters

SupplierAddressId(required): integer(int64)

Value that uniquely identifies the supplier address.
SupplierId(required): integer(int64)

Value that uniquely identifies the supplier.

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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: object

Show Source

AdditionalAddressAttribute1: string

Title: Additional Address Element 1

Maximum Length: 150

First additional address attribute for the flexible supplier address format.
AdditionalAddressAttribute2: string

Title: Additional Address Element 2

Maximum Length: 150

Second additional address attribute for the flexible supplier address format.
AdditionalAddressAttribute3: string

Title: Additional Address Element 3

Maximum Length: 150

Third additional address attribute for the flexible supplier address format.
AdditionalAddressAttribute4: string

Title: Additional Address Element 4

Maximum Length: 150

Fourth Additional address attribute for the flexible supplier address format.
AdditionalAddressAttribute5: string

Title: Additional Address Element 5

Maximum Length: 150

Fifth additional address attribute for the flexible supplier address format.
Addressee: string

Title: Addressee

Maximum Length: 360

Addressee of the supplier address.
AddressLine1: string

Title: Address Line 1

Maximum Length: 240

First line of the supplier address.
AddressLine2: string

Title: Address Line 2

Maximum Length: 240

Second line of the supplier address.
AddressLine3: string

Title: Address Line 3

Maximum Length: 240

Third line of the supplier address.
AddressLine4: string

Title: Address Line 4

Maximum Length: 240

Fourth line of the supplier address.
AddressName: string

Title: Address Name

Maximum Length: 240

Name of the supplier address that is associated to the supplier contact.
AddressPurposeOrderingFlag: boolean

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.
AddressPurposeRemitToFlag: boolean

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.
AddressPurposeRFQOrBiddingFlag: boolean

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.
Building: string

Title: Building

Maximum Length: 240

Building of the supplier address.
City: string

Title: City or Locality

Maximum Length: 60

City of the supplier address.
Country: string

Title: Country

Maximum Length: 80

Country of the supplier address.
CountryCode: string

Title: Country Code

Maximum Length: 2

Abbreviation that identifies the country where the supplier address is located.
County: string

Title: County

Maximum Length: 60

County of the supplier address.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who created the supplier record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date when the user created the supplier record.
DFF: array Flexfields for Supplier Address

Title: Flexfields for Supplier Address

The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.
Email: string

Title: Email

Maximum Length: 320

Email for the supplier address.
FaxAreaCode: string

Title: Fax Area Code

Maximum Length: 20

Abbreviation that identifies the area for the fax of the supplier address.
FaxCountryCode: string

Title: Fax Country Code

Maximum Length: 10

Abbreviation that identifies the country for the fax of the supplier address.
FaxNumber: string

Title: Fax

Maximum Length: 40

Fax of the supplier address.
FloorNumber: string

Title: Floor

Maximum Length: 40

Floor number of the supplier address.
GlobalLocationNumber: string

Title: Global Location Number

Maximum Length: 40

Global location number of the supplier address.
InactiveDate: string (date)

Title: Inactive Date

Date when the supplier address is no longer active.
Language: string

Title: Language

Maximum Length: 255

Language of the supplier address.
LanguageCode: string

Title: Language

Maximum Length: 4

Abbreviation that identifies the language of the supplier address.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

Date and time when the user most recently updated the supplier record.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

User who most recently updated the supplier record.
links: array Links

Title: Links

The link relations associated with the resource instance.
PhoneAreaCode: string

Title: Phone Area Code

Maximum Length: 20

Abbreviation that identifies the area for phone of the supplier address.
PhoneCountryCode: string

Title: Phone Country Code

Maximum Length: 10

Abbreviation that identifies the country for the phone of the supplier address.
PhoneExtension: string

Title: Phone Extension

Maximum Length: 20

Phone extension of the supplier address.
PhoneNumber: string

Title: Phone

Maximum Length: 40

Phone number of the supplier address.
PhoneticAddress: string

Title: Phonetic Address Line

Maximum Length: 560

Phonetic, Japanese kana, or Chinese kanji representation of the address lines.
PostalCode: string

Title: Postal Code

Maximum Length: 60

Postal code of the supplier address.
PostalCodeExtension: string

Title: Postal Plus 4 Code

Maximum Length: 20

Four digit extension to the postal code of the supplier address.
Province: string

Title: Province

Maximum Length: 60

Province of the supplier address.
State: string

Title: State or Region

Maximum Length: 60

State of the supplier address.
Status: string

Title: Status

Read Only: true

Maximum Length: 255

Status of the supplier address.
SupplierAddressId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier address that is associated to the supplier contact.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"Building of the supplier address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"Floor number of the supplier address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxAreaCode":{
            "title":"Fax Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the area for the fax of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"Email for the supplier address.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "DFF":{
            "title":"Flexfields for Supplier Address",
            "type":"array",
            "description":"The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.",
            "items":{
                "$ref":"#/components/schemas/suppliers-addresses-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"Postal code of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FaxCountryCode":{
            "title":"Fax Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the country for the fax of the supplier address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "SupplierAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address that is associated to the supplier contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "GlobalLocationNumber":{
            "title":"Global Location Number",
            "maxLength":"40",
            "type":"string",
            "description":"Global location number of the supplier address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCodeExtension":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"Four digit extension to the postal code of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"County of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the country for the phone of the supplier address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the area for phone of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LanguageCode":{
            "title":"Language",
            "maxLength":"4",
            "type":"string",
            "description":"Abbreviation that identifies the language of the supplier address.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneticAddress":{
            "title":"Phonetic Address Line",
            "maxLength":"560",
            "type":"string",
            "description":"Phonetic, Japanese kana, or Chinese kanji representation of the address lines.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "title":"Language",
            "maxLength":"255",
            "type":"string",
            "description":"Language of the supplier address.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":"40",
            "type":"string",
            "description":"Fax of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"Abbreviation that identifies the country where the supplier address is located.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of the supplier address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InactiveDate",
                    "StartDate"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InactiveDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the supplier address is no longer active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE",
                "NoTimeStamp":"Y",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":"360",
            "type":"string",
            "description":"Addressee of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City or Locality",
            "maxLength":"60",
            "type":"string",
            "description":"City of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"Province of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressPurposeRemitToFlag":{
            "title":"Remit to",
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PayUseStatus"
                ]
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"Phone extension of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressName":{
            "title":"Address Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the supplier address that is associated to the supplier contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third line of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AdditionalAddressAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"Fourth Additional address attribute for the flexible supplier address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second line of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AdditionalAddressAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"Third additional address attribute for the flexible supplier address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"First line of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AdditionalAddressAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"Fifth additional address attribute for the flexible supplier address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State or Region",
            "maxLength":"60",
            "type":"string",
            "description":"State of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AdditionalAddressAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"Second additional address attribute for the flexible supplier address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AdditionalAddressAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"First additional address attribute for the flexible supplier address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"80",
            "type":"string",
            "description":"Country of the supplier address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"Phone number of the supplier address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressPurposeOrderingFlag":{
            "title":"Ordering",
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PurUseStatus"
                ]
            },
            "x-queryable":true
        },
        "AddressPurposeRFQOrBiddingFlag":{
            "title":"RFQ or Bidding",
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RfqUseStatus"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Array of: object suppliers-addresses-DFF-item-response

{
    "title":"Flexfields for Supplier Address",
    "type":"array",
    "description":"The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.",
    "items":{
        "$ref":"#/components/schemas/suppliers-addresses-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : suppliers-addresses-DFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Enter Party Site Information

Maximum Length: 30

Descriptive flexfield context name for supplier sites.
__FLEX_Context_DisplayValue: string

Title: Enter Party Site Information

Descriptive flexfield context display value for supplier sites.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartySiteId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier address.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Enter Party Site Information",
            "type":"string",
            "description":"Descriptive flexfield context display value for supplier sites.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Enter Party Site Information",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for supplier sites.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/addresses/{SupplierAddressId}/child/DFF

Parameters:

SupplierAddressId: $request.path.SupplierAddressId
SupplierId: $request.path.SupplierId

The Flexfields for Supplier Address resource manages supplier address descriptive flexfields.

Examples

This example describes how to get one address.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/addresses/SupplierAddressId"

For example, the following command gets cost adjustment where the supplier address identifier is 300100153044503:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/addresses/300100153044503"

Example Response Body

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

{
  "SupplierAddressId" : 300100153044503,
  "AddressName" : "HQ",
  "CountryCode" : "US",
  "Country" : "United States",
  "AddressLine1" : "22093 Market Street",
  "AddressLine2" : null,
  "AddressLine3" : null,
  "AddressLine4" : null,
  "City" : "SAN FRANCISCO",
  "State" : "CA",
  "PostalCode" : "94102",
  "PostalCodeExtension" : null,
  "Province" : null,
  "County" : null,
  "Building" : null,
  "FloorNumber" : null,
  "PhoneticAddress" : null,
  "LanguageCode" : "US",
  "Language" : "American English",
  "Addressee" : null,
  "GlobalLocationNumber" : null,
  "AdditionalAddressAttribute1" : null,
  "AdditionalAddressAttribute2" : null,
  "AdditionalAddressAttribute3" : null,
  "AdditionalAddressAttribute4" : null,
  "AdditionalAddressAttribute5" : null,
  "AddressPurposeOrderingFlag" : true,
  "AddressPurposeRemitToFlag" : true,
  "AddressPurposeRFQOrBiddingFlag" : false,
  "PhoneCountryCode" : "1",
  "PhoneAreaCode" : "415",
  "PhoneNumber" : "5559908",
  "PhoneExtension" : null,
  "FaxCountryCode" : "1",
  "FaxAreaCode" : "415",
  "FaxNumber" : "5559907",
  "Email" : "eric.smith@example.com",
  "InactiveDate" : "4712-12-31",
  "Status" : "ACTIVE",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/addresses/300100153044503",
    "name" : "addresses",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/addresses/300100153044503",
    "name" : "addresses",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388",
    "name" : "suppliers",
    "kind" : "item"
  } ]
}