1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Channel Indirect Sales Batches
  5. Batch Lines

Get all batch lines

get

/fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}/child/batchLines

Request

Path Parameters
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 a batch line according to the primary key.
      Finder Variables:
      • IndirectSalesBatchLineId; integer; Unique identifier of the batch line.
  • 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:
    • AcceptanceModeCode; string; Abbreviation that identifies the acceptance mode for the batch line. A list of values is defined in the lookup type ORA_SPA_BATCH_LINE_ACCEPT_MODE.
    • Comments; string; Comments that the user enters on the sales order.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DisputedAmount; number; Disputed amount for the batch line.
    • DistributorClaimNumber; string; Number assigned by the distributor that uniquely identifies the claim.
    • DistributorClaimedAmount; number; Calculated claim amount requested by the distributor for the batch line.
    • IndirectSalesBatchId; integer; Value that uniquely identifies the indirect sales batch line. It???s a primary key generated by the application when the indirect sales batch line is created.
    • IndirectSalesBatchLineId; integer; Value that uniquely identifies the indirect sales batch. It???s a primary key generated by the application when the indirect sales batch is created.
    • Item; string; Name of the item.
    • ItemDescription; string; Description of the item.
    • LastUpdateDate; string; Date and time when the user last updated the record.
    • LastUpdatedBy; string; User who last updated the record.
    • LineAttributeCharacter17; string; Character segment for the transaction line's descriptive flexfield.
    • LineAttributeDate1; string; Date segment for the transaction line descriptive flexfield.
    • RejectReasonCode; string; Abbreviation that identifies the reason for rejecting the batch line. A list of values is defined in the lookup type ORA_SPA_BATCH_LINE_REJECT_REASON.
    • SalesOrderNumber; string; Number that identifies the sales order.
    • SpecialPriceAgreementId; integer; Value that uniquely identifies the special price agreement.
    • SpecialPriceAgreementName; string; Name of the special price agreement.
    • SpecialPriceAgreementNumber; string; Number that uniquely identifies the special price agreement.
    • StatusCode; string; Abbreviation that identifies the status of the batch line. A list of values is defined in the lookup type ORA_CJM_SPA_BATCH_LINE_STATUS.
    • UnitAllowedAmount; number; Allowable amount per unit calculated by the system for the batch line.
  • 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 : channelIndirectSalesBatches-batchLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : channelIndirectSalesBatches-batchLines-item-response
Type: object
Show Source
Nested Schema : Disputes
Type: array
Title: Disputes
Error messages generated while validating the distributor's sales orders against their special price agreement.
Show Source
Nested Schema : channelIndirectSalesBatches-batchLines-disputes-item-response
Type: object
Show Source
Back to Top