Create one line
post
/fscmRestApi/resources/11.13.18.05/supplierReturns/{SupplierReturnHeaderId}/child/lines
Request
Path Parameters
-
SupplierReturnHeaderId(required): integer(int64)
Value that uniquely identifies the supplier return header.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:2000
Account associated with the return. -
AccountId: integer
(int64)
Value that uniquely identifies the account associated with the return.
-
CancelFlag: boolean
Default Value:
false
Contains 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:
Comments
Maximum Length:240
Comments entered by the user. -
DFF: array
Flexfields for Supplier Return Lines
Title:
Flexfields for Supplier Return Lines
The Flexfields for Supplier Return Lines resource manages additional details about supplier return lines. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. -
ItemId(required): integer
(int64)
Title:
Item ID
Value that uniquely identifies the inventory item. -
ItemNumber(required): string
Maximum Length:
300
Number that identifies the inventory item. -
ItemRevision: string
Maximum Length:
18
Revision of the item. -
Locator: string
Title:
Locator
Maximum Length:2000
Name of the locator where the item is located. -
LocatorId: integer
(int64)
Title:
Locator ID
Value that uniquely identifies the locator where the item is located. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line. -
PhysicalMaterialReturnRequiredFlag: boolean
Title:
Physical Material Return Required
Maximum Length:1
Default Value:true
Contains 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:
Reason
Maximum Length:30
Reason for the inventory transaction. -
ReasonId: integer
(int64)
Title:
Reason ID
Value 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 Number
Number that identifies the recall notice line. This attribute is associated with a feature that requires opt in. -
RecallNoticeNumber: string
Title:
Recall Notice
Maximum Length:60
Number that identifies the recall notice. This attribute is associated with a feature that requires opt in. -
RequestedDate: string
(date-time)
Title:
Requested Date
Date when the user requested the supplier return line to be shipped. -
RequestedQuantity(required): number
Title:
Requested Quantity
Quantity to be returned. -
ReturnedById(required): integer
(int64)
Title:
Returned By
Value that uniquely identifies the person who created the supplier return line. -
ReturnedByName: string
Title:
Returned By
Maximum Length:2000
Name of the person who created the supplier return line. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested Quantity
Quantity to be returned in the secondary unit of measure of the item. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Maximum Length:25
Secondary unit of measure of the item. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure of the item. -
serials: array
Serial Numbers
Title:
Serial Numbers
The Serial Numbers resource manages the serial numbers associated with a supplier return line. -
Subinventory(required): string
Maximum Length:
10
Name of the subinventory where the item is located. -
SupplierItemNumber: string
Title:
Supplier Item
Maximum Length:300
Number that identifies the supplier item. -
SupplierLotNumber: string
Title:
Supplier Lot
Maximum Length:30
Number that identifies the supplier lot. -
SupplierRMANumber: string
Title:
RMA
Maximum Length:30
Number that identifies the supplier return material authorization (RMA) reference. -
UnitOfMeasure(required): string
Title:
UOM Name
Maximum Length:25
Unit of measure used for the supplier return line. -
UOMCode(required): string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure used for the supplier return line.
Nested Schema : Flexfields for Supplier Return Lines
Type:
array
Title:
Flexfields for Supplier Return Lines
The Flexfields for Supplier Return Lines resource manages additional details about supplier return lines.
Show Source
Nested Schema : Flexfields for Inventory Attributes
Type:
array
Title:
Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line.
Show Source
Nested Schema : Serial Numbers
Type:
array
Title:
Serial Numbers
The Serial Numbers resource manages the serial numbers associated with a supplier return line.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for supplier return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for supplier return lines. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the supplier return line.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive 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 Segment
Descriptive 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 Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number 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:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : schema
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item. -
ToSerialNumber: string
Maximum Length:
80
Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Response
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 : supplierReturns-lines-item-response
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:2000
Account associated with the return. -
AccountId: integer
(int64)
Value that uniquely identifies the account associated with the return.
-
CanceledQuantity: number
Read Only:
true
Quantity that is canceled. -
CancelFlag: boolean
Default Value:
false
Contains 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:
Comments
Maximum Length:240
Comments entered by the user. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the supplier return line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the supplier return line. -
DFF: array
Flexfields for Supplier Return Lines
Title:
Flexfields for Supplier Return Lines
The Flexfields for Supplier Return Lines resource manages additional details about supplier return lines. -
ErrorMessage: string
Title:
Error Message
Read Only:true
Maximum Length:1000
Text of the error message, in case of any errors during processing. -
ErrorMessageName: string
Read Only:
true
Maximum Length:240
Name of the error message, in case of any errors during processing. -
FulfilledQuantity: number
Read Only:
true
Quantity that is fulfilled. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory Attributes
The 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 Description
Read Only:true
Maximum Length:240
Description of the inventory item. -
ItemId: integer
(int64)
Title:
Item ID
Value that uniquely identifies the inventory item. -
ItemNumber: string
Maximum Length:
300
Number that identifies the inventory item. -
ItemRevision: string
Maximum Length:
18
Revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the supplier return line. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the supplier return line. -
LineStatus: string
Title:
Line Status
Read Only:true
Maximum Length:80
Status 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:
true
Maximum Length:30
Default Value:INCOMPLETE
Abbreviation 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:
Links
The link relations associated with the resource instance. -
Locator: string
Title:
Locator
Maximum Length:2000
Name of the locator where the item is located. -
LocatorId: integer
(int64)
Title:
Locator ID
Value that uniquely identifies the locator where the item is located. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Title:
Organization ID
Read Only:true
Value that uniquely identifies the inventory organization. -
PhysicalMaterialReturnRequiredFlag: boolean
Title:
Physical Material Return Required
Maximum Length:1
Default Value:true
Contains 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:
true
Quantity to be returned in the primary unit of measure of the item. -
PrimaryUnitOfMeasure: string
Title:
Primary UOM
Read Only:true
Maximum Length:25
Primary unit of measure of the item. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the primary unit of measure of the item. -
Reason: string
Title:
Reason
Maximum Length:30
Reason for the inventory transaction. -
ReasonId: integer
(int64)
Title:
Reason ID
Value 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 Number
Number that identifies the recall notice line. This attribute is associated with a feature that requires opt in. -
RecallNoticeNumber: string
Title:
Recall Notice
Maximum Length:60
Number that identifies the recall notice. This attribute is associated with a feature that requires opt in. -
RequestedDate: string
(date-time)
Title:
Requested Date
Date when the user requested the supplier return line to be shipped. -
RequestedQuantity: number
Title:
Requested Quantity
Quantity to be returned. -
ReturnedById: integer
(int64)
Title:
Returned By
Value that uniquely identifies the person who created the supplier return line. -
ReturnedByName: string
Title:
Returned By
Maximum Length:2000
Name of the person who created the supplier return line. -
SecondaryCanceledQuantity: number
Read Only:
true
Quantity that is canceled in the secondary unit of measure of the item. -
SecondaryFulfilledQuantity: number
Read Only:
true
Quantity that is fulfilled in the secondary unit of measure of the item. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested Quantity
Quantity to be returned in the secondary unit of measure of the item. -
SecondaryUnitOfMeasure: string
Title:
Secondary UOM
Maximum Length:25
Secondary unit of measure of the item. -
SecondaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure of the item. -
serials: array
Serial Numbers
Title:
Serial Numbers
The Serial Numbers resource manages the serial numbers associated with a supplier return line. -
Subinventory: string
Maximum Length:
10
Name of the subinventory where the item is located. -
SupplierItemNumber: string
Title:
Supplier Item
Maximum Length:300
Number that identifies the supplier item. -
SupplierLotNumber: string
Title:
Supplier Lot
Maximum Length:30
Number that identifies the supplier lot. -
SupplierReturnLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier return line. -
SupplierReturnLineNumber: integer
(int64)
Title:
Line
Read Only:true
Number that identifies the supplier return line. -
SupplierRMANumber: string
Title:
RMA
Maximum Length:30
Number that identifies the supplier return material authorization (RMA) reference. -
UnitOfMeasure: string
Title:
UOM Name
Maximum Length:25
Unit of measure used for the supplier return line. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Abbreviation that identifies the unit of measure used for the supplier return line.
Nested Schema : Flexfields for Supplier Return Lines
Type:
array
Title:
Flexfields for Supplier Return Lines
The Flexfields for Supplier Return Lines resource manages additional details about supplier return lines.
Show Source
Nested Schema : Flexfields for Inventory Attributes
Type:
array
Title:
Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line.
Show Source
Nested Schema : Serial Numbers
Type:
array
Title:
Serial Numbers
The Serial Numbers resource manages the serial numbers associated with a supplier return line.
Show Source
Nested Schema : supplierReturns-lines-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for supplier return lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for supplier return lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierReturnLineId: integer
(int64)
Value that uniquely identifies the supplier return line.
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.
Nested Schema : supplierReturns-lines-inventoryAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive 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 Segment
Descriptive 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 Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number 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:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierReturns-lines-manufacturerParts-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerName: string
Read Only:
true
Maximum Length:360
Name of the manufacturer. -
ManufacturerPartNumber: string
Read Only:
true
Maximum Length:150
Number issued by the manufacturer that uniquely identifies the individual product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierReturns-lines-serials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToSerialNumber: string
Maximum Length:
80
Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- 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 create one line.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/supplierReturns/SupplierReturnHeaderId/child/lines"
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 creates.
{ "ItemNumber": "INV-100", "RequestedQuantity": 1.3, "UnitOfMeasure": "Case of 10", "Subinventory": "FloorStock", "PhysicalMaterialReturnRequiredFlag": true, "ReturnedByName": "Smith, Pat" }
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:33:36.376+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": null, "ErrorMessageName": null, "ErrorMessage": null, "CancelFlag": null, "links": [ ... ] }