Inject order - Fire Docs

orderId

string

required

Unique order identifier from your system.

accountId

string

required

Account identifier.

account

string

Account display name.

source

string

required

Order origin. Examples: App, Kiosco.

platform

string

Client platform. Examples: Android, iOS, Web.

createdAt

string

required

Order creation timestamp. Format: YYYY-MM-DD HH:mm:ss.

channelId

string

required

Fire sales channel ID. Obtain from GET /sales-channels.

channelName

string

Channel display name.

selectedShippingMethod

string

required

Shipping method selected by the customer. Values: delivery, pickup.

accumulatePoints

boolean

Whether the customer is accumulating loyalty points on this order.

redeemPoints

boolean

Whether the customer is redeeming loyalty points on this order.

stock

boolean

Whether stock validation applies to this order.

discount

boolean

Whether discounts are applied on this order.

orderComment

string

General comment from the customer for the entire order.

client

object

required

Customer information.

Show client

uid

string

Customer’s unique identifier from the authentication provider.

name

string

required

First name.

lastName

string

Last name.

phone

string

Phone number.

string

Email address.

govIdType

string

Government ID type. Example: DNI, CI.

govIdNumber

string

Government ID number.

externalId

string

Customer ID in an external system.

string

Customer ID in Fire.

billingInformation

object

Billing details.

Show billingInformation

businessName

string

Business or person name for the invoice.

govIdType

string

Government ID type for billing.

govIdNumber

string

Government ID number for billing.

phone

string

Billing phone number.

string

Billing email.

address

string

Billing address.

externalId

string

Billing ID in an external system.

string

Billing ID in Fire.

additionalInfo

object

Extra customer data (e.g. birthdate, gender).

store

object

required

Store where the order is placed.

Show store

integer

required

Store ID.

name

string

Store display name.

code

string

Store code.

vendorId

integer

Brand identifier.

vendorName

string

Brand name.

latitude

string

Store latitude.

longitude

string

Store longitude.

order

object

required

Order contents.

Show order

products

object[]

required

Ordered products.

Show products[n]

productId

string

required

Product identifier.

product

string

Product display name.

quantity

integer

required

Quantity ordered.

productComment

string

Customer comment for this product.

rewardId

string

Reward or coupon applied to this product.

price

object

Pricing breakdown.

Show price

unitPrice

object

Price per unit. See price object fields below.

totalPrice

object

Total price for quantity. Same structure as unitPrice.

modifierGroups

object[]

Selected modifier groups.

Show modifierGroups[n]

string

Modifier group ID.

description

string

Modifier group description.

selectedModifiers

object[]

Chosen modifier options.

Show selectedModifiers[n]

answerId

string

Answer/option ID.

productId

string

Product used as this modifier option.

product

string

Modifier option name.

quantity

integer

Added quantity.

removedQuantity

integer

Removed quantity (for ingredient removal).

rewardId

string

Reward applied to this modifier.

price

object

Modifier pricing. Same structure as product price.

modifierGroups

object[]

Nested modifier groups (up to 3 levels).

additionalInfo

object

Extra product metadata.

stock

object[]

Stock information for products in this order.

Show stock[n]

productId

string

Product identifier.

stock

integer

Available stock quantity.

shippingMethod

object

required

Shipping details depending on selectedShippingMethod.

Show shippingMethod

delivery

object

Delivery details. Present when selectedShippingMethod is delivery.

Show delivery

deliveryDate

string

Estimated delivery date/time.

latitude

string

Delivery address latitude.

longitude

string

Delivery address longitude.

country

string

Country.

city

string

City.

mainStreet

string

Main street address.

number

string

Street number.

secondaryStreet

string

Cross street or secondary address.

reference

string

Delivery reference or landmark.

propertyId

integer

Property type ID.

observationsAddress

string

Delivery instructions.

numberContactAddress

string

Contact number at delivery address.

zipCode

string

ZIP or postal code.

nickName

string

Address nickname (e.g. “home”, “office”).

externalId

string

Address ID in external system.

string

Address ID in Fire.

driverArrivalDateInStore

string

ISO 8601 timestamp when driver arrived at store.

additionalInfo

object

Extra delivery data (e.g. confirmation code).

pickup

object

Pickup details. Present when selectedShippingMethod is pickup.

Show pickup

pickupDate

string

Scheduled pickup date/time.

prepDate

string

Preparation start date/time.

prepTimeUnit

string

Preparation time unit. Example: minute.

prepTime

integer

Preparation time value.

propertyId

integer

Property type ID.

carryOutOptions

string

Carry-out option label.

contactMethods

object[]

Contact methods for pickup notification.

Show contactMethods[n]

type

string

Contact type: pager, sms, whatsapp.

identifier

string

Identifier (for pager).

countryCode

string

Phone country code.

phoneNumber

string

Phone number.

payments

object

required

Payment breakdown.

Show payments

totals

object[]

Order totals with tax and discount breakdown. Each entry is a price object with currencyCode, subtotalWithoutTaxes, discountPercentage, discountsValue, subtotalIncludeDiscounts, taxesPercentage, taxValue, total, and optionally rewardId.

shippingCost

object[]

Shipping cost line items.

extraCharges

object[]

Additional charges such as tips or packing costs.

Show extraCharges[n]

quantity

integer

Quantity.

productId

string

Associated product ID, if any.

description

string

Charge description (e.g. tip, packing cost).

currencyCode

string

Currency code.

subtotalWithoutTaxes

string

Amount before taxes.

taxValue

string

Tax amount.

total

string

Total including taxes.

discounts

object[]

Itemized discount entries per product and reward.

taxes

object[]

Tax summary entries.

Show taxes[n]

name

string

Tax name (e.g. IVA 15%).

currencyCode

string

Currency code.

