SbPublicApiAuthorizeRequest

snowbee.SbPublicApiAuthorizeRequest

client_idrequired

Client ID from your API credentials

Example"your-client-id"
client_secretrequired

Client secret from your API credentials

Example"your-client-secret"
grant_typerequired
Allowed values"client_credentials"
resourceoptional

One assigned eCom store or loyalty program ID for legacy ecom or loyalty_programs. Omit for modern permissions.

scoperequired

Space-separated granted permissions, including Core scopes, ecom:read, ecom:write, loyalty_programs:read and demand_planning. Legacy ecom and loyalty_programs must be requested alone with resource.

Example"ecom:read ecom:write loyalty_programs:read"
View raw schema
{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string",
      "description": "Client ID from your API credentials",
      "example": "your-client-id",
      "title": "String"
    },
    "client_secret": {
      "type": "string",
      "description": "Client secret from your API credentials",
      "example": "your-client-secret",
      "title": "String"
    },
    "grant_type": {
      "$ref": "#/components/schemas/snowbee.SbPublicApiAuthorizeRequestGrantType"
    },
    "resource": {
      "type": [
        "null",
        "string"
      ],
      "description": "One assigned eCom store or loyalty program ID for legacy ecom or loyalty_programs. Omit for modern permissions.",
      "title": "String"
    },
    "scope": {
      "type": "string",
      "description": "Space-separated granted permissions, including Core scopes, ecom:read, ecom:write, loyalty_programs:read and demand_planning. Legacy ecom and loyalty_programs must be requested alone with resource.",
      "example": "ecom:read ecom:write loyalty_programs:read",
      "title": "String"
    }
  },
  "required": [
    "client_id",
    "client_secret",
    "grant_type",
    "scope"
  ],
  "title": "SbPublicApiAuthorizeRequest"
}