Get one replenishment request
get
/fscmRestApi/resources/11.13.18.05/vmiReplenishmentRequests/{ReplenishmentRequestNumber}
Request
Path Parameters
-
ReplenishmentRequestNumber(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=
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 : 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
Links
- ReplenishmentLifeCycle
-
Parameters:
- ReplenishmentRequestNumber:
$request.path.ReplenishmentRequestNumber
The Replenishment Life Cycle resource gets the life cycle states for a replenishment request. - ReplenishmentRequestNumber:
- ReplenishmentRequestErrors
-
Parameters:
- ReplenishmentRequestNumber:
$request.path.ReplenishmentRequestNumber
The Replenishment Request Errors resource manages the errors received when a request is in the Failed status. - ReplenishmentRequestNumber:
Examples
This example describes how to get one replenishment request.
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/ReplenishmentRequestNumber"
For example, the following command gets one replenishment request:
curl -u username:password "https://servername/fscmRestApi/resources/version/vmiReplenishmentRequests/7002"
Example Response Body
The following shows an example of the response body in JSON format.
{ "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": [ { ... }, { ... }, { ... } ] }