Get Purchase

GET
/api/v1/purchases
This endpoint is designed to list any purchase with the ability to easily filter
Header Parameters
Site-Id
string
*
Query Parameters
limit
integer
order_by
string
customer_identifiers[sparklayer]
string
customer_identifiers[sparklayer_impersonator]
string
customer_identifiers[sparklayer_sales_rep]
string
status
string
type
string
dates[last_updated][lte]
string
dates[last_updated][gte]
string
dates[placed][lte]
string
dates[placed][gte]
string
dates[submitted][lte]
string
dates[submitted][gte]
string
Responses
200
PurchaseBase[]
type
PurchaseType
*
purchase_identifiers
object
*
customer_identifiers
object
*
payment_method
string<quote | upfrontPayment | paymentOnAccount | paymentByInvoice>
dates
object
*
customer_reference
string
currency_code
string
calculated_shipping_address
string
calculated_total
object
All Of
MonetaryObject  +
calculated_total_usd
object
All Of
MonetaryObject  +
calculated_fulfilment_status
string<incoming | processing | shipped | part_shipped | cancelled | returned | part_returned | varied>
500
Error Response
﻿
﻿

Updated 17 Dec 2024

Did this page help you?

Create/Update Purchase

Get order stats for a customer