Update a line
/fscmRestApi/resources/11.13.18.05/supplierReturns/{SupplierReturnHeaderId}/child/lines/{linesUniqID}
Request
-
SupplierReturnHeaderId(required): integer(int64)
Value that uniquely identifies the supplier return header.
-
linesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Lines resource and used to uniquely identify an instance of Lines. The client should not generate the hash key value. Instead, the client should query on the Lines collection resource in order to navigate to a specific instance of Lines to get the hash key.
-
Metadata-Context: string
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: string
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.
- application/json
object-
Account: string
Title:
AccountMaximum Length:4000Account associated with the return. -
AccountId: integer
(int64)
Value that uniquely identifies the account associated with the return.
-
CancelFlag: boolean
Default Value:
falseContains one of the following values: true or false. If true, then the supplier return line is canceled if it is in the Pending fulfillment status. If false, then no action is taken. The default value is false. -
Comments: string
Title:
CommentsMaximum Length:240Comments entered by the user. -
DFF: array
Flexfields for Supplier Return Lines
Title:
Flexfields for Supplier Return LinesThe Flexfields for Supplier Return Lines resource manages additional details about supplier return lines. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer PartsThe Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line. -
PhysicalMaterialReturnRequiredFlag: boolean
Title:
Physical Material Return RequiredMaximum Length:1Default Value:trueContains one of the following values: true or false. If true, then physical return of the material is required. If false, then physical return of the material is not required. The default value is true. -
Reason: string
Title:
ReasonMaximum Length:30Reason for the inventory transaction. -
ReasonId: integer
(int64)
Title:
Reason IDValue that uniquely identifies the inventory transaction reason. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall notice. This attribute is associated with a feature that requires opt in.
-
RecallLineId: integer
(int64)
Value that uniquely identifies the recall notice line. This attribute is associated with a feature that requires opt in.
-
RecallNoticeLineNumber: integer
(int64)
Title:
Recall Notice Line NumberNumber that identifies the recall notice line. This attribute is associated with a feature that requires opt in. -
RecallNoticeNumber: string
Title:
Recall NoticeMaximum Length:60Number that identifies the recall notice. This attribute is associated with a feature that requires opt in. -
RequestedDate: string
(date-time)
Title:
Requested DateDate when the user requested the supplier return line to be shipped. -
ReturnedById: integer
(int64)
Title:
Returned ByValue that uniquely identifies the person who created the supplier return line. -
ReturnedByName: string
Title:
Returned ByMaximum Length:2000Name of the person who created the supplier return line. -
serials: array
Serial Numbers
Title:
Serial NumbersThe Serial Numbers resource manages the serial numbers associated with a supplier return line. -
SupplierItemNumber: string
Title:
Supplier ItemMaximum Length:300Number that identifies the supplier item. -
SupplierLotNumber: string
Title:
Supplier LotMaximum Length:30Number that identifies the supplier lot. -
SupplierRMANumber: string
Title:
RMAMaximum Length:30Number that identifies the supplier return material authorization (RMA) reference.
arrayFlexfields for Supplier Return LinesarrayFlexfields for Inventory AttributesarrayManufacturer PartsarraySerial Numbersobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Descriptive flexfield context name for supplier return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for supplier return lines. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the supplier return line.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name of inventory attributes for supplier return lines. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value of inventory attributes for supplier return lines. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectNumber that identifies the project. This attribute is associated with a feature that requires opt in. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the supplier return line. This attribute is associated with a feature that requires opt in.
-
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskNumber that identifies the task. This attribute is associated with a feature that requires opt in.
object-
FromSerialNumber: string
Maximum Length:
80Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item. -
ToSerialNumber: string
Maximum Length:
80Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Response
- application/json
Default Response
-
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.
object-
Account: string
Title:
AccountMaximum Length:4000Account associated with the return. -
AccountId: integer
(int64)
Value that uniquely identifies the account associated with the return.
-
CanceledQuantity: number
Read Only:
trueQuantity that is canceled. -
CancelFlag: boolean
Default Value:
falseContains one of the following values: true or false. If true, then the supplier return line is canceled if it is in the Pending fulfillment status. If false, then no action is taken. The default value is false. -
Comments: string
Title:
CommentsMaximum Length:240Comments entered by the user. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the supplier return line. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the supplier return line. -
DFF: array
Flexfields for Supplier Return Lines
Title:
Flexfields for Supplier Return LinesThe Flexfields for Supplier Return Lines resource manages additional details about supplier return lines. -
ErrorMessage: string
Title:
Error MessageRead Only:trueMaximum Length:1000Text of the error message, in case of any errors during processing. -
ErrorMessageName: string
Read Only:
trueMaximum Length:240Name of the error message, in case of any errors during processing. -
FulfilledQuantity: number
Read Only:
trueQuantity that is fulfilled. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the inventory item. -
ItemId: integer
(int64)
Title:
Item IDValue that uniquely identifies the inventory item. -
ItemNumber: string
Maximum Length:
300Number that identifies the inventory item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the supplier return line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the supplier return line. -
LineStatus: string
Title:
Line StatusRead Only:trueMaximum Length:80Status of the supplier return line. A list of accepted values is defined in the lookup type ORA_RCV_SUPP_RET_LINE_STATUS. -
LineStatusCode: string
Read Only:
trueMaximum Length:30Default Value:INCOMPLETEAbbreviation the identifies the status of the supplier return line. A list of accepted values is defined in the lookup type ORA_RCV_SUPP_RET_LINE_STATUS. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Title:
LocatorMaximum Length:4000Name of the locator where the item is located. -
LocatorId: integer
(int64)
Title:
Locator IDValue that uniquely identifies the locator where the item is located. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer PartsThe Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line. -
OrganizationCode: string
Read Only:
trueMaximum Length:18Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Title:
Organization IDRead Only:trueValue that uniquely identifies the inventory organization. -
PhysicalMaterialReturnRequiredFlag: boolean
Title:
Physical Material Return RequiredMaximum Length:1Default Value:trueContains one of the following values: true or false. If true, then physical return of the material is required. If false, then physical return of the material is not required. The default value is true. -
PrimaryRequestedQuantity: number
Read Only:
trueQuantity to be returned in the primary unit of measure of the item. -
PrimaryUnitOfMeasure: string
Title:
Primary UOMRead Only:trueMaximum Length:25Primary unit of measure of the item. -
PrimaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the primary unit of measure of the item. -
Reason: string
Title:
ReasonMaximum Length:30Reason for the inventory transaction. -
ReasonId: integer
(int64)
Title:
Reason IDValue that uniquely identifies the inventory transaction reason. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall notice. This attribute is associated with a feature that requires opt in.
-
RecallLineId: integer
(int64)
Value that uniquely identifies the recall notice line. This attribute is associated with a feature that requires opt in.
-
RecallNoticeLineNumber: integer
(int64)
Title:
Recall Notice Line NumberNumber that identifies the recall notice line. This attribute is associated with a feature that requires opt in. -
RecallNoticeNumber: string
Title:
Recall NoticeMaximum Length:60Number that identifies the recall notice. This attribute is associated with a feature that requires opt in. -
RequestedDate: string
(date-time)
Title:
Requested DateDate when the user requested the supplier return line to be shipped. -
RequestedQuantity: number
Title:
Requested QuantityQuantity to be returned. -
ReturnedById: integer
(int64)
Title:
Returned ByValue that uniquely identifies the person who created the supplier return line. -
ReturnedByName: string
Title:
Returned ByMaximum Length:2000Name of the person who created the supplier return line. -
SecondaryCanceledQuantity: number
Read Only:
trueQuantity that is canceled in the secondary unit of measure of the item. -
SecondaryFulfilledQuantity: number
Read Only:
trueQuantity that is fulfilled in the secondary unit of measure of the item. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested QuantityQuantity to be returned in the secondary unit of measure of the item. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOMMaximum Length:25Secondary unit of measure of the item. -
SecondaryUOMCode: string
Maximum Length:
3Abbreviation that identifies the secondary unit of measure of the item. -
serials: array
Serial Numbers
Title:
Serial NumbersThe Serial Numbers resource manages the serial numbers associated with a supplier return line. -
Subinventory: string
Maximum Length:
10Name of the subinventory where the item is located. -
SupplierItemNumber: string
Title:
Supplier ItemMaximum Length:300Number that identifies the supplier item. -
SupplierLotNumber: string
Title:
Supplier LotMaximum Length:30Number that identifies the supplier lot. -
SupplierReturnLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier return line. -
SupplierReturnLineNumber: integer
(int64)
Title:
LineRead Only:trueNumber that identifies the supplier return line. -
SupplierRMANumber: string
Title:
RMAMaximum Length:30Number that identifies the supplier return material authorization (RMA) reference. -
UnitOfMeasure: string
Title:
UOM NameMaximum Length:25Unit of measure used for the supplier return line. -
UOMCode: string
Title:
UOM CodeMaximum Length:3Abbreviation that identifies the unit of measure used for the supplier return line.
arrayFlexfields for Supplier Return LinesarrayFlexfields for Inventory AttributesarrayLinksarrayManufacturer PartsarraySerial Numbersobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Descriptive flexfield context name for supplier return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for supplier return lines. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the supplier return line.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name of inventory attributes for supplier return lines. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value of inventory attributes for supplier return lines. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectNumber that identifies the project. This attribute is associated with a feature that requires opt in. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the supplier return line. This attribute is associated with a feature that requires opt in.
-
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskNumber that identifies the task. This attribute is associated with a feature that requires opt in.
arrayLinksobject-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerName: string
Read Only:
trueMaximum Length:360Name of the manufacturer. -
ManufacturerPartNumber: string
Read Only:
trueMaximum Length:150Number issued by the manufacturer that uniquely identifies the individual product.
arrayLinksobject-
FromSerialNumber: string
Maximum Length:
80Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ToSerialNumber: string
Maximum Length:
80Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
arrayLinks- DFF
-
Parameters:
- SupplierReturnHeaderId:
$request.path.SupplierReturnHeaderId - linesUniqID:
$request.path.linesUniqID
The Flexfields for Supplier Return Lines resource manages additional details about supplier return lines. - SupplierReturnHeaderId:
- inventoryAttributesDFF
-
Parameters:
- SupplierReturnHeaderId:
$request.path.SupplierReturnHeaderId - linesUniqID:
$request.path.linesUniqID
The Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. - SupplierReturnHeaderId:
- manufacturerParts
-
Parameters:
- SupplierReturnHeaderId:
$request.path.SupplierReturnHeaderId - linesUniqID:
$request.path.linesUniqID
The Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line. - SupplierReturnHeaderId:
- serials
-
Parameters:
- SupplierReturnHeaderId:
$request.path.SupplierReturnHeaderId - linesUniqID:
$request.path.linesUniqID
The Serial Numbers resource manages the serial numbers associated with a supplier return line. - SupplierReturnHeaderId:
Examples
This example describes how to update a line.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/supplierReturns/SupplierReturnHeaderId/child/lines/linesUniqID"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"Comments": "Updated the supplier return line"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"SupplierReturnLineId": 300100191493356,
"SupplierReturnLineNumber": 3,
"CreationDate": "2020-05-14T23:33:36+00:00",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2020-05-14T23:34:23.056+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"OrganizationId": 207,
"OrganizationCode": "M1",
"ItemId": 663913,
"ItemNumber": "INV-100",
"ItemDescription": "Plain Item",
"ItemRevision": null,
"LineStatusCode": "INCOMPLETE",
"LineStatus": "Incomplete",
"Subinventory": "FloorStock",
"LocatorId": null,
"Locator": null,
"PhysicalMaterialReturnRequiredFlag": true,
"RequestedQuantity": 1.3,
"FulfilledQuantity": null,
"CanceledQuantity": null,
"UOMCode": "C10",
"UnitOfMeasure": "Case of 10",
"PrimaryRequestedQuantity": 13,
"PrimaryUOMCode": "Ea",
"PrimaryUnitOfMeasure": "Each",
"RequestedDate": null,
"ReturnedById": 25,
"ReturnedByName": "Smith, Pat",
"AccountId": null,
"Account": null,
"LotNumber": null,
"SecondaryRequestedQuantity": null,
"SecondaryFulfilledQuantity": null,
"SecondaryCanceledQuantity": null,
"SecondaryUOMCode": null,
"SecondaryUnitOfMeasure": null,
"SupplierLotNumber": null,
"SupplierItemNumber": null,
"SupplierRMANumber": null,
"RecallHeaderId": null,
"RecallNoticeNumber": null,
"RecallLineId": null,
"RecallNoticeLineNumber": null,
"ReasonId": null,
"Reason": null,
"Comments": "Updated the supplier return line",
"ErrorMessageName": null,
"ErrorMessage": null,
"CancelFlag": null,
"links": [
...
]
}
Example Request Body
The following example includes the contents of the request body in JSON format to cancel a supplier return line. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"CancelFlag": true
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"SupplierReturnLineId": 300100191493356,
"SupplierReturnLineNumber": 3,
"CreationDate": "2020-05-14T23:33:36+00:00",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2020-05-14T23:58:03+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"OrganizationId": 207,
"OrganizationCode": "M1",
"ItemId": 663913,
"ItemNumber": "INV-100",
"ItemDescription": "Plain Item",
"ItemRevision": null,
"LineStatusCode": "CANCELED",
"LineStatus": "Canceled",
"Subinventory": "FloorStock",
"LocatorId": null,
"Locator": null,
"PhysicalMaterialReturnRequiredFlag": true,
"RequestedQuantity": 1.3,
"FulfilledQuantity": null,
"CanceledQuantity": 1.3,
"UOMCode": "C10",
"UnitOfMeasure": "Case of 10",
"PrimaryRequestedQuantity": 13,
"PrimaryUOMCode": "Ea",
"PrimaryUnitOfMeasure": "Each",
"RequestedDate": "2020-05-14T23:57:39+00:00",
"ReturnedById": 25,
"ReturnedByName": "Smith, Pat",
"AccountId": null,
"Account": null,
"LotNumber": null,
"SecondaryRequestedQuantity": null,
"SecondaryFulfilledQuantity": null,
"SecondaryCanceledQuantity": null,
"SecondaryUOMCode": null,
"SecondaryUnitOfMeasure": null,
"SupplierLotNumber": null,
"SupplierItemNumber": null,
"SupplierRMANumber": null,
"RecallHeaderId": null,
"RecallNoticeNumber": null,
"RecallLineId": null,
"RecallNoticeLineNumber": null,
"ReasonId": null,
"Reason": null,
"Comments": "Updated the supplier return line",
"ErrorMessageName": null,
"ErrorMessage": null,
"CancelFlag": true,
"links": [
...
]
}