Go to websiteInstall now

Items

An Item in Swish belongs to a List and references a Shopify product/variant.

get
Authorizations
Query parameters
pagestringOptional

The page cursor

limitnumberOptional

Number of lists/items to return

Default: 50
querystringOptional

Item search query

Example: product:123,456 tag:saved-from-cart,saved-from-page
Responses
200

Returns all items as paginated response

application/json
Responseall of
and
get
/items
GET /api/2025-04/items HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageInfo": {
    "next": "YWZ0ZXI6NjdhNjFkNTU2MWU0ZjlkZTMwMmMwMmEx",
    "previous": "YmVmb3JlOjY3YTYxZDU1NjFlNGY5ZGUzMDJjMDJhMQ=="
  },
  "data": [
    {
      "id": "67a61d5561e4f9de302c02a1",
      "productId": 123,
      "variantId": 456,
      "quantity": 1,
      "createdAt": "2025-01-01T10:00:00.000Z",
      "updatedAt": "2025-01-01T10:00:00.000Z"
    }
  ]
}
post
Authorizations
Body
productIdnumberRequired

The Shopify ID of the product

Example: 123
variantIdnumberOptional

The Shopify ID of the variant

Example: 456
quantitynumberOptional

The quantity of the item

Default: 1Example: 1
tagsstring[]Optional

Tags associated with the item (must contain only lowercase letters, numbers, hyphens or underscores)

Example: ["saved-from-cart"]
Responses
201

The item has been successfully created.

application/json
Responseall of
objectOptional
and
post
/items
POST /api/2025-04/items HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "productId": 123,
  "variantId": 456,
  "quantity": 1,
  "tags": [
    "saved-from-cart"
  ]
}
{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "productId": 123,
    "variantId": 456,
    "quantity": 1,
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
}
delete
Authorizations
Body
itemIdsstring[]Required

The list of item IDs to delete

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

The items have been successfully deleted.

No content
delete
/items
DELETE /api/2025-04/items HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "itemIds": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439022"
  ]
}
No content
patch
Authorizations
Path parameters
itemIdstringRequired

The ID of the item

Example: 67a61d5561e4f9de302c02a1
Body
productIdnumberOptional

The Shopify ID of the product

Example: 123
variantIdnumberOptional

The Shopify ID of the variant

Example: 456
quantitynumberOptional

The quantity of the item

Default: 1Example: 2
Responses
200

The item has been successfully updated.

application/json
Responseall of
objectOptional
and
patch
/items/{itemId}
PATCH /api/2025-04/items/{itemId} HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "productId": 123,
  "variantId": 456,
  "quantity": 2
}
{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "productId": 123,
    "variantId": 456,
    "quantity": 1,
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z"
  }
}
delete
Authorizations
Path parameters
itemIdstringRequired

The ID of the item

Example: 67a61d5561e4f9de302c02a1
Responses
204

The item has been successfully deleted.

No content
delete
/items/{itemId}
DELETE /api/2025-04/items/{itemId} HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
get
Authorizations
Path parameters
itemIdstringRequired

The ID of the item

Example: 67a61d5561e4f9de302c02a1
Responses
200

The item has been successfully found.

application/json
Responseall of
objectOptional
and
get
/items/{itemId}
GET /api/2025-04/items/{itemId} HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "productId": 123,
    "variantId": 456,
    "quantity": 1,
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z",
    "listIds": [
      "text"
    ]
  }
}
put
Authorizations
Path parameters
itemIdstringRequired

The ID of the item

Example: 67a61d5561e4f9de302c02a1
Body
listIdsstring[]Required

The ID of the item to set the lists for

Example: ["67e2704d3c49af2fef03e054","67e2704d3c49af2fef03e054"]
Responses
200

The item has been successfully been added to the lists.

application/json
Responseall of
objectOptional
and
put
/items/{itemId}/lists
PUT /api/2025-04/items/{itemId}/lists HTTP/1.1
Host: swish.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "listIds": [
    "67e2704d3c49af2fef03e054",
    "67e2704d3c49af2fef03e054"
  ]
}
{
  "data": {
    "id": "67a61d5561e4f9de302c02a1",
    "productId": 123,
    "variantId": 456,
    "quantity": 1,
    "createdAt": "2025-01-01T10:00:00.000Z",
    "updatedAt": "2025-01-01T10:00:00.000Z",
    "listIds": [
      "text"
    ]
  }
}

PreviousAPI ReferenceNextLists

Last updated