Appearance
ifood.list-items ​
List iFood items for one category
List items and add-ons for one category.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| 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 |
merchant_ref | string | Yes | — | Provider merchant reference. |
category_ref | string | Yes | — | — |
catalog_context | string | No | DEFAULT | Which catalog context the returned price and status describe. Defaults to DEFAULT, the delivery menu. Names come from 'context' in ifood.list-catalogs. |
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 |
merchant_ref | string | Yes | — | Provider merchant reference. |
category_ref | string | Yes | — | — |
catalog_context | string | No | DEFAULT | Which catalog context the returned price and status describe. Defaults to DEFAULT, the delivery menu. Names come from 'context' in ifood.list-catalogs. |
items | json | Yes | — | Items resolved for catalog_context: each price and status is the live value, with contextModifiers kept intact. |
context_resolution | json | No | — | How the returned price and status were arrived at: the context applied, whether a contextModifier existed for it, and the base values it overlaid. Report the resolved item, not the base. |
read_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 |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
listed | SUCCESS | Items listed | items |
failed | FAILURE | Listing failed | failure_reason, failure_type |
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 ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "ifood.list-items",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"merchant_ref": "value",
"category_ref": "value"
}
}