Get all customer details for an order

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/billToCustomer

Request

Path Parameters
  • Value that uniquely identifies the sales order. It can have the following formats.

    - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
    Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".

    - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
    Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.

    When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
Query Parameters
  • 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>
  • 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:

    • PrimaryKey: Finds bill-to customer details according to the primary key.
      Finder Variables:
      • AddressId; integer; Value that uniquely identifies the bill-to customer address.
    • findBillToAddress: Finds bill-to address details.
      Finder Variables:
      • findBySourceAddressId: Finds bill-to customer details according to the source address identifier.
        Finder Variables:
        • SourceAddressId; string; Value that uniquely identifies the bill-to customer address. Value is 1.
    • 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:
      • AccountNumber; string; Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
      • Address1; string; First line of the bill-to customer address.
      • Address2; string; Second line of the bill-to customer address.
      • Address3; string; Third line of the bill-to customer address.
      • Address4; string; Fourth line of the bill-to customer address.
      • AddressId; integer; Value that uniquely identifies the bill-to customer address.
      • City; string; City of the bill-to customer address.
      • ContactFirstName; string; First name of the person to contact at the bill-to customer site.
      • ContactId; integer; Value that uniquely identifies the contact for the billing account.
      • ContactLastName; string; Last name of the person to contact at the bill-to customer site.
      • ContactMiddleName; string; Middle name of the person to contact at the bill-to customer site.
      • ContactName; string; Person to contact at the bill-to customer site.
      • ContactNameSuffix; string; Name suffix of the person to contact at the bill-to customer site.
      • ContactNumber; string; Telephone number of the person to contact at the bill-to customer site.
      • ContactTitle; string; Title of the person to contact at the bill-to customer site.
      • Country; string; Country of the bill-to customer address.
      • County; string; County of the bill-to customer address.
      • CustomerAccountId; integer; Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
      • PartyName; string; Name of the party who is legally responsible for payment.
      • PersonFirstName; string; If a person is legally responsible for payment, then this attribute contains the first name of the person.
      • PersonLastName; string; If a person is legally responsible for payment, then this attribute contains the last name of the person.
      • PersonMiddleName; string; If a person is legally responsible for payment, then this attribute contains the middle name of the person.
      • PersonNameSuffix; string; If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
      • PersonTitle; string; If a person is legally responsible for payment, then this attribute contains the title of the person.
      • PostalCode; string; Postal code of the bill-to customer address.
      • PreferredContactPointId; integer; Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
      • Province; string; Province of the bill-to customer address.
      • SiteUseId; integer; Value that uniquely identifies the account site that is legally responsible for payment.
      • SourceAddressId; string; Value that uniquely identifies the bill-to customer address. Value is 1.
      • State; string; State of the bill-to customer address.
    • 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 : salesOrdersForOrderHub-billToCustomer
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : salesOrdersForOrderHub-billToCustomer-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    This example describes how to get all customer details for an order.

    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/salesOrdersForOrderHub/OrderKey/child/billToCustomer"

    Example Response Body

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

    {
      "items" : [ {
        "AddressId" : 300100184279031,
        "CustomerAccountId" : 1006,
        "PartyName" : "Computer Service and Rentals",
        "AccountNumber" : "1006",
        "PersonFirstName" : null,
        "PersonLastName" : null,
        "PersonMiddleName" : null,
        "PersonNameSuffix" : null,
        "PersonTitle" : null,
        "SiteUseId" : 1025,
        "Address1" : "301 Summit Hill Drive",
        "Address2" : null,
        "Address3" : null,
        "Address4" : null,
        "City" : "CHATTANOOGA",
        "State" : "TN",
        "PostalCode" : "37401",
        "County" : "Hamilton",
        "Province" : null,
        "Country" : "US",
        "ContactId" : 3152,
        "ContactName" : "Evelyn Jones",
        "ContactNumber" : "CONTACT-1004",
        "ContactFirstName" : "Evelyn",
        "ContactMiddleName" : null,
        "ContactLastName" : "Jones",
        "ContactNameSuffix" : null,
        "ContactTitle" : null,
        "PreferredContactPointId" : 999990005748144,
        "SourceAddressId" : "1",
        "links" : [ {
          "rel" : "self",
          "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/billToCustomer/300100184279031",
          "name" : "billToCustomer",
          "kind" : "item",
          "properties" : {
            "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        }, {
          "rel" : "canonical",
          "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/billToCustomer/300100184279031",
          "name" : "billToCustomer",
          "kind" : "item"
        }, {
          "rel" : "parent",
          "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01",
          "name" : "salesOrdersForOrderHub",
          "kind" : "item"
        } ]
      } ],
      "count" : 1,
      "hasMore" : false,
      "limit" : 25,
      "offset" : 0,
      "links" : [ {
        "rel" : "self",
        "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Sample_order_01/child/billToCustomer",
        "name" : "billToCustomer",
        "kind" : "collection"
      } ]
    }
    
    Back to Top