API Reference

Bulk assign Donation on matching Product Variants

put
https://products.api.shoppinggives.com/subitem/filtered-update
Body Params
boolean | null

(OPTIONAL) Exclude all matching Product Variants from the Donation. Includes all by default.

int32
enum
Allowed:
double | null

Value of the new Donation being added.

causes
array of strings | null

(OPTIONAL) List of EINs associated with this Donation.

causes
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
string | null

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

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
string
required

Your store ID (we will provide this).

Responses

Updated over 4 years ago

Language
Credentials
Response 
 Choose an example:
application/json
Updated over 4 years ago