PRprivy
Orders

Get an order

Changed on

Retrieve a single order by its order id — the identifier assigned by the order's source (your store platform, or the order_id you sent to POST /v1/orders/placed).

Order ids are unique per source. In the rare case two sources share an id, the most recently created order is returned.

A /v1/orders row already carries the whole order, so this is for an id that came from somewhere else rather than a follow-up read.

Required scope: orders_read

get/orders/{order_id}

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Path parameters

order_idinteger required

The order's source-assigned id (returned as order_id in order responses).

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

The order.

Example response

{
  "data": {
    "order_id": 1001,
    "source": "api",
    "email": "buyer@example.com",
    "phone": "+12025550123",
    "total_amount": "95.00",
    "currency_code": "USD",
    "placed_at": "2026-06-01T12:00:00Z",
    "financial_status": "paid",
    "fulfillment_status": "fulfilled",
    "shipment_status": "in_transit",
    "subtotal": 90,
    "discounts": [
      {
        "code": "SAVE10",
        "amount": 10
      }
    ],
    "tax_lines": [
      {
        "title": "VAT",
        "amount": 5
      }
    ],
    "total_items": 2,
    "line_items": [
      {
        "sku": "SKU-1",
        "title": "Sample Product",
        "quantity": 2
      }
    ],
    "billing_address": {
      "first_name": "Jane",
      "last_name": "Shopper",
      "name": "Jane Shopper",
      "address1": "123 Main St",
      "address2": "Apt 101",
      "city": "Boston",
      "state_code": "MA",
      "country_code": "US",
      "postal_code": "02118"
    },
    "shipping_address": {
      "first_name": "Jane",
      "last_name": "Shopper",
      "name": "Jane Shopper",
      "address1": "123 Main St",
      "address2": "Apt 101",
      "city": "Boston",
      "state_code": "MA",
      "country_code": "US",
      "postal_code": "02118"
    },
    "accepts_email_marketing": true,
    "accepts_sms_marketing": true,
    "integration": {
      "store_name": "My Store",
      "store_url": "https://mystore.example.com"
    },
    "created_at": "2026-06-01T12:00:05Z",
    "updated_at": "2026-06-01T12:00:05Z"
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

  • fe500ab59b3bRevision changes
    • info

      endpoint added