ServiceProductListResponse

successbooleanrequired

Always true on a 2xx response.

Example: true

data object[]required

One page of products.

Array [

idstring<uuid>required

Product id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

namestringnullablerequired

Product name.

Example: Sample Widget

descriptionstringnullablerequired

Product description.

Example: A sample product used in documentation.

statusstringnullablerequired

Lifecycle status.

Possible values: [ACTIVE, INACTIVE, DISCONTINUED, null]

brand objectnullablerequired

The product's brand.

idstring<uuid>required

Id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

namestringnullablerequired

Name.

Example: Sample

categories object[]required

Categories the product is filed under.

Array [

idstring<uuid>required

Id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

namestringnullablerequired

Name.

Example: Sample

]

tagsstring[]required

Free-form tags.

Example: ["sample"]

imageUrlsstring[]required

Image URLs, first is the primary image.

Example: ["https://cdn.example.com/images/widget.jpg"]

isTaxExemptbooleannullablerequired

True when the product is exempt from tax.

Example: false

baseUom objectnullablerequired

The unit stock is held in.

idstringnullablerequired

Unit id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

codestringnullablerequired

Unit code.

Example: EA

namestringnullablerequired

Unit name.

Example: Each

symbolstringnullablerequired

Display symbol.

Example: ea

salesUom objectnullablerequired

The unit the product is sold in.

idstringnullablerequired

Unit id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

codestringnullablerequired

Unit code.

Example: EA

namestringnullablerequired

Unit name.

Example: Each

symbolstringnullablerequired

Display symbol.

Example: ea

variants object[]required

The product's variants.

Array [

idstring<uuid>required

Variant id. Use it as variantId when creating quotes and orders.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

productIdstring<uuid>nullablerequired

The product the variant belongs to.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d

skustringnullablerequired

Stock keeping unit.

Example: SKU-1001

namestringnullablerequired

Variant name.

Example: Sample Widget, Large

barcodestringnullablerequired

Barcode.

Example: 0123456789012

attributes objectnullablerequired

Variant attributes as key/value pairs.

property name*anynullable

Variant attributes as key/value pairs.

Example: {"size":"Large"}

pricenumbernullablerequired

List price in the workspace currency.

Example: 15

salePricenumbernullablerequired

Sale price in the workspace currency.

Example: 12.5

isActivebooleannullablerequired

False when the variant is switched off.

Example: true

isDefaultbooleannullablerequired

True for the product's default variant.

Example: true

minOrderQuantitynumbernullablerequired

Smallest quantity that can be ordered.

Example: 1

maxOrderQuantitynumbernullablerequired

Largest quantity that can be ordered.

Example: 1000

salesUom objectnullable

The unit the variant is sold in. Present on list rows only.

idstringnullablerequired

Unit id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

codestringnullablerequired

Unit code.

Example: EA

namestringnullablerequired

Unit name.

Example: Each

symbolstringnullablerequired

Display symbol.

Example: ea

prices object[]

The variant's price tiers, one entry per quantity break and currency. Present on the single-product read only.

Array [

namestringnullablerequired

Name of the price tier.

Example: Standard

minQuantitynumbernullablerequired

Smallest quantity the tier applies to.

Example: 1

maxQuantitynumbernullablerequired

Largest quantity the tier applies to; null when unbounded.

Example: 9

pricenumbernullablerequired

Unit price in the tier's currency.

Example: 12.5

discountPercentnumbernullablerequired

Discount percent the tier carries, when set.

Example: 0

uomIdstring<uuid>nullablerequired

The unit the tier is priced in.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

currencystringnullablerequired

ISO 4217 currency code of price.

Example: USD

validFromstring<date-time>nullablerequired

Tier is valid from this instant.

Example: 2026-01-15T09:30:00.000Z

validTostring<date-time>nullablerequired

Tier is valid until this instant.

Example: 2026-01-15T09:30:00.000Z

isActivebooleannullablerequired

False when the tier is switched off.

Example: true

]

updatedAtstring<date-time>nullablerequired

When the variant last changed.

Example: 2026-01-15T09:30:00.000Z

]

uoms object[]

Every unit the product can be sold in, with conversion factors. Present on the single-product read only.

Array [

uomIdstring<uuid>nullablerequired

The unit id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

variantIdstring<uuid>nullablerequired

The variant this unit setting is for; null when it applies to the product.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

uom objectnullablerequired

The unit.

idstringnullablerequired

Unit id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

codestringnullablerequired

Unit code.

Example: EA

namestringnullablerequired

Unit name.

Example: Each

symbolstringnullablerequired

Display symbol.

Example: ea

isBasebooleannullablerequired

True when this is the product's base unit.

Example: true

isSalesbooleannullablerequired

True when the unit can be sold.

Example: true

conversionFactornumbernullablerequired

How many base units one of this unit contains.

Example: 1

minOrderQtynumbernullablerequired

Smallest quantity that can be ordered in this unit.

Example: 1

maxOrderQtynumbernullablerequired

Largest quantity that can be ordered in this unit.

Example: 1000

orderMultiplenumbernullablerequired

Quantities must be a multiple of this.

Example: 1

listPricenumbernullablerequired

List price in this unit, in the workspace currency.

Example: 15

salePricenumbernullablerequired

Sale price in this unit, in the workspace currency.

Example: 12.5

barcodestringnullablerequired

Barcode for this unit.

Example: 0123456789012

]

deletedbooleanrequired

Always present. True only for a removed product, which a delta pull (updatedAfter) returns so a sync can drop the row.

Example: false

updatedAtstring<date-time>nullablerequired

When the product last changed. Use the newest value as the next updatedAfter.

Example: 2026-01-15T09:30:00.000Z

]

