API Updates

Here you can keep track of changes and upgrades to the Wayfront API.

While we might push backwards-compatible changes (such as adding new resources) to the current API, breaking changes will require a version upgrade.

That way you can choose to stay on the current version, or upgrade to the latest version when it's convenient.

Upgrading your API version

You can see your API version and upgrade it in your workspace's API module. You can roll back to the previous version within two weeks.

For a one-off test you can specify a newer version in your request's header, e.g. X-Api-Version: 2023-12-12.

We'll check the API version in the header first, and fall back to the version in your workspace settings. To keep upgrades easy it's best to only use the header while testing.

March 5, 2024

2024-03-05: Added pagination to message endpoints

Added pagination to order_messages/{order} and ticket_messages/{ticket} endpoints.

Old:

    [
        { /* Message 1 */ },
        { /* Message 2 */ }
        ...
    ]

New:

    {
        "data": [
            { /* Message 1 */ },
            { /* Message 2 */ }
            ...
        ],
        "links": {
            "first": "https://example.spp.io/api/{resource}?page=1",
            "last": "https://example.spp.io/api/{resource}?page=3",
            "prev": null,
            "next": "https://example.spp.io/api/{resource}?page=2"
        },

January 25, 2024

2023-12-14: Updated response formats, new filtering and pagination

Dropped support for Basic auth. You can only use your API key in a Bearer token now.
Pagination now uses page and limit parameters, e.g. ?page=2&limit=150.
Sorting now uses an array, e.g., sort[]=id:desc.
Filtering now uses a filters array e.g. filters[email][$eq]=test@spp.io&filters[status_id][$in][]=1&filters[status_id][$in][]=2. More info here.
New response structure for index requests.

Old:

    [
        { /* Item 1 */ },
        { /* Item 2 */ }
        ...
    ]

New:

    {
        "data": [
            { /* Item 1 */ },
            { /* Item 2 */ }
            ...
        ],
        "links": {
            "first": "https://example.spp.io/api/{resource}?page=1",
            "last": "https://example.spp.io/api/{resource}?page=3",
            "prev": null,
            "next": "https://example.spp.io/api/{resource}?page=2"
        },
        "meta": {
            "current_page": 1,
            "from": 1,
            "last_page": 3,
            "links": [
              {
                "url": null,
                "label": "Previous",
                "active": false
              },
              {
                "url": "https://example.spp.io/api/{resource}?page=1",
                "label": "1",
                "active": true
              },
              {
                "url": "https://example.spp.io/api/{resource}?page=2",
                "label": "2",
                "active": false
              },
              {
                "url": "https://example.spp.io/api/{resource}?page=3",
                "label": "3",
                "active": false
              },
              {
                "url": "https://example.spp.io/api/{resource}?page=2",
                "label": "Next",
                "active": false
              }
            ],
            "path": "https://example.spp.io/api/{resource}",
            "per_page": 20,
            "to": 20,
            "total": 43
        }
    }

New request format for invoice creation and updates.

Old:

item_name[0]="Item 1"
item_name[1]="Item 2"
item_description[0]="Description 1"
item_description[1]="Description 2"

New:

items[0][name]="Item 1"
items[0][description]="Description 1"
items[1][name]="Item 2"
items[1][description]="Description 2"

Invoice object no longer includes the Subscription object. You will have to retrieve the subscription separately.
Resource creation requests now return a 201 status.
Resource deletion requests now return a 204 status.
New expand property lets you retrieve additional fields in your index requests, e.g. GET /clients?expand[]=spent.
New X-Api-Version and X-Api-Identifier response headers.