VWvwala
Energy catalog

Get a merchant by id

Changed on
get/v1/merchants/{id}

Request

Path parameters

idstring uuid required

Response

Default Response

idstring uuid required

Unique identifier (UUID) for the merchant

canonicalNamestring required

Stable identifier derived from the merchant's display name (camelCase, e.g. "engie" or "boltEnergie"). Unique per merchant.

displayNamestring required

The merchant's display name

websitestring uri nullable required

Merchant website URL

hasNativeAppboolean nullable required

Whether the merchant offers a native mobile app

cooperativeboolean nullable required

Whether the merchant is a cooperative

automatedSwitchboolean required

Whether Vwala can switch to this merchant automatically via an API integration (i.e. the merchant is an integration partner), rather than a manual or redirect submission.

vregServicecheckRatinginteger nullable required

VREG servicecheck rating, from 1 to 5 stars.

vregComplaintsPerThousandnumber nullable required

VREG complaints per 1000 customers.

countrystring required

ISO 3166-1 alpha-2 country code (e.g. BE)

Changes

  • 1673faf11a0fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      response property cooperative list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property hasNativeApp list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property usps/items/description list-of-types was narrowed by removing types null from media type application/json of response 200