Orders

Retrieve a list of orders

Changed on

Retrieve a list of orders for the admin dashboard.

get/admin/orders

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/admin/orders
  • Auth: HTTP bearer

Query parameters

limitnumber nullable
pagenumber nullable
order_by'asc' | 'desc'
sort_bystring
include_archived'true' | 'false'
skip_pagination'true' | 'false'
searchstring
team_idsstring[]
start_datestring nullable
end_datestring nullable
profile_idstring uuid
status'CREATED' | 'PAID' | 'CANCELLED'
paid_orders_only'true' | 'false'
include_outlets_data'true' | 'false'

Response

Order retrieved successfully

total_pagesnumber required
current_pagenumber required
next_pagenumber nullable required
previous_pagenumber nullable required
total_recordsnumber required

Example response

{
  "records": [
    {
      "total": 121.09,
      "subtotal": 46.9,
      "processing_fee": 915.35,
      "discount": 12.79,
      "coupon": "AMAZING50",
      "client_secret": "cs_test_a1b2c3d4e5f6_secret_YvoWs3BcRC8REQSwuDDe8yg6b",
      "status": "CREATED",
      "reference_number": "PC12345678",
      "external_reference_number": "PC12345678",
      "customer_invoice_id": "INV-2024-001",
      "customer_invoice_source": "STRIPE",
      "customer_invoice_url": "https://invoice.stripe.com/i/acct_1234567/test_YWNjdF",
      "guest_email": "payer@example.com",
      "account_owner_email": "owner@example.com",
      "guest_stripe_customer_id": "cus_1234567890",
      "checkout_session_id": "cs_test_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "payment_intent_id": "pi_3PgV8XEA5tKCd21d27zsD8x",
      "payment_status": "NOT_STARTED",
      "team": {
        "name": "Team A",
        "contact_email": "contact@team.com"
      },
      "line_items": [
        {
          "quantity": 1,
          "price": 24.69,
          "source": "opportunity_card"
        }
      ],
      "checkout_link": "https://app.presscart.com/orders/checkout/PC12345678",
      "current_invoice": {
        "reference_number": "INV-20261009-7K2M9QXA",
        "source": "STRIPE",
        "url": "https://dashboard.stripe.com/payments/pi_3PgV8XEA5tKCd21d27zsD8x"
      }
    }
  ]
}

Changes