Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://api.crevio.co/v1/orders \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": 123,
      "status": "succeeded",
      "prefixId": "<string>",
      "amount": 123,
      "currency": "<string>",
      "isFree": true,
      "isPaid": true,
      "isSeatOrder": true,
      "hasSubscription": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lineItems": [
        {
          "id": 123,
          "quantity": 123,
          "priceVariant": {
            "id": 123,
            "name": "<string>",
            "amount": 123,
            "currency": "<string>",
            "billingType": "one_time",
            "amountType": "<string>",
            "discountedFromAmount": 123,
            "presetAmount": 123,
            "minimumAmount": 123,
            "maximumAmount": 123,
            "recurringInterval": "<string>",
            "intervalCount": 123,
            "trialPeriodDays": 123,
            "revokeAfterDays": 123,
            "hidden": true,
            "archived": true,
            "waitlist": true,
            "position": 123,
            "prefixId": "<string>",
            "benefits": [
              "<string>"
            ],
            "seatQuantity": 123,
            "isDefault": true,
            "isPayWhatYouWant": true,
            "hasFreeTrial": true,
            "isQuantityLimited": true
          },
          "product": {
            "id": 123,
            "name": "<string>",
            "slug": "<string>",
            "status": "draft",
            "description": "<string>",
            "bodyHtml": "<string>",
            "buttonCta": "<string>",
            "prefixId": "<string>",
            "sellerAccount": {
              "id": 123,
              "name": "<string>",
              "subdomain": "<string>",
              "avatar": {
                "filename": "<string>",
                "contentType": "<string>",
                "byteSize": 123,
                "createdAt": "2023-11-07T05:31:56Z",
                "signedId": "<string>",
                "src": "<string>",
                "srcSet": "<string>"
              },
              "linkInBioPage": {
                "id": 123,
                "title": "<string>",
                "description": "<string>"
              },
              "socialLinks": [
                {
                  "id": 123,
                  "name": "<string>",
                  "url": "<string>",
                  "platform": "<string>",
                  "position": 123,
                  "active": true
                }
              ],
              "referralUrl": "<string>",
              "availableSupportEmail": "<string>"
            },
            "mediaItems": [
              {
                "id": 123,
                "sourceType": "<string>",
                "url": "<string>",
                "provider": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "file": {
                  "filename": "<string>",
                  "contentType": "<string>",
                  "byteSize": 123,
                  "createdAt": "2023-11-07T05:31:56Z",
                  "signedId": "<string>",
                  "src": "<string>",
                  "srcSet": "<string>"
                },
                "contentType": "<string>",
                "embedHtml": "<string>"
              }
            ],
            "reviews": [
              {
                "id": 123,
                "rating": 3,
                "content": "<string>",
                "customerName": "<string>",
                "customerImage": {
                  "filename": "<string>",
                  "contentType": "<string>",
                  "byteSize": 123,
                  "createdAt": "2023-11-07T05:31:56Z",
                  "signedId": "<string>",
                  "src": "<string>",
                  "srcSet": "<string>"
                },
                "position": 123,
                "prefixId": "<string>",
                "createdAt": "2023-11-07T05:31:56Z"
              }
            ],
            "seo": {
              "title": "<string>",
              "description": "<string>",
              "keywords": "<string>"
            },
            "priceVariants": [
              {
                "id": 123,
                "name": "<string>",
                "amount": 123,
                "currency": "<string>",
                "billingType": "one_time",
                "amountType": "<string>",
                "discountedFromAmount": 123,
                "presetAmount": 123,
                "minimumAmount": 123,
                "maximumAmount": 123,
                "recurringInterval": "<string>",
                "intervalCount": 123,
                "trialPeriodDays": 123,
                "revokeAfterDays": 123,
                "hidden": true,
                "archived": true,
                "waitlist": true,
                "position": 123,
                "prefixId": "<string>",
                "benefits": [
                  "<string>"
                ],
                "seatQuantity": 123,
                "isDefault": true,
                "isPayWhatYouWant": true,
                "hasFreeTrial": true,
                "isQuantityLimited": true
              }
            ],
            "url": "<string>",
            "hasMedia": true
          }
        }
      ],
      "customer": {
        "id": 123,
        "email": "jsmith@example.com",
        "name": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "customerType": "lead",
        "prefixId": "<string>",
        "ordersCount": 123,
        "totalSpend": 123,
        "tags": [
          {
            "id": 123,
            "name": "<string>"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "discount": {
        "id": 123,
        "status": "active",
        "discountType": "amount_off",
        "code": "<string>",
        "redeemBy": "2023-11-07T05:31:56Z",
        "maxRedemptions": 123,
        "timesRedeemed": 123,
        "duration": "once",
        "durationInMonths": 123,
        "amountOff": 123,
        "percentOff": 123,
        "currency": "<string>",
        "prefixId": "<string>",
        "destroyable": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "priceVariants": [
          {
            "id": 123,
            "name": "<string>",
            "amount": 123,
            "currency": "<string>",
            "billingType": "one_time",
            "amountType": "<string>",
            "discountedFromAmount": 123,
            "presetAmount": 123,
            "minimumAmount": 123,
            "maximumAmount": 123,
            "recurringInterval": "<string>",
            "intervalCount": 123,
            "trialPeriodDays": 123,
            "revokeAfterDays": 123,
            "hidden": true,
            "archived": true,
            "waitlist": true,
            "position": 123,
            "prefixId": "<string>",
            "benefits": [
              "<string>"
            ],
            "seatQuantity": 123,
            "isDefault": true,
            "isPayWhatYouWant": true,
            "hasFreeTrial": true,
            "isQuantityLimited": true
          }
        ]
      },
      "charge": {
        "id": "<string>",
        "amount": 123,
        "currency": "<string>",
        "status": "<string>",
        "receiptUrl": "<string>"
      },
      "sellerAccount": {
        "id": 123,
        "name": "<string>",
        "subdomain": "<string>",
        "avatar": {
          "filename": "<string>",
          "contentType": "<string>",
          "byteSize": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "signedId": "<string>",
          "src": "<string>",
          "srcSet": "<string>"
        },
        "linkInBioPage": {
          "id": 123,
          "title": "<string>",
          "description": "<string>"
        },
        "socialLinks": [
          {
            "id": 123,
            "name": "<string>",
            "url": "<string>",
            "platform": "<string>",
            "position": 123,
            "active": true
          }
        ],
        "referralUrl": "<string>",
        "availableSupportEmail": "<string>"
      }
    }
  ],
  "pagination": {
    "count": 123,
    "from": 123,
    "in": 123,
    "last": 123,
    "limit": 123,
    "next": 123,
    "previous": 123,
    "offset": 123,
    "page": 123,
    "pages": 123,
    "to": 123
  }
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

status
enum<string>

Filter by order status

Available options:
succeeded,
pending,
failed,
refunded,
partially_refunded
customer_id
string

Filter by customer prefix ID

expand
string

Comma-separated relations to expand: line_items, customer, discount, access_tokens, seller_account, charge

page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Paginated list of orders

items
object[]
pagination
object