Buy with Prime | Developer Documentation
Documentation

personalDataRetrievalTask

Version 2024-11-01

📘

Important

The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.

Overview

Returns a single personal data retrieval task.

ℹ️

Required scope(s)

Manage Shopper Privacy Requests

Response

Return type PersonalDataRetrievalTask

Arguments

ArgumentDescription
taskId (String required)

Specifies the identifier to retrieve a personal data retrieval task.

Examples

Personal Data Retrieval Task With Error

Request

query {
    personalDataRetrievalTask(taskId: "3556a10a-6b0c-481f-a02e-3950c53f12b3") {
        taskId
        status
        submissionDate
        lastUpdatedDate
        dataSubject {
            type
            email
        }
        dataRetrievalLink
        errors {
            code
            message
        }
    }
}

Response

{
  "data": {
    "personalDataRetrievalTask": {
      "taskId": "3556a10a-6b0c-481f-a02e-3950c53f12b3",
      "status": "FAILED",
      "submissionDate": "2024-01-12T20:19:34.638498Z",
      "lastUpdatedDate": "2024-01-12T20:19:35.070533Z",
      "dataSubject": {
        "type": "SHOPPER",
        "email": "[email protected]"
      },
      "errors": [
        {
          "code": "DATA_SUBJECT_NOT_FOUND",
          "message": "The shopper email for request 3556a10a-6b0c-481f-a02e-3950c53f12b3 does not exist"
        }
      ]
    }
  }
}

Personal Data Retrieval Task

Request

query {
    personalDataRetrievalTask(taskId: "29f3fdd6-ee00-4563-a97f-03ec6ca7596d") {
        taskId
        status
        submissionDate
        dataSubject {
            type
            email
        }
        dataRetrievalLink
    }
}

Response

{
  "data": {
    "personalDataRetrievalTask": {
      "taskId": "29f3fdd6-ee00-4563-a97f-03ec6ca7596d",
      "status": "COMPLETED",
      "submissionDate": "2023-10-31T18:21:15.851865Z",
      "dataSubject": {
        "type": "SHOPPER",
        "email": "[email protected]"
      },
      "dataRetrievalLink" : "https://buy-with-prime-requested-data-bucket-prod.s3.amazonaws.com.s3.amazonaws.com/privacyRequest/29f3fdd6-ee00-4563-a97f-03ec6ca7596d/result/data_retrieval.zip?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIAjO8F57XMdxNzWbonLD3jKGx3CqjOagMV%2FSJdlXSQEwAiA0WvVRgbcx9Bm1wbQziu%2FIVDkgWXglEq3IGu7M6MSweiqSAgiS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDIwNTk0NDIyNzI3NCIMe7h10h9%2BVNNOKDWbKuYBG1vaAzqGqHbhggpSxdcbRKBl4rkOQyg2wnRnx6R%2BvAP4bPAK8RuyN3YQuQcgCDu68uOSMF4iFPHpq4nkBhicM2IspZEQRfdpf2kgnNnDCoN0LLAjQwQK3NQtHu%2B4bPvhgtCvm8HbBRM5MoMVAcJbT%2BQxG59b8djr4pCGtYgyhaj25n5k%2B3Fxb%2F44Z415zUhVDwCGmgdt%2BFUCKfs2%2FcUDqavMq3nFJ3RgamPpcDBhrRi8g0Yr4RJikaprSCuSKKvrn2RO4RV0UvcXYu5NiA9NtUxOGNv4DKTrmpe0mJF10IMThAp8OjswobmVrQY6kAEECoZF7ft8%2BHK6uUWUu1eweNzcwjL83Pf%2Fws%2Fw9jsuHDd%2BLs%2F%2FA2k2pTR8lrMOG%2FuMgXi68%2B4FajfHSMLnVYHgf9SmA5VLgBG7g9%2FpCz2VqH%2B5uW04mVGfRyqFt%2F3hrOvg7pUz68Nqq9lQgysOY2JLxptgaUgeodQbATio2PIpG8ioDh3fysjEpbbqhVPSEQs%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240115T162652Z&X-Amz-SignedHeaders=host&X-Amz-Credential=ASIAS74Z3QXFC6IVRFXE%2F20240115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Expires=2&X-Amz-Signature=7515e99c4f70082c53069ac862acd27cdb6c59e5bfa6a636e1b9d5e308b75a75"
    }
  }
}

Non Exist Error

Request

query {
    personalDataRetrievalTask(taskId: "edee74fa-e2d2-422d-a557-809d64bb9ea1") {
        taskId
        status
        submissionDate
        lastUpdatedDate
        dataSubject {
            type
            email
        }
        dataRetrievalLink
    }
}

Response

{
  "errors": [
    {
      "message": "Request references a resource which does not exist.",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "personalDataRetrievalTask"
      ],
      "extensions": {
        "classification": {
          "type": "ResourceNotFoundError",
          "errorType": "ResourceNotFoundException",
          "errorCode": 404
        }
      }
    }
  ],
  "data": {
    "personalDataRetrievalTask": null
  }
}

Updated 4 days ago