Get all replenishment requests
get
/fscmRestApi/resources/11.13.18.05/vmiReplenishmentRequests
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 vendor-managed inventory replenishment requests according to the specified primary key criteria.
Finder Variables- ReplenishmentRequestId; integer; Value that uniquely identifies the vendor-managed inventory replenishment request.
- RowFinder Find vendor-managed inventory replenishment requests according to the replenishment request number.
Finder Variables- ReplenishmentRequestNumber; integer; Value that uniquely identifies the replenishment request.
- PrimaryKey Find vendor-managed inventory replenishment requests according to the specified primary key criteria.
-
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:- CreatedBy; string; User who created the replenishment request.
- CreationDate; string; Date and time when the user created the replenishment request.
- DelivertoLocationId; integer; Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.
- DelivertoLocationName; string; Name of the location where the item is delivered. This attribute isn't available to suppliers.
- DeliveryDate; string; Date when the item is expected to be delivered.
- InventoryItemId; integer; Value that uniquely identifies the inventory item in the replenishment request.
- InvoiceNumber; string; Number that identifies the invoice.
- ItemCategory; string; Category that the application assigns to the item.
- ItemDescription; string; Description of the item.
- ItemNumber; string; Number that identifies the item.
- LastUpdateDate; string; Date and time when the user most recently updated the replenishment request.
- LastUpdatedBy; string; Login of the user who most recently updated the replenishment request.
- Notes; string; Note created by the person who submitted the replenishment request.
- OrganizationCode; string; Abbreviation that identifies the organization that receives the item.
- OrganizationId; integer; Value that uniquely identifies the organization in the replenishment request. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
- OrganizationName; string; Name of the organization that receives the item.
- PaymentNumber; string; Number that identifies the payment.
- ProcessId; integer; Value that uniquely identifies the process of the scheduled job.
- ProcurementBU; string; Name of the business unit. The application assigns the supplier to this business unit.
- ProcurementBUId; integer; Value that uniquely identifies the business unit that manages and owns the purchasing document.
- PurchaseOrderNumber; string; Number that identifies the purchase order.
- ReceiptNumber; string; Number that identifies the receipt.
- ReplenishmentQuantity; number; Quantity of the replenishment requests for the inventory item.
- ReplenishmentRequestId; integer; Value that uniquely identifies the replenishment request.
- ReplenishmentRequestNumber; string; Number that identifies the replenishment request.
- RequisitionId; integer; Value that uniquely identifies the requisition. This attribute isn't available to suppliers.
- RequisitionNumber; string; Number that identifies the requisition. This attribute isn't available to suppliers.
- RequisitionRequesterId; integer; Value that uniquely identifies the user requesting the requisition.
- RequisitionRequesterName; string; Name of the user requesting the requisition.
- ShipToLocation; string; Name of the ship-to location.
- ShipmentNumber; string; Number that identifies the shipment.
- Status; string; State of the of the replenishment request. Values can be Submitted, In Process, Requested, Pending Approval, Closed, Failed, Canceled, or Rejected.
- StatusCode; string; Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS.
- Subinventory; string; Name of the subinventory that receives the item.
- SubinventoryDescription; string; Description of the subinventory.
- SubmittedDate; string; Date when the replenishment request was submitted.
- SupplierId; integer; Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
- SupplierItemId; integer; Value that uniquely identifies the supplier item in the replenishment request.
- SupplierItemName; string; Name of the item given by the supplier.
- SupplierName; string; Name of the supplier who ships the item.
- SupplierNumber; string; Number that identifies the supplier who ships the item.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site that manages this item.
- SupplierSiteName; string; Name of the supplier site that ships the item.
- UOMCode; string; Abbreviation that identifies the unit of measure for the item.
- UnitOfMeasure; string; Unit of measure for the item.
- VmiItemId; integer; Value that uniquely identifies the vendor-managed inventory item.
-
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:
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 : vmiReplenishmentRequests
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 : vmiReplenishmentRequests-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the replenishment request. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the replenishment request. -
DelivertoLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers. -
DelivertoLocationName: string
Read Only:
true
Maximum Length:240
Name of the location where the item is delivered. This attribute isn't available to suppliers. -
DeliveryDate: string
(date)
Date when the item is expected to be delivered.
-
InventoryItemId: integer
(int64)
Default Value:
-2
Value that uniquely identifies the inventory item in the replenishment request. -
InvoiceNumber: string
Read Only:
true
Number that identifies the invoice. -
ItemCategory: string
Read Only:
true
Maximum Length:255
Category that the application assigns to the item. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item. -
ItemNumber: string
Number that identifies the item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the replenishment request. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who most recently updated the replenishment request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: string
Maximum Length:
400
Note created by the person who submitted the replenishment request. -
OrganizationCode: string
Abbreviation that identifies the organization that receives the item.
-
OrganizationId: integer
(int64)
Default Value:
-2
Value that uniquely identifies the organization in the replenishment request. This organization receives the shipment. It's a primary key that the application generates when it creates an organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organization that receives the item. -
PaymentNumber: string
Read Only:
true
Number that identifies the payment. -
ProcessId: integer
(int64)
Read Only:
true
Value that uniquely identifies the process of the scheduled job. -
ProcurementBU: string
Name of the business unit. The application assigns the supplier to this business unit.
-
ProcurementBUId: integer
Value that uniquely identifies the business unit that manages and owns the purchasing document.
-
PurchaseOrderNumber: string
Read Only:
true
Number that identifies the purchase order. -
ReceiptNumber: string
Read Only:
true
Number that identifies the receipt. -
ReplenishmentLifeCycle: array
Replenishment Life Cycle
Title:
Replenishment Life Cycle
The Replenishment Life Cycle resource gets the life cycle states for a replenishment request. -
ReplenishmentQuantity: number
Quantity of the replenishment requests for the inventory item.
-
ReplenishmentRequestErrors: array
Replenishment Request Errors
Title:
Replenishment Request Errors
The Replenishment Request Errors resource manages the errors received when a request is in the Failed status. -
ReplenishmentRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replenishment request. -
ReplenishmentRequestNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the replenishment request. -
RequisitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition. This attribute isn't available to suppliers. -
RequisitionNumber: string
Read Only:
true
Maximum Length:64
Number that identifies the requisition. This attribute isn't available to suppliers. -
RequisitionRequesterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the user requesting the requisition. -
RequisitionRequesterName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the user requesting the requisition. -
ShipmentNumber: string
Read Only:
true
Number that identifies the shipment. -
ShipToLocation: string
Read Only:
true
Name of the ship-to location. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
State of the of the replenishment request. Values can be Submitted, In Process, Requested, Pending Approval, Closed, Failed, Canceled, or Rejected. -
StatusCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS. -
Subinventory: string
Maximum Length:
10
Name of the subinventory that receives the item. -
SubinventoryDescription: string
Title:
Description
Read Only:true
Maximum Length:50
Description of the subinventory. -
SubmittedDate: string
(date)
Read Only:
true
Date when the replenishment request was submitted. -
SupplierId: integer
(int64)
Default Value:
-2
Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier. -
SupplierItemId: integer
Read Only:
true
Value that uniquely identifies the supplier item in the replenishment request. -
SupplierItemName: string
Read Only:
true
Maximum Length:255
Name of the item given by the supplier. -
SupplierName: string
Name of the supplier who ships the item.
-
SupplierNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the supplier who ships the item. -
SupplierSiteId: integer
(int64)
Default Value:
-2
Value that uniquely identifies the supplier site that manages this item. -
SupplierSiteName: string
Maximum Length:
255
Name of the supplier site that ships the item. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure for the item. -
UOMCode: string
Title:
Primary UOM
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure for the item. -
VmiItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the vendor-managed inventory item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Replenishment Life Cycle
Type:
array
Title:
Replenishment Life Cycle
The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.
Show Source
Nested Schema : Replenishment Request Errors
Type:
array
Title:
Replenishment Request Errors
The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.
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.
Nested Schema : vmiReplenishmentRequests-ReplenishmentLifeCycle-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Quantity: number
Read Only:
true
Quantity of the replenishment request in the replenishment life cycle state. -
ReplenishmentLifeCycleCode: string
Read Only:
true
Maximum Length:25
Value that identifies the state of the replenishment item in the procurement life cycle. A list of accepted values is defined in the lookup type ORA_VCS_VMI_REPL_LIFE_CYCLE. -
ReplenishmentLifeCycleName: string
Read Only:
true
Maximum Length:80
State of the replenishment request in the procurement life cycle. Values can be pending request approval, pending receipt, pending shipment, or pending delivery.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : vmiReplenishmentRequests-ReplenishmentRequestErrors-item-response
Type:
Show Source
object
-
ErrorCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the error message. -
ErrorDescription: string
Read Only:
true
Maximum Length:2000
Description of the error message. -
ErrorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the error message. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all replenishment requests.
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/vmiReplenishmentRequests"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ReplenishmentRequestId": 300100174116536, "ReplenishmentRequestNumber": "7001", "SupplierId": 100000012050255, "SupplierName": "CV_SuppD05", "SupplierNumber": "7", "SupplierSiteId": null, "SupplierSiteName": null, "ProcurementBUId": null, "ProcurementBU": null, "OrganizationId": 300100152267719, "OrganizationCode": "VMIMFG3", "OrganizationName": "VMI Manufacturing 3", "Subinventory": null, "SubinventoryDescription": null, "DelivertoLocationId": 300100152267642, "DelivertoLocationName": "VMI-MFG3 – Manufacturing 3", "ShipToLocation": "VMIMFG3", "InventoryItemId": 300100173317974, "VmiItemId": 16002, "ItemNumber": "VMI-P200", "ItemDescription": "VMI Product 200", "ItemCategory": "Miscellaneous_1", "SupplierItemId": null, "SupplierItemName": null, "ReplenishmentQuantity": 120, "UnitOfMeasure": "Each", "UOMCode": "Ea", "Status": "Failed", "StatusCode": "ORA_VCS_REQUEST_ERROR", "DeliveryDate": "2018-10-09", "ProcessId": 34540, "SubmittedDate": "2018-10-09", "Notes": "Notes from supplier.", "RequisitionId": null, "RequisitionNumber": null, "PurchaseOrderNumber": null, "PaymentNumber": null, "ShipmentNumber": null, "ReceiptNumber": null, "InvoiceNumber": null, "RequisitionRequesterId": 300100073936640, "RequisitionRequesterName": "COLLABPLANNER COLLABPLANNER", "CreatedBy": "CVSUPPD05", "CreationDate": "2018-10-09T19:56:26+00:00", "LastUpdatedBy": "CVSUPPD05", "LastUpdateDate": "2018-10-09T19:56:27.838+00:00", "links": [ { ... }, { ... }, { ... } ] }, { "ReplenishmentRequestId": 111111, "ReplenishmentRequestNumber": "1111", "SupplierId": 100000012050255, "SupplierName": "CV_SuppD05", "SupplierNumber": "7", "SupplierSiteId": null, "SupplierSiteName": null, "ProcurementBUId": null, "ProcurementBU": null, "OrganizationId": 300100152267719, "OrganizationCode": "VMIMFG3", "OrganizationName": "VMI Manufacturing 3", "Subinventory": null, "SubinventoryDescription": null, "DelivertoLocationId": 300100152267642, "DelivertoLocationName": "VMI-MFG3 – Manufacturing 3", "ShipToLocation": "VMIMFG3", "InventoryItemId": 300100173317974, "VmiItemId": 16002, "ItemNumber": "VMI-P200", "ItemDescription": "VMI Product 200", "ItemCategory": "Miscellaneous_1", "SupplierItemId": null, "SupplierItemName": null, "ReplenishmentQuantity": 120, "UnitOfMeasure": "Each", "UOMCode": "Ea", "Status": "Failed", "StatusCode": "ORA_VCS_REQUEST_ERROR", "DeliveryDate": "2018-10-09", "ProcessId": 34577, "SubmittedDate": "2018-10-09", "Notes": "Notes from supplier.", "RequisitionId": "100469", "RequisitionNumber": "3", "PurchaseOrderNumber": null, "PaymentNumber": null, "ShipmentNumber": null, "ReceiptNumber": null, "InvoiceNumber": null, "RequisitionRequesterId": 300100073936640, "RequisitionRequesterName": "COLLABPLANNER COLLABPLANNER", "CreatedBy": "CVSUPPD05", "CreationDate": "2018-10-09T20:39:11+00:00", "LastUpdatedBy": "CVSUPPD05", "LastUpdateDate": "2018-10-09T20:39:11.120+00:00", "links": [ { ... }, { ... }, { ... } ] }, { "ReplenishmentRequestId": 300100174116573, "ReplenishmentRequestNumber": "7002", "SupplierId": 100000012050255, "SupplierName": "CV_SuppD05", "SupplierNumber": "7", "SupplierSiteId": null, "SupplierSiteName": null, "ProcurementBUId": null, "ProcurementBU": null, "OrganizationId": 300100152267719, "OrganizationCode": "VMIMFG3", "OrganizationName": "VMI Manufacturing 3", "Subinventory": null, "SubinventoryDescription": null, "DelivertoLocationId": 300100152267642, "DelivertoLocationName": "VMI-MFG3 – Manufacturing 3", "ShipToLocation": "VMIMFG3", "InventoryItemId": 300100173317974, "VmiItemId": 16002, "ItemNumber": "VMI-P200", "ItemDescription": "VMI Product 200", "ItemCategory": "Miscellaneous_1", "SupplierItemId": null, "SupplierItemName": null, "ReplenishmentQuantity": 120, "UnitOfMeasure": "Each", "UOMCode": "Ea", "Status": "Requested", "StatusCode": "ORA_VCS_REQUEST_REQUESTED", "DeliveryDate": "2018-10-09", "ProcessId": 34577, "SubmittedDate": "2018-10-09", "Notes": "Notes from supplier.", "RequisitionId": "100469", "RequisitionNumber": "3", "PurchaseOrderNumber": null, "PaymentNumber": null, "ShipmentNumber": null, "ReceiptNumber": null, "InvoiceNumber": null, "RequisitionRequesterId": 300100073936640, "RequisitionRequesterName": "COLLABPLANNER COLLABPLANNER", "CreatedBy": "CVSUPPD05", "CreationDate": "2018-10-09T20:39:11+00:00", "LastUpdatedBy": "CVSUPPD05", "LastUpdateDate": "2018-10-09T20:39:11.120+00:00", "links": [ { ... }, { ... }, { ... } ] } ], "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { ... } ] }