{"_id":"5adf4e5aac13b80003d23172","category":{"_id":"5adf4e59ac13b80003d23157","version":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-12T15:22:00.041Z","from_sync":false,"order":4,"slug":"coupon","title":"Catalog"},"user":"560d5913af97231900938124","parentDoc":null,"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-12T15:21:02.800Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[],"url":""},"isReference":true,"order":23,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/catalog/custom-parameters/:custom-parameter-id</span>\n\n<hr>\n\n##Documentation\nThe Retrieve Custom Parameter request enables you to retrieve details of an existing custom parameter in your account.\n\n###Request Content\nEnter the `custom-parameter-id` into the web service URL, in the format:\n`services/2/catalog/custom-parameters/{custom-parameter-id}`\n\nFor example:\n`services/2/catalog/custom-parameters/123456`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `custom-parameter` resource (see [custom-parameter](doc:custom-parameter)).\nFor details about possible errors, see: [General Errors](doc:general-errors) and [Catalog Errors](doc:catalog-errors).\n\n<hr>\n\n##Examples\n\n###Request Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/catalog/custom-parameters/16807 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Custom Parameter Request\"\n    }\n  ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<custom-parameter xmlns=\\\"http://ws.plimus.com\\\">\\n  <custom-param-title>API CheckBox</custom-param-title>\\n  <active>true</active>\\n  <mandatory>true</mandatory>\\n  <custom-param-settings>\\n    <custom-param-type>boolean</custom-param-type>\\n    <visual-settings>\\n      <title-alignment>left</title-alignment>\\n    </visual-settings>\\n  </custom-param-settings>\\n</custom-parameter>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Custom Parameter Response\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"retrieve-custom-parameter","type":"endpoint","title":"Retrieve Custom Parameter"}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

getRetrieve Custom Parameter

Definition

https://sandbox.bluesnap.com/services/2/catalog/custom-parameters/:custom-parameter-id

Documentation

The Retrieve Custom Parameter request enables you to retrieve details of an existing custom parameter in your account.

Request Content

Enter the custom-parameter-id into the web service URL, in the format:
services/2/catalog/custom-parameters/{custom-parameter-id}

For example:
services/2/catalog/custom-parameters/123456

Response Details

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

Examples

Request Example

Retrieve Custom Parameter Request
curl -v -X GET https://sandbox.bluesnap.com/services/2/catalog/custom-parameters/16807 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Example

Retrieve Custom Parameter Response
<?xml version="1.0" encoding="UTF-8"?>
<custom-parameter xmlns="http://ws.plimus.com">
  <custom-param-title>API CheckBox</custom-param-title>
  <active>true</active>
  <mandatory>true</mandatory>
  <custom-param-settings>
    <custom-param-type>boolean</custom-param-type>
    <visual-settings>
      <title-alignment>left</title-alignment>
    </visual-settings>
  </custom-param-settings>
</custom-parameter>