1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Sales Orders for Order Hub Requests
  5. Order Lines
  6. Ship-to Customers

Get all customer details for an order

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/shipToCustomer

Request

Path Parameters
  • Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
  • This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
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: Find ship-to customer details according to the primary key.
      Finder Variables:
      • AddressUseType; string; Type of the ship-to customer address. Valid value is SHIP_TO.
      • SourceTransactionId; string; Value that uniquely identifies the transaction in the source application.
      • SourceTransactionLineId; string; Value that uniquely identifies the transaction line from the source application.
      • SourceTransactionScheduleId; string; Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.
      • SourceTransactionSystem; string; Source application that created the order. Review and update the value for this attribute using the Manage Trading Community Source Systems and Manage Upstream and Fulfillment Source Systems tasks.
    • findByAddressUseType: Find ship-to customer details according to the address type.
      Finder Variables:
      • AddressUseType; string; Type of the ship-to customer address. Valid value is SHIP_TO.
  • 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:
    • Address1; string; First line of the ship-to customer address.
    • Address2; string; Second line of the ship-to customer address.
    • Address3; string; Third line of the ship-to customer address.
    • Address4; string; Fourth line of the ship-to customer address.
    • AddressOrigSystemReference; string; Value that uniquely identifies the ship-to party address in the source application that captures the transaction.
    • AddressUseType; string; Type of address. Valid value is SHIP_TO.
    • City; string; City of the ship-to customer address.
    • ContactFirstName; string; First name of the person to contact at the ship-to party site.
    • ContactId; integer; Value that uniquely identifies the contact at the ship-to party site.
    • ContactLastName; string; Last name of the person to contact at the ship-to party site.
    • ContactMiddleName; string; Middle name of the person to contact at the ship-to party site.
    • ContactName; string; Name of the person to contact at the ship-to party site.
    • ContactNameSuffix; string; Name suffix of the person to contact at the ship-to party site.
    • ContactNumber; string; Telephone number of the person to contact at the ship-to party site.
    • ContactOrigSystemReference; string; Value that uniquely identifies the ship-to party contact in the source application that captures the transaction.
    • ContactTitle; string; Title of the person to contact at the ship-to party site.
    • Country; string; Country of the ship-to customer address.
    • County; string; County of the ship-to customer address.
    • PartyContactEmail; string; Email address of the primary contact at the ship-to customer site.
    • PartyId; integer; Value that uniquely identifies the ship-to party.
    • PartyName; string; Name of the ship-to party.
    • PartyNumber; string; Telephone number of the ship-to party.
    • PartyOrganizationEmail; string; Email address of the organization at the ship-to customer site.
    • PartyPersonEmail; string; Email address of the person to contact at the ship-to customer site.
    • PartyType; string; Type of the ship-to party. Acceptable values are PERSON or ORGANIZATION.
    • PersonFirstName; string; First name of the person to contact at the ship-to customer site.
    • PersonLastName; string; Last name of the person to contact at the ship-to customer site.
    • PersonMiddleName; string; Middle name of the person to contact at the ship-to customer site.
    • PersonNameSuffix; string; Name suffix of the person to contact at the ship-to customer site.
    • PersonTitle; string; Title of the person to contact at the ship-to customer site.
    • PostalCode; string; Postal code of the ship-to customer address.
    • PreferredContactPointId; integer; Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
    • PreferredContactPointOrigSystemReference; string; Value that uniquely identifies the preferred contact point of the ship-to party in the source application that captures the transaction.
    • Province; string; Province of the ship-to customer address.
    • ShipToRequestRegion; string; Region of the ship-to party. It is used by Oracle Global Order Promising Cloud.
    • SiteId; integer; Value that uniquely identifies the ship-to customer address.
    • SourceTransactionId; string; Value that uniquely identifies the transaction in the source application.
    • SourceTransactionLineId; string; Value that uniquely identifies the transaction line in the source application.
    • SourceTransactionScheduleId; string; Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.
    • SourceTransactionSystem; string; Source application that created the order. Review and update the value for this attribute using the Manage Trading Community Source Systems, Manage Upstream and Fulfillment Source Systems tasks.
    • State; string; State of the ship-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 : salesOrdersForOrderHubRequests-lines-shipToCustomer
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : salesOrdersForOrderHubRequests-lines-shipToCustomer-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 -i -X GET \
-H "Authorization:Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==" \
-H "REST-Framework-Version:4" \
-H "prefer:return=representation" \
-H "Content-Type:application/json" \
'https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/shipToCustomer'

Example Response Body

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

{
	"items" : [ {
		"Address1" : "401 Island Parkway",
		"Address2" : null,
		"Address3" : null,
		"Address4" : null,
		"AddressUseType" : "SHIP_TO",
		"City" : "BUFFALO",
		"ContactFirstName" : "Henry",
		"ContactLastName" : "Johnson",
		"ContactMiddleName" : null,
		"ContactNameSuffix" : null,
		"ContactTitle" : null,
		"Country" : "US",
		"County" : "ERIE",
		"PersonFirstName" : null,
		"PersonLastName" : null,
		"PersonMiddleName" : null,
		"PersonNameSuffix" : null,
		"PartyContactEmail" : null,
		"ContactId" : 5801,
		"ContactName" : "Henry Johnson",
		"ContactNumber" : "8623",
		"PartyId" : 1002,
		"PartyName" : "Small, Inc.",
		"PartyNumber" : "1002",
		"PartyOrganizationEmail" : null,
		"PartyPersonEmail" : null,
		"SiteId" : 21765,
		"PostalCode" : "14201",
		"PreferredContactPointId" : null,
		"Province" : null,
		"SourceTransactionId" : "R13_Rest_stage_01",
		"SourceTransactionLineId" : "1",
		"SourceTransactionScheduleId" : "1",
		"SourceTransactionSystem" : "GPR",
		"State" : null,
		"PersonTitle" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/shipToCustomer/000600000007534849505F544F0000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
			"name" : "shipToCustomer",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/shipToCustomer/000600000007534849505F544F0000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
			"name" : "shipToCustomer",
			"kind" : "item"
		}, {
			"rel" : "parent",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052",
			"name" : "lines",
			"kind" : "item"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/lines/00050000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000131000000013100000003475052/child/shipToCustomer",
		"name" : "shipToCustomer",
		"kind" : "collection"
	} ]
}
Back to Top