{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"optional","examples":{"codes":[]},"method":"get","results":{"codes":[{"code":"","language":"text"}]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Retrieve Custom Parameter","type":"endpoint","slug":"retrieve-custom-parameter","excerpt":"","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>","updates":[],"order":9,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c742637ad58c70033b9c6b8","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Catalog","slug":"coupon","order":4,"from_sync":false,"reference":true,"_id":"5c742637ad58c70033b9c69d","version":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-05-12T15:22:00.041Z","__v":0},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"Main","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c742637ad58c70033b9c699","5c742637ad58c70033b9c69a","5c742637ad58c70033b9c69b","5c742637ad58c70033b9c69c","5c742637ad58c70033b9c69d","5c742637ad58c70033b9c69e","5c742637ad58c70033b9c69f","5c742637ad58c70033b9c6a0","5c742637ad58c70033b9c6a1","5c742637ad58c70033b9c6a2","5c742637ad58c70033b9c6a3"],"_id":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedbcf19b49e8004462d199","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-05-12T15:21:02.800Z","githubsync":"","__v":0}

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

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

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