Get one customer details for an order
get
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/billToCustomer/{billToCustomerUniqID}
Request
Path Parameters
-
OrderKey(required): string
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.
-
billToCustomerUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
linesUniqID(required): string
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
-
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.
Back to TopResponse
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 : salesOrdersForOrderHubRequests-lines-billToCustomer-item-response
Type:
Show Source
object
-
AccountNumber: string
Maximum Length:
30
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
Maximum Length:
240
First line of the bill-to customer address. -
Address2: string
Maximum Length:
240
Second line of the bill-to customer address. -
Address3: string
Maximum Length:
240
Third line of the bill-to customer address. -
Address4: string
Maximum Length:
240
Fourth line of the bill-to customer address. -
AddressOrigSystemReference: string
Maximum Length:
255
Value that uniquely identifies the bill-to customer address in the source application that captures the transaction. -
AddressUseType: string
Maximum Length:
30
Type of address. Valid value is BILL_TO. -
City: string
Maximum Length:
60
City of the bill-to customer address. -
ContactFirstName: string
Maximum Length:
150
First name of the person to contact at the bill-to customer site. -
ContactId: integer
(int64)
Value that uniquely identifies the contact for the billing account.
-
ContactLastName: string
Maximum Length:
150
Last name of the person to contact at the bill-to customer site. -
ContactMiddleName: string
Maximum Length:
60
Middle name of the person to contact at the bill-to customer site. -
ContactName: string
Maximum Length:
360
Name of the person to contact at the bill-to customer site. -
ContactNameSuffix: string
Maximum Length:
30
Name suffix of the person to contact at the bill-to customer site. -
ContactNumber: string
Maximum Length:
30
Telephone number of the person to contact at the bill-to customer site. -
ContactOrigSystemReference: string
Maximum Length:
255
Value that uniquely identifies the bill-to customer contact in the source application that captures the transaction. -
ContactTitle: string
Maximum Length:
60
Title of the person to contact at the bill-to customer site. -
Country: string
Maximum Length:
60
Country of the bill-to customer address. -
County: string
Maximum Length:
60
County of the bill-to customer address. -
CustomerAccountId: integer
(int64)
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.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyContactEmail: string
Maximum Length:
320
Email address of the primary contact who is legally responsible for payment. -
PartyName: string
Maximum Length:
360
Name of the party who is legally responsible for payment. -
PartyOrganizationEmail: string
Maximum Length:
320
Email address of the organization who is legally responsible for payment. -
PartyPersonEmail: string
Maximum Length:
320
Email address of the person who is legally responsible for payment. -
PartyType: string
Maximum Length:
30
Type of the bill-to party. Acceptable values are PERSON or ORGANIZATION. -
PersonFirstName: string
Maximum Length:
150
If a person is legally responsible for payment, then this attribute contains the first name of the person. -
PersonLastName: string
Maximum Length:
150
If a person is legally responsible for payment, then this attribute contains the last name of the person. -
PersonMiddleName: string
Maximum Length:
60
If a person is legally responsible for payment, then this attribute contains the middle name of the person. -
PersonNameSuffix: string
Maximum Length:
30
If a person is legally responsible for payment, then this attribute contains the name suffix of the person. -
PersonTitle: string
Maximum Length:
60
If a person is legally responsible for payment, then this attribute contains the title of the person. -
PostalCode: string
Maximum Length:
60
Postal code of the bill-to customer address. -
PreferredContactPointId: integer
(int64)
Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
-
PreferredContactPointOrigSystemReference: string
Maximum Length:
240
Value that uniquely identifies the preferred contact point of the bill-to party in the source application that captures the transaction. -
Province: string
Maximum Length:
60
Province of the bill-to customer address. -
SiteUseId: integer
(int64)
Value that uniquely identifies the account site that is legally responsible for payment.
-
SourceTransactionId: string
Maximum Length:
50
Value that uniquely identifies the transaction in the source application. -
SourceTransactionLineId: string
Maximum Length:
50
Value that uniquely identifies the transaction line from the source application. -
SourceTransactionScheduleId: string
Maximum Length:
50
Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value. -
SourceTransactionSystem: string
Maximum Length:
30
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
Maximum Length:
60
State of the bill-to customer address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.