Purchasing API

...

Purchasing API Docs

Purchasing

Get Purchase

GET
/api/v1/purchases/{lookupBy}/{identifier}
Retrieve an cart, quote, awaiting approval order or an finalised order
Header Parameters
Site-Id
string
*
Responses
200
Purchase
Description
SparkLayer purchase object
All Of
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>
revision_date
string<date-time>
billing_address
PurchaseAddress
packages
Package[]
*
One Of
Incoming 
accounting_files
PurchaseFiles[]
*
custom_fields
object[]
*
metadata
object[]
404
Error Response
500
Error Response
﻿
﻿

Updated 17 Dec 2024

Did this page help you?

Delete Purchase

Docs powered by Archbee