API reference | Products

Method	Path	Summary
GET	…/products	List products in the workspace catalog
POST	…/products	Create a product
PATCH	…/products/{productId}	Update a product
DELETE	…/products/{productId}	Soft-delete (archive) a product
POST	…/products/{productId}/restore	Restore a previously deleted product

Paths start with /workspaces/{workspaceId}. GET endpoints need products:read, the others products:write.

The Product object

firestoreIdstringrequired

ID of the product.

workspaceIdstringrequired

ID of the workspace.

creationobjectrequired

When and by whom the resource was created.

Show 2 child fields

creationDateTimestringdate-timerequired

Date and time when the resource was created.

createdBystring

ID of the user who created the resource, when recorded.

activationobjectrequired

Whether the resource is enabled, and when and by whom it was last enabled or disabled.

Show 3 child fields

enabledbooleanrequired

Whether the resource is enabled.

updateDateTimestringdate-timerequired

Date and time when enabled was last set.

updatedBystring

ID of the user who last set enabled, when recorded.

codestringrequired

nameobjectrequired

Show 1 child field

defaultstringrequired

Text in the default language.

unitobject

Show 1 child field

defaultstringrequired

Text in the default language.

Show all 21 fields

purchaseNameobject

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseCurrencystring

ISO 4217 currency code

purchaseMilliAmountnumber

purchaseDescriptionobject

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseAccountstring

Code of an account in the chart of accounts.

purchaseTaxTypeIdstring

ID of the tax type.

saleNameobject

Show 1 child field

defaultstringrequired

Text in the default language.

saleCurrencystring

ISO 4217 currency code

saleMilliAmountnumber

saleDescriptionobject

Show 1 child field

defaultstringrequired

Text in the default language.

saleAccountstring

Code of an account in the chart of accounts.

saleTaxTypeIdstring

ID of the tax type.

supplierReferencesobject[]required

Show 3 child fields

counterpartyIdstring

ID of the counterparty.

codestring

namestring

tagsstring[]required

The Product object

