{"_id":"5adf4e5aac13b80003d23165","category":{"_id":"5adf4e59ac13b80003d23154","version":"5adf4e59ac13b80003d23152","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,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5adf4e59ac13b80003d23153","5adf4e59ac13b80003d23154","5adf4e59ac13b80003d23155","5adf4e59ac13b80003d23156","5adf4e59ac13b80003d23157","5adf4e59ac13b80003d23158","5adf4e59ac13b80003d23159","5adf4e59ac13b80003d2315a","5adf4e59ac13b80003d2315b","5adf4e59ac13b80003d2315c","5adf4e59ac13b80003d2315d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-12T14:59:10.658Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"optional","params":[],"url":""},"isReference":true,"order":5,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/orders/{order-id}/fulfillment/license-keys|download-links</span>\n\n<hr>\n\n##Documentation\nFor some transactions, the shopper may be entitled to a license key (serial number) and/or download link. The Retrieve Fulfillment Information request enables you to obtain the relevant fulfillment details. You can then display the information to the shopper on your Thank You page once the transaction is complete.\n\n###Request Content\n**Retrieve license keys**\nEnter the `order-id` into the web service URL for license keys, in the format:\n`services/2/orders/{order-id}/fulfillment/license-keys`\n\nFor example:\n`services/2/orders/123456/fulfillment/license-keys`\n\n**Retrieve download links**\nEnter the `order-id` into the web service URL for download links, in the format:\n`services/2/orders/{order-id}/fulfillment/download-links`\n\nFor example:\n`services/2/orders/123456/fulfillment/download-links`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `fulfillment` resource (see [fulfillment](doc:fulfillment)).\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/3612045/fulfillment/license-keys  \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Fulfillment Information Request: license keys\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/3612045/fulfillment/download-links \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"download links\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<fulfillment xmlns=\\\"http://ws.plimus.com\\\">\\n  <sku-license>\\n    <sku-id>151</sku-id>\\n    <sku-name>my test product</sku-name>\\n    <license-key>A1234567890</license-key>\\n  </sku-license>\\n</fulfillment>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Fulfillment Information Response: license keys\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<fulfillment xmlns=\\\"http://ws.plimus.com\\\">\\n  <sku-download-link>\\n    <sku-id>151</sku-id>\\n    <sku-name>my test product</sku-name>\\n    <download-link>http://support.BlueSnap.com/jsp/download_app.jsp?contractId=151</download-link>\\n  </sku-download-link>\\n</fulfillment>\",\n      \"language\": \"xml\",\n      \"name\": \"download links\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-fulfillment-information","type":"endpoint","title":"Retrieve Fulfillment Information"}

getRetrieve Fulfillment Information


Definition

https://sandbox.bluesnap.com/services/2/orders/{order-id}/fulfillment/license-keys|download-links


Documentation

For some transactions, the shopper may be entitled to a license key (serial number) and/or download link. The Retrieve Fulfillment Information request enables you to obtain the relevant fulfillment details. You can then display the information to the shopper on your Thank You page once the transaction is complete.

Request Content

Retrieve license keys
Enter the order-id into the web service URL for license keys, in the format:
services/2/orders/{order-id}/fulfillment/license-keys

For example:
services/2/orders/123456/fulfillment/license-keys

Retrieve download links
Enter the order-id into the web service URL for download links, in the format:
services/2/orders/{order-id}/fulfillment/download-links

For example:
services/2/orders/123456/fulfillment/download-links

Response Details

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


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/3612045/fulfillment/license-keys  \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/orders/3612045/fulfillment/download-links \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<?xml version="1.0" encoding="UTF-8"?>
<fulfillment xmlns="http://ws.plimus.com">
  <sku-license>
    <sku-id>151</sku-id>
    <sku-name>my test product</sku-name>
    <license-key>A1234567890</license-key>
  </sku-license>
</fulfillment>
<?xml version="1.0" encoding="UTF-8"?>
<fulfillment xmlns="http://ws.plimus.com">
  <sku-download-link>
    <sku-id>151</sku-id>
    <sku-name>my test product</sku-name>
    <download-link>http://support.BlueSnap.com/jsp/download_app.jsp?contractId=151</download-link>
  </sku-download-link>
</fulfillment>