Core API
...
Core API Docs
Orders
Get a Order
GET
PATH PARAMETERS
id
string
*Either the Internal or External ID
HEADER PARAMETERS
Site-Id
string
*Example: jones-climbing
Spark Layer Site ID
RESPONSES
200
Successful response
Order-2
id
string
Example: o_123
Order ID (always prefixed with o_)
customer_id
string
Example: cu_123
Customer Id
spark_billing_chargeable
boolean
Spark Billing Chargable Order
payment_method
string<upfrontPayment | paymentByInvoice | paymentOnAccount | hokodoPayment | other>
Payment Method
status
string<incoming | processing | shipped | part_shipped | returned | complete | cancelled | on_hold>
Example: processing
Combined package status (Display only)
currency_code
string
external_id
string
Example: B2B00123
External Id
visible_id
string
Example: B2B00123
Visible Id (shown in the My A/c Section)
customer_reference
string
Example: PO123
Customer Reference
created_at
string<date-time>
Example: 2021-01-30T08:30:00Z
Checkout Completed At
billing_address
object
[All Of:Address-2]packages
OrderPackage-2[]
total_sub
object
[All Of:Price-2]total_shipping
object
[All Of:Price-2]total
object
[All Of:Price-2]invoice_url
string
Invoice URL
metadata
object
Metadata
custom_fields
object[]
Additional information collected during checkout
default
Error Response
Updated 18 Sep 2023
Did this page help you?