Skip to content
Proud to collaborate with Microsoft for Startups

ifood.connection.complete-authorization ​

Exchange a merchant's authorization code for a durable iFood grant

Exchange the merchant's authorization code for a durable grant.

Leg two, and not a poll. iFood shows the authorization code to the merchant in the Portal after they confirm the user code, and the merchant hands it back — the provider expects authorization_code supplied and has no method that retrieves it. There is nothing to wait for, so there is no schedule_transition here.

The exchange happens by writing the code beside the verifier already on the connection and then opening a provider: the service builds credentials from the connection, and connect performs the authorization_code grant. Doing it that way means this workflow never handles a token itself.

Afterwards the single-use material is deleted in the same write that stores the refresh token. An authorization code survives its exchange only as a stale bearer credential in an encrypted blob nobody audits.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-ifood
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
connection_uuidstringYes—The merchant connection begun by ifood.connection.begin-authorization
authorization_codestringYes—The code iFood showed the merchant after they confirmed the user code
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
connection_uuidstringYes——
workflow_run_idstringNo——
authorizedbooleanYes——
merchants_grantedintegerYes——
merchant_refslistYes——
completed_atstringYes——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_stepjsonNo——
failed_layerintegerNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——
provider_request_refstringNo——
retryablebooleanNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—execute—
executingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedexecuteexecuting—
executingcompletecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
authorizedSUCCESSThe merchant's authorization was exchanged for a durable grantauthorized, merchants_granted, merchant_refs
failedFAILUREThe authorization exchange failedfailure_reason, failure_type, retryable

Business Errors ​

CodeMessage Template
IFOOD_ORGANIZATION_CONTEXT_INVALIDAuthenticated organization context is missing or does not match the workflow input
IFOOD_CONNECTION_NOT_FOUNDiFood connection {connection_uuid} was not found in the authenticated organization
IFOOD_CONNECTION_WRONG_PROVIDERConnection {connection_uuid} is not an iFood connection
IFOOD_CONNECTION_SERVICE_UNAVAILABLEThe shared cloud connection service is unavailable
IFOOD_PROVIDER_CAPABILITY_MISSINGThe installed iFood provider does not expose the required API operation
IFOOD_AUTHENTICATION_FAILEDiFood rejected the connection credentials or bearer token
IFOOD_PROVIDER_REQUEST_FAILEDThe iFood API request failed
IFOOD_RESPONSE_SHAPE_INVALIDThe iFood Merchant API returned an invalid merchant record
IFOOD_PAGINATION_INVALIDMerchant page must be at least 1 and limit must be between 1 and 100
IFOOD_SALES_WINDOW_INVALIDSales dates must use YYYY-MM-DD, be ordered, and span no more than 8 inclusive days
IFOOD_SALES_PAGINATION_INVALIDSales page must be a zero-based integer
IFOOD_SALES_RESPONSE_SHAPE_INVALIDThe iFood Financial Sales API returned an invalid response
IFOOD_FINANCIAL_EVENTS_WINDOW_INVALIDFinancial Events dates must use YYYY-MM-DD, be ordered, and span no more than 33 inclusive days
IFOOD_SETTLEMENTS_WINDOW_INVALIDSettlements dates must use YYYY-MM-DD, be ordered, and span no more than 90 inclusive days
IFOOD_FINANCIAL_PAGINATION_INVALIDFinancial page must be one-based and page_size must be between 100 and 300
IFOOD_FINANCIAL_EVENTS_RESPONSE_SHAPE_INVALIDThe iFood Financial Events API returned an invalid response
IFOOD_SETTLEMENTS_RESPONSE_SHAPE_INVALIDThe iFood Settlements API returned an invalid response
IFOOD_DATA_ENVIRONMENT_INVALIDdata_environment must be exactly 'production' or 'homologation'
IFOOD_DATA_ENVIRONMENT_UNSUPPORTEDThe installed iFood provider does not support data_environment; upgrade ltinteg-cloud-connections to request homologation records

API Usage ​

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

{
  "workflow_type": "ifood.connection.complete-authorization",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "authorization_code": "value"
  }
}