Service

Endpoint

Service-to-service integration endpoints. Authenticated with a service access token.

Look up a user's wallet by email

POST

https://edge.preo.cloud

/api/wallet/service/customer/lookup

Look up a user's wallet by email › query Parameters

edition_id

string

When set, the response arrays (purchases/orders/passes) are filtered to this edition.

include

string

Comma-separated list of sections to include: user, purchases, orders, passes, centrifugo. Defaults to all.

order_status

string

In-memory filter: keep only orders with this status.

purchase_status

string

In-memory filter: keep only purchases with this status.

Look up a user's wallet by email › Request Body

email

string · email · required

org_id

string

Look up a user's wallet by email › Responses

object · required

object[] · required

object · required

POST/api/wallet/service/customer/lookup

curl --request POST \
  --url https://edge.preo.cloud/api/wallet/service/customer/lookup \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com",
  "org_id": "org_id"
}
'

shell

Example Request Body

{
  "email": "test@example.com",
  "org_id": "org_id"
}

json

Example Responses

{
  "user": {
    "id": "id",
    "email": "test@example.com",
    "first_name": "first_name",
    "last_name": "last_name",
    "phone_number": "phone_number",
    "locale": "locale"
  },
  "purchases": [
    {
      "id": "id",
      "edition": "edition",
      "edition_id": "edition_id",
      "order_id": "order_id",
      "transaction_id": "transaction_id",
      "product": "product",
      "product_type": "product_type",
      "variant": "variant",
      "variant_metadata": {},
      "options": [
        "string"
      ],
      "code": "code",
      "metadata": {},
      "status": "paid",
      "available_uses": 0,
      "available_uses_today": 0,
      "is_unlimited_use": true,
      "price_paid": 0,
      "deposit_paid": 0,
      "handling_fee_paid": 0,
      "purchased_date": "2024-08-25T15:00:00Z",
      "vendor_code": "vendor_code"
    }
  ],
  "orders": [
    {
      "id": "id",
      "edition": "edition",
      "edition_id": "edition_id",
      "order_number": "order_number",
      "type": "online",
      "status": "pending",
      "amount": 0,
      "currency": "eur",
      "created": "2024-08-25T15:00:00Z",
      "created_display": "created_display",
      "cart": {
        "id": "id",
        "status": "created",
        "subtotal": 0,
        "handling_fee": 0,
        "service_fee": 0,
        "discount": 0,
        "tax": 0,
        "total": 0,
        "currency": "currency",
        "coupon": {
          "id": "id",
          "code": "codeaa",
          "type": "regular",
          "metadata": {}
        },
        "items": [
          {
            "product": {
              "id": "id",
              "name": "name",
              "vendor": {
                "id": "id",
                "name": "name"
              },
              "product_type": "product_type",
              "metadata": {},
              "image_url": "image_url"
            },
            "variant": {
              "id": "id",
              "name": "name",
              "metadata": {}
            },
            "options": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "location": {
              "id": "id",
              "name": "name"
            },
            "quantity": 0,
            "price": 0,
            "deposit": 0,
            "packaging_deposit": 0,
            "total": 0
          }
        ],
        "metadata": {}
      },
      "purchase_ids": [
        "string"
      ],
      "transactions": [
        {
          "id": "id",
          "status": "pending",
          "service": "service",
          "amount": 0,
          "currency": "eur",
          "service_fee": 0,
          "handling_fee": 0,
          "created": "2024-08-25T15:00:00Z"
        }
      ],
      "metadata": {}
    }
  ],
  "passes": [
    {
      "id": "id",
      "edition": "edition",
      "edition_id": "edition_id",
      "contents": "customer_card",
      "serial_number": "serial_number",
      "apple_url": "apple_url",
      "google_url": "google_url",
      "design": {
        "id": "id",
        "name": "name"
      }
    }
  ],
  "centrifugo": {
    "ws_url": "https://www.example.com/path/to/resource",
    "channel": "channel",
    "token": "token"
  },
  "_metadata": {
    "served_from": "cache",
    "served_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Look up a user's wallet by their ID

GET

https://edge.preo.cloud

/api/wallet/service/users/{user_id}

Look up a user's wallet by their ID › path Parameters

user_id

string · required

Look up a user's wallet by their ID › query Parameters

edition_id

string

When set, the response arrays (purchases/orders/passes) are filtered to this edition.

include

string

Comma-separated list of sections to include: user, purchases, orders, passes, centrifugo. Defaults to all.

order_status

string

In-memory filter: keep only orders with this status.

purchase_status

string

In-memory filter: keep only purchases with this status.

Look up a user's wallet by their ID › Responses

200

object · required

object[] · required

object · required

GET/api/wallet/service/users/{user_id}

curl --request GET \
  --url https://edge.preo.cloud/api/wallet/service/users/:user_id

shell

Example Responses

{
  "user": {
    "id": "id",
    "email": "test@example.com",
    "first_name": "first_name",
    "last_name": "last_name",
    "phone_number": "phone_number",
    "locale": "locale"
  },
  "purchases": [
    {
      "id": "id",
      "edition": "edition",
      "edition_id": "edition_id",
      "order_id": "order_id",
      "transaction_id": "transaction_id",
      "product": "product",
      "product_type": "product_type",
      "variant": "variant",
      "variant_metadata": {},
      "options": [
        "string"
      ],
      "code": "code",
      "metadata": {},
      "status": "paid",
      "available_uses": 0,
      "available_uses_today": 0,
      "is_unlimited_use": true,
      "price_paid": 0,
      "deposit_paid": 0,
      "handling_fee_paid": 0,
      "purchased_date": "2024-08-25T15:00:00Z",
      "vendor_code": "vendor_code"
    }
  ],
  "orders": [
    {
      "id": "id",
      "edition": "edition",
      "edition_id": "edition_id",
      "order_number": "order_number",
      "type": "online",
      "status": "pending",
      "amount": 0,
      "currency": "eur",
      "created": "2024-08-25T15:00:00Z",
      "created_display": "created_display",
      "cart": {
        "id": "id",
        "status": "created",
        "subtotal": 0,
        "handling_fee": 0,
        "service_fee": 0,
        "discount": 0,
        "tax": 0,
        "total": 0,
        "currency": "currency",
        "coupon": {
          "id": "id",
          "code": "codeaa",
          "type": "regular",
          "metadata": {}
        },
        "items": [
          {
            "product": {
              "id": "id",
              "name": "name",
              "vendor": {
                "id": "id",
                "name": "name"
              },
              "product_type": "product_type",
              "metadata": {},
              "image_url": "image_url"
            },
            "variant": {
              "id": "id",
              "name": "name",
              "metadata": {}
            },
            "options": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "location": {
              "id": "id",
              "name": "name"
            },
            "quantity": 0,
            "price": 0,
            "deposit": 0,
            "packaging_deposit": 0,
            "total": 0
          }
        ],
        "metadata": {}
      },
      "purchase_ids": [
        "string"
      ],
      "transactions": [
        {
          "id": "id",
          "status": "pending",
          "service": "service",
          "amount": 0,
          "currency": "eur",
          "service_fee": 0,
          "handling_fee": 0,
          "created": "2024-08-25T15:00:00Z"
        }
      ],
      "metadata": {}
    }
  ],
  "passes": [
    {
      "id": "id",
      "edition": "edition",
      "edition_id": "edition_id",
      "contents": "customer_card",
      "serial_number": "serial_number",
      "apple_url": "apple_url",
      "google_url": "google_url",
      "design": {
        "id": "id",
        "name": "name"
      }
    }
  ],
  "centrifugo": {
    "ws_url": "https://www.example.com/path/to/resource",
    "channel": "channel",
    "token": "token"
  },
  "_metadata": {
    "served_from": "cache",
    "served_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

User

Look up a user's wallet by email

POST

https://edge.preo.cloud

/api/wallet/service/customer/lookup

Look up a user's wallet by email › query Parameters

edition_id

string

When set, the response arrays (purchases/orders/passes) are filtered to this edition.

include

string

Comma-separated list of sections to include: user, purchases, orders, passes, centrifugo. Defaults to all.

order_status

string

In-memory filter: keep only orders with this status.

purchase_status

string

In-memory filter: keep only purchases with this status.

Look up a user's wallet by email › Request Body

email

string · email · required

org_id

string

Look up a user's wallet by email › Responses

object · required

object[] · required

object · required

Look up a user's wallet by their ID

GET

https://edge.preo.cloud

/api/wallet/service/users/{user_id}

Look up a user's wallet by their ID › path Parameters

user_id

string · required

Look up a user's wallet by their ID › query Parameters

edition_id

string

When set, the response arrays (purchases/orders/passes) are filtered to this edition.

include

string

Comma-separated list of sections to include: user, purchases, orders, passes, centrifugo. Defaults to all.

order_status

string

In-memory filter: keep only orders with this status.

purchase_status

string

In-memory filter: keep only purchases with this status.

Look up a user's wallet by their ID › Responses

200

object · required

object[] · required

object · required