page objectrequired

Paging state.

hasMorebooleanrequired

True when more rows follow this page.

Example: true

nextCursorstringnullablerequired

Opaque cursor. Pass it back as the cursor query parameter to fetch the next page; null on the last page.

Example: bzo1MA

ServiceProductListResponse

{
  "success": true,
  "data": [
    {
      "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
      "name": "Sample Widget",
      "description": "A sample product used in documentation.",
      "status": "ACTIVE",
      "brand": {
        "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
        "name": "Sample"
      },
      "categories": [
        {
          "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "name": "Sample"
        }
      ],
      "tags": [
        "sample"
      ],
      "imageUrls": [
        "https://cdn.example.com/images/widget.jpg"
      ],
      "isTaxExempt": false,
      "baseUom": {
        "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
        "code": "EA",
        "name": "Each",
        "symbol": "ea"
      },
      "salesUom": {
        "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
        "code": "EA",
        "name": "Each",
        "symbol": "ea"
      },
      "variants": [
        {
          "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "productId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
          "sku": "SKU-1001",
          "name": "Sample Widget, Large",
          "barcode": "0123456789012",
          "attributes": {
            "size": "Large"
          },
          "price": 15,
          "salePrice": 12.5,
          "isActive": true,
          "isDefault": true,
          "minOrderQuantity": 1,
          "maxOrderQuantity": 1000,
          "salesUom": {
            "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
            "code": "EA",
            "name": "Each",
            "symbol": "ea"
          },
          "prices": [
            {
              "name": "Standard",
              "minQuantity": 1,
              "maxQuantity": 9,
              "price": 12.5,
              "discountPercent": 0,
              "uomId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
              "currency": "USD",
              "validFrom": "2026-01-15T09:30:00.000Z",
              "validTo": "2026-01-15T09:30:00.000Z",
              "isActive": true
            }
          ],
          "updatedAt": "2026-01-15T09:30:00.000Z"
        }
      ],
      "uoms": [
        {
          "uomId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "variantId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "uom": {
            "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
            "code": "EA",
            "name": "Each",
            "symbol": "ea"
          },
          "isBase": true,
          "isSales": true,
          "conversionFactor": 1,
          "minOrderQty": 1,
          "maxOrderQty": 1000,
          "orderMultiple": 1,
          "listPrice": 15,
          "salePrice": 12.5,
          "barcode": "0123456789012"
        }
      ],
      "deleted": false,
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "page": {
    "hasMore": true,
    "nextCursor": "bzo1MA"
  }
}