Assign Donation to Product

put

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

Creates a new Donation and assigns it to the specified Product. Also clears any Group donation overrides
that are currently in place on the Product.

Path Params

int64

required

ID of the Product 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).

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200Success