The order object contains information such as their orderStatus, lineItems, etc.
{
id: "00000000-0000-0000-0000-000000000000",
remoteId: "2191357149242",
orderStatus: "Active",
lineItems: [
{
quantity: 1,
productId: "4463254208570",
price: "1000.00",
unitCost: "",
currency: "USD",
variantId: "31586061353018",
title: "T-Shirt",
sku: "shirt-01"
}
],
orderNumber: "1001",
paymentStatus: "Paid",
customer: {
customerId: "3046096732218",
firstName: "Chase",
lastName: "Red",
phone: "",
email: "[email protected]"
},
currency: "USD",
totalPrice: "1000.00",
totalDiscount: "0.00",
totalShipping: "0.00",
totalTax: "0.00",
fulfillmentStatus: "unfulfilled",
remoteCreatedAt: "2023-11-19T17:00:17.000Z",
remoteUpdatedAt: "2023-11-19T17:00:17.000Z",
remoteDeleted: false,
createdAt: "2024-02-22T11:17:53.264Z",
updatedAt: "2024-02-22T13:54:03.445Z"
}
Properties
id
String
A string field that represents the unique identifier of the order.
remoteId
String
The ID of the object in the third-party application.
orderNumber
String
A string field that represents the order number assigned to the order.
orderStatus
String
A string field that represents the current status of the order.
fulfillmentStatus
String
A string field that represents the fulfillment status of the order.
totalShipping
String
A number field that represents the total cost of shipping for the order.
totalDiscount
String
A string field that represents the total discount applied to the order.
totalTax
String
A string field that represents the total tax applied to the order.
totalPrice
String
A string field that represents the total price of the order.
currency
String
A string field that represents the currency used for the order.
lineItems
Object[]
An array of objects that represent the individual line items in the order.
paymentStatus
String
A string field that represents the payment status of the order.
billingAddress
Object
An object that represents the billing address of the customer who placed the order.
shippingAddress
Object
An object that represents the shipping address of the customer who placed the order.
customer
Object
An object that represents the customer who placed the order.
remoteCreatedAt
DateTime
The exact date and time when the record was first added or created in the third-party application.
remoteUpdatedAt
DateTime
The latest date and time when any modifications or updates were made to the record's details in the third-party application.
remoteDeleted
Boolean
Flag to indicate that the record has been deleted in the third-party application.
createdAt
DateTime
Date and time the record has been synced into the data cache.
updatedAt
DateTime
Date and time the record has been updated in the data cache.
Order Line Item Object Properties
productId
String
A unique identifier for the product.
variantId
String
A unique identifier for the product variant.
title
String
The title of the product or variant.
price
String
The price of the line item.
unitCost
String
The unit cost of the line item.
currency
String
The currency used for the line item price and unit cost.
sku
String
The SKU (stock keeping unit) of the line item.
quantity
Number
The quantity of the line item.
Shipping / Billing Address Object Properties
address1
String
The first line of the street address.
address2
String
The second line of the street address.
city
String
The city or locality.
postalCode
String
The postal or ZIP code.
region
String
The region or state.
countryCode
String
The two-letter country code.
firstName
String
The first name of the recipient.
lastName
String
The last name of the recipient.
phone
String
The phone number of the recipient.
Order Customer Object Properties
customerId
String
A unique identifier for a customer.
firstName
String
The first name of the customer.
lastName
String
The last name of the customer.
email
String
The email address of the customer.
phone
String
The phone number of the customer.