Create a Donation

post

https://donations.api.shoppinggives.com/

Authorization: Store:Donation:Create

Donations generated through this endpoint will be placed on the store's currently open receivable, and charged like any other e-commerce driven donation.

Body Params

causeId

string

required

The EIN of the cause associated with this donation.

donationAmount

double

Amount of the donation associated with this purchase.

orderId

string | null

Internal ID of the order you want to reference; must match the user facing order ID.

total

double

The original total amount paid by the customer.

source

int32

The donation source (0 = eCommerce Sales, 2 = Yotpo Loyalty Points, 3 = Point of Sale).

lockDateUtc

date-time | null

(OPTIONAL) Date after which the donation cannot be altered (default = now).

orderCreatedAtUtc

date-time | null

When the order was created at (in UTC)

customerId

string | null

(OPTIONAL) Any string used to identify a user in your CMS, for example:"CUST01234", "1234412", or "PERSON1"; used for reporting purposes.

locationId

uuid | null

The location ID (for point of sale ONLY).

Headers

x-store-id

string | null

Your store ID (we will provide this).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Donation amount isn't greater than 0