Square · Example Payload

Order Example

RestaurantBookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks

Order Example is an example object payload from Square, with 29 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idlocation_idreference_idsourcecustomer_idline_itemstaxesdiscountsservice_chargesfulfillmentsreturnsreturn_amountsnet_amountsrounding_adjustmenttendersrefundsmetadatacreated_atupdated_atclosed_atstateversiontotal_moneytotal_tax_moneytotal_discount_moneytotal_tip_moneytotal_service_charge_moneyticket_namepricing_options

Example Payload

{
  "id": "A1B2C3D4E5F6",
  "location_id": "A1B2C3D4E5F6",
  "reference_id": "A1B2C3D4E5F6",
  "source": {
    "name": "Annie\u2019s Hot Sauce"
  },
  "customer_id": "A1B2C3D4E5F6",
  "line_items": [
    {
      "uid": "sample-value",
      "name": "Annie\u2019s Hot Sauce",
      "quantity": "sample-value",
      "catalog_object_id": "A1B2C3D4E5F6",
      "catalog_version": 221,
      "variation_name": "sample-value",
      "note": "Sample Square record.",
      "base_price_money": {
        "amount": 25595,
        "currency": "USD"
      },
      "gross_sales_money": {
        "amount": 13235,
        "currency": "USD"
      },
      "total_tax_money": {
        "amount": 44986,
        "currency": "USD"
      },
      "total_discount_money": {
        "amount": 38531,
        "currency": "USD"
      },
      "total_money": {
        "amount": 24997,
        "currency": "USD"
      },
      "applied_taxes": [
        {}
      ],
      "applied_discounts": [
        {}
      ],
      "item_type": "ITEM",
      "metadata": {}
    }
  ],
  "taxes": [
    {
      "uid": "sample-value",
      "catalog_object_id": "A1B2C3D4E5F6",
      "name": "Annie\u2019s Hot Sauce",
      "type": "UNKNOWN_TAX",
      "percentage": "sample-value",
      "scope": "OTHER_TAX_SCOPE",
      "applied_money": {
        "amount": 7656,
        "currency": "USD"
      }
    },
    {
      "uid": "sample-value",
      "catalog_object_id": "A1B2C3D4E5F6",
      "name": "Annie\u2019s Hot Sauce",
      "type": "UNKNOWN_TAX",
      "percentage": "sample-value",
      "scope": "LINE_ITEM",
      "applied_money": {
        "amount": 1914,
        "currency": "USD"
      }
    }
  ],
  "discounts": [
    {
      "uid": "sample-value",
      "catalog_object_id": "A1B2C3D4E5F6",
      "name": "Annie\u2019s Hot Sauce",
      "type": "FIXED_AMOUNT",
      "percentage": "sample-value",
      "amount_money": {
        "amount": 10467,
        "currency": "USD"
      },
      "applied_money": {
        "amount": 21631,
        "currency": "USD"
      },
      "scope": "OTHER_DISCOUNT_SCOPE"
    }
  ],
  "service_charges": [
    {
      "uid": "sample-value",
      "name": "Annie\u2019s Hot Sauce",
      "catalog_object_id": "A1B2C3D4E5F6",
      "percentage": "sample-value",
      "amount_money": {
        "amount": 39667,
        "currency": "USD"
      },
      "total_money": {
        "amount": 18572,
        "currency": "USD"
      }
    },
    {
      "uid": "sample-value",
      "name": "Annie\u2019s Hot Sauce",
      "catalog_object_id": "A1B2C3D4E5F6",
      "percentage": "sample-value",
      "amount_money": {
        "amount": 45979,
        "currency": "USD"
      },
      "total_money": {
        "amount": 14066,
        "currency": "USD"
      }
    }
  ],
  "fulfillments": [
    {
      "uid": "sample-value",
      "type": "PICKUP",
      "state": "PREPARED"
    }
  ],
  "returns": [
    {}
  ],
  "return_amounts": {},
  "net_amounts": {},
  "rounding_adjustment": {},
  "tenders": [
    {}
  ],
  "refunds": [
    {},
    {}
  ],
  "metadata": {},
  "created_at": "2026-03-15T14:30:00Z",
  "updated_at": "2026-03-15T14:30:00Z",
  "closed_at": "2026-03-15T14:30:00Z",
  "state": "DRAFT",
  "version": 587,
  "total_money": {
    "amount": 46053,
    "currency": "USD"
  },
  "total_tax_money": {
    "amount": 38247,
    "currency": "USD"
  },
  "total_discount_money": {
    "amount": 40352,
    "currency": "USD"
  },
  "total_tip_money": {
    "amount": 47334,
    "currency": "USD"
  },
  "total_service_charge_money": {
    "amount": 10868,
    "currency": "USD"
  },
  "ticket_name": "sample-value",
  "pricing_options": {
    "auto_apply_discounts": true,
    "auto_apply_taxes": false
  }
}