{
  "firestoreId": "Pr4wJ8tM1xNq6zRb3vKf",
  "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
  "creation": {
    "creationDateTime": "2026-03-02T09:15:00.000Z",
    "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  },
  "activation": {
    "enabled": true,
    "updateDateTime": "2026-03-02T09:15:00.000Z",
    "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  },
  "code": "string",
  "name": {
    "default": "string"
  },
  "unit": {
    "default": "string"
  },
  "purchaseName": {
    "default": "string"
  },
  "purchaseCurrency": "CHF",
  "purchaseMilliAmount": 0,
  "purchaseDescription": {
    "default": "string"
  },
  "purchaseAccount": "1020",
  "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
  "saleName": {
    "default": "string"
  },
  "saleCurrency": "CHF",
  "saleMilliAmount": 0,
  "saleDescription": {
    "default": "string"
  },
  "saleAccount": "1020",
  "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
  "supplierReferences": [
    {
      "counterpartyId": "Cp2nG7vB4xLq9wRt5hMz",
      "code": "string",
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

GET/workspaces/{workspaceId}/products

List products in the workspace catalog

Scopeproducts:read

Path parameters

workspaceIdstringrequired

ID of the workspace.

Query parameters

limitinteger

Maximum number of items to return, from 1 to 100. A missing, invalid or non-positive value falls back to 20, and a larger value to 100.

Default20

startAfterstring

Cursor of the page to return: the nextCursor of the previous page.

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

idsstring[]

Comma-separated IDs of the items to return, up to 30. When set, limit, startAfter and the filters are ignored.

activation.enabledboolean

Whether the resource is enabled.

Returns

200

List of items

dataProduct[]required

Items of the page, in list order.

limitintegerrequired

Page size of the request, or the number of requested ids.

nextCursorstring

Cursor of the next page, to pass as startAfter. Absent when the page holds fewer items than limit; a full last page still has one, and the page it points to is empty.

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": [
    {
      "firestoreId": "Pr4wJ8tM1xNq6zRb3vKf",
      "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
      "creation": {
        "creationDateTime": "2026-03-02T09:15:00.000Z",
        "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
      },
      "activation": {
        "enabled": true,
        "updateDateTime": "2026-03-02T09:15:00.000Z",
        "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
      },
      "code": "string",
      "name": {
        "default": "string"
      },
      "unit": {
        "default": "string"
      },
      "purchaseName": {
        "default": "string"
      },
      "purchaseCurrency": "CHF",
      "purchaseMilliAmount": 0,
      "purchaseDescription": {
        "default": "string"
      },
      "purchaseAccount": "1020",
      "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
      "saleName": {
        "default": "string"
      },
      "saleCurrency": "CHF",
      "saleMilliAmount": 0,
      "saleDescription": {
        "default": "string"
      },
      "saleAccount": "1020",
      "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
      "supplierReferences": […],
      "tags": [
        "string"
      ]
    }
  ],
  "limit": 0,
  "nextCursor": "string"
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

POST/workspaces/{workspaceId}/products

Create a product

Scopeproducts:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

Query parameters

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

Request body

codestringrequired

nameobjectrequired

Show 1 child field

defaultstringrequired

Text in the default language.

unitobject

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseNameobject

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseCurrencystring

ISO 4217 currency code

purchaseMilliAmountnumber

purchaseDescriptionobject

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseAccountstring

Code of an account in the chart of accounts.

purchaseTaxTypeIdstring

ID of the tax type.

saleNameobject

Show 1 child field

defaultstringrequired

Text in the default language.

saleCurrencystring

ISO 4217 currency code

saleMilliAmountnumber

saleDescriptionobject

Show 1 child field

defaultstringrequired

Text in the default language.

saleAccountstring

Code of an account in the chart of accounts.

saleTaxTypeIdstring

ID of the tax type.

supplierReferencesobject[]

Default[]

Show 3 child fields

counterpartyIdstring

ID of the counterparty.

codestring

namestring

tagsstring[]

Default[]

Returns

200

Successful response

dataProductrequired

curl -X POST 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "string",
  "name": {
    "default": "string"
  },
  "unit": {
    "default": "string"
  },
  "purchaseName": {
    "default": "string"
  },
  "purchaseCurrency": "CHF",
  "purchaseMilliAmount": 0,
  "purchaseDescription": {
    "default": "string"
  },
  "purchaseAccount": "1020",
  "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
  "saleName": {
    "default": "string"
  },
  "saleCurrency": "CHF",
  "saleMilliAmount": 0,
  "saleDescription": {
    "default": "string"
  },
  "saleAccount": "1020",
  "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
  "supplierReferences": [],
  "tags": []
}'

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "code": "string",
    "name": {
      "default": "string"
    },
    "unit": {
      "default": "string"
    },
    "purchaseName": {
      "default": "string"
    },
    "purchaseCurrency": "CHF",
    "purchaseMilliAmount": 0,
    "purchaseDescription": {
      "default": "string"
    },
    "purchaseAccount": "1020",
    "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
    "saleName": {
      "default": "string"
    },
    "saleCurrency": "CHF",
    "saleMilliAmount": 0,
    "saleDescription": {
      "default": "string"
    },
    "saleAccount": "1020",
    "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
    "supplierReferences": [],
    "tags": []
  }),
});
console.log(await response.json());

import os

import requests

response = requests.post(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "code": "string",
        "name": {
            "default": "string",
        },
        "unit": {
            "default": "string",
        },
        "purchaseName": {
            "default": "string",
        },
        "purchaseCurrency": "CHF",
        "purchaseMilliAmount": 0,
        "purchaseDescription": {
            "default": "string",
        },
        "purchaseAccount": "1020",
        "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
        "saleName": {
            "default": "string",
        },
        "saleCurrency": "CHF",
        "saleMilliAmount": 0,
        "saleDescription": {
            "default": "string",
        },
        "saleAccount": "1020",
        "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
        "supplierReferences": [],
        "tags": [],
    },
)
print(response.json())

