Manage Service Parts Returns

You can use REST API to view one or many Service Parts Returns. Service Parts Returns in Service Logistics are parts that should be returned from a field service technician to a specific return location. Service Parts Returns include defective parts and excess parts. Service Logistics Return Routing Rules are used to determine the return location for the parts.

Here is a typical application processing flow for the scenarios:

  1. You can query for one specific part return.
  2. You can query for multiple part returns.

Query for One Service Parts Return

In this scenario, you can query for one specific part return.

Example URL

Use this resource URL format.

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/servicePartReturns/<ReturnId>"

Example Response

Here's an example of the response body in JSON format.

{
  "ReturnId": 100100261492861,
  "StockLocationId": 300100175333710,
  "OrganizationId": 5702,
  "OrganizationCode": "FST",
  "OrganizationName": "Field Service Technicians",
  "Subinventory": "FS_Truck1",
  "OwningPartyId": 2458,
  "OwningPartyName": "Lisa Pickford",
  "ItemId": 249,
  "ItemNumber": "CM13139",
  "ItemDescription": "Hard Drive - 8GB",
  "Revision": null,
  "Quantity": 7,
  "UOMCode": "Ea",
  "UnitOfMeasure": "Each",
  "DestinationOrganizationId": 207,
  "DestinationOganizationCode": "M1",
  "DestinationOrganizationName": "Seattle Manufacturing",
  "DestinationSubinventory": null,
  "ReturnAddress": "3455 108th Avenue, SEATTLE, WA 98101, UNITED STATES",
  "LastReceivedDate": "2004-08-31",
  "ReturnTypeCode": "EXCESS",
  "ReturnType": "Excess",
  "RecoveredPartDispositionCode": "M",
  "RecoveredPartsDisposition": "Fast return",
  "CreatedBy": "RCL_USER",
  "CreationDate": "2021-06-16T13:32:28+00:00",
  "LastUpdatedBy": "RCL_USER",
  "LastUpdateDate": "2021-06-16T13:32:28+00:00",
  "LastUpdateLogin": null,
  "links": [
    {
      "rel": "self",
      "href": "http://servername/fscmRestApi/resources/version/servicePartReturns/100100261492861",
      "name": "servicePartReturns",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://servername/fscmRestApi/resources/version/servicePartReturns/100100261492861",
      "name": "servicePartReturns",
      "kind": "item"
    }
  ]
}

Query for All Service Parts Return

In this scenario, you can you can query for all service parts returns.

Example URL

Use this resource URL format.

GET

curl -u username:password "https://servername/fscmRestApi/resources/version/servicePartReturns"

Example Response

Here's an example of the response body in JSON format.

{
  "items": [
    {
      "ReturnId": 100100261492860,
      "StockLocationId": 300100175333710,
      "OrganizationId": 5702,
      "OrganizationCode": "FST",
      "OrganizationName": "Field Service Technicians",
      "Subinventory": "FS_Truck1",
      "OwningPartyId": 2458,
      "OwningPartyName": "Lisa Pickford",
      "ItemId": 237,
      "ItemNumber": "CM32546",
      "ItemDescription": "Battery - NiHM",
      "Revision": null,
      "Quantity": 10,
      "UOMCode": "Ea",
      "UnitOfMeasure": "Each",
      "DestinationOrganizationId": 207,
      "DestinationOganizationCode": "M1",
      "DestinationOrganizationName": "Seattle Manufacturing",
      "DestinationSubinventory": null,
      "ReturnAddress": "3455 108th Avenue, SEATTLE, WA 98101, UNITED STATES",
      "LastReceivedDate": "2004-10-08",
      "ReturnTypeCode": "EXCESS",
      "ReturnType": "Excess",
      "RecoveredPartDispositionCode": null,
      "RecoveredPartsDisposition": null,
      "CreatedBy": "RCL_USER",
      "CreationDate": "2021-06-16T13:32:27+00:00",
      "LastUpdatedBy": "RCL_USER",
      "LastUpdateDate": "2021-06-16T13:32:27+00:00",
      "LastUpdateLogin": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername/fscmRestApi/resources/version/servicePartReturns/100100261492860",
          "name": "servicePartReturns",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://servername/fscmRestApi/resources/version/servicePartReturns/100100261492860",
          "name": "servicePartReturns",
          "kind": "item"
        }
      ]
    },
    {
      "ReturnId": 100100261492861,
      "StockLocationId": 300100175333710,
      "OrganizationId": 5702,
      "OrganizationCode": "FST",
      "OrganizationName": "Field Service Technicians",
      "Subinventory": "FS_Truck1",
      "OwningPartyId": 2458,
      "OwningPartyName": "Lisa Pickford",
      "ItemId": 249,
      "ItemNumber": "CM13139",
      "ItemDescription": "Hard Drive - 8GB",
      "Revision": null,
      "Quantity": 7,
      "UOMCode": "Ea",
      "UnitOfMeasure": "Each",
      "DestinationOrganizationId": 207,
      "DestinationOganizationCode": "M1",
      "DestinationOrganizationName": "Seattle Manufacturing",
      "DestinationSubinventory": null,
      "ReturnAddress": "3455 108th Avenue, SEATTLE, WA 98101, UNITED STATES",
      "LastReceivedDate": "2004-08-31",
      "ReturnTypeCode": "EXCESS",
      "ReturnType": "Excess",
      "RecoveredPartDispositionCode": "M",
      "RecoveredPartsDisposition": "Fast return",
      "CreatedBy": "RCL_USER",
      "CreationDate": "2021-06-16T13:32:28+00:00",
      "LastUpdatedBy": "RCL_USER",
      "LastUpdateDate": "2021-06-16T13:32:28+00:00",
      "LastUpdateLogin": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername/fscmRestApi/resources/version/servicePartReturns/100100261492861",
          "name": "servicePartReturns",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://servername/fscmRestApi/resources/version/servicePartReturns/100100261492861",
          "name": "servicePartReturns",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": true,
  "limit": 2,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername/fscmRestApi/resources/version/servicePartReturns",
      "name": "servicePartReturns",
      "kind": "collection"
    }
  ]
}