{"_id":"5a96eca189442e002041120f","category":{"_id":"5a96ec9189442e002041114f","version":"5a96ec9189442e002041114d","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"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-02-28T17:53:21.809Z","releaseDate":"2018-02-28T17:53:21.809Z","categories":["5a96ec9189442e002041114e","5a96ec9189442e002041114f","5a96ec9189442e0020411150","5a96ec9189442e0020411151","5a96ec9189442e0020411152","5a96ec9189442e0020411153","5a96ec9189442e0020411154","5a96ec9189442e0020411155","5a96ec9189442e0020411156","5a96ec9189442e0020411157","5a96ec9189442e0020411158"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.2 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-12T14:59:28.338Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"optional","params":[],"url":""},"isReference":true,"order":6,"body":"##Definition\nBy order ID or seller order ID:\nhttps<span>://sandbox.bluesnap.com/services/2/orders/:order-id|:seller-order-id,:seller-id</span>\n\nBy invoice ID or subscription ID\nhttps<span>://sandbox.bluesnap.com/services/2/orders/resolve?invoiceId={invoice-id}|subscriptionid={subscription-id}</span>\n\n<hr>\n\n##Documentation\nThe Retrieve Order request enables you to retrieve details about an order, including the product, quantity, price, invoice details, fulfillment information, and more.\n\n###Request Content\n**Retrieve based on order ID in BlueSnap**\nEnter the `order-id` into the web service URL, in the format:\n`services/2/orders/{order-id}`\n\nFor example:\n`services/2/orders/9876543`\n\n**Retrieve based on seller order ID**\nEnter the unique ID that you assigned to the order (the `seller-order-id`), **and** your seller ID in BlueSnap (`seller-id`) into the web service URL, in the format:\n`services/2/orders/{seller-order-id},{seller-id}`\n\nFor example:\n`services/2/orders/456789123,111222`\n\n**Retrieve based on invoice ID**\nEnter the `invoice-id` into the web service URL, in the format:\n`services/2/orders/resolve?invoiceId={invoice-id}`\n\nFor example:\n`services/2/orders/resolve?invoiceId=34567`\n\n**Retrieve based on subscription ID**\nEnter the subscription ID into the web service URL, in the format:\n`services/2/orders/resolve?subscriptionid={subscription-id}`\n\nFor example:\n`services/2/orders/?subscriptionid=87654`\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Locating the relevant ID type\",\n  \"body\": \"Each type of ID above is a different value in BlueSnap. Make sure that you are using the relevant ID in your request. You can find the IDs here: \\n  * The order ID appears in the `order-id` field in the response when you create a new order.\\n  * The invoice ID appears in the `invoice-id` field when you create a new order.\\n  * The subscription ID appears in the `url` field when you create a new subscription.\"\n}\n[/block]\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\n\nThe response contains the retrieved `order` resource (see [order](doc:order)).\nIf the order has been refunded, there will be a separate invoice listed in the response for the original charge and each refund.\n\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/orders/3906167 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Order Request: by order ID in BlueSnap\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/36642950,391768 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by seller order ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/resolve?invoiceId=38399968 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by invoice ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/resolve?subscriptionid=39469016 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"by subscription 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<order xmlns=\\\"http://ws.plimus.com\\\">\\n  <order-id>3906167</order-id>\\n  <ordering-shopper>\\n    <shopper-id>19489486</shopper-id>\\n  </ordering-shopper>\\n  <cart>\\n    <charged-currency>USD</charged-currency>\\n    <cart-item>\\n      <sku>\\n        <sku-id>2175514</sku-id>\\n        <sku-name>TestProduct Gold Edition</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>38398826</invoice-id>\\n        <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=ECD5940FFEDE3C46</url>\\n        <financial-transactions>\\n          <financial-transaction>\\n            <status>Approved</status>\\n            <date-due>02-Jul-18</date-due>\\n            <date-created>02-Jul-18</date-created>\\n            <amount>15.00</amount>\\n            <currency>USD</currency>\\n            <soft-descriptor>BLS*MYCOMPANY</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>9</expiration-month>\\n              <expiration-year>2019</expiration-year>\\n            </credit-card>\\n            <paypal-transaction-data/>\\n            <invoice-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>141355567898/fax>\\n            </invoice-contact-info>\\n            <skus>\\n              <sku>\\n                <sku-id>2175514</sku-id>\\n                <sku-name>TestProduct Gold Edition</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    <download-links>\\n      <sku-download-link>\\n        <sku-id>2175514</sku-id>\\n        <sku-name>TestProduct Gold Edition</sku-name>\\n        <download-link>https://sandbox.bluesnap.com/jsp/dlapp.jsp?ref=38398826C2175514C6687830</download-link>\\n      </sku-download-link>\\n    </download-links>\\n  </fulfillment>\\n</order>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Order Response: by order ID in BlueSnap\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<order xmlns=\\\"http://ws.plimus.com\\\">\\n  <order-id>3979819</order-id>\\n  <seller-order-id>36642950</seller-order-id>\\n  <ordering-shopper>\\n    <shopper-id>19562772</shopper-id>\\n  </ordering-shopper>\\n  <cart>\\n    <charged-currency>USD</charged-currency>\\n    <cart-item>\\n      <sku>\\n        <sku-id>2186520</sku-id>\\n        <sku-name>recurring</sku-name>\\n      </sku>\\n      <quantity>1</quantity>\\n      <url>https://localhost:8445/services/2/subscriptions/39520970</url>\\n      <item-sub-total>0.00</item-sub-total>\\n    </cart-item>\\n    <tax>0.00</tax>\\n    <tax-rate>0</tax-rate>\\n    <total-cart-cost>0.00</total-cart-cost>\\n  </cart>\\n  <post-sale-info>\\n    <invoices>\\n      <invoice>\\n        <invoice-id>38502076</invoice-id>\\n        <url>http://localhost:8080/jsp/show_invoice.jsp?ref=25F7796A6577E36D</url>\\n        <financial-transactions>\\n          <financial-transaction>\\n            <status>Approved</status>\\n            <date-due>12-Nov-18</date-due>\\n            <date-created>12-Nov-18</date-created>\\n            <amount>0.00</amount>\\n            <currency>USD</currency>\\n            <payment-method>PayPal</payment-method>\\n            <target-balance>VENDOR_PAYPAL_ACCOUNT</target-balance>\\n            <paypal-transaction-data>\\n              <pp-transaction-id>7FL54220CM2536942</pp-transaction-id>\\n              <pp-subscription-id>I-9CLN2MF8YUUM</pp-subscription-id>\\n            </paypal-transaction-data>\\n            <invoice-contact-info>\\n              <first-name>Bob</first-name>\\n              <last-name>Bobby</last-name>\\n              <email>bobby@example.com</email>\\n              <address1>1 Main St</address1>\\n              <city>San Jose</city>\\n              <state>CA</state>\\n              <zip>95131</zip>\\n              <country>us</country>\\n            </invoice-contact-info>\\n            <skus>\\n              <sku>\\n                <sku-id>2186520</sku-id>\\n                <sku-name>recurring</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      \"language\": \"xml\",\n      \"name\": \"by seller order ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<order xmlns=\\\"http://ws.plimus.com\\\">\\n  <order-id>3906167</order-id>\\n  <ordering-shopper>\\n    <shopper-id>19489486</shopper-id>\\n  </ordering-shopper>\\n  <cart>\\n    <charged-currency>USD</charged-currency>\\n    <cart-item>\\n      <sku>\\n        <sku-id>2175514</sku-id>\\n        <sku-name>TestProduct Gold Edition</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>38398826</invoice-id>\\n        <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=ECD5940FFEDE3C46</url>\\n        <financial-transactions>\\n          <financial-transaction>\\n            <status>Approved</status>\\n            <date-due>02-Jul-18</date-due>\\n            <date-created>02-Jul-18</date-created>\\n            <amount>15.00</amount>\\n            <currency>USD</currency>\\n            <soft-descriptor>BLS*MYCOMPANY</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>9</expiration-month>\\n              <expiration-year>2019</expiration-year>\\n            </credit-card>\\n            <paypal-transaction-data/>\\n            <invoice-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>75654</zip>\\n              <country>US</country>\\n              <phone>14135556789</phone>\\n              <fax>14135556788</fax>\\n            </invoice-contact-info>\\n            <skus>\\n              <sku>\\n                <sku-id>2175514</sku-id>\\n                <sku-name>TestProduct Gold Edition</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    <download-links>\\n      <sku-download-link>\\n        <sku-id>2175514</sku-id>\\n        <sku-name>TestProduct Gold Edition</sku-name>\\n        <download-link>https://sandbox.bluesnap.com/jsp/dlapp.jsp?ref=38398826C2175514C6687830</download-link>\\n      </sku-download-link>\\n    </download-links>\\n  </fulfillment>\\n</order>\",\n      \"language\": \"xml\",\n      \"name\": \"by invoice ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<order xmlns=\\\"http://ws.plimus.com\\\">\\n  <order-id>3923051</order-id>\\n  <ordering-shopper>\\n    <shopper-id>19505364</shopper-id>\\n    <seller-shopper-id>987654321</seller-shopper-id>\\n  </ordering-shopper>\\n  <cart>\\n    <charged-currency>USD</charged-currency>\\n    <cart-item>\\n      <sku>\\n        <sku-id>2178834</sku-id>\\n        <sku-name>Contract Example</sku-name>\\n      </sku>\\n      <quantity>1</quantity>\\n      <url>https://sandbox.bluesnap.com/services/2/subscriptions/39469016</url>\\n      <item-sub-total>5.00</item-sub-total>\\n    </cart-item>\\n    <tax>0.00</tax>\\n    <tax-rate>0</tax-rate>\\n    <total-cart-cost>5.00</total-cart-cost>\\n  </cart>\\n  <post-sale-info>\\n    <invoices>\\n      <invoice>\\n        <invoice-id>38420528</invoice-id>\\n        <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=A29AC4EA01AA732F</url>\\n        <financial-transactions>\\n          <financial-transaction>\\n            <status>Approved</status>\\n            <date-due>26-Aug-18</date-due>\\n            <date-created>26-Aug-18</date-created>\\n            <amount>5.00</amount>\\n            <currency>USD</currency>\\n            <soft-descriptor>BLS*DescTest</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>DEBIT</card-sub-type>\\n              <expiration-month>9</expiration-month>\\n              <expiration-year>2019</expiration-year>\\n            </credit-card>\\n            <paypal-transaction-data />\\n            <invoice-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>75654</zip>\\n              <country>US</country>\\n              <phone>14135556789</phone>\\n              <fax>14135556788</fax>\\n            </invoice-contact-info>\\n            <skus>\\n              <sku>\\n                <sku-id>2178834</sku-id>\\n              </sku>\\n            </skus>\\n          </financial-transaction>\\n        </financial-transactions>\\n      </invoice>\\n      <invoice>\\n        <invoice-id>38420530</invoice-id>\\n        <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=F293E0FA74B9EED5</url>\\n        <financial-transactions>\\n          <financial-transaction>\\n            <status>Approved</status>\\n            <date-due>26-Aug-18</date-due>\\n            <date-created>26-Aug-18</date-created>\\n            <amount>-5.00</amount>\\n            <currency>USD</currency>\\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>DEBIT</card-sub-type>\\n              <expiration-month>9</expiration-month>\\n              <expiration-year>2019</expiration-year>\\n            </credit-card>\\n            <paypal-transaction-data />\\n            <invoice-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>75654</zip>\\n              <country>US</country>\\n              <phone>14135556789</phone>\\n              <fax>14135556788</fax>\\n            </invoice-contact-info>\\n            <skus>\\n              <sku>\\n                <sku-id>2178834</sku-id>\\n                <sku-name>Contract Example</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      \"language\": \"xml\",\n      \"name\": \"by subscription ID\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<order xmlns=\\\"http://ws.plimus.com\\\">\\n    <order-id>3906915</order-id>\\n    <seller-order-id>1234567890</seller-order-id>\\n    <ordering-shopper>\\n        <shopper-id>19990000</shopper-id>\\n    </ordering-shopper>\\n    <cart>\\n        <charged-currency>EUR</charged-currency>\\n        <cart-item>\\n            <sku>\\n                <sku-id>2181378</sku-id>\\n                <sku-name>Contract 1</sku-name>\\n            </sku>\\n            <quantity>1</quantity>\\n            <item-sub-total>99.99</item-sub-total>\\n        </cart-item>\\n        <tax>0.00</tax>\\n        <tax-rate>0</tax-rate>\\n        <total-cart-cost>99.99</total-cart-cost>\\n    </cart>\\n    <post-sale-info>\\n        <invoices>\\n            <invoice>\\n                <invoice-id>38417916</invoice-id>\\n                <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=DAEF2E3</url>\\n                <financial-transactions>\\n                    <financial-transaction>\\n                        <status>Approved</status>\\n                        <date-due>13-Sep-16</date-due>\\n                        <date-created>13-Sep-16</date-created>\\n                        <amount>99.99</amount>\\n                        <currency>EUR</currency>\\n                        <soft-descriptor>BLS&#x2a;DescTest1234567</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>9</expiration-month>\\n                            <expiration-year>2019</expiration-year>\\n                        </credit-card>\\n                        <paypal-transaction-data/>\\n                        <invoice-contact-info>\\n                            <first-name>John</first-name>\\n                            <last-name>Doe</last-name>\\n                            <email>jdoe&#x40;johndoeandsons.com</email>\\n                            <address1>138 Market st</address1>\\n                            <city>San Francisco</city>\\n                            <zip>756543</zip>\\n                            <country>fr</country>\\n                            <phone>1413555666</phone>\\n                        </invoice-contact-info>\\n                        <skus>\\n                            <sku>\\n                                <sku-id>2181378</sku-id>\\n                            </sku>\\n                        </skus>\\n                    </financial-transaction>\\n                </financial-transactions>\\n            </invoice>\\n            <invoice>\\n                <invoice-id>38417918</invoice-id>\\n                <original-invoice-id>38417916</original-invoice-id>\\n                <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=8F1F5FECB</url>\\n                <financial-transactions>\\n                    <financial-transaction>\\n                        <status>Approved</status>\\n                        <date-due>13-Sep-16</date-due>\\n                        <date-created>13-Sep-16</date-created>\\n                        <amount>-55.55</amount>\\n                        <currency>EUR</currency>\\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>9</expiration-month>\\n                            <expiration-year>2019</expiration-year>\\n                        </credit-card>\\n                        <paypal-transaction-data/>\\n                        <invoice-contact-info>\\n                            <first-name>John</first-name>\\n                            <last-name>Doe</last-name>\\n                            <email>jdoe&#x40;johndoeandsons.com</email>\\n                            <address1>138 Market st</address1>\\n                            <city>San Francisco</city>\\n                            <zip>756543</zip>\\n                            <country>fr</country>\\n                            <phone>1413555666</phone>\\n                        </invoice-contact-info>\\n                        <skus>\\n                            <sku>\\n                                <sku-id>2181378</sku-id>\\n                                <sku-name>Contract 1</sku-name>\\n                            </sku>\\n                        </skus>\\n                    </financial-transaction>\\n                </financial-transactions>\\n            </invoice>\\n            <invoice>\\n                <invoice-id>38417920</invoice-id>\\n                <original-invoice-id>38417916</original-invoice-id>\\n                <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=335F0843E</url>\\n                <financial-transactions>\\n                    <financial-transaction>\\n                        <status>Approved</status>\\n                        <date-due>13-Sep-16</date-due>\\n                        <date-created>13-Sep-16</date-created>\\n                        <amount>-44.44</amount>\\n                        <currency>EUR</currency>\\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>9</expiration-month>\\n                            <expiration-year>2019</expiration-year>\\n                        </credit-card>\\n                        <paypal-transaction-data/>\\n                        <invoice-contact-info>\\n                            <first-name>John</first-name>\\n                            <last-name>Doe</last-name>\\n                            <email>jdoe&#x40;johndoeandsons.com</email>\\n                            <address1>138 Market st</address1>\\n                            <city>San Francisco</city>\\n                            <zip>756543</zip>\\n                            <country>fr</country>\\n                            <phone>1413555666</phone>\\n                        </invoice-contact-info>\\n                        <skus>\\n                            <sku>\\n                                <sku-id>2181378</sku-id>\\n                                <sku-name>Contract 1</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\",\n      \"language\": \"xml\",\n      \"name\": \"order with refunds\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-order","type":"get","title":"Retrieve Order"}

Definition

By order ID or seller order ID:
https://sandbox.bluesnap.com/services/2/orders/:order-id|:seller-order-id,:seller-id

By invoice ID or subscription ID
https://sandbox.bluesnap.com/services/2/orders/resolve?invoiceId={invoice-id}|subscriptionid={subscription-id}


Documentation

The Retrieve Order request enables you to retrieve details about an order, including the product, quantity, price, invoice details, fulfillment information, and more.

Request Content

Retrieve based on order ID in BlueSnap
Enter the order-id into the web service URL, in the format:
services/2/orders/{order-id}

For example:
services/2/orders/9876543

Retrieve based on seller order ID
Enter the unique ID that you assigned to the order (the seller-order-id), and your seller ID in BlueSnap (seller-id) into the web service URL, in the format:
services/2/orders/{seller-order-id},{seller-id}

For example:
services/2/orders/456789123,111222

Retrieve based on invoice ID
Enter the invoice-id into the web service URL, in the format:
services/2/orders/resolve?invoiceId={invoice-id}

For example:
services/2/orders/resolve?invoiceId=34567

Retrieve based on subscription ID
Enter the subscription ID into the web service URL, in the format:
services/2/orders/resolve?subscriptionid={subscription-id}

For example:
services/2/orders/?subscriptionid=87654

Locating the relevant ID type

Each type of ID above is a different value in BlueSnap. Make sure that you are using the relevant ID in your request. You can find the IDs here:

  • The order ID appears in the order-id field in the response when you create a new order.
  • The invoice ID appears in the invoice-id field when you create a new order.
  • The subscription ID appears in the url field when you create a new subscription.

Response Details

If successful, the response HTTP status code is 200 OK.

The response contains the retrieved order resource (see order).
If the order has been refunded, there will be a separate invoice listed in the response for the original charge and each refund.

For details about possible errors, see: General Errors.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/3906167 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/36642950,391768 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/resolve?invoiceId=38399968 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/resolve?subscriptionid=39469016 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order xmlns="http://ws.plimus.com">
  <order-id>3906167</order-id>
  <ordering-shopper>
    <shopper-id>19489486</shopper-id>
  </ordering-shopper>
  <cart>
    <charged-currency>USD</charged-currency>
    <cart-item>
      <sku>
        <sku-id>2175514</sku-id>
        <sku-name>TestProduct Gold Edition</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>38398826</invoice-id>
        <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=ECD5940FFEDE3C46</url>
        <financial-transactions>
          <financial-transaction>
            <status>Approved</status>
            <date-due>02-Jul-18</date-due>
            <date-created>02-Jul-18</date-created>
            <amount>15.00</amount>
            <currency>USD</currency>
            <soft-descriptor>BLS*MYCOMPANY</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>9</expiration-month>
              <expiration-year>2019</expiration-year>
            </credit-card>
            <paypal-transaction-data/>
            <invoice-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>141355567898/fax>
            </invoice-contact-info>
            <skus>
              <sku>
                <sku-id>2175514</sku-id>
                <sku-name>TestProduct Gold Edition</sku-name>
              </sku>
            </skus>
          </financial-transaction>
        </financial-transactions>
      </invoice>
    </invoices>
  </post-sale-info>
  <fulfillment>
    <license-keys/>
    <download-links>
      <sku-download-link>
        <sku-id>2175514</sku-id>
        <sku-name>TestProduct Gold Edition</sku-name>
        <download-link>https://sandbox.bluesnap.com/jsp/dlapp.jsp?ref=38398826C2175514C6687830</download-link>
      </sku-download-link>
    </download-links>
  </fulfillment>
</order>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order xmlns="http://ws.plimus.com">
  <order-id>3979819</order-id>
  <seller-order-id>36642950</seller-order-id>
  <ordering-shopper>
    <shopper-id>19562772</shopper-id>
  </ordering-shopper>
  <cart>
    <charged-currency>USD</charged-currency>
    <cart-item>
      <sku>
        <sku-id>2186520</sku-id>
        <sku-name>recurring</sku-name>
      </sku>
      <quantity>1</quantity>
      <url>https://localhost:8445/services/2/subscriptions/39520970</url>
      <item-sub-total>0.00</item-sub-total>
    </cart-item>
    <tax>0.00</tax>
    <tax-rate>0</tax-rate>
    <total-cart-cost>0.00</total-cart-cost>
  </cart>
  <post-sale-info>
    <invoices>
      <invoice>
        <invoice-id>38502076</invoice-id>
        <url>http://localhost:8080/jsp/show_invoice.jsp?ref=25F7796A6577E36D</url>
        <financial-transactions>
          <financial-transaction>
            <status>Approved</status>
            <date-due>12-Nov-18</date-due>
            <date-created>12-Nov-18</date-created>
            <amount>0.00</amount>
            <currency>USD</currency>
            <payment-method>PayPal</payment-method>
            <target-balance>VENDOR_PAYPAL_ACCOUNT</target-balance>
            <paypal-transaction-data>
              <pp-transaction-id>7FL54220CM2536942</pp-transaction-id>
              <pp-subscription-id>I-9CLN2MF8YUUM</pp-subscription-id>
            </paypal-transaction-data>
            <invoice-contact-info>
              <first-name>Bob</first-name>
              <last-name>Bobby</last-name>
              <email>bobby@example.com</email>
              <address1>1 Main St</address1>
              <city>San Jose</city>
              <state>CA</state>
              <zip>95131</zip>
              <country>us</country>
            </invoice-contact-info>
            <skus>
              <sku>
                <sku-id>2186520</sku-id>
                <sku-name>recurring</sku-name>
              </sku>
            </skus>
          </financial-transaction>
        </financial-transactions>
      </invoice>
    </invoices>
  </post-sale-info>
  <fulfillment>
    <license-keys/>
  </fulfillment>
</order>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order xmlns="http://ws.plimus.com">
  <order-id>3906167</order-id>
  <ordering-shopper>
    <shopper-id>19489486</shopper-id>
  </ordering-shopper>
  <cart>
    <charged-currency>USD</charged-currency>
    <cart-item>
      <sku>
        <sku-id>2175514</sku-id>
        <sku-name>TestProduct Gold Edition</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>38398826</invoice-id>
        <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=ECD5940FFEDE3C46</url>
        <financial-transactions>
          <financial-transaction>
            <status>Approved</status>
            <date-due>02-Jul-18</date-due>
            <date-created>02-Jul-18</date-created>
            <amount>15.00</amount>
            <currency>USD</currency>
            <soft-descriptor>BLS*MYCOMPANY</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>9</expiration-month>
              <expiration-year>2019</expiration-year>
            </credit-card>
            <paypal-transaction-data/>
            <invoice-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>
            </invoice-contact-info>
            <skus>
              <sku>
                <sku-id>2175514</sku-id>
                <sku-name>TestProduct Gold Edition</sku-name>
              </sku>
            </skus>
          </financial-transaction>
        </financial-transactions>
      </invoice>
    </invoices>
  </post-sale-info>
  <fulfillment>
    <license-keys/>
    <download-links>
      <sku-download-link>
        <sku-id>2175514</sku-id>
        <sku-name>TestProduct Gold Edition</sku-name>
        <download-link>https://sandbox.bluesnap.com/jsp/dlapp.jsp?ref=38398826C2175514C6687830</download-link>
      </sku-download-link>
    </download-links>
  </fulfillment>
</order>
<?xml version="1.0" encoding="UTF-8"?>
<order xmlns="http://ws.plimus.com">
  <order-id>3923051</order-id>
  <ordering-shopper>
    <shopper-id>19505364</shopper-id>
    <seller-shopper-id>987654321</seller-shopper-id>
  </ordering-shopper>
  <cart>
    <charged-currency>USD</charged-currency>
    <cart-item>
      <sku>
        <sku-id>2178834</sku-id>
        <sku-name>Contract Example</sku-name>
      </sku>
      <quantity>1</quantity>
      <url>https://sandbox.bluesnap.com/services/2/subscriptions/39469016</url>
      <item-sub-total>5.00</item-sub-total>
    </cart-item>
    <tax>0.00</tax>
    <tax-rate>0</tax-rate>
    <total-cart-cost>5.00</total-cart-cost>
  </cart>
  <post-sale-info>
    <invoices>
      <invoice>
        <invoice-id>38420528</invoice-id>
        <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=A29AC4EA01AA732F</url>
        <financial-transactions>
          <financial-transaction>
            <status>Approved</status>
            <date-due>26-Aug-18</date-due>
            <date-created>26-Aug-18</date-created>
            <amount>5.00</amount>
            <currency>USD</currency>
            <soft-descriptor>BLS*DescTest</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>DEBIT</card-sub-type>
              <expiration-month>9</expiration-month>
              <expiration-year>2019</expiration-year>
            </credit-card>
            <paypal-transaction-data />
            <invoice-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>
            </invoice-contact-info>
            <skus>
              <sku>
                <sku-id>2178834</sku-id>
              </sku>
            </skus>
          </financial-transaction>
        </financial-transactions>
      </invoice>
      <invoice>
        <invoice-id>38420530</invoice-id>
        <url>http://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=F293E0FA74B9EED5</url>
        <financial-transactions>
          <financial-transaction>
            <status>Approved</status>
            <date-due>26-Aug-18</date-due>
            <date-created>26-Aug-18</date-created>
            <amount>-5.00</amount>
            <currency>USD</currency>
            <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>DEBIT</card-sub-type>
              <expiration-month>9</expiration-month>
              <expiration-year>2019</expiration-year>
            </credit-card>
            <paypal-transaction-data />
            <invoice-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>
            </invoice-contact-info>
            <skus>
              <sku>
                <sku-id>2178834</sku-id>
                <sku-name>Contract Example</sku-name>
              </sku>
            </skus>
          </financial-transaction>
        </financial-transactions>
      </invoice>
    </invoices>
  </post-sale-info>
  <fulfillment>
    <license-keys />
  </fulfillment>
</order>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<order xmlns="http://ws.plimus.com">
    <order-id>3906915</order-id>
    <seller-order-id>1234567890</seller-order-id>
    <ordering-shopper>
        <shopper-id>19990000</shopper-id>
    </ordering-shopper>
    <cart>
        <charged-currency>EUR</charged-currency>
        <cart-item>
            <sku>
                <sku-id>2181378</sku-id>
                <sku-name>Contract 1</sku-name>
            </sku>
            <quantity>1</quantity>
            <item-sub-total>99.99</item-sub-total>
        </cart-item>
        <tax>0.00</tax>
        <tax-rate>0</tax-rate>
        <total-cart-cost>99.99</total-cart-cost>
    </cart>
    <post-sale-info>
        <invoices>
            <invoice>
                <invoice-id>38417916</invoice-id>
                <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=DAEF2E3</url>
                <financial-transactions>
                    <financial-transaction>
                        <status>Approved</status>
                        <date-due>13-Sep-16</date-due>
                        <date-created>13-Sep-16</date-created>
                        <amount>99.99</amount>
                        <currency>EUR</currency>
                        <soft-descriptor>BLS&#x2a;DescTest1234567</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>9</expiration-month>
                            <expiration-year>2019</expiration-year>
                        </credit-card>
                        <paypal-transaction-data/>
                        <invoice-contact-info>
                            <first-name>John</first-name>
                            <last-name>Doe</last-name>
                            <email>jdoe&#x40;johndoeandsons.com</email>
                            <address1>138 Market st</address1>
                            <city>San Francisco</city>
                            <zip>756543</zip>
                            <country>fr</country>
                            <phone>1413555666</phone>
                        </invoice-contact-info>
                        <skus>
                            <sku>
                                <sku-id>2181378</sku-id>
                            </sku>
                        </skus>
                    </financial-transaction>
                </financial-transactions>
            </invoice>
            <invoice>
                <invoice-id>38417918</invoice-id>
                <original-invoice-id>38417916</original-invoice-id>
                <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=8F1F5FECB</url>
                <financial-transactions>
                    <financial-transaction>
                        <status>Approved</status>
                        <date-due>13-Sep-16</date-due>
                        <date-created>13-Sep-16</date-created>
                        <amount>-55.55</amount>
                        <currency>EUR</currency>
                        <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>9</expiration-month>
                            <expiration-year>2019</expiration-year>
                        </credit-card>
                        <paypal-transaction-data/>
                        <invoice-contact-info>
                            <first-name>John</first-name>
                            <last-name>Doe</last-name>
                            <email>jdoe&#x40;johndoeandsons.com</email>
                            <address1>138 Market st</address1>
                            <city>San Francisco</city>
                            <zip>756543</zip>
                            <country>fr</country>
                            <phone>1413555666</phone>
                        </invoice-contact-info>
                        <skus>
                            <sku>
                                <sku-id>2181378</sku-id>
                                <sku-name>Contract 1</sku-name>
                            </sku>
                        </skus>
                    </financial-transaction>
                </financial-transactions>
            </invoice>
            <invoice>
                <invoice-id>38417920</invoice-id>
                <original-invoice-id>38417916</original-invoice-id>
                <url>https://sandbox.bluesnap.com/jsp/show_invoice.jsp?ref=335F0843E</url>
                <financial-transactions>
                    <financial-transaction>
                        <status>Approved</status>
                        <date-due>13-Sep-16</date-due>
                        <date-created>13-Sep-16</date-created>
                        <amount>-44.44</amount>
                        <currency>EUR</currency>
                        <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>9</expiration-month>
                            <expiration-year>2019</expiration-year>
                        </credit-card>
                        <paypal-transaction-data/>
                        <invoice-contact-info>
                            <first-name>John</first-name>
                            <last-name>Doe</last-name>
                            <email>jdoe&#x40;johndoeandsons.com</email>
                            <address1>138 Market st</address1>
                            <city>San Francisco</city>
                            <zip>756543</zip>
                            <country>fr</country>
                            <phone>1413555666</phone>
                        </invoice-contact-info>
                        <skus>
                            <sku>
                                <sku-id>2181378</sku-id>
                                <sku-name>Contract 1</sku-name>
                            </sku>
                        </skus>
                    </financial-transaction>
                </financial-transactions>
            </invoice>
        </invoices>
    </post-sale-info>
    <fulfillment>
        <license-keys/>
    </fulfillment>
</order>