Get Recall Notice Details

You can use the REST API to get recall notice details.

Here's a typical process flow for this scenario:

Send a REST request to get the details of the recall notice, parts, lot numbers, serial numbers, lot serial numbers, and contact information for a specific recall header.

The response payload includes details that describe the results of the request.

You can extract the values for these attributes from the response payload and display them in your partner client.

Example URL

Use this resource URL format:

GET

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

For example, the following command gets the recall notice details and the associated information when the recall notice header is 300100636759880.

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

Example Response

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

{
    "HeaderId": "300100636759880",
    "RecallNoticeNumber": "RND1443",
    "BusinessUnitId": "300100200125593",
    "BusinessUnitName": "Vision Healthcare USA",
    "DupValidationFlag": true,
    "LocateStatus": "COMPLETED",
    "ManufacturerId": null,
    "BpaManufacturerLineId": null,
    "RecallingFirm": "Medline Industries, Inc",
    "ManufacturerNumber": null,
    "ModeOfCaptureCode": null,
    "ModeOfCapture": null,
    "RecallReceivedFrom": "HC01Org",
    "AdditionalInformation": null,
    "VendorId": "6133",
    "RecallClosedDate": null,
    "RelatedLinks": null,
    "ObjectVersionNumber": 5,
    "OriginalHeaderId": null,
    "PotentialRisk": "Who consumes this Drug will fall ill.",
    "RecallClassificationTypeCode": "Class I",
    "RecallClassificationType": "High Risk",
    "RecallNoticeTypeCode": "ORA_ADVISORY",
    "RecallNoticeType": "Advisory",
    "RecallSourceTypeCode": "ORA_SUPPLIER",
    "RecallSourceType": "Supplier",
    "RecallHeaderStatusCode": "ORA_OPEN",
    "RecallHeaderStatus": "Open",
    "ReplacementTypeCode": "ORA_RETURN_WITH_CREDIT",
    "ReplacementType": "Request a product return with credit",
    "RecallClosingDate": "2030-08-25",
    "RecallInitiationDate": "2019-12-11",
    "RecallInstruction": "Scrap all the Drug in ground.",
    "RecallReason": "The H2O used for production for this drug are impure",
    "SourceReferenceNumber": "Auto_BATRef_TS21093018",
    "CreatedBy": "user1",
    "CreationDate": "2024-03-21",
    "LastUpdateDate": "2024-03-21",
    "LastUpdatedBy": "user1",
    "LastUpdateLogin": "142F3F7A602103EFE063B86015AC398B",
    "RecallTrackStartDate": null,
    "RecallTrackEndDate": null,
    "Comments": null,
    "NumberOfLinesFound": "1",
    "NumberOfLinesInProgress": "1",
    "NumberOfLinesClosed": "0",
    "TasksAssigned": "5",
    "TraceabilityStatusFound": "2",
    "TasksCompleted": "20",
    "ItemsNotFoundFlag": "false",
    "IsWithdrawEligibleFlag": "false",
    "TotalTraceabilityStatus": "4",
    "TotalTasksCompleted": "1",
    "LocateRequestId": "321007",
    "TrackStartDate": "2024-03-18",
    "TrackEndDate": "2024-03-21",
    "@context": {
        "key": "300100636759880",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/recallNoticesV2/300100636759880",
                "name": "recallNoticesV2",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/recallNoticesV2/300100636759880",
                "name": "recallNoticesV2",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/recallNoticesV2/300100636759880/child/attachments",
                "name": "attachments",
                "kind": "collection"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/recallNoticesV2/300100636759880/child/recallBusinessUnits",
                "name": "recallBusinessUnits",
                "kind": "collection"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/recallNoticesV2/300100636759880/child/recallContacts",
                "name": "recallContacts",
                "kind": "collection"
            },
            {
                "rel": "child",
                "href": "https://servername/fscmRestApi/resources/version/recallNoticesV2/300100636759880/child/recallLines",
                "name": "recallLines",
                "kind": "collection"
            }
        ]
    }
}