Retrieves orders attributed to members of a LoudCrowd program. Each result identifies the program member and includes attribution methods, financial values, and platform timestamps. Orders are returned in the order LoudCrowd received them, with the most recent first. Requires the Read orders and Read programs scopes.
Use this endpoint to retrieve orders attributed to members of a LoudCrowd program. Each result identifies the program member and includes attribution methods, financial values, and platform timestamps.
Required scopes
This endpoint requires the Read orders and Read programs scopes.
Which orders are returned
An order is included when:
- The member was approved for the program when the order was placed.
- The order came from the program's connected store.
- The order uses the program's currency.
- The order was placed on or after the program was created.
Cancelled and fully refunded orders are included.
Pagination
Orders are returned in the order LoudCrowd received them, with the most recent first.
Send nextCursor unchanged as the cursor query parameter for the next request. You can instead follow the URL in the Link response header.
On the final page, nextCursor is null and the Link header is absent.
Attribution
Each order appears once. ambassadorLcId identifies the selected program member.
attributionTypes lists every distinct attribution method recorded for the order. It can include more than one method.
| Attribution type | Meaning |
|---|---|
LANDED | The purchase followed a tracked visit. |
AFFILIATE_CODE | The customer used an ambassador's affiliate or discount code. |
LINK_DISCOUNT | An automatic discount associated with an ambassador link was applied. |
EXTERNAL | An external affiliate network supplied the attribution. |
MANUAL | The attribution was assigned manually. |
Monetary values
All monetary values use the order's three-letter currency code. They are returned as exact decimal strings, so parse them with a decimal or fixed-point number type.
amountis the order total before refunds. It includestaxandshipping.refundAmountis LoudCrowd's processed refund total. It includesrefundTax.refundTaxis the tax portion ofrefundAmount, not an additional refund.
Cancelled orders
Cancelled orders remain in the response. Their financial values depend on when the cancellation occurs:
- If the order is cancelled before commission is paid,
amount,tax,shipping,refundAmount,refundTax, andcommissionAmountare all"0.00". - If the order is cancelled after commission is paid, those values remain as recorded when the commission was paid.
currency is still returned.
Sample calculations
Given these values:
| Field | Value |
|---|---|
currency | "USD" |
amount | "115.00" |
tax | "10.00" |
shipping | "5.00" |
refundAmount | "23.00" |
refundTax | "3.00" |
- Order amount after refunds:
amount - refundAmount = 115.00 - 23.00 = 92.00 - Tax after refunds:
tax - refundTax = 10.00 - 3.00 = 7.00 - Non-tax portion of the refund:
refundAmount - refundTax = 23.00 - 3.00 = 20.00 - Amount before refunds, excluding tax and shipping:
amount - tax - shipping = 115.00 - 10.00 - 5.00 = 100.00
Do not subtract refundTax from amount again. It is already included in refundAmount.