Search Product Variants

post

https://products.api.shoppinggives.com/subitem/get-filtered-search

Search your Store's Product Variants.

Query Params

page

int32

Defaults to 1

Use for pagination: The page of results to return, in correlation to the defined pageLength value.

pageLength

int32

Defaults to 25

Use for pagination: The number of results per page.

Body Params

excludedFromDonationsFilter

int32

enum

Allowed:

donationFilters

array of objects | null

(OPTIONAL) Only include Product Variants with the specified donation values in the search results.

donationFilters

collectionsFilter

array of int64s | null

(OPTIONAL) Only return Product Variants that are members of the Group entities
specified by the IDs provided.

collectionsFilter

ignoreVariantIds

array of int64s | null

(OPTIONAL) Exclude Product Variants with the corresponding Variant IDs from search results.

ignoreVariantIds

searchTerm

string | null

(OPTIONAL) Filter search by the text provided, which can include a Product Variant's partial or full name,
SKU or description.

ignoreDirectDonation

boolean

(OPTIONAL) Excludes Product Variants that are set as having a direct donation (paid directly by customer, not by store)
from the search results.
Examples are the Round-up and Add-on Product Variants.

Headers

x-store-id

string

required

Your store ID (we will provide this).

Responses

200Success

400Paginated page numbers must begin at 1, not 0