Lists

A List in Swish belongs to a Profile and contains Items.

get

Authorizations

Swish API key

HTTPRequired

Responses

200

Returns all lists as paginated response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/lists

HTTPcURLJavaScriptPython

GET /api/2025-04/lists HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "67a61d5561e4f9de302c02a1",
      "name": "My List",
      "createdAt": "2025-01-01T10:00:00.000Z",
      "updatedAt": "2025-01-01T10:00:00.000Z"
    }
  ]
}

post

Authorizations

Swish API key

HTTPRequired

Body

application/json

namestringRequired

The name of the list

Example: My List

Responses

201

The list has been successfully created.

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/lists

HTTPcURLJavaScriptPython

POST /api/2025-04/lists HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "My List"
}

{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "name": "My List",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
}

get

Authorizations

Swish API key

HTTPRequired

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Query parameters

sortstring · enumOptional

The sort order of the items in the list

Default: recently_savedPossible values:

Responses

200

The list has been successfully retrieved.

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/lists/{listId}

HTTPcURLJavaScriptPython

GET /api/2025-04/lists/{listId} HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "name": "My List",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z",
    "items": [
      {
        "id": "67a61d5561e4f9de302c02a1",
        "productId": 123,
        "variantId": 456,
        "quantity": 1,
        "createdAt": "2025-01-01T10:00:00.000Z",
        "updatedAt": "2025-01-01T10:00:00.000Z"
      }
    ]
  }
}

patch

Authorizations

Swish API key

HTTPRequired

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Body

application/json

namestringRequired

The name of the list

Example: My List

Responses

200

The list has been successfully updated.

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/lists/{listId}

HTTPcURLJavaScriptPython

PATCH /api/2025-04/lists/{listId} HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "My List"
}

{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "name": "My List",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
}

delete

Authorizations

Swish API key

HTTPRequired

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Responses

204

The list has been successfully deleted.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/lists/{listId}

HTTPcURLJavaScriptPython

DELETE /api/2025-04/lists/{listId} HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

put

Authorizations

Swish API key

HTTPRequired

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Body

application/json

itemIdsstring[]Required

The list of item IDs to reorder

Example: ["507f1f77bcf86cd799439011","507f1f77bcf86cd799439022"]

Responses

200

The list items have been successfully reordered.

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/lists/{listId}/items/order

HTTPcURLJavaScriptPython

PUT /api/2025-04/lists/{listId}/items/order HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "itemIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439022"
  ]
}

{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "name": "My List",
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
}