Get Purchase

GET
This endpoint is designed to list any purchase with the ability to easily filter
HEADER PARAMETERS
Site-Id
string
*
Example: jones-climbing
Spark Layer Site ID
QUERY PARAMETERS
customer_identifiers[sparklayer]
string
Filter by customer_identifiers[sparklayer]
customer_identifiers[sparklayer_impersonator]
string
Filter by customer_identifiers[sparklayer_impersonator]
customer_identifiers[sparklayer_sales_rep]
string
Filter by customer_identifiers[sparklayer_sales_rep]
type
string
Example: order
Filter by type
dates[last_updated][lte]
string
Filter by dates[last_updated][lte]
dates[last_updated[gte]
string
Filter by dates[last_updated[gte]
dates[placed][lte]
string
Filter by dates[placed][lte]
dates[placed][gte]
string
Filter by dates[placed][gte]
RESPONSES
200
PurchaseBase[]
type
PurchaseType
Example: order
order_identifiers
object
customer_identifiers
object
payment_method
string<invoice | on_account | platform_upfront>
dates
object
customer_reference
string
currency_code
string
Example: GBP
calculated_shipping_address
string
calculated_total
MonetaryObject
calculated_total_usd
MonetaryObject
calculated_fulfilment_status
string
500
Error Response
﻿
﻿

Updated 18 Sep 2023

Did this page help you?

Create/Update Purchase

JavaScript SDK

Docs powered by

Archbee