Update one return

patch

/fscmRestApi/resources/11.13.18.05/receivingReturns/{ReturnHeaderId}

Request

Path Parameters
  • 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=
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 return.
  • Lines
    Title: Lines
    Supplier return lines associated with a supplier return.
  • Title: One-Time Ship-to Location
    Maximum Length: 4000
    One time ship-to address for the 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 return lines are submitted for processing and the status is moved to fulfilled or pending fulfillment. If false, then all the lines remain in an incomplete status. The default value is false.
Nested Schema : Lines
Type: array
Title: Lines
Supplier return lines associated with a supplier return.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : inventoryAttributesDFF
Type: array
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Manufacturer Parts
Type: array
Title: Manufacturer Parts
Manufacturer parts associated with a return line.
Show Source
Nested Schema : referencedDFF
Type: array
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The serial numbers associated with a return line.
Show Source
Nested Schema : unreferencedDFF
Type: array
Show Source
Nested Schema : receivingReturns-lines-inventoryAttributesDFF-item-patch-request
Type: object
Show Source
Nested Schema : receivingReturns-lines-lineAttachments-item-patch-request
Type: object
Show Source
Nested Schema : receivingReturns-lines-manufacturerParts-item-patch-request
Type: object
Show Source
Nested Schema : receivingReturns-lines-referencedDFF-item-patch-request
Type: object
Show Source
Nested Schema : receivingReturns-lines-serials-item-patch-request
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.
Nested Schema : receivingReturns-lines-unreferencedDFF-item-patch-request
Type: object
Show Source
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 : receivingReturns-item-response
Type: object
Show Source
Nested Schema : Lines
Type: array
Title: Lines
Supplier return lines associated with a supplier return.
Show Source
Nested Schema : receivingReturns-lines-item-response
Type: object
Show Source
Nested Schema : inventoryAttributesDFF
Type: array
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Manufacturer Parts
Type: array
Title: Manufacturer Parts
Manufacturer parts associated with a return line.
Show Source
Nested Schema : referencedDFF
Type: array
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The serial numbers associated with a return line.
Show Source
Nested Schema : unreferencedDFF
Type: array
Show Source
Nested Schema : receivingReturns-lines-inventoryAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingReturns-lines-lineAttachments-item-response
Type: object
Show Source
Nested Schema : receivingReturns-lines-manufacturerParts-item-response
Type: object
Show Source
Nested Schema : receivingReturns-lines-referencedDFF-item-response
Type: object
Show Source
Nested Schema : receivingReturns-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.
Nested Schema : receivingReturns-lines-unreferencedDFF-item-response
Type: object
Show Source
Back to Top