ifood.sales-compare

Compare iFood sales for a period against another period

Two periods and the difference between them.

Overview

Property	Value
Workflow type	Linear
Library	App-ifood
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Authenticated organization UUID injected by the workflow boundary
connection_uuid	uuid	Yes	—	Organization-scoped iFood CloudConnection UUID
workflow_run_id	string	No	—	Engine-stamped parent DAG run id
data_environment	string	No	production	Which iFood data set to read: 'production' (default) or 'homologation' for official iFood test records. Homologation maps to a provider-owned request header; callers never supply HTTP headers. Persisted evidence must be partitioned by this value so test and production records can never be reconciled together.
merchant_ref	string	Yes	—	—
start_date	string	Yes	—	—
end_date	string	Yes	—	—
compare_start_date	string	No	—	First day of the period to compare against. Omit and the immediately preceding window of the same length is used.
compare_end_date	string	No	—	Last day of the comparison period; derived when omitted

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Authenticated organization UUID injected by the workflow boundary
connection_uuid	uuid	Yes	—	Organization-scoped iFood CloudConnection UUID
workflow_run_id	string	No	—	Engine-stamped parent DAG run id
data_environment	string	No	production	Which iFood data set to read: 'production' (default) or 'homologation' for official iFood test records. Homologation maps to a provider-owned request header; callers never supply HTTP headers. Persisted evidence must be partitioned by this value so test and production records can never be reconciled together.
merchant_ref	string	Yes	—	—
start_date	string	Yes	—	—
end_date	string	Yes	—	—
compare_start_date	string	No	—	First day of the period to compare against. Omit and the immediately preceding window of the same length is used.
compare_end_date	string	No	—	Last day of the comparison period; derived when omitted
current	json	Yes	—	—
previous	json	Yes	—	—
concluded_delta	string	Yes	—	current minus previous, in currency
concluded_delta_pct	string	No	—	Percent change; null when the previous period sold nothing
order_delta	integer	Yes	—	—
direction	string	Yes	—	up, down, or flat
currency	string	Yes	—	—
both_periods_complete	boolean	Yes	—	False when either window hit the page cap; the comparison is partial
ledger_covers_both	boolean	Yes	—	False when the settlement ledger has not reached the end of either period; a comparison against a window the ledger cannot see yet is not a comparison
fetched_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
compared	SUCCESS	Both periods totalled and compared	current, previous, concluded_delta, direction
failed	FAILURE	Comparison 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.sales-compare",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "merchant_ref": "value",
    "start_date": "value"
  }
}