Profiles

Retrieve a profile orders

Retrieve details of a profile orders.

get/profiles/{profile_id}/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/profiles/{profile_id}/orders
  • Auth: HTTP bearer

Path parameters

profile_idstring uuid required
Example:ba31c95d-feab-4cbf-b5a2-9b6653a37600

Query parameters

limitnumber nullable
pagenumber nullable
order_by'asc' | 'desc'
sort_bystring
include_archived'true' | 'false'
skip_pagination'true' | 'false'
start_datestring nullable
end_datestring nullable
paid_orders_only'true' | 'false'

Response

Profile Orders retrieved successfully

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

Example response

{
  "records": [
    {
      "total": 55.95,
      "subtotal": 193.65,
      "processing_fee": 878.19,
      "discount": 166.55,
      "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",
      "metadata": {
        "some_field": "decet"
      },
      "line_items": [
        {
          "quantity": 1,
          "price": 930.29
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.