{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"optional","method":"delete","results":{"codes":[{"code":"","language":"text"}]},"settings":"","examples":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Delete Shopper","type":"endpoint","slug":"delete-shopper","excerpt":"URL `services/2/shoppers/{shopper-id}`","body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/shoppers/:shopper-id|:seller-shopper-id,:seller-id</span>\n\n<hr>\n\n##Documentation\nThe Delete Shopper request allows you to delete an existing shopper using their Shopper ID or the Seller Shopper ID.\n\n###Request Content\n\nNo content is required in the request body. Enter the relevant IDs in the request URL, as follows:\n\n**Delete based on Shopper ID in BlueSnap**\nEnter the `shopper-id` into the web service URL, in the format:\n`services/2/shoppers/{shopper-id}`\n\nFor example:\n`services/2/shoppers/2345678`\n\n\n**Delete based on Seller Shopper ID**\nEnter the unique ID that you assigned to the shopper (the `seller-shopper-id`), **and** your seller ID in BlueSnap (`seller-id`) into the web service URL, in the format:\n`services/2/shoppers/{seller-shopper-id},{seller-id}`\n\nFor example:\n`services/2/shoppers/456789123,397248`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nFor details about possible errors, see: [General Errors](doc:general-errors) and [Shopper Errors](doc:shopper-errors).\n\n###Validations\nBefore a delete shopper request is approved, BlueSnap will verify the following:\n  * The shopper has not already been deleted\n  * The shopper does not have any transactions from the past 12 months\n  * The shopper does not have any active subscriptions\n  * The shopper does not have any pending ECP or SEPA payments \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please note that any deleted shopper or shopper data will be masked in reports that include that information.\",\n  \"title\": \"Deleted Shopper Data\"\n}\n[/block]\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X DELETE https://sandbox.bluesnap.com/services/2/shoppers/19570404 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Delete Shopper Request: by shopper ID in BlueSnap\"\n    },\n    {\n      \"code\": \"curl -v -X DELETE https://sandbox.bluesnap.com/services/2/shoppers/19570404,388632 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by seller shopper ID\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<message xmlns=\\\"http://ws.plimus.com\\\">\\n    <description>Your request to delete shopper ID 19570404 has been received and will be processed within 7 days.</description>\\n</message>\",\n      \"language\": \"xml\",\n      \"name\": \"Delete Shopper Response: by shopper ID in BlueSnap\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<message xmlns=\\\"http://ws.plimus.com\\\">\\n    <description>Your request to delete seller shopper ID 19570404 has been received and will be processed within 7 days.</description>\\n</message>\",\n      \"language\": \"xml\",\n      \"name\": \"by seller shopper ID\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","updates":[],"order":999,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60b8e003cca1d90049bf643a","createdAt":"2021-06-03T13:58:27.529Z","user":"606df105d9ab93003f73cb10","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Shoppers","slug":"vaulted-shopper-service","order":3,"from_sync":false,"reference":true,"_id":"6040037678d626005641a087","version":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-19T18:31:30.299Z","__v":0},"version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6040037678d626005641a084","6040037678d626005641a085","6040037678d626005641a086","6040037678d626005641a087","6040037678d626005641a088","6040037678d626005641a089","6040037678d626005641a08a","6040037678d626005641a08b","6040037678d626005641a08c","6040037678d626005641a08d","6040037678d626005641a08e"],"_id":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5c742637ad58c70033b9c762","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0}

deleteDelete Shopper

URL `services/2/shoppers/{shopper-id}`

Definition

https://sandbox.bluesnap.com/services/2/shoppers/:shopper-id|:seller-shopper-id,:seller-id


Documentation

The Delete Shopper request allows you to delete an existing shopper using their Shopper ID or the Seller Shopper ID.

Request Content

No content is required in the request body. Enter the relevant IDs in the request URL, as follows:

Delete based on Shopper ID in BlueSnap
Enter the shopper-id into the web service URL, in the format:
services/2/shoppers/{shopper-id}

For example:
services/2/shoppers/2345678

Delete based on Seller Shopper ID
Enter the unique ID that you assigned to the shopper (the seller-shopper-id), and your seller ID in BlueSnap (seller-id) into the web service URL, in the format:
services/2/shoppers/{seller-shopper-id},{seller-id}

For example:
services/2/shoppers/456789123,397248

Response Details

If successful, the response HTTP status code is 200 OK.
For details about possible errors, see: General Errors and Shopper Errors.

Validations

Before a delete shopper request is approved, BlueSnap will verify the following:

  • The shopper has not already been deleted
  • The shopper does not have any transactions from the past 12 months
  • The shopper does not have any active subscriptions
  • The shopper does not have any pending ECP or SEPA payments

Deleted Shopper Data

Please note that any deleted shopper or shopper data will be masked in reports that include that information.


Examples

Request Examples

curl -v -X DELETE https://sandbox.bluesnap.com/services/2/shoppers/19570404 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X DELETE https://sandbox.bluesnap.com/services/2/shoppers/19570404,388632 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<message xmlns="http://ws.plimus.com">
    <description>Your request to delete shopper ID 19570404 has been received and will be processed within 7 days.</description>
</message>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<message xmlns="http://ws.plimus.com">
    <description>Your request to delete seller shopper ID 19570404 has been received and will be processed within 7 days.</description>
</message>