{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"optional","method":"get","results":{"codes":[{"code":"","language":"text"}]},"settings":"","examples":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Retrieve Shopper","type":"endpoint","slug":"retrieve-vaulted-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 Retrieve Shopper request enables you to retrieve details about a saved shopper, including their contact info, payment info, and more.\n\n###Request Content\n**Retrieve 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**Retrieve 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.\nThe response contains the retrieved `shopper` resource (see [shopper](doc:shopper)).\nFor details about possible errors, see: [General Errors](doc:general-errors) and [Shopper Errors](doc:shopper-errors).\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/shoppers/19575994 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Shopper Request: by shopper ID in BlueSnap\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/shoppers/1234abcd,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<shopper xmlns=\\\"http://ws.plimus.com\\\">\\n    <shopper-info>\\n      <shopper-id>19575994</shopper-id>\\n      <seller-shopper-id>1234abcd</seller-shopper-id>\\n        <shopper-contact-info>\\n            <title>Mr</title>\\n            <first-name>ECP Shopper first name</first-name>\\n            <last-name>ECP Shopper last name</last-name>\\n            <email>email:::at:::email.com</email>\\n            <address1>123 Oxford</address1>\\n            <city>London</city>\\n            <state>NY</state>\\n            <zip>54321</zip>\\n            <country>us</country>\\n            <phone>1800808080</phone>\\n            <fax>1800808080</fax>\\n        </shopper-contact-info>\\n        <shipping-contact-info/>\\n        <invoice-contacts-info>\\n            <invoice-contact-info>\\n                <default>true</default>\\n                <title>Mr</title>\\n                <first-name>ECP Shopper first name</first-name>\\n               <last-name>ECP Shopper last name</last-name>\\n                <email>[email protected]</email>\\n                <address1>123 Oxford</address1>\\n                <city>London</city>\\n                <state>NY</state>\\n                <zip>54321</zip>\\n                <country>us</country>\\n                <phone>1800808080</phone>\\n                <fax>1800808080</fax>\\n            </invoice-contact-info>\\n        </invoice-contacts-info>\\n        <payment-info>\\n            <credit-cards-info/>\\n            <ecps-info>\\n                <ecp-info>\\n                    <billing-contact-info>\\n                        <first-name>first</first-name>\\n                        <last-name>last name</last-name>\\n                        <address1>123 Oxford</address1>\\n                        <city>ny</city>\\n                        <state>NY</state>\\n                        <zip>90210</zip>\\n                        <country>us</country>\\n                    </billing-contact-info>\\n                    <ecp>\\n                        <account-type>CONSUMER_CHECKING</account-type>\\n                        <public-account-number>99993</public-account-number>\\n                        <public-routing-number>75151</public-routing-number>\\n                    </ecp>\\n                </ecp-info>\\n                <ecp-info>\\n                    <billing-contact-info>\\n                        <first-name>ECP Billing first name</first-name>\\n                        <last-name>ECP Billing last name</last-name>\\n                        <address1>123 Oxford</address1>\\n                        <city>New York</city>\\n                        <state>NY</state>\\n                        <zip>54321</zip>\\n                        <country>us</country>\\n                        <company-name>ECP Company</company-name>\\n                    </billing-contact-info>\\n                    <ecp>\\n                        <account-type>CORPORATE_CHECKING</account-type>\\n                        <public-account-number>99992</public-account-number>\\n                        <public-routing-number>75150</public-routing-number>\\n                    </ecp>\\n                </ecp-info>\\n            </ecps-info>\\n            <sepa-direct-debits-info/>\\n            <balance/>\\n        </payment-info>\\n        <store-id>8540</store-id>\\n        <shopper-currency>USD</shopper-currency>\\n        <locale>en</locale>\\n        <permitted-future-charges>false</permitted-future-charges>\\n    </shopper-info>\\n</shopper>\\n\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Shopper Response: by shopper ID in BlueSnap\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<shopper xmlns=\\\"http://ws.plimus.com\\\">\\n    <shopper-info>\\n       <shopper-id>19575994</shopper-id>\\n      <seller-shopper-id>1234abcd</seller-shopper-id>\\n        <shopper-contact-info>\\n            <title>Mr</title>\\n            <first-name>ECP Shopper first name</first-name>\\n            <last-name>ECP Shopper last name</last-name>\\n            <email>[email protected]</email>\\n            <address1>123 Oxford</address1>\\n            <city>London</city>\\n            <state>NY</state>\\n            <zip>54321</zip>\\n            <country>us</country>\\n            <phone>1800808080</phone>\\n            <fax>1800808080</fax>\\n        </shopper-contact-info>\\n        <shipping-contact-info/>\\n        <invoice-contacts-info>\\n            <invoice-contact-info>\\n                <default>true</default>\\n                <title>Mr</title>\\n                <first-name>ECP Shopper first name</first-name>\\n               <last-name>ECP Shopper last name</last-name>\\n                <email>[email protected]</email>\\n                <address1>123 Oxford</address1>\\n                <city>London</city>\\n                <state>NY</state>\\n                <zip>54321</zip>\\n                <country>us</country>\\n                <phone>1800808080</phone>\\n                <fax>1800808080</fax>\\n            </invoice-contact-info>\\n        </invoice-contacts-info>\\n        <payment-info>\\n            <credit-cards-info/>\\n            <ecps-info>\\n                <ecp-info>\\n                    <billing-contact-info>\\n                        <first-name>first</first-name>\\n                        <last-name>last name</last-name>\\n                        <address1>123 Oxford</address1>\\n                        <city>ny</city>\\n                        <state>NY</state>\\n                        <zip>90210</zip>\\n                        <country>us</country>\\n                    </billing-contact-info>\\n                    <ecp>\\n                        <account-type>CONSUMER_CHECKING</account-type>\\n                        <public-account-number>99993</public-account-number>\\n                        <public-routing-number>75151</public-routing-number>\\n                    </ecp>\\n                </ecp-info>\\n                <ecp-info>\\n                    <billing-contact-info>\\n                        <first-name>ECP Billing first name</first-name>\\n                        <last-name>ECP Billing last name</last-name>\\n                        <address1>123 Oxford</address1>\\n                        <city>New York</city>\\n                        <state>NY</state>\\n                        <zip>54321</zip>\\n                        <country>us</country>\\n                        <company-name>ECP Company</company-name>\\n                    </billing-contact-info>\\n                    <ecp>\\n                        <account-type>CORPORATE_CHECKING</account-type>\\n                        <public-account-number>99992</public-account-number>\\n                        <public-routing-number>75150</public-routing-number>\\n                    </ecp>\\n                </ecp-info>\\n            </ecps-info>\\n            <sepa-direct-debits-info/>\\n            <balance/>\\n        </payment-info>\\n        <store-id>8540</store-id>\\n        <shopper-currency>USD</shopper-currency>\\n        <locale>en</locale>\\n        <permitted-future-charges>false</permitted-future-charges>\\n    </shopper-info>\\n</shopper>\",\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":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6040037678d626005641a13e","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},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","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"},"createdAt":"2016-01-27T20:28:32.932Z","githubsync":"","__v":0}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

getRetrieve Shopper

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

Definition

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

Documentation

The Retrieve Shopper request enables you to retrieve details about a saved shopper, including their contact info, payment info, and more.

Request Content

Retrieve 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

Retrieve 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.
The response contains the retrieved shopper resource (see shopper).
For details about possible errors, see: General Errors and Shopper Errors.

Examples

Request Examples

Retrieve Shopper Request: by shopper ID in BlueSnap
by seller shopper ID
curl -v -X GET https://sandbox.bluesnap.com/services/2/shoppers/19575994 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/shoppers/1234abcd,388632 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

Retrieve Shopper Response: by shopper ID in BlueSnap
by seller shopper ID
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shopper xmlns="http://ws.plimus.com">
    <shopper-info>
      <shopper-id>19575994</shopper-id>
      <seller-shopper-id>1234abcd</seller-shopper-id>
        <shopper-contact-info>
            <title>Mr</title>
            <first-name>ECP Shopper first name</first-name>
            <last-name>ECP Shopper last name</last-name>
            <email>[email protected]</email>
            <address1>123 Oxford</address1>
            <city>London</city>
            <state>NY</state>
            <zip>54321</zip>
            <country>us</country>
            <phone>1800808080</phone>
            <fax>1800808080</fax>
        </shopper-contact-info>
        <shipping-contact-info/>
        <invoice-contacts-info>
            <invoice-contact-info>
                <default>true</default>
                <title>Mr</title>
                <first-name>ECP Shopper first name</first-name>
               <last-name>ECP Shopper last name</last-name>
                <email>[email protected]</email>
                <address1>123 Oxford</address1>
                <city>London</city>
                <state>NY</state>
                <zip>54321</zip>
                <country>us</country>
                <phone>1800808080</phone>
                <fax>1800808080</fax>
            </invoice-contact-info>
        </invoice-contacts-info>
        <payment-info>
            <credit-cards-info/>
            <ecps-info>
                <ecp-info>
                    <billing-contact-info>
                        <first-name>first</first-name>
                        <last-name>last name</last-name>
                        <address1>123 Oxford</address1>
                        <city>ny</city>
                        <state>NY</state>
                        <zip>90210</zip>
                        <country>us</country>
                    </billing-contact-info>
                    <ecp>
                        <account-type>CONSUMER_CHECKING</account-type>
                        <public-account-number>99993</public-account-number>
                        <public-routing-number>75151</public-routing-number>
                    </ecp>
                </ecp-info>
                <ecp-info>
                    <billing-contact-info>
                        <first-name>ECP Billing first name</first-name>
                        <last-name>ECP Billing last name</last-name>
                        <address1>123 Oxford</address1>
                        <city>New York</city>
                        <state>NY</state>
                        <zip>54321</zip>
                        <country>us</country>
                        <company-name>ECP Company</company-name>
                    </billing-contact-info>
                    <ecp>
                        <account-type>CORPORATE_CHECKING</account-type>
                        <public-account-number>99992</public-account-number>
                        <public-routing-number>75150</public-routing-number>
                    </ecp>
                </ecp-info>
            </ecps-info>
            <sepa-direct-debits-info/>
            <balance/>
        </payment-info>
        <store-id>8540</store-id>
        <shopper-currency>USD</shopper-currency>
        <locale>en</locale>
        <permitted-future-charges>false</permitted-future-charges>
    </shopper-info>
</shopper>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shopper xmlns="http://ws.plimus.com">
    <shopper-info>
       <shopper-id>19575994</shopper-id>
      <seller-shopper-id>1234abcd</seller-shopper-id>
        <shopper-contact-info>
            <title>Mr</title>
            <first-name>ECP Shopper first name</first-name>
            <last-name>ECP Shopper last name</last-name>
            <email>[email protected]</email>
            <address1>123 Oxford</address1>
            <city>London</city>
            <state>NY</state>
            <zip>54321</zip>
            <country>us</country>
            <phone>1800808080</phone>
            <fax>1800808080</fax>
        </shopper-contact-info>
        <shipping-contact-info/>
        <invoice-contacts-info>
            <invoice-contact-info>
                <default>true</default>
                <title>Mr</title>
                <first-name>ECP Shopper first name</first-name>
               <last-name>ECP Shopper last name</last-name>
                <email>[email protected]</email>
                <address1>123 Oxford</address1>
                <city>London</city>
                <state>NY</state>
                <zip>54321</zip>
                <country>us</country>
                <phone>1800808080</phone>
                <fax>1800808080</fax>
            </invoice-contact-info>
        </invoice-contacts-info>
        <payment-info>
            <credit-cards-info/>
            <ecps-info>
                <ecp-info>
                    <billing-contact-info>
                        <first-name>first</first-name>
                        <last-name>last name</last-name>
                        <address1>123 Oxford</address1>
                        <city>ny</city>
                        <state>NY</state>
                        <zip>90210</zip>
                        <country>us</country>
                    </billing-contact-info>
                    <ecp>
                        <account-type>CONSUMER_CHECKING</account-type>
                        <public-account-number>99993</public-account-number>
                        <public-routing-number>75151</public-routing-number>
                    </ecp>
                </ecp-info>
                <ecp-info>
                    <billing-contact-info>
                        <first-name>ECP Billing first name</first-name>
                        <last-name>ECP Billing last name</last-name>
                        <address1>123 Oxford</address1>
                        <city>New York</city>
                        <state>NY</state>
                        <zip>54321</zip>
                        <country>us</country>
                        <company-name>ECP Company</company-name>
                    </billing-contact-info>
                    <ecp>
                        <account-type>CORPORATE_CHECKING</account-type>
                        <public-account-number>99992</public-account-number>
                        <public-routing-number>75150</public-routing-number>
                    </ecp>
                </ecp-info>
            </ecps-info>
            <sepa-direct-debits-info/>
            <balance/>
        </payment-info>
        <store-id>8540</store-id>
        <shopper-currency>USD</shopper-currency>
        <locale>en</locale>
        <permitted-future-charges>false</permitted-future-charges>
    </shopper-info>
</shopper>