Orders

Endpoint

Order retrieval and search across editions with filtering by status, customer, and date.

List orders

GET

https://api.preo.dev

/v1/orders

List orders from accessible editions. Requires at least one of edition_id, organization_id, or customer_id to be provided. Filter by edition_id to see orders from a specific edition, by organization_id to see orders from all editions in an organization, or by customer_id to see orders from a specific customer across all accessible editions.

List orders › query Parameters

created_after

string · date-time

Filter orders created after this datetime (ISO 8601 format)

created_before

string · date-time

Filter orders created before this datetime (ISO 8601 format)

customer_email

string

Search by customer email (case-insensitive, partial match)

customer_id

string

Filter by customer user ID (e.g., usr_...). Returns orders from all accessible editions.

customer_phone

string

Search by customer phone number (case-insensitive, partial match)

edition_id

string

Filter by specific edition (e.g., edt_...)

order_number

string

Search by order number (case-insensitive, partial match)

ordering

string[] · style: form

Order results by field (prefix with - for descending)

created - Created
-created - Created (descending)
modified - Modified
-modified - Modified (descending)
order_number - Order number
-order_number - Order number (descending)
status - Status
-status - Status (descending)
type - Type
-type - Type (descending)
amount - Amount
-amount - Amount (descending)

Enum values:

-amount

-created

-modified

-order_number

-status

-type

amount

created

organization_id

string

Filter by organization (e.g., org_...). Returns orders from all editions in the organization.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page (default: 100).

search

string

Combined search across order number, order ID, customer email, customer phone, and transaction ID

status

string · enum

Filter by order status: pending, confirmed, completed, cancelled

pending - Pending
confirmed - Confirmed
completed - Completed
cancelled - Cancelled

Enum values:

cancelled

completed

confirmed

pending

transaction_id

string

Filter by transaction ID (e.g., trx_...)

type

string · enum

Filter by order type: online, in-person, imported

online - Online
in-person - In Person
imported - Imported

Enum values:

imported

in-person

online

List orders › Responses

200

count

integer · required

object[] · required

next

string · uri

previous

string · uri

GET/v1/orders

curl --request GET \
  --url https://api.preo.dev/v1/orders

shell

Example Responses

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "id",
      "order_number": "order_number",
      "type": "online",
      "status": "pending",
      "edition": {
        "id": "id",
        "full_name": "full_name",
        "slug": "slug",
        "start_date": "2024-08-25T15:00:00Z",
        "end_date": "2024-08-25T15:00:00Z",
        "timezone": "timezone",
        "is_draft": true,
        "published_at": "2024-08-25T15:00:00Z"
      },
      "amount": 0,
      "currency": "eur",
      "customer_name": "customer_name",
      "customer_email": "customer_email",
      "items_count": 0,
      "has_payment": true,
      "created": "2024-08-25T15:00:00Z",
      "modified": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Retrieve order details

GET

https://api.preo.dev

/v1/orders/{id}

Get detailed information about a specific order, including transactions and purchases.

Retrieve order details › path Parameters

id

string · required

A unique value identifying this Order.

Retrieve order details › Responses

200

Full order serializer for detail view.

id

string · readOnly · required

object · readOnly · required

Light readonly serializer for embedding in other resources.

amount

number · double · min: 0 · readOnly · required

currency

string · enum · readOnly · required

eur - EUR
usd - USD
gbp - GBP
pln - PLN
dkk - DKK
sek - SEK
nok - NOK

Enum values:

eur

usd

gbp

pln

dkk

sek

nok

readOnly · required

object · readOnly · required

Detailed user serializer with full customer profile

object[] · readOnly · required

completed_transaction_id

string | null · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

order_number

string | null · maxLength: 16

type

string · enum

online - Online
in-person - In Person
imported - Imported

Enum values:

online

in-person

imported

status

string · enum

pending - Pending
confirmed - Confirmed
completed - Completed
cancelled - Cancelled

Enum values:

pending

confirmed

completed

cancelled

metadata

GET/v1/orders/{id}

curl --request GET \
  --url https://api.preo.dev/v1/orders/:id

shell

Example Responses

