1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Supplier Returns

Update a supplier return

patch

/fscmRestApi/resources/11.13.18.05/supplierReturns/{SupplierReturnHeaderId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Description
    Maximum Length: 240
    Description of the supplier return.
  • Text of the error message, in case of any errors during processing.
  • Name of the error message, in case of any errors during processing.
  • Lines
    Title: Lines
    The Lines resource manages one or more supplier return lines associated with a supplier return.
  • Title: One-Time Ship-to Location
    Maximum Length: 4000
    One time ship-to location for the supplier return. For example, in case of recall management, user may want to ship it back to the manufacturer instead of the supplier.
  • Default Value: false
    Contains one of the following values: true or false. If true, then all the supplier return lines are interfaced to inventory or shipping for processing and the status is moved to Fulfilled or Pending fulfillment. If false, then all the lines remain in the Incomplete status. The default value is false.
Nested Schema : Lines
Type: array
Title: Lines
The Lines resource manages one or more supplier return lines associated with a supplier return.
Show Source
Nested Schema : schema
Type: object
Show Source
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 : supplierReturns-lines-DFF-item-patch-request
Type: object
Show Source
Nested Schema : supplierReturns-lines-inventoryAttributesDFF-item-patch-request
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the supplier return line. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : supplierReturns-lines-manufacturerParts-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 80
    Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item.
  • Maximum Length: 80
    Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : supplierReturns-item-response
Type: object
Show Source
Nested Schema : Lines
Type: array
Title: Lines
The Lines resource manages one or more supplier return lines associated with a supplier return.
Show Source
Nested Schema : supplierReturns-lines-item-response
Type: object
Show Source
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 : supplierReturns-lines-DFF-item-response
Type: object
Show Source
Nested Schema : supplierReturns-lines-inventoryAttributesDFF-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the supplier return line. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : supplierReturns-lines-manufacturerParts-item-response
Type: object
Show Source
Nested Schema : supplierReturns-lines-serials-item-response
Type: object
Show Source
  • Maximum Length: 80
    Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item.
  • Links
  • Maximum Length: 80
    Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
Links
lines
Parameters:
  • SupplierReturnHeaderId: $request.path.SupplierReturnHeaderId
The Lines resource manages one or more supplier return lines associated with a supplier return.
Back to Top

Examples

This example describes how to update a supplier return.

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"

Example 1 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. 

{
	"Description": "Updated description",
	"OneTimeShipToLocation": "Updated ship-to location"
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"SupplierReturnHeaderId": 300100191493353,
	"SupplierReturnNumber": "38003",
	"CreationDate": "2020-05-14T23:16:49+00:00",
	"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"LastUpdateDate": "2020-05-14T23:22:22+00:00",
	"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"Description": "Updated description",
	"OneTimeShipToLocation": "Updated ship-to location",
	"SupplierId": 21,
	"SupplierName": "Tall Manufacturing",
	"SupplierSiteId": 460,
	"SupplierSiteCode": "NANTERRE_HQ",
	"ErrorMessageName": null,
	"ErrorMessage": null,
	"SubmitFlag": null,
	"links": [
	...
	]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to submit a supplier return. 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. 

{
    "SubmitFlag": true
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"SupplierReturnHeaderId": 300100191493353,
	"SupplierReturnNumber": "38003",
	"CreationDate": "2020-05-14T23:16:49+00:00",
	"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"LastUpdateDate": "2020-05-14T23:57:39+00:00",
	"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"Description": "Updated description",
	"OneTimeShipToLocation": "Updated ship-to location",
	"SupplierId": 21,
	"SupplierName": "Tall Manufacturing",
	"SupplierSiteId": 460,
	"SupplierSiteCode": "NANTERRE_HQ",
	"ErrorMessageName": null,
	"ErrorMessage": null,
	"SubmitFlag": true,
	"links": [
	...
	]
}
Back to Top