Retrieve Order History

POST https://sandbox.bluesnap.com/services/2

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

Retrieve Subscription History Request: by BlueSnap shopper ID

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='

by seller shopper ID

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='

by shopper ID with `fulldescription` parameter

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='

with pagination (max 20 results)

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='

with pagination (starting after order 3769930)

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

Retrieve Subscription History Response: by BlueSnap shopper ID

<?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>

by seller shopper ID

<?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>

by shopper ID with `fulldescription` parameter

<?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>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>[email protected]</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>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>[email protected]</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>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>[email protected]</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>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>[email protected]</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>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>[email protected]</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>

with pagination (max 20 results)

<?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>

with pagination (starting after order 3769930)

<?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>

Back to Top