{"_id":"5b8ec6a1f8dd7c0003385fb6","category":{"_id":"5b8ec6a1f8dd7c0003385fa3","version":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-03T20:45:01.593Z","from_sync":false,"order":1,"slug":"topics","title":"Orders"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"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-05-12T14:59:59.053Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"optional","params":[],"url":""},"isReference":true,"order":6,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/tools/order-history-retriever?shopperid|shopperid&sellerid</span>\n\n<hr>\n\n##Documentation\nThe Retrieve Order History request enables you to retrieve a list of orders that a specific shopper has purchased.\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/tools/order-history-retriever?shopperid`\n\nFor example:\n`services/2/tools/order-history-retriever?shopperid=12345678`\n\n\n**Retrieve based on seller shopper ID**\nEnter your unique ID that you have assigned to the shopper (the `seller-shopper-id`) as the value of the `shopperid` query parameter in the URL, **and also** enter your seller ID in BlueSnap as the value of the `sellerid` query parameter. Format:\n`services/2/tools/order-history-retriever?shopperid&sellerid`\n\nFor example:\n`services/2/tools/order-history-retriever?shopperid=456789123&sellerid=397248`\n<br>\n**Query Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"`fulldescription`\",\n    \"1-0\": \"`starting_after`\",\n    \"2-0\": \"`ending_before`\",\n    \"3-0\": \"`limit`\",\n    \"0-1\": \"**true** = Return complete details for each order in the response\\n**false** (default) = Return URLs that you can use to obtain information about each order.\",\n    \"0-2\": \"`fulldescription=true`\",\n    \"1-1\": \"Order ID. The response will contain only orders after the specified order ID (exclusive). \\nUseful for pagination.\",\n    \"2-1\": \"Order ID. The response will contain only orders before the specified order ID (exclusive). \\nUseful for pagination.\",\n    \"3-1\": \"Positive integer. Sets the maximum number of results to return (i.e. page size).\\nUseful for pagination.\",\n    \"1-2\": \"`starting_after=999`\",\n    \"2-2\": \"`ending_before=1100`\",\n    \"3-2\": \"`limit=50`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `order-history` resource (see [order-history](doc:order-history)).\nFor details about possible errors, see: [General Errors](doc:general-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/tools/order-history-retriever?shopperId=19489486 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Subscription History Request: by BlueSnap shopper ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?sellerId=390650&shopperId=99111125 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by seller shopper ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?shopperId=19481324&fulldescription=true \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by shopper ID with `fulldescription` parameter\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?&sellerid=382526&shopperid=19481324&limit=20 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"with pagination (max 20 results)\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?&sellerid=382526&shopperid=19481324&limit=20&starting_after=3769930 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"with pagination (starting after order 3769930)\"\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<order-history xmlns=\\\"http://ws.plimus.com\\\">\\n  <ordering-shopper>\\n    <shopper-id>19489486</shopper-id>\\n  </ordering-shopper>\\n  <past-orders>\\n    <url>https://sandbox.bluesnap.com/services/2/orders/3921935</url>\\n    <url>https://sandbox.bluesnap.com/services/2/orders/3906917</url>\\n    <url>https://sandbox.bluesnap.com/services/2/orders/3906903</url>\\n  </past-orders>\\n</order-history>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Subscription History Response: by BlueSnap shopper ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<order-history xmlns=\\\"http://ws.plimus.com\\\">\\n  <ordering-shopper>\\n    <seller-shopper-id>99111125</seller-shopper-id>\\n  </ordering-shopper>\\n  <past-orders>\\n    <url>https://sandbox.bluesnap.com/services/2/orders/3921975</url>\\n  </past-orders>\\n</order-history>\",\n      \"language\": \"xml\",\n      \"name\": \"by seller shopper ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<order-history xmlns=\\\"http://ws.plimus.com\\\">\\n  <ordering-shopper>\\n    <shopper-id>19481324</shopper-id>\\n  </ordering-shopper>\\n  <past-orders>\\n    <order>\\n      <order-id>3916087</order-id>\\n      <ordering-shopper>\\n        <shopper-id>19481324</shopper-id>\\n      </ordering-shopper>\\n      <cart>\\n        <charged-currency>USD</charged-currency>\\n        <cart-item>\\n          <sku>\\n            <sku-id>2178316</sku-id>\\n            <sku-name>product contract 2</sku-name>\\n          </sku>\\n          <quantity>1</quantity>\\n          <item-sub-total>50.00</item-sub-total>\\n        </cart-item>\\n        <tax>0.00</tax>\\n        <tax-rate>0</tax-rate>\\n        <total-cart-cost>50.00</total-cart-cost>\\n      </cart>\\n      <post-sale-info>\\n        <invoices>\\n          <invoice>\\n            <invoice-id>38410844</invoice-id>\\n            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=AF1E16243B5023FF</url>\\n            <financial-transactions>\\n              <financial-transaction>\\n                <status>Approved</status>\\n                <date-due>28-Jul-18</date-due>\\n                <date-created>28-Jul-18</date-created>\\n                <amount>50.00</amount>\\n                <currency>USD</currency>\\n                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>\\n                <payment-method>Credit Card</payment-method>\\n                <target-balance>PLIMUS_ACCOUNT</target-balance>\\n                <credit-card>\\n                  <card-last-four-digits>1111</card-last-four-digits>\\n                  <card-type>Visa</card-type>\\n                  <card-sub-type>CREDIT</card-sub-type>\\n                  <card-category>CLASSIC</card-category>\\n                  <expiration-month>1</expiration-month>\\n                  <expiration-year>2015</expiration-year>\\n                </credit-card>\\n                <paypal-transaction-data />\\n                <invoice-contact-info>\\n                  <first-name>Lex</first-name>\\n                  <last-name>Luther</last-name>\\n                  <email>Lex:::at:::corp.com</email>\\n                  <address1>asdasd</address1>\\n                  <city>Metropolise</city>\\n                  <state>NY</state>\\n                  <zip>21344</zip>\\n                  <country>us</country>\\n                  <phone>3454646544</phone>\\n                </invoice-contact-info>\\n                <skus>\\n                  <sku>\\n                    <sku-id>2178316</sku-id>\\n                  </sku>\\n                </skus>\\n              </financial-transaction>\\n            </financial-transactions>\\n          </invoice>\\n        </invoices>\\n      </post-sale-info>\\n      <fulfillment>\\n        <license-keys />\\n      </fulfillment>\\n    </order>\\n    <order>\\n      <order-id>3915891</order-id>\\n      <ordering-shopper>\\n        <shopper-id>19481324</shopper-id>\\n      </ordering-shopper>\\n      <cart>\\n        <charged-currency>USD</charged-currency>\\n        <cart-item>\\n          <sku>\\n            <sku-id>2178316</sku-id>\\n            <sku-name>product contract 2</sku-name>\\n          </sku>\\n          <quantity>1</quantity>\\n          <item-sub-total>50.00</item-sub-total>\\n        </cart-item>\\n        <tax>0.00</tax>\\n        <tax-rate>0</tax-rate>\\n        <total-cart-cost>50.00</total-cart-cost>\\n      </cart>\\n      <post-sale-info>\\n        <invoices>\\n          <invoice>\\n            <invoice-id>38410646</invoice-id>\\n            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=6C7662D549196461</url>\\n            <financial-transactions>\\n              <financial-transaction>\\n                <status>Approved</status>\\n                <date-due>28-Jul-18</date-due>\\n                <date-created>28-Jul-18</date-created>\\n                <amount>50.00</amount>\\n                <currency>USD</currency>\\n                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>\\n                <payment-method>Credit Card</payment-method>\\n                <target-balance>PLIMUS_ACCOUNT</target-balance>\\n                <credit-card>\\n                  <card-last-four-digits>1111</card-last-four-digits>\\n                  <card-type>Visa</card-type>\\n                  <card-sub-type>CREDIT</card-sub-type>\\n                  <card-category>CLASSIC</card-category>\\n                  <expiration-month>1</expiration-month>\\n                  <expiration-year>2015</expiration-year>\\n                </credit-card>\\n                <paypal-transaction-data />\\n                <invoice-contact-info>\\n                  <first-name>Lex</first-name>\\n                  <last-name>Luther</last-name>\\n                  <email>Lex@corp.com</email>\\n                  <address1>asdasd</address1>\\n                  <city>Metropolise</city>\\n                  <state>NY</state>\\n                  <zip>21341</zip>\\n                  <country>us</country>\\n                  <phone>3454646544</phone>\\n                </invoice-contact-info>\\n                <skus>\\n                  <sku>\\n                    <sku-id>2178316</sku-id>\\n                  </sku>\\n                </skus>\\n              </financial-transaction>\\n            </financial-transactions>\\n          </invoice>\\n        </invoices>\\n      </post-sale-info>\\n      <fulfillment>\\n        <license-keys />\\n      </fulfillment>\\n    </order>\\n    <order>\\n      <order-id>3915889</order-id>\\n      <ordering-shopper>\\n        <shopper-id>19481324</shopper-id>\\n      </ordering-shopper>\\n      <cart>\\n        <charged-currency>USD</charged-currency>\\n        <cart-item>\\n          <sku>\\n            <sku-id>2178316</sku-id>\\n            <sku-name>product contract 2</sku-name>\\n          </sku>\\n          <quantity>1</quantity>\\n          <item-sub-total>50.00</item-sub-total>\\n        </cart-item>\\n        <tax>0.00</tax>\\n        <tax-rate>0</tax-rate>\\n        <total-cart-cost>50.00</total-cart-cost>\\n      </cart>\\n      <post-sale-info>\\n        <invoices>\\n          <invoice>\\n            <invoice-id>38410644</invoice-id>\\n            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=71A715095E1E26AD</url>\\n            <financial-transactions>\\n              <financial-transaction>\\n                <status>Approved</status>\\n                <date-due>28-Jul-18</date-due>\\n                <date-created>28-Jul-18</date-created>\\n                <amount>50.00</amount>\\n                <currency>USD</currency>\\n                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>\\n                <payment-method>Credit Card</payment-method>\\n                <target-balance>PLIMUS_ACCOUNT</target-balance>\\n                <credit-card>\\n                  <card-last-four-digits>1111</card-last-four-digits>\\n                  <card-type>Visa</card-type>\\n                  <card-sub-type>CREDIT</card-sub-type>\\n                  <card-category>CLASSIC</card-category>\\n                  <expiration-month>1</expiration-month>\\n                  <expiration-year>2015</expiration-year>\\n                </credit-card>\\n                <paypal-transaction-data />\\n                <invoice-contact-info>\\n                  <first-name>Lex</first-name>\\n                  <last-name>Luther</last-name>\\n                  <email>Lex@corp.com</email>\\n                  <address1>asdasd</address1>\\n                  <city>Metropolise</city>\\n                  <state>NY</state>\\n                  <zip>21341</zip>\\n                  <country>us</country>\\n                  <phone>3454646544</phone>\\n                </invoice-contact-info>\\n                <skus>\\n                  <sku>\\n                    <sku-id>2178316</sku-id>\\n                  </sku>\\n                </skus>\\n              </financial-transaction>\\n            </financial-transactions>\\n          </invoice>\\n        </invoices>\\n      </post-sale-info>\\n      <fulfillment>\\n        <license-keys />\\n      </fulfillment>\\n    </order>\\n    <order>\\n      <order-id>3915887</order-id>\\n      <ordering-shopper>\\n        <shopper-id>19481324</shopper-id>\\n      </ordering-shopper>\\n      <cart>\\n        <charged-currency>USD</charged-currency>\\n        <cart-item>\\n          <sku>\\n            <sku-id>2178316</sku-id>\\n            <sku-name>product contract 2</sku-name>\\n          </sku>\\n          <quantity>1</quantity>\\n          <item-sub-total>50.00</item-sub-total>\\n        </cart-item>\\n        <tax>0.00</tax>\\n        <tax-rate>0</tax-rate>\\n        <total-cart-cost>50.00</total-cart-cost>\\n      </cart>\\n      <post-sale-info>\\n        <invoices>\\n          <invoice>\\n            <invoice-id>38410636</invoice-id>\\n            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=2A607E5F4B7B4A0B</url>\\n            <financial-transactions>\\n              <financial-transaction>\\n                <status>Approved</status>\\n                <date-due>28-Jul-18</date-due>\\n                <date-created>28-Jul-18</date-created>\\n                <amount>50.00</amount>\\n                <currency>USD</currency>\\n                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>\\n                <payment-method>Credit Card</payment-method>\\n                <target-balance>PLIMUS_ACCOUNT</target-balance>\\n                <credit-card>\\n                  <card-last-four-digits>1111</card-last-four-digits>\\n                  <card-type>Visa</card-type>\\n                  <card-sub-type>CREDIT</card-sub-type>\\n                  <card-category>CLASSIC</card-sub-type>\\n                  <expiration-month>1</expiration-month>\\n                  <expiration-year>2015</expiration-year>\\n                </credit-card>\\n                <paypal-transaction-data />\\n                <invoice-contact-info>\\n                  <first-name>Lex</first-name>\\n                  <last-name>Luther</last-name>\\n                  <email>Lex@corp.com</email>\\n                  <address1>asdasd</address1>\\n                  <city>Metropolise</city>\\n                  <state>NY</state>\\n                  <zip>21341</zip>\\n                  <country>US</country>\\n                  <phone>3454646544</phone>\\n                </invoice-contact-info>\\n                <skus>\\n                  <sku>\\n                    <sku-id>2178316</sku-id>\\n                  </sku>\\n                </skus>\\n              </financial-transaction>\\n            </financial-transactions>\\n          </invoice>\\n        </invoices>\\n      </post-sale-info>\\n      <fulfillment>\\n        <license-keys />\\n      </fulfillment>\\n    </order>\\n    <order>\\n      <order-id>3897529</order-id>\\n      <ordering-shopper>\\n        <shopper-id>19481324</shopper-id>\\n      </ordering-shopper>\\n      <cart>\\n        <charged-currency>USD</charged-currency>\\n        <cart-item>\\n          <sku>\\n            <sku-id>2178316</sku-id>\\n            <sku-name>product contract 2</sku-name>\\n          </sku>\\n          <quantity>1</quantity>\\n          <item-sub-total>15.00</item-sub-total>\\n        </cart-item>\\n        <tax>0.00</tax>\\n        <tax-rate>0</tax-rate>\\n        <total-cart-cost>15.00</total-cart-cost>\\n      </cart>\\n      <post-sale-info>\\n        <invoices>\\n          <invoice>\\n            <invoice-id>38388646</invoice-id>\\n            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=F0C616EBCDF48920</url>\\n            <financial-transactions>\\n              <financial-transaction>\\n                <status>Approved</status>\\n                <date-due>11-Jun-18</date-due>\\n                <date-created>11-Jun-18</date-created>\\n                <amount>15.00</amount>\\n                <currency>USD</currency>\\n                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>\\n                <payment-method>Credit Card</payment-method>\\n                <target-balance>PLIMUS_ACCOUNT</target-balance>\\n                <credit-card>\\n                  <card-last-four-digits>1111</card-last-four-digits>\\n                  <card-type>Visa</card-type>\\n                  <card-sub-type>CREDIT</card-sub-type>\\n                  <card-category>CLASSIC</card-category>\\n                  <expiration-month>1</expiration-month>\\n                  <expiration-year>2015</expiration-year>\\n                </credit-card>\\n                <paypal-transaction-data />\\n                <invoice-contact-info>\\n                  <first-name>Lex</first-name>\\n                  <last-name>Luther</last-name>\\n                  <email>Lex@corp.com</email>\\n                  <address1>asdasd</address1>\\n                  <city>Metropolise</city>\\n                  <state>NY</state>\\n                  <zip>21341</zip>\\n                  <country>us</country>\\n                  <phone>3454646544</phone>\\n                </invoice-contact-info>\\n                <skus>\\n                  <sku>\\n                    <sku-id>2178316</sku-id>\\n                    <sku-name>product contract 2</sku-name>\\n                  </sku>\\n                </skus>\\n              </financial-transaction>\\n            </financial-transactions>\\n          </invoice>\\n        </invoices>\\n      </post-sale-info>\\n      <fulfillment>\\n        <license-keys />\\n      </fulfillment>\\n    </order>\\n  </past-orders>\\n</order-history>\",\n      \"language\": \"xml\",\n      \"name\": \"by shopper ID with `fulldescription` parameter\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<order-history \\n    xmlns=\\\"http://ws.plimus.com\\\">\\n    <ordering-shopper>\\n        <seller-shopper-id>19481324</seller-shopper-id>\\n    </ordering-shopper>\\n    <past-orders>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769930</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769929</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769928</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769927</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769926</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769925</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769924</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769923</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769922</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769921</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769920</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769919</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769918</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769917</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769916</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769915</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769914</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769913</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769912</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769911</url>\\n    </past-orders>\\n</order-history>\",\n      \"language\": \"xml\",\n      \"name\": \"with pagination (max 20 results)\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<order-history \\n    xmlns=\\\"http://ws.plimus.com\\\">\\n    <ordering-shopper>\\n        <seller-shopper-id>19481324</seller-shopper-id>\\n    </ordering-shopper>\\n    <past-orders>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769950</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769949</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769948</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769947</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769946</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769945</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769944</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769943</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769942</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769941</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769940</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769939</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769938</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769937</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769936</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769935</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769934</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769933</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769932</url>\\n        <url>https://sandbox.bluesnap.com/services/2/orders/3769931</url>\\n    </past-orders>\\n</order-history>\",\n      \"language\": \"xml\",\n      \"name\": \"with pagination (starting after order 3769930)\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-order-history","type":"endpoint","title":"Retrieve Order History"}

getRetrieve Order History


Definition

https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?shopperid|shopperid&sellerid


Documentation

The Retrieve Order History request enables you to retrieve a list of orders that a specific shopper has purchased.

Request Content

Retrieve based on shopper ID in BlueSnap
Enter the shopper-id into the web service URL, in the format:
services/2/tools/order-history-retriever?shopperid

For example:
services/2/tools/order-history-retriever?shopperid=12345678

Retrieve based on seller shopper ID
Enter your unique ID that you have assigned to the shopper (the seller-shopper-id) as the value of the shopperid query parameter in the URL, and also enter your seller ID in BlueSnap as the value of the sellerid query parameter. Format:
services/2/tools/order-history-retriever?shopperid&sellerid

For example:
services/2/tools/order-history-retriever?shopperid=456789123&sellerid=397248


Query Parameters

Parameter Name
Description
Example

fulldescription

true = Return complete details for each order in the response
false (default) = Return URLs that you can use to obtain information about each order.

fulldescription=true

starting_after

Order ID. The response will contain only orders after the specified order ID (exclusive).
Useful for pagination.

starting_after=999

ending_before

Order ID. The response will contain only orders before the specified order ID (exclusive).
Useful for pagination.

ending_before=1100

limit

Positive integer. Sets the maximum number of results to return (i.e. page size).
Useful for pagination.

limit=50

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved order-history resource (see order-history).
For details about possible errors, see: General Errors.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?shopperId=19489486 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?sellerId=390650&shopperId=99111125 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?shopperId=19481324&fulldescription=true \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?&sellerid=382526&shopperid=19481324&limit=20 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/tools/order-history-retriever?&sellerid=382526&shopperid=19481324&limit=20&starting_after=3769930 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order-history xmlns="http://ws.plimus.com">
  <ordering-shopper>
    <shopper-id>19489486</shopper-id>
  </ordering-shopper>
  <past-orders>
    <url>https://sandbox.bluesnap.com/services/2/orders/3921935</url>
    <url>https://sandbox.bluesnap.com/services/2/orders/3906917</url>
    <url>https://sandbox.bluesnap.com/services/2/orders/3906903</url>
  </past-orders>
</order-history>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order-history xmlns="http://ws.plimus.com">
  <ordering-shopper>
    <seller-shopper-id>99111125</seller-shopper-id>
  </ordering-shopper>
  <past-orders>
    <url>https://sandbox.bluesnap.com/services/2/orders/3921975</url>
  </past-orders>
</order-history>
<?xml version="1.0" encoding="UTF-8"?>
<order-history xmlns="http://ws.plimus.com">
  <ordering-shopper>
    <shopper-id>19481324</shopper-id>
  </ordering-shopper>
  <past-orders>
    <order>
      <order-id>3916087</order-id>
      <ordering-shopper>
        <shopper-id>19481324</shopper-id>
      </ordering-shopper>
      <cart>
        <charged-currency>USD</charged-currency>
        <cart-item>
          <sku>
            <sku-id>2178316</sku-id>
            <sku-name>product contract 2</sku-name>
          </sku>
          <quantity>1</quantity>
          <item-sub-total>50.00</item-sub-total>
        </cart-item>
        <tax>0.00</tax>
        <tax-rate>0</tax-rate>
        <total-cart-cost>50.00</total-cart-cost>
      </cart>
      <post-sale-info>
        <invoices>
          <invoice>
            <invoice-id>38410844</invoice-id>
            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=AF1E16243B5023FF</url>
            <financial-transactions>
              <financial-transaction>
                <status>Approved</status>
                <date-due>28-Jul-18</date-due>
                <date-created>28-Jul-18</date-created>
                <amount>50.00</amount>
                <currency>USD</currency>
                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>
                <payment-method>Credit Card</payment-method>
                <target-balance>PLIMUS_ACCOUNT</target-balance>
                <credit-card>
                  <card-last-four-digits>1111</card-last-four-digits>
                  <card-type>Visa</card-type>
                  <card-sub-type>CREDIT</card-sub-type>
                  <card-category>CLASSIC</card-category>
                  <expiration-month>1</expiration-month>
                  <expiration-year>2015</expiration-year>
                </credit-card>
                <paypal-transaction-data />
                <invoice-contact-info>
                  <first-name>Lex</first-name>
                  <last-name>Luther</last-name>
                  <email>Lex@corp.com</email>
                  <address1>asdasd</address1>
                  <city>Metropolise</city>
                  <state>NY</state>
                  <zip>21344</zip>
                  <country>us</country>
                  <phone>3454646544</phone>
                </invoice-contact-info>
                <skus>
                  <sku>
                    <sku-id>2178316</sku-id>
                  </sku>
                </skus>
              </financial-transaction>
            </financial-transactions>
          </invoice>
        </invoices>
      </post-sale-info>
      <fulfillment>
        <license-keys />
      </fulfillment>
    </order>
    <order>
      <order-id>3915891</order-id>
      <ordering-shopper>
        <shopper-id>19481324</shopper-id>
      </ordering-shopper>
      <cart>
        <charged-currency>USD</charged-currency>
        <cart-item>
          <sku>
            <sku-id>2178316</sku-id>
            <sku-name>product contract 2</sku-name>
          </sku>
          <quantity>1</quantity>
          <item-sub-total>50.00</item-sub-total>
        </cart-item>
        <tax>0.00</tax>
        <tax-rate>0</tax-rate>
        <total-cart-cost>50.00</total-cart-cost>
      </cart>
      <post-sale-info>
        <invoices>
          <invoice>
            <invoice-id>38410646</invoice-id>
            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=6C7662D549196461</url>
            <financial-transactions>
              <financial-transaction>
                <status>Approved</status>
                <date-due>28-Jul-18</date-due>
                <date-created>28-Jul-18</date-created>
                <amount>50.00</amount>
                <currency>USD</currency>
                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>
                <payment-method>Credit Card</payment-method>
                <target-balance>PLIMUS_ACCOUNT</target-balance>
                <credit-card>
                  <card-last-four-digits>1111</card-last-four-digits>
                  <card-type>Visa</card-type>
                  <card-sub-type>CREDIT</card-sub-type>
                  <card-category>CLASSIC</card-category>
                  <expiration-month>1</expiration-month>
                  <expiration-year>2015</expiration-year>
                </credit-card>
                <paypal-transaction-data />
                <invoice-contact-info>
                  <first-name>Lex</first-name>
                  <last-name>Luther</last-name>
                  <email>Lex@corp.com</email>
                  <address1>asdasd</address1>
                  <city>Metropolise</city>
                  <state>NY</state>
                  <zip>21341</zip>
                  <country>us</country>
                  <phone>3454646544</phone>
                </invoice-contact-info>
                <skus>
                  <sku>
                    <sku-id>2178316</sku-id>
                  </sku>
                </skus>
              </financial-transaction>
            </financial-transactions>
          </invoice>
        </invoices>
      </post-sale-info>
      <fulfillment>
        <license-keys />
      </fulfillment>
    </order>
    <order>
      <order-id>3915889</order-id>
      <ordering-shopper>
        <shopper-id>19481324</shopper-id>
      </ordering-shopper>
      <cart>
        <charged-currency>USD</charged-currency>
        <cart-item>
          <sku>
            <sku-id>2178316</sku-id>
            <sku-name>product contract 2</sku-name>
          </sku>
          <quantity>1</quantity>
          <item-sub-total>50.00</item-sub-total>
        </cart-item>
        <tax>0.00</tax>
        <tax-rate>0</tax-rate>
        <total-cart-cost>50.00</total-cart-cost>
      </cart>
      <post-sale-info>
        <invoices>
          <invoice>
            <invoice-id>38410644</invoice-id>
            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=71A715095E1E26AD</url>
            <financial-transactions>
              <financial-transaction>
                <status>Approved</status>
                <date-due>28-Jul-18</date-due>
                <date-created>28-Jul-18</date-created>
                <amount>50.00</amount>
                <currency>USD</currency>
                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>
                <payment-method>Credit Card</payment-method>
                <target-balance>PLIMUS_ACCOUNT</target-balance>
                <credit-card>
                  <card-last-four-digits>1111</card-last-four-digits>
                  <card-type>Visa</card-type>
                  <card-sub-type>CREDIT</card-sub-type>
                  <card-category>CLASSIC</card-category>
                  <expiration-month>1</expiration-month>
                  <expiration-year>2015</expiration-year>
                </credit-card>
                <paypal-transaction-data />
                <invoice-contact-info>
                  <first-name>Lex</first-name>
                  <last-name>Luther</last-name>
                  <email>Lex@corp.com</email>
                  <address1>asdasd</address1>
                  <city>Metropolise</city>
                  <state>NY</state>
                  <zip>21341</zip>
                  <country>us</country>
                  <phone>3454646544</phone>
                </invoice-contact-info>
                <skus>
                  <sku>
                    <sku-id>2178316</sku-id>
                  </sku>
                </skus>
              </financial-transaction>
            </financial-transactions>
          </invoice>
        </invoices>
      </post-sale-info>
      <fulfillment>
        <license-keys />
      </fulfillment>
    </order>
    <order>
      <order-id>3915887</order-id>
      <ordering-shopper>
        <shopper-id>19481324</shopper-id>
      </ordering-shopper>
      <cart>
        <charged-currency>USD</charged-currency>
        <cart-item>
          <sku>
            <sku-id>2178316</sku-id>
            <sku-name>product contract 2</sku-name>
          </sku>
          <quantity>1</quantity>
          <item-sub-total>50.00</item-sub-total>
        </cart-item>
        <tax>0.00</tax>
        <tax-rate>0</tax-rate>
        <total-cart-cost>50.00</total-cart-cost>
      </cart>
      <post-sale-info>
        <invoices>
          <invoice>
            <invoice-id>38410636</invoice-id>
            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=2A607E5F4B7B4A0B</url>
            <financial-transactions>
              <financial-transaction>
                <status>Approved</status>
                <date-due>28-Jul-18</date-due>
                <date-created>28-Jul-18</date-created>
                <amount>50.00</amount>
                <currency>USD</currency>
                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>
                <payment-method>Credit Card</payment-method>
                <target-balance>PLIMUS_ACCOUNT</target-balance>
                <credit-card>
                  <card-last-four-digits>1111</card-last-four-digits>
                  <card-type>Visa</card-type>
                  <card-sub-type>CREDIT</card-sub-type>
                  <card-category>CLASSIC</card-sub-type>
                  <expiration-month>1</expiration-month>
                  <expiration-year>2015</expiration-year>
                </credit-card>
                <paypal-transaction-data />
                <invoice-contact-info>
                  <first-name>Lex</first-name>
                  <last-name>Luther</last-name>
                  <email>Lex@corp.com</email>
                  <address1>asdasd</address1>
                  <city>Metropolise</city>
                  <state>NY</state>
                  <zip>21341</zip>
                  <country>US</country>
                  <phone>3454646544</phone>
                </invoice-contact-info>
                <skus>
                  <sku>
                    <sku-id>2178316</sku-id>
                  </sku>
                </skus>
              </financial-transaction>
            </financial-transactions>
          </invoice>
        </invoices>
      </post-sale-info>
      <fulfillment>
        <license-keys />
      </fulfillment>
    </order>
    <order>
      <order-id>3897529</order-id>
      <ordering-shopper>
        <shopper-id>19481324</shopper-id>
      </ordering-shopper>
      <cart>
        <charged-currency>USD</charged-currency>
        <cart-item>
          <sku>
            <sku-id>2178316</sku-id>
            <sku-name>product contract 2</sku-name>
          </sku>
          <quantity>1</quantity>
          <item-sub-total>15.00</item-sub-total>
        </cart-item>
        <tax>0.00</tax>
        <tax-rate>0</tax-rate>
        <total-cart-cost>15.00</total-cart-cost>
      </cart>
      <post-sale-info>
        <invoices>
          <invoice>
            <invoice-id>38388646</invoice-id>
            <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=F0C616EBCDF48920</url>
            <financial-transactions>
              <financial-transaction>
                <status>Approved</status>
                <date-due>11-Jun-18</date-due>
                <date-created>11-Jun-18</date-created>
                <amount>15.00</amount>
                <currency>USD</currency>
                <soft-descriptor>BLS*BLUESNAP</soft-descriptor>
                <payment-method>Credit Card</payment-method>
                <target-balance>PLIMUS_ACCOUNT</target-balance>
                <credit-card>
                  <card-last-four-digits>1111</card-last-four-digits>
                  <card-type>Visa</card-type>
                  <card-sub-type>CREDIT</card-sub-type>
                  <card-category>CLASSIC</card-category>
                  <expiration-month>1</expiration-month>
                  <expiration-year>2015</expiration-year>
                </credit-card>
                <paypal-transaction-data />
                <invoice-contact-info>
                  <first-name>Lex</first-name>
                  <last-name>Luther</last-name>
                  <email>Lex@corp.com</email>
                  <address1>asdasd</address1>
                  <city>Metropolise</city>
                  <state>NY</state>
                  <zip>21341</zip>
                  <country>us</country>
                  <phone>3454646544</phone>
                </invoice-contact-info>
                <skus>
                  <sku>
                    <sku-id>2178316</sku-id>
                    <sku-name>product contract 2</sku-name>
                  </sku>
                </skus>
              </financial-transaction>
            </financial-transactions>
          </invoice>
        </invoices>
      </post-sale-info>
      <fulfillment>
        <license-keys />
      </fulfillment>
    </order>
  </past-orders>
</order-history>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order-history 
    xmlns="http://ws.plimus.com">
    <ordering-shopper>
        <seller-shopper-id>19481324</seller-shopper-id>
    </ordering-shopper>
    <past-orders>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769930</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769929</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769928</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769927</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769926</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769925</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769924</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769923</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769922</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769921</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769920</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769919</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769918</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769917</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769916</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769915</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769914</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769913</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769912</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769911</url>
    </past-orders>
</order-history>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order-history 
    xmlns="http://ws.plimus.com">
    <ordering-shopper>
        <seller-shopper-id>19481324</seller-shopper-id>
    </ordering-shopper>
    <past-orders>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769950</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769949</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769948</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769947</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769946</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769945</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769944</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769943</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769942</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769941</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769940</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769939</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769938</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769937</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769936</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769935</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769934</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769933</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769932</url>
        <url>https://sandbox.bluesnap.com/services/2/orders/3769931</url>
    </past-orders>
</order-history>