Search in documentation

Modules

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Solutions

Logistics

Order structure

Use GET logistics/orders/{id} to get complete order details.An order contains:

General information: ID, type, creation date
Merchant: Store data
Customer: Customer data
Items: Product quantity and weight
Payments: Payment methods and amounts
Delivery: Delivery address and method
Schedule: Scheduled time (when applicable)

Field reference

General information

Field	Type	Description
id	uuid	Unique order identifier
displayId	string	Friendly ID to display in the store interface
orderType	enum	Order type: `DELIVERY` or `TAKEOUT`
orderTiming	enum	Delivery timing: `IMMEDIATE` or `SCHEDULED`
createdAt	date	Order creation date and time
isTest	boolean	Indicates if it's a test order

Example:

{
  "id": "32c15e00-9861-4548-b5f0-15580defc999",
  "displayId": "fc999",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "isTest": false
}

merchant

Field	Type	Description
id	uuid	Unique store identifier
name	string	Store name

Example:

{
  "merchant": {
    "id": "50647eee-5eb6-41a2-b2d8-999998ed677f",
    "name": "Store Name"
  }
}

merchant.merchantAddress

Field	Type	Description
country	string	Country code
state	string	State
city	string	City
district	string	District
street	string	Street
number	string	Number
postalCode	string	Postal code
latitude	number	Latitude coordinate
longitude	number	Longitude coordinate

Example:

{
  "merchantAddress": {
    "country": "BR",
    "state": "AC",
    "city": "Bujari",
    "district": "Bujari",
    "street": "Ramal Bujari",
    "number": "122",
    "postalCode": "12345678",
    "latitude": -9.822384,
    "longitude": -67.948589
  }
}

customer

Field	Type	Description
id	uuid	Unique customer identifier
name	string	Customer name
phone.number	string	Customer phone or iFood's 0800 number
phone.localizer	string	Locator code to use when calling the 0800 number
phone.localizerExpiration	date	Locator expiration date

Phone field is optionalThe phone field expires 3 hours after the order delivery date.

Example:

{
  "customer": {
    "name": "Murilo Gontijo",
    "phone": {
      "number": "0800 705 3040",
      "localizer": "75159000",
      "localizerExpiration": "2024-01-09T00:44:42.547Z"
    }
  }
}

items

Field	Type	Description
index	integer	Item position in the list
quantity	integer	Quantity
weight.unit	string	Unit: `GRAMS` or `LITERS`
weight.value	number	Weight value

Example:

"items": [
  {
    "index": 1,
    "quantity": 1,
    "weight": {
      "unit": "GRAMS",
      "value": 750
    }
  },
  {
    "index": 2,
    "quantity": 1,
    "weight": {
      "unit": "LITERS",
      "value": 2
    }
  }
]

payments

Field	Type	Description
prepaid	double	Amount already paid (online)
pending	double	Amount to collect on delivery
methods.value	double	Payment amount
methods.currency	string	Currency (e.g., `BRL`)
methods.method	enum	Method: `CASH`, `CREDIT`, `DEBIT`, `MEAL_VOUCHER`, `FOOD_VOUCHER`, `GIFT_CARD`, `DIGITAL_WALLET`, `PIX`, `OTHER`
methods.type	string	Type: `ONLINE` or `OFFLINE`
methods.prepaid	boolean	Indicates if already paid
methods.cash.changeFor	double	Change amount (for cash payment)

Example:

"payments": {
  "prepaid": 0,
  "pending": 103.99,
  "methods": [
    {
      "value": 103.99,
      "currency": "BRL",
      "method": "CASH",
      "prepaid": false,
      "type": "OFFLINE",
      "cash": {
        "changeFor": 150
      }
    }
  ]
}

delivery

Field	Type	Description
mode	enum	Delivery mode: `DEFAULT` (standard) or `EXPRESS`
deliveredBy	enum	Responsible: `MERCHANT` (own delivery)
deliveryDateTime	date	Estimated delivery date and time
observations	string	Customer observations about the delivery
deliveryAddress	object	Delivery address

Example:

"delivery": {
  "mode": "DEFAULT",
  "deliveredBy": "MERCHANT",
  "deliveryDateTime": "2020-01-01T00:00:00.000Z",
  "observations": "Leave at reception",
  "deliveryAddress": {...}
}

deliveryAddress

Field	Type	Description
streetName	string	Street name
streetNumber	string	Number (may contain letters)
formattedAddress	string	Complete formatted address
neighborhood	string	Neighborhood
complement	string	Complement (apartment, block, etc)
reference	string	Reference point
postalCode	string	Postal code (optional, may come as zero)
city	string	City
state	string	State
country	string	Country
coordinates.latitude	double	Latitude coordinate
coordinates.longitude	double	Longitude coordinate

Example:

