GET:gateways.json
Commerce APIGET:gateways.json

GET:gateways.json

Description

Get all or specific gateways.

This is a typical bulk get endpoint.

Permission bit: "gateways.read"

Topic: Gateways

Query Parameters

ids: Comma-separated array of String, required

List of gateway ids. See also: Unique Identifiers

Example: ?ids=gw_EQzGqWoY,gw_EQzGqWoY


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)

Example: ?loose=true


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY


type: GatewayType

Filter results by gateway type

Example: ?type=manual

Response Body

Array of Gateway

Response Body Type

Loading module