{
  "data": {
    "firestoreId": "Pr4wJ8tM1xNq6zRb3vKf",
    "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
    "creation": {
      "creationDateTime": "2026-03-02T09:15:00.000Z",
      "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
    },
    "activation": {
      "enabled": true,
      "updateDateTime": "2026-03-02T09:15:00.000Z",
      "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
    },
    "code": "string",
    "name": {
      "default": "string"
    },
    "unit": {
      "default": "string"
    },
    "purchaseName": {
      "default": "string"
    },
    "purchaseCurrency": "CHF",
    "purchaseMilliAmount": 0,
    "purchaseDescription": {
      "default": "string"
    },
    "purchaseAccount": "1020",
    "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
    "saleName": {
      "default": "string"
    },
    "saleCurrency": "CHF",
    "saleMilliAmount": 0,
    "saleDescription": {
      "default": "string"
    },
    "saleAccount": "1020",
    "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
    "supplierReferences": […],
    "tags": [
      "string"
    ]
  }
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

PATCH/workspaces/{workspaceId}/products/{productId}

Update a product

Scopeproducts:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

productIdstringrequired

ID of the product.

Request body

codestring

nameobject

Show 1 child field

defaultstringrequired

Text in the default language.

unitobject | null

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseNameobject | null

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseCurrencystring | null

ISO 4217 currency code

purchaseMilliAmountnumber | null

purchaseDescriptionobject | null

Show 1 child field

defaultstringrequired

Text in the default language.

purchaseAccountstring | null

Code of an account in the chart of accounts.

purchaseTaxTypeIdstring | null

ID of the tax type.

saleNameobject | null

Show 1 child field

defaultstringrequired

Text in the default language.

saleCurrencystring | null

ISO 4217 currency code

saleMilliAmountnumber | null

saleDescriptionobject | null

Show 1 child field

defaultstringrequired

Text in the default language.

saleAccountstring | null

Code of an account in the chart of accounts.

saleTaxTypeIdstring | null

ID of the tax type.

supplierReferencesobject[]

Show 3 child fields

counterpartyIdstring

ID of the counterparty.

codestring

namestring

tagsstring[]

Returns

204

No content

curl -X PATCH 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "purchaseCurrency": "CHF",
  "purchaseAccount": "1020",
  "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
  "saleCurrency": "CHF",
  "saleAccount": "1020",
  "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
  "supplierReferences": [
    {
      "counterpartyId": "Cp2nG7vB4xLq9wRt5hMz"
    }
  ]
}'

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "purchaseCurrency": "CHF",
    "purchaseAccount": "1020",
    "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
    "saleCurrency": "CHF",
    "saleAccount": "1020",
    "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
    "supplierReferences": [
      {
        "counterpartyId": "Cp2nG7vB4xLq9wRt5hMz"
      }
    ]
  }),
});
console.log(response.status);

import os

import requests

response = requests.patch(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "purchaseCurrency": "CHF",
        "purchaseAccount": "1020",
        "purchaseTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
        "saleCurrency": "CHF",
        "saleAccount": "1020",
        "saleTaxTypeId": "Tt9mC5rL2wQz7nVb4kHp",
        "supplierReferences": [
            {
                "counterpartyId": "Cp2nG7vB4xLq9wRt5hMz",
            },
        ],
    },
)
print(response.status_code)

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

DELETE/workspaces/{workspaceId}/products/{productId}

Soft-delete (archive) a product

Scopeproducts:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

productIdstringrequired

ID of the product.

Returns

204

No content

curl -X DELETE 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(response.status);

import os

import requests

response = requests.delete(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.status_code)

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

POST/workspaces/{workspaceId}/products/{productId}/restore

Restore a previously deleted product

Scopeproducts:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

productIdstringrequired

ID of the product.

Returns

204

No content

curl -X POST 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf/restore' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf/restore', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(response.status);

import os

import requests

response = requests.post(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/products/Pr4wJ8tM1xNq6zRb3vKf/restore",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.status_code)

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Cookies, with your consent

Products

The Product object

List products in the workspace catalog

Path parameters

Query parameters

Returns

Create a product

Path parameters

Query parameters

Request body

Returns

Update a product

Path parameters

Request body

Returns

Soft-delete (archive) a product

Path parameters

Returns

Restore a previously deleted product

Path parameters

Returns

Start building on your own data.