{
  "id": "id",
  "order_number": "order_number",
  "type": "online",
  "status": "pending",
  "organization": {
    "id": "id",
    "name": "name",
    "slug": "slug",
    "avatar": {
      "thumbnail": "https://www.example.com/path/to/resource",
      "optimized": "https://www.example.com/path/to/resource",
      "large": "https://www.example.com/path/to/resource",
      "original": "https://www.example.com/path/to/resource"
    }
  },
  "edition": {
    "id": "id",
    "full_name": "full_name",
    "slug": "slug",
    "start_date": "2024-08-25T15:00:00Z",
    "end_date": "2024-08-25T15:00:00Z",
    "timezone": "timezone",
    "is_draft": true,
    "published_at": "2024-08-25T15:00:00Z"
  },
  "amount": 0,
  "currency": "eur",
  "cart": {
    "id": "id",
    "status": "created",
    "items": [
      {
        "id": "id",
        "product": {
          "api_id": "api_id",
          "name": "name",
          "is_draft": true,
          "images": [
            {
              "thumbnail": "https://www.example.com/path/to/resource",
              "optimized": "https://www.example.com/path/to/resource",
              "large": "https://www.example.com/path/to/resource",
              "original": "https://www.example.com/path/to/resource"
            }
          ]
        },
        "variant": {
          "api_id": "api_id",
          "name": "name"
        },
        "location": {
          "api_id": "api_id",
          "name": "name",
          "is_draft": true
        },
        "quantity": 0,
        "options": [
          {
            "api_id": "api_id",
            "name": "name",
            "price_mod": 0,
            "deposit_mod": 0
          }
        ],
        "price_with_options": 0,
        "deposit_with_options": 0,
        "handling_fee": 0
      }
    ],
    "coupon_code": "coupon_code",
    "subtotal": 0,
    "deposit": 0,
    "handling_fee": 0,
    "service_fee": 0,
    "discount": 0,
    "tax": 0,
    "total": 0,
    "summary": {
      "summary_lines": [
        {
          "key": "key",
          "label": "label",
          "amount": 0,
          "formatted": "formatted",
          "is_negative": true,
          "is_total": true,
          "note": "note"
        }
      ],
      "currency": "currency"
    },
    "created": "2024-08-25T15:00:00Z"
  },
  "customer": {
    "api_id": "api_id",
    "full_name": "full_name",
    "email": "test@example.com",
    "phone_number": "phone_number",
    "date_joined": "2024-08-25T15:00:00Z",
    "last_seen": "2024-08-25T15:00:00Z",
    "metadata": {}
  },
  "transactions": [
    {
      "id": "id",
      "type": "online",
      "status": "pending",
      "service": "service",
      "amount": 0,
      "currency": "eur",
      "service_fee": 0,
      "handling_fee": 0,
      "refunded_amount": 0,
      "available_refund_amount": 0,
      "created": "2024-08-25T15:00:00Z"
    }
  ],
  "purchases": [
    {
      "id": "id",
      "vendor_code": "vendor_code",
      "status": "paid",
      "product": {
        "api_id": "api_id",
        "name": "name",
        "is_draft": true,
        "images": [
          {
            "thumbnail": "https://www.example.com/path/to/resource",
            "optimized": "https://www.example.com/path/to/resource",
            "large": "https://www.example.com/path/to/resource",
            "original": "https://www.example.com/path/to/resource"
          }
        ]
      },
      "variant": {
        "api_id": "api_id",
        "name": "name"
      },
      "location": {
        "api_id": "api_id",
        "name": "name",
        "is_draft": true
      },
      "options": [
        {
          "api_id": "api_id",
          "name": "name",
          "price_mod": 0,
          "deposit_mod": 0
        }
      ],
      "user": {
        "api_id": "api_id",
        "full_name": "full_name",
        "email": "test@example.com"
      },
      "price_paid": 0,
      "deposit_paid": 0,
      "handling_fee_paid": 0,
      "max_available_refund_amount": 0,
      "available_uses": 0,
      "is_unlimited_use": true,
      "created": "2024-08-25T15:00:00Z",
      "modified": "2024-08-25T15:00:00Z"
    }
  ],
  "completed_transaction_id": "completed_transaction_id",
  "metadata": {},
  "created": "2024-08-25T15:00:00Z",
  "modified": "2024-08-25T15:00:00Z"
}

json

application/json

Editions Purchases

List orders

GET

https://api.preo.dev

/v1/orders

List orders › query Parameters

created_after

string · date-time

Filter orders created after this datetime (ISO 8601 format)

created_before

string · date-time

Filter orders created before this datetime (ISO 8601 format)

customer_email

string

Search by customer email (case-insensitive, partial match)

customer_id

string

Filter by customer user ID (e.g., usr_...). Returns orders from all accessible editions.

customer_phone

string

Search by customer phone number (case-insensitive, partial match)

edition_id

string

Filter by specific edition (e.g., edt_...)

order_number

string

Search by order number (case-insensitive, partial match)

ordering

string[] · style: form

Order results by field (prefix with - for descending)

created - Created
-created - Created (descending)
modified - Modified
-modified - Modified (descending)
order_number - Order number
-order_number - Order number (descending)
status - Status
-status - Status (descending)
type - Type
-type - Type (descending)
amount - Amount
-amount - Amount (descending)

Enum values:

-amount

-created

-modified

-order_number

-status

-type

amount

created

organization_id

string

Filter by organization (e.g., org_...). Returns orders from all editions in the organization.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page (default: 100).

search

string

Combined search across order number, order ID, customer email, customer phone, and transaction ID

status

string · enum

Filter by order status: pending, confirmed, completed, cancelled

pending - Pending
confirmed - Confirmed
completed - Completed
cancelled - Cancelled

Enum values:

cancelled

completed

confirmed

pending

transaction_id

string

Filter by transaction ID (e.g., trx_...)

type

string · enum

Filter by order type: online, in-person, imported

online - Online
in-person - In Person
imported - Imported

Enum values:

imported

in-person

online

List orders › Responses

200

count

integer · required

object[] · required

next

string · uri

previous

string · uri

Retrieve order details

GET

https://api.preo.dev

/v1/orders/{id}

Get detailed information about a specific order, including transactions and purchases.

Retrieve order details › path Parameters

id

string · required

A unique value identifying this Order.

Retrieve order details › Responses

200

Full order serializer for detail view.

id

string · readOnly · required

object · readOnly · required

Light readonly serializer for embedding in other resources.

amount

number · double · min: 0 · readOnly · required

currency

string · enum · readOnly · required

eur - EUR
usd - USD
gbp - GBP
pln - PLN
dkk - DKK
sek - SEK
nok - NOK

Enum values:

eur

usd

gbp

pln

dkk

sek

nok

readOnly · required

object · readOnly · required

Detailed user serializer with full customer profile

object[] · readOnly · required

completed_transaction_id

string | null · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

order_number

string | null · maxLength: 16

type

string · enum

online - Online
in-person - In Person
imported - Imported

Enum values:

online

in-person

imported

status

string · enum

pending - Pending
confirmed - Confirmed
completed - Completed
cancelled - Cancelled

Enum values:

pending

confirmed

completed

cancelled

metadata