SbPublicApiOAuthTokenRequest

snowbee.SbPublicApiOAuthTokenRequest

client_idoptional

Client ID when using client_secret_post. Omit when using HTTP Basic.

client_secretoptional

Client secret when using client_secret_post. Omit when using HTTP Basic.

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"
tenant_idrequired

SnowBee tenant ID

Example"019c1234-5678-7abc-8def-123456789012"
View raw schema
{
  "type": "object",
  "properties": {
    "client_id": {
      "type": [
        "null",
        "string"
      ],
      "description": "Client ID when using client_secret_post. Omit when using HTTP Basic.",
      "title": "String"
    },
    "client_secret": {
      "type": [
        "null",
        "string"
      ],
      "description": "Client secret when using client_secret_post. Omit when using HTTP Basic.",
      "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"
    },
    "tenant_id": {
      "type": "string",
      "description": "SnowBee tenant ID",
      "example": "019c1234-5678-7abc-8def-123456789012",
      "title": "String"
    }
  },
  "required": [
    "grant_type",
    "scope",
    "tenant_id"
  ],
  "title": "SbPublicApiOAuthTokenRequest"
}