Assign Donation to a Product Variant

put

https://products.api.shoppinggives.com/subitem/{id}/donation

Creates a new Donation and assigns it to the specified Product Variant. Also clears any Group donation
overrides in place on the Variant (but not its parent Product).

Path Params

int64

required

ID of the Product Variant as it appears in our system.

Body Params

donationType

int32

enum

required

Allowed:

donationAmount

double

required

Value of donation relative to the DonationType (ex: type=0 (percent) + amount=3 = 3% of order value)

causes

array of strings | null

(OPTIONAL) List of nonprofit EINs that will receive donations from the entity when purchased.
Can be up to 6 nonprofits, or a single portfolio.

causes

excluded

boolean

Determines if this Donation should be excluded from all entity donation calculations.

startDateUtc

date-time | null

(OPTIONAL) Datetime stamp to start offering this Donation on the entity. Only viable when Donation is
NOT excluded.

endDateUtc

date-time | null

(OPTIONAL) Datetime stamp to stop offering this Donation on the entity. Only viable when Donation is
NOT excluded.

Headers

x-store-id

string

required

Your store ID (we will provide this).

Responses

200Success

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