List products

GET/products

Retrieve this store’s products, including unpublished listings.

Bearer token ·products:read

Query parameters

perPageinteger

Results per page, from 1 to 100.

Default: 30. Min: 1.Max: 100.

afterinteger

Product cursor returned as nextCursor.

Min: 0.

externalIdstring

Your permanent product ID. Unique within this connection.

Up to 160 characters.

updatedSincestring

Return products changed at or after this ISO date-time.

Format: date-time.

Integration notes

Follow nextCursor as after until it is null. Retain resource versions when applying updates.

Responses

Request successful.

Response fields

dataobject[]

Child fields

externalIdstring | null

Your permanent product ID. Unique within this connection.

titlestring

Product name.

Up to 255 characters.

descriptionstring

Product description.

Up to 20000 characters.

pricenumber

Price in NGN, not kobo.

Min: 0.Max: 1000000000.

currency"NGN"

Supported write currency.

visibleboolean

Publish the product. Store policies and moderation still apply.

Default: false.

coverobject

Primary product image. A public HTTPS image is required.

Child fields

kind"image"required

Media type.

urlstringrequired

Public HTTPS URL.

Format: uri.

galleryobject[]

Additional HTTPS product images.

Up to 12 items.

Child fields

kind"image"required

Media type.

urlstringrequired

Public HTTPS URL.

Format: uri.

tagsstring[]

Short product labels.

Up to 20 items.

categorystring | null

Product category.

Up to 120 characters.

variantsobject[]

At most 200 combinations. Stock fields are prohibited here.

Up to 3 items.

Child fields

namestringrequired

Option name, such as Size.

Up to 80 characters.

valuesstring[]required

Option values, such as M and L.

Up to 20 items.

valueConfigobject

Per-value prices and SKUs.

Child fields

pricenumber

Price in NGN, not kobo.

Min: 0.

skustring

Stock keeping unit.

Up to 100 characters.

combinationConfigobject

Per-combination prices and SKUs.

Child fields

pricenumber

Price in NGN, not kobo.

Min: 0.

skustring

Stock keeping unit.

Up to 100 characters.

variantIdsobject | array

External variation IDs to Storlio variation keys.

idstring

Storlio resource ID.

versioninteger

Current resource version.

Min: 1.

productTypestring

listingTypestring

moderationStatusstring | null

inStockboolean

urlstring

Public HTTPS URL.

Format: uri.

updatedAtstring

Last update in ISO 8601 format.

Format: date-time.

slugstring

shippingobject | null

nextCursorstring | null

Use this cursor for the next page; null marks the end.