TWtweakwise
Item

Returns all items

get/item

Request

  • The document declares no server URL.
  • Auth
    API key in header TWN-InstanceKey and API key in header TWN-Authentication

Query parameters

limitinteger

The maximum number of records which should be retrieved. You cannot retrieve more than 100 records in a single call. By default, the limit is 20.

offsetinteger

The number of records which should be skipped.

searchTermstring

Search for the string in both the (display) name and URL name of item.

updatedByApiItemUpdateSource[]

Product last updated by source.

typesstring[]

Specific item type. Default values are: product, visual

groupCodestring

Item group code, used in grouped navigation and search

statusApiItemStatus[]

Filter by Item status (Active/Inactive)

categoriesinteger[]

Filter items by category id's

includeSubCategoriesboolean

When true, also include items from sub-categories of the provided category IDs. Defaults to false.

Response

OK

Totalinteger nullable required

The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.

Changes

No recorded changes to this operation across all 1 revision of this API.