Orders

List orders

Lists the organization's orders, optionally filtered by location, touchpoint, status, and date range.

get/v1/orders

Request

  • Base URL
    https://orders-api.paymongo.com
  • URL
    https://orders-api.paymongo.com/v1/orders
  • Auth
    HTTP basic

Query parameters

location_slugstring

Filter by location slug

touchpoint_codestring

Filter by touchpoint code

statusstring

Filter by order status

fulfillment_statusstring

Filter by fulfillment status

fromstring

Start of the created-at range (ISO 8601)

tostring

End of the created-at range (ISO 8601)

limitinteger

Maximum number of orders to return (1-100)

Response

OK

has_moreboolean

Example response

{
  "data": [
    {
      "amount_subtotal": 19800,
      "amount_total": 21800,
      "billed_at": "2026-06-24 08:00:00+00:00",
      "coin_pay": {
        "coins": 76,
        "rate_version": "2026-10-12 08:00:00+00:00"
      },
      "completed_at": "2026-06-24 08:30:00+00:00",
      "created_at": "2026-06-24 07:55:00+00:00",
      "currency": "PHP",
      "custom_fees": [
        {
          "amount": 5000,
          "name": "Shipping fee"
        }
      ],
      "customer": {
        "account_id": "org_consumer123",
        "email": "juan@example.com",
        "id": "cus_abc123"
      },
      "description": "Donation | name:Juan tier:Gold",
      "fulfilled_at": "2026-10-14 09:12:00+00:00",
      "fulfilled_by": "org_abc123",
      "fulfillment_status": "pending",
      "group": {
        "expires_at": "2026-06-24 09:55:00+00:00",
        "participants": [
          {
            "email": "juan@example.com",
            "is_host": true,
            "name": "Juan Dela Cruz",
            "participant_id": "prt_abc123"
          }
        ],
        "share_url": "https://orders.paymongo.com/g/order_abc123",
        "split_mode": "split_equally"
      },
      "id": "order_abc123",
      "inventory_oversold_at": "2026-06-24 08:31:00+00:00",
      "items": [
        {
          "added_by": "prt_abc123",
          "amount": 19800,
          "description": "Chocolate, 8 inch",
          "image_snapshot": "https://files.paymongo.com/img_abc123",
          "item_id": "item_abc123",
          "name_snapshot": "Chickenjoy",
          "product_id": "prod_abc123",
          "quantity": 2,
          "unit_amount": 9900,
          "variant_id": "prdvar_abc123"
        }
      ],
      "livemode": true,
      "location_slug": "bgc-branch",
      "order_number": "001",
      "payments": [
        {
          "amount": 21800,
          "amount_charged": 22300,
          "checkout_session_id": "cs_abc123",
          "checkout_url": "https://checkout.paymongo.com/cs_abc123",
          "fee": 500,
          "paid_at": "2026-06-24 08:30:00+00:00",
          "participant_id": "prt_abc123",
          "payment_id": "pay_abc123",
          "status": "pending"
        }
      ],
      "purchase_reference": "7K3M-92QA",
      "status": "pending",
      "tips": {
        "amount": 2000,
        "resolved_amount": 2000,
        "type": "fixed"
      },
      "touchpoint_code": "table-01",
      "updated_at": "2026-06-24 07:55:00+00:00",
      "version": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.