Purchasing API
...
Purchasing API Docs
Purchasing
Create/Update Purchase
PUT
/api/v1/purchases/{lookupBy}/{identifier}
Path Parameters
lookupBy
string
*
identifier
string
*
Body Parameters
body
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[]
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[]
403
Trying to update purchase SparkLayer ID, which is immutable
404
Error Response
409
A conflict has occurred
500
Error Response
Updated 24 Sep 2024
Did this page help you?