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",
updatedTimestamp: 1592351971,
createdTimestamp: 1589865701,
}
Properties
idString
A string field that represents the unique identifier of the order.
remoteIdString
The ID of the object in the third-party application.
createdTimestampNumber
A number field that indicates the Unix timestamp (in seconds) when the order was created.
updatedTimestampNumber
A number field that indicates the Unix timestamp (in seconds) when the order was last updated.
orderNumberString
A string field that represents the order number assigned to the order.
orderStatusString
A string field that represents the current status of the order.
fulfillmentStatusString
A string field that represents the fulfillment status of the order.
totalShippingString
A number field that represents the total cost of shipping for the order.
totalDiscountString
A string field that represents the total discount applied to the order.
totalTaxString
A string field that represents the total tax applied to the order.
totalPriceString
A string field that represents the total price of the order.
currencyString
A string field that represents the currency used for the order.
lineItemsObject[]
An array of objects that represent the individual line items in the order.
paymentStatusString
A string field that represents the payment status of the order.
billingAddressObject
An object that represents the billing address of the customer who placed the order.
shippingAddressObject
An object that represents the shipping address of the customer who placed the order.
customerObject
An object that represents the customer who placed the order.
Order Line Item Object Properties
productIdString
A unique identifier for the product.
variantIdString
A unique identifier for the product variant.
titleString
The title of the product or variant.
priceString
The price of the line item.
unitCostString
The unit cost of the line item.
currencyString
The currency used for the line item price and unit cost.
skuString
The SKU (stock keeping unit) of the line item.
quantityNumber
The quantity of the line item.
Shipping / Billing Address Object Properties
address1String
The first line of the street address.
address2String
The second line of the street address.
cityString
The city or locality.
postalCodeString
The postal or ZIP code.
regionString
The region or state.
countryCodeString
The two-letter country code.
firstNameString
The first name of the recipient.
lastNameString
The last name of the recipient.
phoneString
The phone number of the recipient.
Order Customer Object Properties
customerIdString
A unique identifier for a customer.
firstNameString
The first name of the customer.
lastNameString
The last name of the customer.
emailString
The email address of the customer.
phoneString
The phone number of the customer.