Lists

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

get

Authorizations

Responses

Responseall of

objectOptional

and

get

HTTPcURLJavaScriptPython

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

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

post

Authorizations

Body

namestringRequired

The name of the list

Example: My List

Responses

Responseall of

objectOptional

and

post

HTTPcURLJavaScriptPython

POST /api/2025-04/lists HTTP/1.1
Host: swish.app
Authorization: Bearer JWT
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

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

Responseall of

objectOptional

and

get

HTTPcURLJavaScriptPython

GET /api/2025-04/lists/{listId} HTTP/1.1
Host: swish.app
Authorization: Bearer JWT
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

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Body

namestringRequired

The name of the list

Example: My List

Responses

Responseall of

objectOptional

and

patch

HTTPcURLJavaScriptPython

PATCH /api/2025-04/lists/{listId} HTTP/1.1
Host: swish.app
Authorization: Bearer JWT
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

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Responses

delete

HTTPcURLJavaScriptPython

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

No content

put

Authorizations

Path parameters

listIdstringRequired

The ID of the list

Example: 67a61d5561e4f9de302c02a1

Body

itemIdsstring[]Required

The list of item IDs to reorder

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

Responses

Responseall of

objectOptional

and

put

HTTPcURLJavaScriptPython

PUT /api/2025-04/lists/{listId}/items/order HTTP/1.1
Host: swish.app
Authorization: Bearer JWT
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"
  }
}