Strictly / PayWithZero Public API

Items

Endpointhttps://api.paywithzero.net/v1

Download schema

List of Items

GET

https://api.paywithzero.net/v1

/v1/public/item

Returns a paginated list of catalog items.

List of Items › Headers

authorization

string · required

List of Items › Responses

200

Paginated items list.

object[]

total

integer

page

integer

limit

integer

Create an item

POST

https://api.paywithzero.net/v1

/v1/public/item

Create a new product/service item in the catalog.

Create an item › Headers

authorization

string · required

Create an item › Request Body

name

string · required

Item name

type

string · required

Item type

description

string · required

Item description

salesPrice

number · required

Item sales price

sku

string

Item SKU

object[]

Item's categories

taxes

string[]

Item's taxes

Create an item › Responses

Item created.

No data returned

POST/v1/public/item

curl --request POST \
  --url https://api.paywithzero.net/v1/v1/public/item \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "name": "Test api item",
  "type": "product",
  "description": "test",
  "salesPrice": -5.5,
  "categories": [
    {
      "name": "cat",
      "id": "6243240a2da210001f8f0cb3"
    },
    {
      "name": "cat2",
      "id": null
    }
  ],
  "taxes": [],
  "sku": "1234"
}
'

shell

Example Request Body

{
  "name": "Test api item",
  "type": "product",
  "description": "test",
  "salesPrice": -5.5,
  "categories": [
    {
      "name": "cat",
      "id": "6243240a2da210001f8f0cb3"
    },
    {
      "name": "cat2",
      "id": null
    }
  ],
  "taxes": [],
  "sku": "1234"
}

json

application/json

Example Responses

{
  "data": {
    "categories": [
      {
        "name": "cat",
        "createdAt": "2022-03-29T17:24:53.876Z",
        "updatedAt": "2022-03-29T17:24:53.876Z",
        "id": "624340e564d1f81e59d730fd"
      },
      {
        "name": "cat1",
        "createdAt": "2022-03-29T17:24:53.876Z",
        "updatedAt": "2022-03-29T17:24:53.876Z",
        "id": "624340e564d1f81e59d730fd"
      }
    ],
    "taxes": [],
    "deletedAt": null,
    "name": "Test api item",
    "type": "product",
    "description": "test",
    "salesPrice": 0.3,
    "sku": "1234",
    "createdBy": "EXAMPLE",
    "updatedBy": "EXAMPLE",
    "owner": "EXAMPLE",
    "ownerGroup": null,
    "createdAt": "2022-03-29T12:17:18.227Z",
    "updatedAt": "2022-03-29T12:17:18.227Z",
    "id": "EXAMPLE"
  }
}

json

application/json

List of items

GET

https://api.paywithzero.net/v1

/v1/public/item/select-all

Returns all items without pagination — use for dropdowns/autocomplete.

List of items › Headers

authorization

string · required

List of items › Responses

200

All items returned.

No data returned

List of categories

GET

https://api.paywithzero.net/v1

/v1/public/item/categories

Returns all item categories.

List of categories › Headers

authorization

string · required

List of categories › Responses

200

Categories returned.

No data returned

Get one Item by id

GET

https://api.paywithzero.net/v1

/v1/public/item/{id}

Retrieve a single item by ID.

Get one Item by id › path Parameters

id

string · required

Item ID

Get one Item by id › Headers

authorization

string · required

Get one Item by id › Responses

Item returned.

No data returned

GET/v1/public/item/{id}

curl --request GET \
  --url https://api.paywithzero.net/v1/v1/public/item/:id \
  --header 'authorization: <string>'

shell

Example Responses

{
  "data": {
    "categories": [
      {
        "name": "cat",
        "createdAt": "2022-03-29T15:21:46.095Z",
        "updatedAt": "2022-03-29T15:21:46.095Z",
        "id": "6243240a2da210001f8f0cb3"
      }
    ],
    "taxes": [],
    "deletedAt": "2022-03-29T12:26:47.933Z",
    "name": "Test api item",
    "type": "product",
    "description": "test api",
    "salesPrice": 0.3,
    "sku": "1234",
    "clientId": "5ff76fb63bcf0a001c6228e0",
    "createdBy": "EXAMPLE",
    "updatedBy": "EXAMPLE",
    "owner": "EXAMPLE",
    "ownerGroup": null,
    "createdAt": "2022-03-29T12:17:18.227Z",
    "updatedAt": "2022-03-29T17:20:09.134Z",
    "id": "EXAMPLE"
  }
}

json

application/json

Delete a item by id

DELETE

https://api.paywithzero.net/v1

/v1/public/item/{id}

Permanently delete a catalog item.

Delete a item by id › path Parameters

id

string · required

Item ID

Delete a item by id › Headers

authorization

string · required

Delete a item by id › Responses

Item deleted.

No data returned

Update an Item

PATCH

https://api.paywithzero.net/v1

/v1/public/item/{id}

