ifood.connection.begin-authorization

Start a merchant's authorization of the registered iFood application

Request the user code a merchant types into the iFood Portal.

Overview

Property	Value
Workflow type	Linear
Library	App-ifood
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	string	Yes	—	—
app_connection_uuid	string	No	—	The ifood_app connection whose registered application the merchant authorizes. Required normally. On a deployment locked to its own configured application it must be OMITTED -- supplying it is refused rather than ignored, because ignoring it would let you believe you authorized against your application when you authorized against the deployment's.
connection_uuid	string	No	—	An existing merchant connection to authorize. Omit it on a first run and supply connection_name instead -- the journey creates the connection, because nothing else can.
connection_name	string	No	—	Names the merchant connection to create when connection_uuid is omitted. Re-running with the same name resumes that journey rather than starting a second one.
data_environment	string	No	production	Recorded on a newly created connection; ignored for an existing one.
workflow_run_id	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
organization_uuid	string	Yes	—	—
app_connection_uuid	string	No	—	The ifood_app connection whose registered application the merchant authorizes. Required normally. On a deployment locked to its own configured application it must be OMITTED -- supplying it is refused rather than ignored, because ignoring it would let you believe you authorized against your application when you authorized against the deployment's.
connection_uuid	string	No	—	An existing merchant connection to authorize. Omit it on a first run and supply connection_name instead -- the journey creates the connection, because nothing else can.
connection_name	string	No	—	Names the merchant connection to create when connection_uuid is omitted. Re-running with the same name resumes that journey rather than starting a second one.
data_environment	string	No	production	Recorded on a newly created connection; ignored for an existing one.
workflow_run_id	string	No	—	—
merchant_connection_uuid	string	Yes	—	The merchant connection holding the verifier; pass this to complete-authorization
connection_created	boolean	Yes	—	True when this run created the connection rather than resuming one
user_code	string	Yes	—	—
verification_url	string	No	—	—
verification_url_complete	string	No	—	—
expires_in	integer	No	—	—
verifier_stored	boolean	Yes	—	—
requested_at	string	Yes	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_step	json	No	—	—
failed_layer	integer	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—
failed_at	string	No	—	—
provider_request_ref	string	No	—	—
retryable	boolean	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
initiated	Yes	No	—	execute	—
executing	No	No	—	complete	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
initiated	execute	executing	—
executing	complete	completed	—
* (any state)	fail	failed	—

Outcomes

Outcome	Type	Description	State Data Keys
requested	SUCCESS	A user code was issued for the merchant to authorize	user_code, verification_url_complete, expires_in
failed	FAILURE	The user-code request failed	failure_reason, failure_type, retryable

Business Errors

Code	Message Template
IFOOD_ORGANIZATION_CONTEXT_INVALID	Authenticated organization context is missing or does not match the workflow input
IFOOD_CONNECTION_NOT_FOUND	iFood connection {connection_uuid} was not found in the authenticated organization
IFOOD_CONNECTION_WRONG_PROVIDER	Connection {connection_uuid} is not an iFood connection
IFOOD_CONNECTION_SERVICE_UNAVAILABLE	The shared cloud connection service is unavailable
IFOOD_PROVIDER_CAPABILITY_MISSING	The installed iFood provider does not expose the required API operation
IFOOD_AUTHENTICATION_FAILED	iFood rejected the connection credentials or bearer token
IFOOD_PROVIDER_REQUEST_FAILED	The iFood API request failed
IFOOD_RESPONSE_SHAPE_INVALID	The iFood Merchant API returned an invalid merchant record
IFOOD_PAGINATION_INVALID	Merchant page must be at least 1 and limit must be between 1 and 100
IFOOD_SALES_WINDOW_INVALID	Sales dates must use YYYY-MM-DD, be ordered, and span no more than 8 inclusive days
IFOOD_SALES_PAGINATION_INVALID	Sales page must be a zero-based integer
IFOOD_SALES_RESPONSE_SHAPE_INVALID	The iFood Financial Sales API returned an invalid response
IFOOD_FINANCIAL_EVENTS_WINDOW_INVALID	Financial Events dates must use YYYY-MM-DD, be ordered, and span no more than 33 inclusive days
IFOOD_SETTLEMENTS_WINDOW_INVALID	Settlements dates must use YYYY-MM-DD, be ordered, and span no more than 90 inclusive days
IFOOD_FINANCIAL_PAGINATION_INVALID	Financial page must be one-based and page_size must be between 100 and 300
IFOOD_FINANCIAL_EVENTS_RESPONSE_SHAPE_INVALID	The iFood Financial Events API returned an invalid response
IFOOD_SETTLEMENTS_RESPONSE_SHAPE_INVALID	The iFood Settlements API returned an invalid response
IFOOD_DATA_ENVIRONMENT_INVALID	data_environment must be exactly 'production' or 'homologation'
IFOOD_DATA_ENVIRONMENT_UNSUPPORTED	The installed iFood provider does not support data_environment; upgrade ltinteg-cloud-connections to request homologation records

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "ifood.connection.begin-authorization",
  "initial_data": {
    "organization_uuid": "value"
  }
}