Get all purchase order lines
get
/fscmRestApi/resources/11.13.18.05/massReplacementPurchaseOrders
Request
Query Parameters
-
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 -
finder: string
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 purchase order lines according to the primary key.
Finder Variables- POLineId; integer; Value that uniquely identifies the purchase order line entity.
- findByItemMpn Find purchase order lines according to the primary internal item and primary MPN.
Finder Variables- bindGlobal; string;
- bindGroupId; string;
- bindItemId; integer;
- bindMode; integer;
- bindMpn; string;
- bindOrgId; integer; Value that uniquely identifies the replacement inventory organization for which purchase order lines must be replaced.
- bindPrcBuId; integer;
- bindReplacementId; integer;
- bindVendorId; integer;
- bindVendorSiteId; integer;
- PrimaryKey Find purchase order lines according to the primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CurrencyCode; string; Abbreviation that identifies the currency in the purchase order line.
- OrderNumber; string; Number of the purchase order.
- POHeaderId; integer; Value that uniquely identifies the purchase order header entity.
- POLine; number; Number of the purchase order line entity.
- POLineId; integer; Value that uniquely identifies the purchase order line.
- Precision; integer; Value that indicates the number of digits to which the unit price attribute in the source agreement line must be rounded off.
- PurchasingUOM; string; Name of the unit of measure in the purchase order line.
- PurchasingUOMCode; string; Abbreviation that identifies the unit of measure in the purchase order line.
- RequisitioningBU; string; Name of the requisitioning business unit for which the purchase order is created
- RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit for which the purchase order is created.
- Status; string; Value of the purchase order header status.
- UnitPrice; number; Value of unit price of the purchase order line.
-
totalResults: boolean
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
-
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(required):
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(required):
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 : massReplacementPurchaseOrders
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : massReplacementPurchaseOrders-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency in the purchase order line. -
itemReplacementPODistributions: array
Mass Replacement Purchase Order Distributions
Title:
Mass Replacement Purchase Order Distributions
The massReplacementPurchaseOrders and itemReplacementPODistributions view object lists the purchase order distributions that correspond to the purchase order lines that are due for mass replacement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:30
Number of the purchase order. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order header entity. -
POLine: number
Read Only:
true
Number of the purchase order line entity. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
Precision: integer
(int32)
Read Only:
true
Value that indicates the number of digits to which the unit price attribute in the source agreement line must be rounded off. -
PurchasingUOM: string
Read Only:
true
Maximum Length:25
Name of the unit of measure in the purchase order line. -
PurchasingUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure in the purchase order line. -
RequisitioningBU: string
Read Only:
true
Maximum Length:240
Name of the requisitioning business unit for which the purchase order is created -
RequisitioningBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisitioning business unit for which the purchase order is created. -
Status: string
Read Only:
true
Maximum Length:80
Value of the purchase order header status. -
UnitPrice: number
Read Only:
true
Value of unit price of the purchase order line.
Nested Schema : Mass Replacement Purchase Order Distributions
Type:
array
Title:
Mass Replacement Purchase Order Distributions
The massReplacementPurchaseOrders and itemReplacementPODistributions view object lists the purchase order distributions that correspond to the purchase order lines that are due for mass replacement.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : massReplacementPurchaseOrders-itemReplacementPODistributions-item-response
Type:
Show Source
object
-
DeliverToLocation: string
Read Only:
true
Maximum Length:60
Name of the deliver-to location for which the purchase order line has an open distribution. -
DeliverToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the deliver-to location for which the purchase order line has an open distribution. -
DestinationSubinventory: string
Read Only:
true
Maximum Length:10
Name of the subinventory for which the purchase order line has an open distribution. -
DistributionNumber: number
Read Only:
true
Number of the purchase order distribution due for replacement. -
LineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PODistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order distribution. -
POHeaderId: integer
Read Only:
true
Value that uniquely identifies the purchase order header. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
QuantityDue: number
Read Only:
true
Value of the purchase order distribution quantity due for replacement. -
ReplacementDetailId: number
Read Only:
true
Value that uniquely identifies the replacement line. -
Requester: string
Read Only:
true
Maximum Length:240
Name of the requester for which the purchase order line has an open distribution. -
RequesterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requester for which the purchase order line has an open distribution. -
Requisition: string
Read Only:
true
Maximum Length:146
Number of the backing requisition that belongs to the purchase order distribution due for replacement. -
ScheduleNumber: number
Read Only:
true
Number of the purchase order schedule due for replacement. -
ShipToOrganization: string
Read Only:
true
Maximum Length:240
Name of the inventory organization for which the purchase order line has an open schedule. -
ShipToOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization for which the purchase order line has an open schedule. -
ShipToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization for which purchase order line has an open schedule.
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.
Examples
This example describes how to get all purchase order lines.
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/massReplacementPurchaseOrders"
For example, here's how you get one or more purchase orders for mass replacement using the findByItemMPN finder.
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementPurchaseOrders?expand=itemReplacementPODistributions&finder=findByItemMpn;bindPrcBuId=204,bindItemId=100000004,bindMode=1,bindVendorSiteId=400009,bindVendorId=900009,bindReplacementId=2423,bindGlobal=Y"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ "items": [ { "POHeaderId": 300100546688493, "POLineId": 300100546688494, "RequisitioningBUId": 204, "RequisitioningBU": "Vision Operations", "OrderNumber": "1005856", "Status": "Open", "POLine": 1, "PurchasingUOMCode": "Ea", "PurchasingUOM": "Each", "UnitPrice": 0.1, "CurrencyCode": "USD", "itemReplacementPODistributions": [ { "POHeaderId": 300100546688493, "POLineId": 300100546688494, "LineLocationId": 300100546688495, "ShipToOrganizationId": 204, "ShipToOrganizationCode": "V1", "ShipToOrganization": "Vision Operations", "PODistributionId": 300100546688496, "DistributionNumber": 1, "ScheduleNumber": 1, "Requisition": "10505240-1.1", "DeliverToLocationId": 204, "DeliverToLocation": "V1- New York City", "DestinationSubinventory": "FG", "RequesterId": 100010026863783, "Requester": ???REQ001???, "QuantityDue": 10 } ] }]} "