Partial update of a catalog item.

Update an Item › path Parameters

id

string · required

Item ID

Update an Item › Headers

authorization

string · required

Update an Item › Request Body

name

string · required

Item name

type

string · required

Item type

description

string · required

Item description

salesPrice

number · required

Item sales price

sku

string

Item SKU

object[]

Item's categories

taxes

string[]

Item's taxes

Update an Item › Responses

Item updated.

No data returned

PATCH/v1/public/item/{id}

curl --request PATCH \
  --url https://api.paywithzero.net/v1/v1/public/item/:id \
  --header 'Content-Type: application/json' \
  --header 'authorization: <string>' \
  --data '
{
  "description": "test api",
  "categories": [
    {
      "name": "cat",
      "id": null
    },
    {
      "name": "cat1",
      "id": "6243240a2da210001f8f0cb3"
    }
  ],
  "taxes": []
}
'

shell

Example Request Body

{
  "description": "test api",
  "categories": [
    {
      "name": "cat",
      "id": null
    },
    {
      "name": "cat1",
      "id": "6243240a2da210001f8f0cb3"
    }
  ],
  "taxes": []
}

json

application/json

Example Responses

{
  "data": {
    "categories": [],
    "taxes": [],
    "deletedAt": null,
    "name": "Test api item",
    "type": "product",
    "description": "test",
    "salesPrice": 0.3,
    "sku": "1234",
    "createdBy": "EXAMPLE",
    "updatedBy": "EXAMPLE",
    "owner": "EXAMPLE",
    "ownerGroup": null,
    "createdAt": "2022-03-29T12:17:18.227Z",
    "updatedAt": "2022-03-29T12:17:18.227Z",
    "id": "EXAMPLE"
  }
}

json

application/json

Delete a list of items

POST

https://api.paywithzero.net/v1

/v1/public/item/bulk-delete

Delete multiple catalog items by ID list.

Delete a list of items › Headers

authorization

string · required

Delete a list of items › Request Body

itemList

string[] · required

Bulk Action list of items

createdBy

string

Username owner of the action

Delete a list of items › Responses

200

Items deleted.

No data returned

Duplicate an item

POST

https://api.paywithzero.net/v1

/v1/public/item/duplicate/{id}

Create a copy of an existing item.

Duplicate an item › path Parameters

id

string · required

Item ID to duplicate

Duplicate an item › Headers

authorization

string · required

Duplicate an item › Responses

Duplicate created.

No data returned

Duplicate a list item

POST

https://api.paywithzero.net/v1

/v1/public/item/bulk-duplicate

Duplicate multiple items at once.

Duplicate a list item › Headers

authorization

string · required

Duplicate a list item › Request Body

itemList

string[] · required

Bulk Action list of items

createdBy

string

Username owner of the action

Duplicate a list item › Responses

200

Duplicates created.

No data returned

Invoices Payments

Create an item

POST

https://api.paywithzero.net/v1

/v1/public/item

Create a new product/service item in the catalog.

Create an item › Headers

authorization

string · required

Create an item › Request Body

name

string · required

Item name

type

string · required

Item type

description

string · required

Item description

salesPrice

number · required

Item sales price

sku

string

Item SKU

object[]

Item's categories

taxes

string[]

Item's taxes

Create an item › Responses

Item created.

No data returned

Update an Item

PATCH

https://api.paywithzero.net/v1

/v1/public/item/{id}

Partial update of a catalog item.

Update an Item › path Parameters

id

string · required

Item ID

Update an Item › Headers

authorization

string · required

Update an Item › Request Body

name

string · required

Item name

type

string · required

Item type

description

string · required

Item description

salesPrice

number · required

Item sales price

sku

string

Item SKU

object[]

Item's categories

taxes

string[]

Item's taxes

Update an Item › Responses

Item updated.

No data returned

Delete a list of items

POST

https://api.paywithzero.net/v1

/v1/public/item/bulk-delete

Delete multiple catalog items by ID list.

Delete a list of items › Headers

authorization

string · required

Delete a list of items › Request Body

itemList

string[] · required

Bulk Action list of items

createdBy

string

Username owner of the action

Delete a list of items › Responses

200

Items deleted.

No data returned

Duplicate an item

POST

https://api.paywithzero.net/v1

/v1/public/item/duplicate/{id}

Create a copy of an existing item.

Duplicate an item › path Parameters

id

string · required

Item ID to duplicate

Duplicate an item › Headers

authorization

string · required

Duplicate an item › Responses

Duplicate created.

No data returned

Duplicate a list item

POST

https://api.paywithzero.net/v1

/v1/public/item/bulk-duplicate

Duplicate multiple items at once.

Duplicate a list item › Headers

authorization

string · required

Duplicate a list item › Request Body

itemList

string[] · required

Bulk Action list of items

createdBy

string

Username owner of the action

Duplicate a list item › Responses

200

Duplicates created.

No data returned