Retrieve Custom Parameter

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

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>

Back to Top