1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Customer Trade Profiles

Get all profiles

get

/fscmRestApi/resources/11.13.18.05/customerTradeProfiles

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:

    • PrimaryKey: Finds customer trade profiles according to the primary key.
      Finder Variables:
      • CustomerTradeProfileId; integer; Value that uniquely identifies the customer trade profile.
  • 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:
    • Address; string; Address of the customer or the customer site.
    • BUId; integer; Value that uniquely identifies the business unit.
    • BillToAccountId; integer; Value that uniquely identifies the bill-to account.
    • BillToAccountNumber; string; Number that uniquely identifies the bill-to account.
    • BillToSite; string; Name of the bill-to customer site.
    • BillToSiteId; integer; Value that uniquely identifies the bill-to customer site.
    • BusinessUnit; string; Name of the business unit.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • Customer; string; Name of the customer.
    • CustomerId; integer; Value that uniquely identifies the customer.
    • CustomerTradeProfileId; integer; Value that uniquely identifies the customer trade profile. It's a primary key that the application generates when it creates the customer trade profile.
    • DeductionWriteOffThreshold; number; Minimum deduction threshold that's eligible for an automatic write-off. For example, you enter 200 as the threshold. If you receive a deduction of $190, it's under the threshold and is eligible for an automatic write-off. The value entered should always be a positive number.
    • DefaultClaimOwner; string; Default owner for the claim.
    • DefaultClaimOwnerId; integer; Value that uniquely identifies the default owner for the claim.
    • DefaultClaimOwnerPersonNumber; string; Number that uniquely identifies the default owner for the claim.
    • EnabledFlag; boolean; Contains one of the following values: true or false. If true, then the customer trade profile is enabled. If false, then the customer trade profile is disabled. The default value is true.
    • LastUpdateDate; string; Login that the user used when updating the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • PayOverEarnings; string; Value that identifies if the pay over is allowed. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_PAY_OVER_EARNING.
    • PayOverEarningsCode; string; Abbreviation that identifies if the pay over is allowed.
    • PayOverThresholdOverrideFlag; boolean; Contains one of the following values: true or false. If true, then the pay over is allowed even if the association amount crosses the threshold limit. If false, then the pay over isn't allowed if the association amount crosses the threshold limit.
    • PayOverThresholdType; string; Type of pay over threshold. A list of accepted values is defined in the lookup type ORA_CJM_CLM_PAY_OVER_THLD_TYPE.
    • PayOverThresholdTypeCode; string; Abbreviation that identifies the pay over threshold type.
    • PayOverThresholdValue; number; Pay over threshold limit value.
    • Supplier; string; Name of the supplier.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierNumber; string; Number that identifies the supplier.
    • SupplierSite; string; Name of the supplier site.
    • SupplierSiteAddress; string; Address of the supplier site.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
  • 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 : customerTradeProfiles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : customerTradeProfiles-item-response
Type: object
Show Source
Nested Schema : Mappings
Type: array
Title: Mappings
Mapping between customer and internal entities such as customer reason.
Show Source
Nested Schema : customerTradeProfiles-mappings-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all profiles.

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/customerTradeProfiles"

Example Response Body

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

{
	"items": [
	{
		"CustomerTradeProfileId": 300100211667182,
		"BUId": 204,
		"BusinessUnit": "Vision Operations",
		"CustomerId": 1006,
		"Customer": "Tall Manufacturing",
		"BillToAccountId": 1006,
		"BillToAccountNumber": "1006",
		"BillToSiteId": 10921,
		"BillToSite": "10921",
		"DefaultClaimOwnerId": 300100181693728,
		"DefaultClaimOwner": "channel_user",
		"DeductionWriteOffThreshold": 5,
		"EnabledFlag": true,
		"CreatedBy": "channel_user",
		"CreationDate": "2020-11-06T10:19:18+00:00",
		"LastUpdateDate": "2020-11-06T10:26:42+00:00",
		"LastUpdatedBy": "channel_user",
		"Address": "Example Inc. 401 Island Parkway, Redwood Shores, CA 94065",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/customerTradeProfiles/300100211667182",
			"name": "customerTradeProfiles",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/customerTradeProfiles/300100211667182",
			"name": "customerTradeProfiles",
			"kind": "item"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/customerTradeProfiles",
		"name": "customerTradeProfiles",
		"kind": "collection"
	}
	]
}
Back to Top