Get the brand widget configuration (widget)

GET /widget/config

Headers

  • X-Popsell-Domain string Required

    The domain of the user

Responses

  • 200 application/json

    Returns the configuration

    Hide response attributes Show response attributes object
    • global object
      Hide global attributes Show global attributes object
      • signInUrl string
      • signUpUrl string
      • ambassadorProfileUrl string
      • ambassadorProfilePostUrl string
      • ambassadorPresentationUrl string
      • customContactUrl string
      • assetsFolderName string
      • redirectUrl string
      • defaultLanguage string
      • sandboxUrl string
    • community object
      Hide community attributes Show community attributes object
      • defaultGeolocation array[object]
      • locationType string
      • defaultSortBy integer
    • im object
      Hide im attribute Show im attribute object
      • chattopic integer
    • picking object
      Hide picking attributes Show picking attributes object
      • nameSelector object
        Hide nameSelector attributes Show nameSelector attributes object
        • selector string
        • attribute string(nullable)
      • descriptionSelector object
        Hide descriptionSelector attributes Show descriptionSelector attributes object
        • selector string
        • attribute string(nullable)
      • imageSelector object
        Hide imageSelector attributes Show imageSelector attributes object
        • selector string
        • attribute string(nullable)
      • priceSelector object
        Hide priceSelector attributes Show priceSelector attributes object
        • selector string
        • attribute string(nullable)
      • skuSelector object
        Hide skuSelector attributes Show skuSelector attributes object
        • selector string
        • attribute string(nullable)
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
GET /widget/config 
curl \
 --request GET 'https://domain.tld/api/v2/widget/config' \
 --header "X-Popsell-Domain: example.com"
Response examples (200) 
{
  "global": {
    "signInUrl": "string",
    "signUpUrl": "string",
    "ambassadorProfileUrl": "string",
    "ambassadorProfilePostUrl": "string",
    "ambassadorPresentationUrl": "string",
    "customContactUrl": "string",
    "assetsFolderName": "string",
    "redirectUrl": "string",
    "defaultLanguage": "string",
    "sandboxUrl": "string"
  },
  "community": {
    "defaultGeolocation": [
      {}
    ],
    "locationType": "string",
    "defaultSortBy": 42
  },
  "im": {
    "chattopic": 42
  },
  "picking": {
    "nameSelector": {
      "selector": "string",
      "attribute": "string"
    },
    "descriptionSelector": {
      "selector": "string",
      "attribute": "string"
    },
    "imageSelector": {
      "selector": "string",
      "attribute": "string"
    },
    "priceSelector": {
      "selector": "string",
      "attribute": "string"
    },
    "skuSelector": {
      "selector": "string",
      "attribute": "string"
    }
  }
}
Response examples (401) 
{
  "message": "Unauthorized."
}