subtotalWithoutTaxes

string

Taxable base amount.

percentage

string

Tax percentage.

total

string

Total tax amount.

paymentMethods

object[]

Payment methods used.

Show paymentMethods[n]

processor

string

Payment processor name (e.g. Kushki, Efectivo).

currencyCode

string

Currency code.

paymentMethodCode

string

Payment method code.

transactionType

string

Transaction type (e.g. credit).

transactionId

string

Transaction identifier.

transactionStatus

string

Transaction status (e.g. APPROVED).

exactPayment

boolean

Whether exact payment was provided.

totalBill

string

Amount charged with this method.

acquirer

object

Acquiring bank details.

card

object

Card details (mask, bin, last four digits, brand, holder).

transactionDate

object

Transaction date with timezone info.

metadata

object

Processor-specific metadata.

marketing

object

Loyalty and coupon information.

Show marketing

loyalty

object

Loyalty points accumulation and redemption breakdown.

Show loyalty

accumulation

object

Points earned: storeCost, marketingCost, totalPoints.

redemption

object

Points redeemed: storeCost, marketingCost, totalPoints.

accountBalancePoints

string

Customer’s current point balance.

coupons

object[]

Coupons and rewards applied.

Show coupons[n]

rewardId

string

Reward identifier.

name

string

Reward display name.

additionalInfo

object

Extra reward data.

additionalInfo

object

Extra order-level metadata (e.g. kiosk IP address).

Price object

The following fields appear in price objects throughout the payload (unitPrice, totalPrice):

Field	Type	Description
`currencyCode`	string	ISO 4217 currency code (e.g. `USD`)
`totalBeforeSale`	string	Price before any sale pricing
`subtotalWithoutTaxes`	string	Subtotal excluding taxes
`discountPercentage`	string	Discount percentage applied
`discountsValue`	string	Discount amount
`subtotalIncludeDiscounts`	string	Subtotal after discounts, before taxes
`taxesPercentage`	string	Tax percentage
`taxValue`	string	Tax amount
`total`	string	Final total
`suggestedPrice`	string	Original suggested price

{
  "orderId": "0000012194-081101",
  "accountId": "10",
  "account": "Fire App",
  "source": "App",
  "platform": "Android",
  "createdAt": "2022-11-02 08:14:00",
  "channelId": "1",
  "channelName": "Domicilio App",
  "selectedShippingMethod": "delivery",
  "accumulatePoints": true,
  "redeemPoints": false,
  "stock": false,
  "discount": false,
  "orderComment": "No onions please",
  "client": {
    "uid": "Bwsyaszx36b5UXXdqFDFBi6ki7j1",
    "name": "Jane",
    "lastName": "Doe",
    "phone": "0972241639",
    "email": "jane.doe@example.com",
    "govIdType": "DNI",
    "govIdNumber": "1751930486",
    "id": "402399"
  },
  "store": {
    "id": 10,
    "name": "Gran Santa Fe",
    "code": "T001",
    "vendorId": 8,
    "vendorName": "Blue Co",
    "latitude": "-2.32423423",
    "longitude": "-80.21312312"
  },
  "order": {
    "products": [
      {
        "productId": "991117",
        "product": "Classic Burger",
        "quantity": 1,
        "price": {
          "unitPrice": {
            "currencyCode": "USD",
            "subtotalWithoutTaxes": "7.7826",
            "discountPercentage": "0.0000",
            "discountsValue": "0.0000",
            "subtotalIncludeDiscounts": "7.7826",
            "taxesPercentage": "15.0000",
            "taxValue": "1.1739",
            "total": "8.9900",
            "suggestedPrice": "8.9900"
          },
          "totalPrice": {
            "currencyCode": "USD",
            "subtotalWithoutTaxes": "7.7826",
            "discountPercentage": "0.0000",
            "discountsValue": "0.0000",
            "subtotalIncludeDiscounts": "7.7826",
            "taxesPercentage": "15.0000",
            "taxValue": "1.1739",
            "total": "8.9900",
            "suggestedPrice": "8.9900"
          }
        },
        "modifierGroups": [],
        "additionalInfo": {}
      }
    ],
    "stock": []
  },
  "shippingMethod": {
    "delivery": {
      "deliveryDate": "2022-11-02 08:45:00",
      "latitude": "-2.2244266",
      "longitude": "-80.9044868",
      "country": "Ecuador",
      "city": "Guayaquil",
      "mainStreet": "Av. Principal 123",
      "reference": "Grey house",
      "zipCode": "090101"
    }
  },
  "payments": {
    "totals": [
      {
        "currencyCode": "USD",
        "subtotalWithoutTaxes": "7.7826",
        "discountPercentage": "0.0000",
        "discountsValue": "0.0000",
        "subtotalIncludeDiscounts": "7.7826",
        "taxesPercentage": "15.0000",
        "taxValue": "1.1739",
        "total": "8.9900"
      }
    ],
    "shippingCost": [],
    "extraCharges": [],
    "discounts": [],
    "taxes": [
      {
        "name": "IVA 15%",
        "currencyCode": "USD",
        "subtotalWithoutTaxes": "7.7826",
        "percentage": "15.0000",
        "total": "1.1739"
      }
    ],
    "paymentMethods": [
      {
        "processor": "Kushki",
        "currencyCode": "USD",
        "paymentMethodCode": "2",
        "transactionType": "credit",
        "transactionId": "049258058662543450",
        "transactionStatus": "APPROVED",
        "exactPayment": true,
        "totalBill": "8.9900"
      }
    ]
  },
  "additionalInfo": {}
}

{
  "id": "fire_order_abc",
  "orderId": "0000012194-081101",
  "status": "received",
  "createdAt": "2025-01-15T14:30:00Z"
}

API

​Price object

Price object