Bulk assign Donation on matching Product Variants

put

https://products.api.shoppinggives.com/subitem/filtered-update

Body Params

excludeAll

boolean | null

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

donationType

int32

enum

Allowed:

donationValue

double | null

Value of the new Donation being added.

causes

array of strings | null

(OPTIONAL) List of EINs associated with this Donation.

causes

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).

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200Success

400Maximum of 6 EINs or 1 Portfolio as the causes. If any Portfolios are present, there cannot be any EINs.