More on Configurations

Product Configurations

METHOD URI

GET
/v2/products/{id}/configurations

Sample Request and Response

Sample Request: GET
'https://sandbox-wapi.posportal.com/v2/products/126747/configurations'

Sample Response:

{
  "result": [
    {
      "id": 2,
      "name": "Application",
      "options": [
        {
          "id": 1325,
          "name": "XYZ QS",
          "required": false,
          "p2pe": false,
          "includedProducts": [
            {
              "id": 128327,
              "name": "Configuration - Level 2",
              "price": 0
            }
          ],
          "attributes": [
            {
              "id": 3,
              "name": "Download ID:",
              "dataType": "STRING",
              "attributeDecimals": null,
              "attributeLength": 20,
              "defaultValue": "",
              "allowedValues": null,
              "required": true,
              "deviceSpecific": true
            },
            {
              "id": 15,
              "name": "Application IP/DNS:",
              "dataType": "STRING",
              "attributeDecimals": null,
              "attributeLength": 26,
              "defaultValue": "Default IP",
              "allowedValues": null,
              "required": true,
              "deviceSpecific": true
            },
            {
              "id": 16,
              "name": "PABX",
              "dataType": "STRING",
              "attributeDecimals": null,
              "attributeLength": 5,
              "defaultValue": "",
              "allowedValues": null,
              "required": false,
              "deviceSpecific": false
            }
          ],
          "relatedProducts": [
            {
              "id": 3,
              "description": "EDC Terminal Sticker (label template required)",
              "product": {
                "id": 101942,
                "name": "Sticker, Terminal (EDC)",
                "price": 1
              },
              "type": "PICKABLE",
              "selectedByDefault": true
            },
            {
              "id": 5,
              "description": "Visa Test",
              "product": {
                "id": 112957,
                "name": "Device Configuration- Test Transaction, Visa",
                "price": 2.5
              },
              "type": "NON_PICKABLE",
              "selectedByDefault": true
            }
          ]
        }
      ]
    }
  ]
}

Notes:

• Making a request to the /v2/products/{id}/configurations endpoint brings back all certified configurations for a given product ID, including applications, debit injections, data keys, operating systems, and more.
• The required Boolean indicates whether or not the configuration option is required for that product; configuration options where required is true must be included in the order post.
• The p2pe Boolean identifies your P2PE data key. The p2pe field will only be true for certified P2PE data keys or “Encrypted for” configurations.
• IncludedProducts are products that will be created as order items when that configuration option is ordered. These can include service parts for the configuration, as well as physical products like the tamper bag required for P2PE devices.
• Attributes are the inputs identified during the certification process for a given configuration option. The value entered for an attribute must obey the dataType, attributeLength, and attributeDecimals as dictated by product admin. For attributes with a picklist data type, a list of allowedValues will be returned in the response. Attributes marked required must be included in the order post for that configuration option. If an attribute is deviceSpecific, the order quantity for the device must be 1. If none of the attributes for all selected configuration options are deviceSpecific, the order quantity can be greater than 1 for that device.
• RelatedProducts are optional products related to a given configuration option that may or may not be needed for the order. These include things like the EDC terminal sticker, Visa Tests, and Debit Tests. Note: relatedProducts replace legacy transaction tests. “Pickable” (e.g., EDC sticker) and “non-pickable” (e.g., Visa test) are distinguished by the type field. If selectedByDefault is true, POS Portal recommends the relatedProduct be automatically selected for the user in the customer’s UI. However, the relatedProduct ID must be specified to be added to the order, even if selectedByDefault is true.
• The allowMultipleOptions Boolean indicates whether multiple options can be selected from the same configuration for a single order item. If allowMultipleOptions is false, only one option can be selected from the available options for that configuration. If allowMultipleOptions is true, multiple options can be selected from that configuration for the same order item. For example, if the Operating System configuration has allowMultipleOptions: false, only one Operating System option can be selected for the device. If the Secure Key configuration has allowMultipleOptions: true, multiple Secure Key options can be selected for the same device.