Skip to main content
POST
/
sales
Create a new sale
curl --request POST \
  --url https://www.pushlapgrowth.com/api/v1/sales \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "promoCode": "<string>",
  "name": "<string>",
  "externalId": "<string>",
  "externalInvoiceId": "<string>",
  "totalEarned": 123,
  "commissionRate": 123
}'
{
  "id": 123,
  "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "externalInvoiceId": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "totalEarned": 123,
  "commissionRate": 123,
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Sale details

totalEarned
number
required

Total amount earned from the sale

referralId
string<uuid>

The referral ID, or affiliate link or affiliate ID associated with the sale (required if email and promoCode are not provided)

email
string<email>

Email associated with the sale (required if referralId and promoCode are not provided)

promoCode
string

The promotional code associated with an affiliate (required if referralId and email are not provided). When used, the promo code will be validated and its redemption count will be incremented.

name
string

Name of the customer (required if not found via referralId or email)

externalId
string

The external ID of the sale

externalInvoiceId
string

The external invoice ID of the sale

commissionRate
number

Commission rate for the sale (optional, defaults to affiliate's commission rate)

Response

Sale created successfully

id
integer

The sale ID

affiliateId
string<uuid>

The affiliate ID associated with the sale

referralId
string<uuid>

The referral ID associated with the sale

externalId
string

The external ID of the sale

externalInvoiceId
string

The external invoice ID of the sale

name
string

Name of the sale

email
string<email>

Email associated with the sale

totalEarned
number

Total amount earned from the sale

commissionRate
number

Commission rate for the sale

createdAt
string<date-time>

Creation timestamp of the sale

I