{"_id":"5b8ec6a1f8dd7c0003386041","category":{"_id":"5b8ec6a1f8dd7c0003385faa","version":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","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-06-28T12:31:08.354Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":92,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"7-0\": \"`invoice-contacts-info`\",\n    \"7-1\": \"container\",\n    \"7-3\": \"Container of [invoice-contacts-info](doc:invoice-contacts-info) properties.\",\n    \"h-4\": \"Description\",\n    \"7-2\": \"Optional\",\n    \"8-0\": \"`shipping-contact-info`\",\n    \"8-1\": \"container\",\n    \"8-2\": \"Optional\",\n    \"8-3\": \"Container of [shipping-contact-info](doc:shipping-contact-info) properties.\",\n    \"0-0\": \"`seller-shopper-id`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Optional\",\n    \"9-0\": \"`shopper-contact-info`\",\n    \"10-0\": \"`payment-info`\",\n    \"9-1\": \"container\",\n    \"10-1\": \"container\",\n    \"9-2\": \"Optional\",\n    \"10-2\": \"Optional\",\n    \"9-3\": \"Container of [shopper-contact-info](doc:shopper-contact-info) properties.\",\n    \"10-3\": \"Container of [payment-info](doc:payment-info) properties.\",\n    \"0-3\": \"Unique shopper ID assigned by the merchant.\",\n    \"1-0\": \"`store-id`\",\n    \"2-0\": \"`vat-code`\",\n    \"3-0\": \"`shopper-currency`\",\n    \"4-0\": \"`locale`\",\n    \"1-1\": \"*integer*\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"1-3\": \"Merchant’s store ID.\\nTo pick up the soft descriptor configured in the system you will need to include the `store-id`. Please contact [merchants:::at:::bluesnap.com](mailto:merchants@bluesnap.com) if you do not know your `store-id`.\",\n    \"2-3\": \"Value added tax identification number (VATIN) associated with the shopper. A shopper with a VATIN does not pay VAT to the merchant.\",\n    \"4-3\": \"Shopper's selected language.  See [Language codes](/docs/language-codes).\",\n    \"3-3\": \"Shopper's selected currency. All prices and orders for this shopper will be based on this currency.\\nSee [Currency codes](/docs/currency-codes).\\n\\n*Note: In the [Create Order and New Shopper](doc:create-shopper-and-order) request, the shopper currency and order currency must match.*\",\n    \"4-2\": \"Optional\",\n    \"3-2\": \"Optional\",\n    \"2-2\": \"Optional\",\n    \"1-2\": \"Optional\",\n    \"5-0\": \"`soft-descriptor`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional; Relevant if sending a credit card number\",\n    \"5-3\": \"Description that may appear on the shopper's bank statement when BlueSnap validates the card.\",\n    \"6-0\": \"`descriptor-phone-number`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional; Relevant if sending a credit card number\",\n    \"6-3\": \"Merchant's support phone number, which may appear on the shopper's bank statement when BlueSnap validates the card. \\n\\nLength: 0-20 characters\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"`shopper-id`\",\n    \"0-1\": \"*long*\",\n    \"0-2\": \"Shopper's BlueSnap ID.\",\n    \"1-0\": \"`seller-shopper-id`\",\n    \"2-0\": \"`store-id`\",\n    \"3-0\": \"`vat-code`\",\n    \"4-0\": \"`shopper-currency`\",\n    \"5-0\": \"`locale`\",\n    \"6-0\": \"`invoice-contacts-info`\",\n    \"7-0\": \"`shipping-contact-info`\",\n    \"8-0\": \"`shopper-contact-info`\",\n    \"9-0\": \"`payment-info`\",\n    \"9-1\": \"container\",\n    \"8-1\": \"container\",\n    \"7-1\": \"container\",\n    \"6-1\": \"container\",\n    \"5-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"2-1\": \"*integer*\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Unique shopper ID assigned by the merchant.\",\n    \"2-2\": \"Merchant’s store ID.\",\n    \"3-2\": \"Value added tax identification number (VATIN) associated with the shopper. A shopper with a VATIN does not pay VAT to the merchant.\",\n    \"4-2\": \"Shopper's selected currency. All prices and orders for this shopper will be based on this currency.\\nSee [Currency codes](/docs/currency-codes).\",\n    \"5-2\": \"Shopper's selected language.  See [Language codes](/docs/language-codes).\",\n    \"6-2\": \"Container of [invoice-contacts-info](doc:invoice-contacts-info) properties.\",\n    \"7-2\": \"Container of [shipping-contact-info](doc:shipping-contact-info)  properties.\",\n    \"8-2\": \"Container of [shopper-contact-info](doc:shopper-contact-info) properties.\",\n    \"9-2\": \"Container of [payment-info](doc:payment-info) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]","excerpt":"","slug":"shopper-info","type":"basic","title":"shopper-info"}

Request

Property Name
Type
Required
Description

seller-shopper-id

string

Optional

Unique shopper ID assigned by the merchant.

store-id

integer

Optional

Merchant’s store ID.
To pick up the soft descriptor configured in the system you will need to include the store-id. Please contact merchants@bluesnap.com if you do not know your store-id.

vat-code

string

Optional

Value added tax identification number (VATIN) associated with the shopper. A shopper with a VATIN does not pay VAT to the merchant.

shopper-currency

string

Optional

Shopper's selected currency. All prices and orders for this shopper will be based on this currency.
See Currency codes.

Note: In the Create Order and New Shopper request, the shopper currency and order currency must match.

locale

string

Optional

Shopper's selected language. See Language codes.

soft-descriptor

string

Optional; Relevant if sending a credit card number

Description that may appear on the shopper's bank statement when BlueSnap validates the card.

descriptor-phone-number

string

Optional; Relevant if sending a credit card number

Merchant's support phone number, which may appear on the shopper's bank statement when BlueSnap validates the card.

Length: 0-20 characters

invoice-contacts-info

container

Optional

Container of invoice-contacts-info properties.

shipping-contact-info

container

Optional

Container of shipping-contact-info properties.

shopper-contact-info

container

Optional

Container of shopper-contact-info properties.

payment-info

container

Optional

Container of payment-info properties.

Response

Property Name
Type
Description

shopper-id

long

Shopper's BlueSnap ID.

seller-shopper-id

string

Unique shopper ID assigned by the merchant.

store-id

integer

Merchant’s store ID.

vat-code

string

Value added tax identification number (VATIN) associated with the shopper. A shopper with a VATIN does not pay VAT to the merchant.

shopper-currency

string

Shopper's selected currency. All prices and orders for this shopper will be based on this currency.
See Currency codes.

locale

string

Shopper's selected language. See Language codes.

invoice-contacts-info

container

Container of invoice-contacts-info properties.

shipping-contact-info

container

Container of shipping-contact-info properties.

shopper-contact-info

container

Container of shopper-contact-info properties.

payment-info

container

Container of payment-info properties.