Orders API

List orders

⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead.

Retrieve all orders.

The results are paginated.

🔑 Access with

API key

Advanced access token with orders.read

OAuth access with orders.read

get/orders

Request

  • Base URL
    https://api.mollie.com/v2
  • URL
    https://api.mollie.com/v2/orders
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: orders.read

Query parameters

fromstring
Example:ord_5B8cwPMGnU

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

sortstring
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

profileIdstring

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Example:pfl_5B8cwPMGnU

The identifier referring to the profile you wish to retrieve orders for.

Most API credentials are linked to a single profile. In these cases the profileId is already implied.

To retrieve all orders across the organization, use an organization-level API credential and omit the profileId parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

A list of order objects.

countinteger

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "orders": [
      {
        "id": "ord_5B8cwPMGnU",
        "mode": "live",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "amountRefunded": {
          "currency": "EUR",
          "value": "10.00"
        },
        "amountCaptured": {
          "currency": "EUR",
          "value": "10.00"
        },
        "redirectUrl": "https://www.example.com/redirect",
        "cancelUrl": "https://www.example.com/cancel",
        "webhookUrl": "https://www.example.com/webhook",
        "billingAddress": {
          "title": "Mr.",
          "givenName": "John",
          "familyName": "Doe",
          "organizationName": "Mollie B.V.",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "4th floor",
          "postalCode": "5678AB",
          "email": "example@email.com",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL"
        },
        "shippingAddress": {
          "title": "Mr.",
          "givenName": "John",
          "familyName": "Doe",
          "organizationName": "Mollie B.V.",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "4th floor",
          "postalCode": "5678AB",
          "email": "example@email.com",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL"
        },
        "locale": "en_US",
        "method": "creditcard",
        "shopperCountryMustMatchBillingCountry": true,
        "status": "created",
        "isCancelable": true,
        "profileId": "pfl_5B8cwPMGnU",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "authorizedAt": "2025-04-03T14:03:17+00:00",
        "paidAt": "2025-04-03T14:03:17+00:00",
        "canceledAt": "2025-04-03T14:03:17+00:00",
        "expiresAt": "2025-01-01",
        "expiredAt": "2025-04-03T14:03:17+00:00",
        "completedAt": "2025-04-03T14:03:17+00:00",
        "consumerDateOfBirth": "2000-01-01",
        "lines": [
          {
            "id": "odl_5B8cwPMGnU",
            "type": "physical",
            "name": "Ready Player One",
            "quantity": 2,
            "quantityShipped": 1,
            "amountShipped": {
              "currency": "EUR",
              "value": "10.00"
            },
            "quantityRefunded": 1,
            "amountRefunded": {
              "currency": "EUR",
              "value": "10.00"
            },
            "quantityCanceled": 1,
            "amountCanceled": {
              "currency": "EUR",
              "value": "10.00"
            },
            "shippableQuantity": 1,
            "refundableQuantity": 1,
            "cancelableQuantity": 1,
            "unitPrice": {
              "currency": "EUR",
              "value": "10.00"
            },
            "discountAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "totalAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "vatAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "sku": "978-1524763282",
            "category": "eco",
            "status": "created",
            "isCancelable": true,
            "orderId": "ord_5B8cwPMGnU",
            "imageUrl": "https://www.example.com/image",
            "productUrl": "https://www.example.com/product",
            "createdAt": "2024-03-20T09:13:37+00:00",
            "_links": {
              "self": {
                "href": "https://...",
                "type": "application/hal+json"
              },
              "imageUrl": {
                "href": "https://...",
                "type": "application/hal+json"
              },
              "productUrl": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          }
        ],
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "checkout": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "dashboard": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.