API Reference
SupportSiteVibes Login

Send order data

post
https://api.sitevibes.com/v1/order-data

Send information about order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Identifier used to differentiate different applications api is used in

string
required

Unique user session identifier used to differentiate unique impressions

string
required

Unique Id of the order

string | null

Date or date with time of when order was created, for new orders will use current date if null

string | null

Channel flag (null, "online", "in_store", "phone", "website", "app")

string | null

Order Payment Methods (multiple values can be included, separated by a comma). Standard methods ("credit_card", "gift_card", "store_credit", "paypal", "apple_pay", "google_pay")

string | null

Update order status value

boolean | null
Defaults to false

Enroll a customer in loyalty program if they are not already enrolled

string | null

Shipping method name

number | null

Shipping total price

products
array of objects
required

List of ordered products

products*
string

Customer email

string

Customer first name

string

Customer last name

coupons
array of strings

Array of loyalty coupon codes used in this order

coupons
boolean
Defaults to false

Prevent sending Loyalty - Points Earned Email for this earn type

boolean
Defaults to false

When updating existing order, remove order products that are not send in current request

boolean
Defaults to false

When true, the response will include points_earned (the order's total loyalty points at ingest) and new_points_earned (the delta from this specific request, useful when updating an existing order). Both are null if the customer is not enrolled in the loyalty program or no earn type matched. points_earned reflects the headline total for the order and may change later (e.g. refunds). Use the loyalty customer activity endpoint for the authoritative current balance.

billing_address
object | null

Billing Address

shipping_address
object | null

Shipping Address

boolean

Test request only for request validation (sent information will not be saved)

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?