Orders

Endpoint: https://api.omnisend.com/v3/orders

Order payment statuses:

Status	Description
awaitingPayment	Awaiting payment
partiallyPaid	Partially paid
paid	Order paid
partiallyRefunded	Partially refunded
refunded	Refunded
voided	Payment canceled

Order fulfillment statuses:

Status	Description
unfulfilled	order placed
inProgress	order in progress
fulfilled	order prepared for pickup (if delivery type pickup selected) or shipped
delivered	order has been picked up by or delivered to customer
restocked	Restocked

Order cancellation

If order was cancelled - pass canceledDate parameter and cancelReason (optional)

Product categories

To be able to use segmentation by ordered product categories, you need to pass product.categoryIDs within order and all your categories using categories endpoint.

Parameters

Parameter	Type	Description
orderID	string	Order ID from your system
orderNumber	string	Order number. Showed on invoices, etc.
email	string	Contact's email address
contactID	string	Contact's ID in our system
firstName	string	Name
lastName	string	Last name
company	string	Company name
phone	string	Phone number, E.164 format. Phone number in other formats will be accepted, but won't be used in our system (automation, etc.)
cartID	string	Cart ID from which order was made
shippingMethod	string	Shipping method/title
trackingCode	string	Parcel tracking code
courierTitle	string	Courier title
courierUrl	string	Parcel tracking url
orderUrl	string	Link to order page
source	string	Order source
tags	array of strings	Array of order tags
discountCode	string	If available - discount code used for order
currency	string	Currency ISO 4217 code
subTotalSum	integer	Sub total sum in cents
subTotalTaxIncluded	boolean	Whether subTotalSum includes taxes, default: false
orderSum	integer	Final order sum in cents
discountSum	integer	Total discount in cents
discountValue	integer	Discount value: sum in cents for `fixedAmount` type; percentage value for `percentage` type; empty for `freeShipping`
discountType	string	Discount type: `percentage`, `fixedAmount`, `freeShipping`
taxSum	integer	Tax sum in cents
shippingSum	integer	Shipping sum in cents
createdAt	string (format: date-time)	Order creation date. ISO 8601 format. Example: 2017-06-30T17:00:00Z
updatedAt	string (format: date-time)	Order update date. ISO 8601 format. Example: 2017-06-30T17:00:00Z
contactNote	string	Contact's note
paymentMethod	string	Payment method (example: paypal, credit card).
paymentStatus	string	See above for available statuses. You need to map your status with our statuses.
canceledDate	string	If order was canceled - cancellation date. ISO 8601 format. Example: 2017-06-30T17:00:00Z
cancelReason	string	Order cancel reason
fulfillmentStatus	string	See above for available statuses. You need to map your status with our statuses.
billingAddress	object	Object for billing address
shippingAddress	object	Object for shipping address
country	string	Country
countryCode	string	ISO 3166-1 country code, 3 characters. Example: USA
state	string	State
stateCode	string	State code
city	string	City
address	string	Address (street, house, apartment)
address2	string	Address second line
postalCode	string	Contact's postal or zip code.
products	array	Array or products
productID	string	Product ID
sku	string	Product's stock keeping unit
variantID	string	Product variant identificator
variantTitle	string	Product variant title
title	string	Product title
vendor	string	Product's vendor
weight	integer	Product's weight in grams
quantity	integer	Quantity - only whole number.
price	integer	Final price in cents (with discount, with taxes, etc.)
discount	integer	Discount sum in cents.
imageUrl	string	Link to product image
productUrl	string	Link to product page
categoryIDs	array of strings	Array of categories ID's. Pass all categories ID's, including all parent categories ID's, to which product belongs.
product.tags	array of strings	Array of order product tags