publicPortalConfig

Public: no authentication required.

Returns a seller's public portal settings for its storefront login page. Needs no sign-in. Returns null for an unknown subdomain.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PublicPortalConfig($subdomain: String!) {
  publicPortalConfig(subdomain: $subdomain) {
    countryCode
    currencyCode
    mobileAndroidPackageName
    portalName
    accentColor
    allowDirectOrders
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PublicPortalConfig($subdomain: String!) {\n  publicPortalConfig(subdomain: $subdomain) {\n    countryCode\n    currencyCode\n    mobileAndroidPackageName\n    portalName\n    accentColor\n    allowDirectOrders\n  }\n}",
  "variables": {
    "subdomain": "string"
  }
}
EOF

Variables:

{
  "subdomain": "string"
}

Response:

{
  "data": {
    "publicPortalConfig": {
      "countryCode": "string",
      "currencyCode": "string",
      "mobileAndroidPackageName": "string",
      "portalName": "string",
      "accentColor": "string",
      "allowDirectOrders": true
    }
  }
}

publicPortalConfig(
  subdomain: String!
): PublicPortalConfig

Arguments

publicPortalConfig.subdomain ● String! non-null scalar

The seller's storefront subdomain.

Type

PublicPortalConfig object

The portal settings returned to the customer portal and buyer app. It carries nothing sensitive.