1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. List of Values
  4. Contract Ship to Organization Locations

Get all bill-to locations

get

/fscmRestApi/resources/11.13.18.05/contractShipToOrganizationsLocations

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • ActiveLocationFinder Finds active bill-to locations with an active indicator.
      Finder Variables
      • pActiveFlag; string; Active indicator to find a bill-to location.
    • BillToSiteLocationFinder Finds bill-to site locations with a yes and no indicator.
      Finder Variables
      • pYesNoFlag; string; The yes and no indicator to find a bill-to site location.
    • InvOrgIdFinder Finds inventory organization with an organization identifier.
      Finder Variables
      • pInventoryOrgId; integer; The inventory organization identifier.
    • LocationAltKey
      Finder Variables
      • EffectiveEndDate; string;
      • EffectiveStartDate; string;
      • InternalLocationCode; string;
      • SetId; integer;
    • PrimaryKey Finds the primary key of bill-to location with a location identifier and effective dates.
      Finder Variables
      • EffectiveEndDate; string; The effective end date of the bill-to location.
      • EffectiveStartDate; string; The effective start date of the bill-to location.
      • LocationId; integer; The location identifier of the bill-to location.
    • ShippingLocationFinder Finds shipping locations with a yes and no indicator.
      Finder Variables
      • pYesNoFlag; string; The yes and no indicator to find a shipping location.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AcLocationCode; string; The code of the bill-to location.
    • ActiveStatus; string; The active status of the bill-to location.
    • AddressLine1; string; Address line 1 of the bill-to location.
    • AttributeDate1; string; Date attribute 1 of the bill-to location.
    • AttributeDate10; string; Date attribute 10 of the bill-to location.
    • AttributeDate11; string; Date attribute 11 of the bill-to location.
    • AttributeDate12; string; Date attribute 12 of the bill-to location.
    • AttributeDate13; string; Date attribute 13 of the bill-to location.
    • AttributeDate14; string; Date attribute 14 of the bill-to location.
    • AttributeDate15; string; Date attribute 15 of the bill-to location.
    • AttributeDate2; string; Date attribute 2 of the bill-to location.
    • AttributeDate3; string; Date attribute 3 of the bill-to location.
    • AttributeDate4; string; Date attribute 4 of the bill-to location.
    • AttributeDate5; string; Date attribute 5 of the bill-to location.
    • AttributeDate6; string; Date attribute 6 of the bill-to location.
    • AttributeDate7; string; Date attribute 7 of the bill-to location.
    • AttributeDate8; string; Date attribute 8 of the bill-to location.
    • AttributeDate9; string; Date attribute 9 of the bill-to location.
    • AttributeNumber1; number; Number attribute 1 of the bill-to location.
    • AttributeNumber10; number; Number attribute 10 of the bill-to location.
    • AttributeNumber11; number; Number attribute 11 of the bill-to location.
    • AttributeNumber12; number; Number attribute 12 of the bill-to location.
    • AttributeNumber13; number; Number attribute 13 of the bill-to location.
    • AttributeNumber14; number; Number attribute 14 of the bill-to location.
    • AttributeNumber15; number; Number attribute 15 of the bill-to location.
    • AttributeNumber16; number; Number attribute 16 of the bill-to location.
    • AttributeNumber17; number; Number attribute 17 of the bill-to location.
    • AttributeNumber18; number; Number attribute 18 of the bill-to location.
    • AttributeNumber19; number; Number attribute 19 of the bill-to location.
    • AttributeNumber2; number; Number attribute 2 of the bill-to location.
    • AttributeNumber20; number; Number attribute 20 of the bill-to location.
    • AttributeNumber3; number; Number attribute 3 of the bill-to location.
    • AttributeNumber4; number; Number attribute 4 of the bill-to location.
    • AttributeNumber5; number; Number attribute 5 of the bill-to location.
    • AttributeNumber6; number; Number attribute 6 of the bill-to location.
    • AttributeNumber7; number; Number attribute 7 of the bill-to location.
    • AttributeNumber8; number; Number attribute 8 of the bill-to location.
    • AttributeNumber9; number; Number attribute 9 of the bill-to location.
    • BillToSiteFlag; string; The bill-to site indicator of the bill-to location.
    • Country; string; The country of the bill-to location.
    • Description2; string; The description 2 of the bill-to location.
    • EmployeeLocationFlag; string; The employee location indicator of the bill-to location.
    • InternalLocationCode; string; The internal location code of the bill-to location.
    • InventoryOrganizationId; integer; The inventory organization identifier of the bill-to location.
    • InventoryOrganizationName; string; The inventory organization name of the bill-to location.
    • LocationCode; string; The code of the bill-to location.
    • LocationId; integer; The unique identifier of the bill-to location.
    • MainphoneCountryCode1; string; The main phone country code 1 of the bill-to location.
    • OfficeSiteFlag; string; The office site indicator of the bill-to location.
    • OfficialLanguageCode; string; The official language code of the bill-to location.
    • OtherphoneAreaCode3; string; The other phone area code 3 of the bill-to location.
    • OtherphoneExtension3; string; The other phone extension 3 of the bill-to location.
    • OtherphoneSubscriberNum3; string; The other phone subscriber number 3 of the bill-to location.
    • PostalCode; string; The postal code of the bill-to location.
    • ReceivingSiteFlag; string; The receiving site indicator of the bill-to location.
    • Region1; string; The region 1 of the bill-to location.
    • SetCode; string; The set code of the bill-to location.
    • SetName; string; The set name of the bill-to location.
    • ShipToLocationId; integer; The ship-to location of the bill-to location.
    • ShipToSiteFlag; string; The ship-to site indicator of the bill-to location.
    • SysEffectiveDate; string; The system effective date of the bill-to location.
    • TimezoneCode; string; The time zone code of the bill-to location.
    • TownOrCity; string; The town or city of the bill-to location.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : contractShipToOrganizationsLocations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : contractShipToOrganizationsLocations-item-response
Type: object
Show Source
Nested Schema : Geometry
Type: object
Read Only: true
The geometry of the bill-to location.
Back to Top