API Reference

Create Sale

post
https://sales.api.shoppinggives.com/

Authorization: Store:Sales:Write

Body Params
string | null

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

double

Total amount of this sale.

double

Amount before discount (line items alone).

double

Total discount for the order.

double

Subtotal of the user's shopping cart AFTER discount (i.e. line items - discounts).

promoCodes
array of strings | null

Any coupon / promo codes used during the purchase.

promoCodes
uuid | null

A GUID that is created via our tracking script and stored in sessionStorage. It is used to identify the customer's shopping session and save their selected cause. It is best to retrieve the ID from the sessionStorage object and provide here, but we fall back to setting it from the order confirmation page.

uuid | null

(OPTIONAL) Location information for user-based metrics.

lineItems
array of objects | null

An array of line items included in the order.

lineItems
date-time

The time the order was created (UTC); this allows us to tell the difference between order creation time and our sale creation time.

string | null

(OPTIONAL) The first name associated with the user.

string | null

(OPTIONAL) The last name associated with the user.

string | null

(OPTIONAL) The user's email address; this is not stored in plain text, and will be hashed as the user's GivingProfileId for analytics.

string | null

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

int32

(OPTIONAL) The gender associated with the user; see below for options.
0 = Unknown
1 = Male
2 = Female
3 = Other

string | null

(OPTIONAL) The location address associated with the user.

string | null

(OPTIONAL) The city associated with the user.

string | null

(OPTIONAL) The zipcode associated with the user.

string | null

(OPTIONAL) The country associated with the user.

string | null

(OPTIONAL) The region associated with the user.

userExtensions
object | null

(OPTIONAL) Custom, freeform JSON extensions for querying and analytics.

extensions
object | null

(OPTIONAL) Custom, freeform JSON extensions for querying and analytics.

string | null

(OPTIONAL) If email notifications are enabled, we will attempt to email this address with donation confirmation if provided.

string | null

(OPTIONAL) If email notifications are enabled, this is the name of the user the donation confirmation will be addressed to.

Headers
string
required

Your store ID (we will provide this).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 years ago

Language
Credentials
Response 
 Choose an example:
text/plain
application/json
text/json
Updated about 2 years ago