"deliveryAddress": {
  "streetName": "STREET X",
  "streetNumber": "20A",
  "formattedAddress": "STREET X, 20A",
  "neighborhood": "Neighborhood",
  "complement": "Apt 101",
  "reference": "Near the square",
  "postalCode": "99999999",
  "city": "SAO PAULO",
  "state": "SP",
  "country": "BR",
  "coordinates": {
    "latitude": -26.999999,
    "longitude": -48.999999
  }
}

schedule

Present only in scheduled orders (orderTiming: SCHEDULED).

Field	Type	Description
deliveryDateTimeStart	date	Delivery window start
deliveryDateTimeEnd	date	Delivery window end

Example:

"schedule": {
  "deliveryDateTimeStart": "2020-01-01T00:20:00.000Z",
  "deliveryDateTimeEnd": "2020-01-01T01:20:00.000Z"
}

Scenario examples

1. Immediate delivery with offline payment (credit card)

{
  "id": "4934a1e8-2071-4ac7-9ff6-6e634bb6008d",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "9843",
  "createdAt": "2024-03-20T14:33:08.052Z",
  "isTest": true,
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "122",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 4050",
      "localizer": "89121704",
      "localizerExpiration": "2024-03-20T18:33:08.052Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 3,
      "weight": {
        "unit": "GRAMS",
        "value": 2250
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 200
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 323.99,
    "methods": [
      {
        "value": 323.99,
        "currency": "BRL",
        "method": "CREDIT",
        "prepaid": false,
        "type": "OFFLINE"
      }
    ]
  },
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-04-01T15:18:04.801Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

2. Immediate delivery with online payment (already paid)

{
  "id": "63ec432e-4f0d-4097-b4fe-11bc2dac14af",
  "orderType": "DELIVERY",
  "orderTiming": "IMMEDIATE",
  "displayId": "1728",
  "createdAt": "2024-04-01T15:18:04.801Z",
  "isTest": true,
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "0",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 4050",
      "localizer": "83984177",
      "localizerExpiration": "2024-04-01T19:18:04.801Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1
    },
    {
      "index": 2,
      "quantity": 1
    }
  ],
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-04-01T15:18:04.801Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

3. Scheduled delivery with cash payment (with change)

{
  "id": "5076514a-2ad1-49fe-b38c-e849b4cbeaab",
  "orderType": "DELIVERY",
  "orderTiming": "SCHEDULED",
  "displayId": "9305",
  "createdAt": "2024-01-08T20:44:42.547Z",
  "isTest": false,
  "schedule": {
    "deliveryDateTimeStart": "2024-01-16T18:00:00.000Z",
    "deliveryDateTimeEnd": "2024-01-16T18:30:00.000Z"
  },
  "merchant": {
    "id": "b0954b6b-f99c-44b6-ba1e-987f32b2b22a",
    "name": "Teste - murilogontijo",
    "merchantAddress": {
      "country": "BR",
      "state": "AC",
      "city": "Bujari",
      "district": "Bujari",
      "street": "Ramal Bujari",
      "number": "122",
      "postalCode": "12345678",
      "latitude": -9.822384,
      "longitude": -67.948589
    }
  },
  "customer": {
    "name": "PEDIDO DE TESTE - Murilo Gontijo",
    "phone": {
      "number": "0800 705 3040",
      "localizer": "75159000",
      "localizerExpiration": "2024-01-09T00:44:42.547Z"
    }
  },
  "items": [
    {
      "index": 1,
      "quantity": 1,
      "weight": {
        "unit": "GRAMS",
        "value": 750
      }
    },
    {
      "index": 2,
      "quantity": 1,
      "weight": {
        "unit": "LITERS",
        "value": 2
      }
    }
  ],
  "payments": {
    "prepaid": 0,
    "pending": 103.99,
    "methods": [
      {
        "value": 103.99,
        "currency": "BRL",
        "method": "CASH",
        "prepaid": false,
        "type": "OFFLINE",
        "cash": {
          "changeFor": 150
        }
      }
    ]
  },
  "delivery": {
    "mode": "DEFAULT",
    "deliveredBy": "MERCHANT",
    "deliveryDateTime": "2024-01-08T22:14:42.547Z",
    "observations": "PEDIDO DE TESTE! NÃO ENTREGAR",
    "deliveryAddress": {
      "streetName": "Rua TESTE",
      "streetNumber": "999999",
      "formattedAddress": "Rua TESTE, 999999",
      "neighborhood": "Bairro TESTE",
      "complement": "Complemento TESTE",
      "postalCode": "99999999",
      "city": "TESTE",
      "state": "XX",
      "country": "XX",
      "reference": "TESTE",
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  }
}

Was this page helpful?

Rate your experience in the new Developer portal:

On this page

merchant.merchantAddress

1. Immediate delivery with offline payment (credit card)

2. Immediate delivery with online payment (already paid)

3. Scheduled delivery with cash payment (with change)

Content read0%