Create one supplier return

post

/fscmRestApi/resources/11.13.18.05/supplierReturns

Request

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.
  • 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
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.
  • Maximum Length: 18
    Abbreviation that identifies the inventory organization.
  • Title: Organization ID
    Value that uniquely identifies the inventory organization.
  • 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.
  • Title: Supplier ID
    Value that uniquely identifies the supplier.
  • Title: Supplier
    Maximum Length: 360
    Name of the supplier.
  • Title: Supplier Site
    Maximum Length: 240
    Abbreviation that identifies the supplier site.
  • Title: Supplier Site ID
    Value that uniquely identifies the supplier site.
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 : DFF
Type: array
Show Source
Nested Schema : inventoryAttributesDFF
Type: array
Show Source
Nested Schema : Manufacturer Parts
Type: array
Title: Manufacturer Parts
Manufacturer parts associated with a 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: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : supplierReturns-lines-manufacturerParts-item-post-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 : DFF
Type: array
Show Source
Nested Schema : inventoryAttributesDFF
Type: array
Show Source
Nested Schema : Manufacturer Parts
Type: array
Title: Manufacturer Parts
Manufacturer parts associated with a 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
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.
Back to Top

Examples

This example describes how to create one supplier return.

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"

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.

{
	"OrganizationCode": "M1",
	"Description": "Description entered from POST",
	"OneTimeShipToLocation": "Redwood City, CA 940",
	"SupplierName": "Tall Manufacturing",
	"SupplierSiteCode": "NANTERRE_HQ",
	"SubmitFlag": false,
	"lines": [
	{
		"ItemNumber": "RCV-100",
		"Subinventory": "FloorStock",
		"PhysicalMaterialReturnRequiredFlag": true,
		"RequestedQuantity": 1,
		"UnitOfMeasure": "Box of 5",
		"ReturnedByName": "Smith, Pat"
	},
	{
		"ItemNumber": "VC110",
		"ItemRevision": "A",
		"Subinventory": "FloorStock",
		"PhysicalMaterialReturnRequiredFlag": false,
		"RequestedQuantity": 5,
		"UnitOfMeasure": "Each",
		"LotNumber": "L1589498093",
		"ReturnedByName": "Smith, Pat",
		"serials": [
		{
			"FromSerialNumber": "S158949809303",
			"ToSerialNumber": "S158949809304"
		},
		{
			"FromSerialNumber": "S158949809310",
			"ToSerialNumber": "S158949809312"
		}
		]
	}
	]
}

Example 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:16:49.277+00:00",
	"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
	"OrganizationId": 207,
	"OrganizationCode": "M1",
	"Description": "Description entered from POST",
	"OneTimeShipToLocation": "Redwood City, CA 940",
	"SupplierId": 21,
	"SupplierName": "Tall Manufacturing",
	"SupplierSiteId": 460,
	"SupplierSiteCode": "NANTERRE_HQ",
	"ErrorMessageName": null,
	"ErrorMessage": null,
	"SubmitFlag": false,
	"lines": {
		"items": [
		{
			"SupplierReturnLineId": 300100191493354,
			"SupplierReturnLineNumber": 1,
			"CreationDate": "2020-05-14T23:16:49.078+00:00",
			"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
			"LastUpdateDate": "2020-05-14T23:16:49.279+00:00",
			"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
			"OrganizationId": 207,
			"OrganizationCode": "M1",
			"ItemId": 663907,
			"ItemNumber": "RCV-100",
			"ItemDescription": "Plain Item",
			"ItemRevision": null,
			"LineStatusCode": "INCOMPLETE",
			"LineStatus": "Incomplete",
			"Subinventory": "FloorStock",
			"LocatorId": null,
			"Locator": null,
			"PhysicalMaterialReturnRequiredFlag": true,
			"RequestedQuantity": 1,
			"FulfilledQuantity": null,
			"CanceledQuantity": null,
			"UOMCode": "BX5",
			"UnitOfMeasure": "Box of 5",
			"PrimaryRequestedQuantity": 5,
			"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": [
			...
			]
		},
		{
			"SupplierReturnLineId": 300100191493355,
			"SupplierReturnLineNumber": 2,
			"CreationDate": "2020-05-14T23:16:49.131+00:00",
			"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
			"LastUpdateDate": "2020-05-14T23:16:49.283+00:00",
			"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
			"OrganizationId": 207,
			"OrganizationCode": "M1",
			"ItemId": 663997,
			"ItemNumber": "VC110",
			"ItemDescription": "VC-Lot Serial Revision",
			"ItemRevision": "A",
			"LineStatusCode": "INCOMPLETE",
			"LineStatus": "Incomplete",
			"Subinventory": "FloorStock",
			"LocatorId": null,
			"Locator": null,
			"PhysicalMaterialReturnRequiredFlag": false,
			"RequestedQuantity": 5,
			"FulfilledQuantity": null,
			"CanceledQuantity": null,
			"UOMCode": "Ea",
			"UnitOfMeasure": "Each",
			"PrimaryRequestedQuantity": 5,
			"PrimaryUOMCode": "Ea",
			"PrimaryUnitOfMeasure": "Each",
			"RequestedDate": null,
			"ReturnedById": 25,
			"ReturnedByName": "Smith, Pat",
			"AccountId": null,
			"Account": null,
			"LotNumber": "L1589498093",
			"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,
			"serials": {
				"items": [
				{
					"FromSerialNumber": "S158949809303",
					"ToSerialNumber": "S158949809304",
					"links": [
					...
					]
				},
				{
					"FromSerialNumber": "S158949809310",
					"ToSerialNumber": "S158949809312",
					"links": [
					...
					]
				}
				],
				"count": 2,
				"hasMore": false,
				"limit": 25,
				"offset": 0,
				"links": [
				...
				]
			},
			"links": [
			...
			]
		}
		],
		"count": 2,
		"hasMore": false,
		"limit": 25,
		"offset": 0,
		"links": [
		...
		]
	},
	"links": [
	...
	]
}
Back to Top