{"_id":"5b8ec6a1f8dd7c0003386067","category":{"_id":"5b8ec6a1f8dd7c0003385fa5","version":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-19T18:31:30.299Z","from_sync":false,"order":3,"slug":"vaulted-shopper-service","title":"Shoppers"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b19742cb3baf90003cab5ae","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b8ec6a1f8dd7c0003385fa2","5b8ec6a1f8dd7c0003385fa3","5b8ec6a1f8dd7c0003385fa4","5b8ec6a1f8dd7c0003385fa5","5b8ec6a1f8dd7c0003385fa6","5b8ec6a1f8dd7c0003385fa7","5b8ec6a1f8dd7c0003385fa8","5b8ec6a1f8dd7c0003385fa9","5b8ec6a1f8dd7c0003385faa","5b8ec6a1f8dd7c0003385fab","5b8ec6a1f8dd7c0003385fac"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-27T20:28:32.932Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","examples":{"codes":[]},"auth":"optional","params":[],"url":""},"isReference":true,"order":2,"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>1236548</shopper-id>\\n    <seller-shopper-id>1234abcd</seller-shopper-id>\\n    <shopper-contact-info>\\n      <title>Mr.</title>\\n      <first-name>John</first-name>\\n      <last-name>Doe</last-name>\\n      <email>jdoe:::at:::johndoeandsons.com</email>\\n      <company-name>JohnDoeAndSons</company-name>\\n      <address1>138 Market St</address1>\\n      <city>San Francisco</city>\\n      <state>CA</state>\\n      <zip>75654</zip>\\n      <country>US</country>\\n      <phone>14135556789</phone>\\n      <fax>14135556788</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>John</first-name>\\n        <last-name>Doe</last-name>\\n        <email>jdoe@johndoeandsons.com</email>\\n        <company-name>JohnDoeAndSons</company-name>\\n        <address1>138 Market St</address1>\\n        <city>San Francisco</city>\\n        <state>CA</state>\\n        <zip>756543</zip>\\n        <country>US</country>\\n        <phone>14135556789</phone>\\n        <fax>14135556788</fax>\\n      </invoice-contact-info>\\n    </invoice-contacts-info>\\n    <payment-info>\\n      <credit-cards-info/>\\n      <ecps-info/>\\n      <balance/>\\n    </payment-info>\\n    <store-id>4677</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\": \"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>54891234</shopper-id>\\n    <seller-shopper-id>1234abcd</seller-shopper-id>\\n    <shopper-contact-info>\\n      <title>Mr.</title>\\n      <first-name>John</first-name>\\n      <last-name>Doe</last-name>\\n      <email>jdoe@johndoeandsons.com</email>\\n      <company-name>JohnDoeAndSons</company-name>\\n      <address1>138 Market st</address1>\\n      <city>San Francisco</city>\\n      <state>CA</state>\\n      <zip>756543</zip>\\n      <country>us</country>\\n      <phone>1413555666</phone>\\n      <fax>1413555666789</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>John</first-name>\\n        <last-name>Doe</last-name>\\n        <email>jdoe@johndoeandsons.com</email>\\n        <company-name>JohnDoeAndSons</company-name>\\n        <address1>138 Market st</address1>\\n        <city>San Francisco</city>\\n        <state>CA</state>\\n        <zip>756543</zip>\\n        <country>us</country>\\n        <phone>1413555666</phone>\\n        <fax>1413555666789</fax>\\n      </invoice-contact-info>\\n    </invoice-contacts-info>\\n    <payment-info>\\n      <credit-cards-info/>\\n      <ecps-info/>\\n      <balance/>\\n    </payment-info>\\n    <store-id>4677</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>","excerpt":"URL `services/2/shoppers/{shopper-id}`","slug":"retrieve-vaulted-shopper","type":"endpoint","title":"Retrieve Shopper"}

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>1236548</shopper-id>
    <seller-shopper-id>1234abcd</seller-shopper-id>
    <shopper-contact-info>
      <title>Mr.</title>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <email>jdoe@johndoeandsons.com</email>
      <company-name>JohnDoeAndSons</company-name>
      <address1>138 Market St</address1>
      <city>San Francisco</city>
      <state>CA</state>
      <zip>75654</zip>
      <country>US</country>
      <phone>14135556789</phone>
      <fax>14135556788</fax>
    </shopper-contact-info>
    <shipping-contact-info/>
    <invoice-contacts-info>
      <invoice-contact-info>
        <default>true</default>
        <title>Mr.</title>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <email>jdoe@johndoeandsons.com</email>
        <company-name>JohnDoeAndSons</company-name>
        <address1>138 Market St</address1>
        <city>San Francisco</city>
        <state>CA</state>
        <zip>756543</zip>
        <country>US</country>
        <phone>14135556789</phone>
        <fax>14135556788</fax>
      </invoice-contact-info>
    </invoice-contacts-info>
    <payment-info>
      <credit-cards-info/>
      <ecps-info/>
      <balance/>
    </payment-info>
    <store-id>4677</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>54891234</shopper-id>
    <seller-shopper-id>1234abcd</seller-shopper-id>
    <shopper-contact-info>
      <title>Mr.</title>
      <first-name>John</first-name>
      <last-name>Doe</last-name>
      <email>jdoe@johndoeandsons.com</email>
      <company-name>JohnDoeAndSons</company-name>
      <address1>138 Market st</address1>
      <city>San Francisco</city>
      <state>CA</state>
      <zip>756543</zip>
      <country>us</country>
      <phone>1413555666</phone>
      <fax>1413555666789</fax>
    </shopper-contact-info>
    <shipping-contact-info/>
    <invoice-contacts-info>
      <invoice-contact-info>
        <default>true</default>
        <title>Mr.</title>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
        <email>jdoe@johndoeandsons.com</email>
        <company-name>JohnDoeAndSons</company-name>
        <address1>138 Market st</address1>
        <city>San Francisco</city>
        <state>CA</state>
        <zip>756543</zip>
        <country>us</country>
        <phone>1413555666</phone>
        <fax>1413555666789</fax>
      </invoice-contact-info>
    </invoice-contacts-info>
    <payment-info>
      <credit-cards-info/>
      <ecps-info/>
      <balance/>
    </payment-info>
    <store-id>4677</store-id>
    <shopper-currency>USD</shopper-currency>
    <locale>en</locale>
    <permitted-future-charges>false</permitted-future-charges>
  </shopper-info>
</shopper>