Velo: Wix Stores "Orders" Collection Fields

To use the Orders collection in code, refer to it as "Stores/Orders".

This document describes the permissions and fields in your Orders collection.

Permissions

The Order collection has the following permissions:

• Read: Admin 
• Create: None
• Update: None
• Delete: None

You cannot change the Order collection's permissions. 

Fields

The field name is listed as the heading of each section, with the field ID listed in parentheses, like this: Name (name). The fields appear in this document in the order in which they appear in your collection by default.

Number (number)

Description: Running order number.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: Yes

Can be sorted: Yes

Can be filtered: eq, ne, hasSome, le, lt, gt, ge

Read-only: Yes

ID (_id)

Description: The ID of the order. This is a system field and is hidden by default.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: Yes

Can be filtered: eq, ne, hasSome

Read-only: Yes

Updated Date (_updatedDate)

Description: The date and time the order was last updated. This is a system field and is hidden by default.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: Yes

Can be filtered: eq, ne, hasSome, lt, le, gt, ge

Read-only: Yes

Billing Info (billingInfo)

Description: Billing information as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Buyer Info (buyerInfo)

Description: Buyer information as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Note: "identityType" is one of the following:

• "MEMBER": A logged-in site member.
• "CONTACT": A Wix contact.

Buyer Note (buyerNote)

Description: A note added by the buyer on the cart page when creating the order.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Date Created (_dateCreated)

Description: Date and time the order was created.

Type: Date

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: Yes

Can be filtered: eq, ne, hasSome, lt, le, gt, ge

Read-only: Yes

Currency (currency)

Description: Currency of the order.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Fulfillment Status (fulfillmentStatus)

Description: The status of the order's fulfillment.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Note: Value is one of:

• "FULFILLED" - Order was fulfilled successfully.
• "NOT_FULFILLED" - Order is not yet fulfilled.
• "CANCELLED" - Order was cancelled.
• "PARTIALLY_FULFILLED": Order was partially fulfilled.

Archived (archived)

Description: Whether the order is archived.

Type: Boolean

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: eq, ne

Read-only: Yes

Line Items (lineItems)

Description: Lists all the line items for this order in an array of JSON objects.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Note: The "lineItemType" value is one of:

• "PHYSICAL"
• "DIGITAL"
• "CUSTOM_AMOUNT_ITEM" - Item with a custom price.

Activities (activities)

Description: List of activities for this order in an array of JSON objects.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Notes: The "type" value is one of:

• "MERCHANT_COMMENT" - A merchant comment.
• "ORDER_PLACED" - Order placed.
• "ORDER_PAID" - Order marked as paid, either by the store owner (for offline orders), or when an online transaction is confirmed.
• "ORDER_FULFILLED" - Order shipping status set as fulfilled.
• "ORDER_NOT_FULFILLED" - Order shipping status set as not fulfilled.
• "DOWNLOAD_LINK_SENT" - Download link was sent (relevant for orders with digital line items).
• "PICKUP_READY_EMAIL_SENT" - Email notification for pickup was sent.
• "TRACKING_NUMBER_ADDED" - Shipping tracking number was set.
• "TRACKING_NUMBER_EDITED" - Shipping tracking number was edited.
• "TRACKING_LINK_WAS_SET" - Shipping tracking link was set.
• "SHIPPING_CONFIRMATION_EMAIL_SENT" - An email confirmation of the order shipment was sent.
• "INVOICE_WAS_SET" - Invoice was added to the order.
• "INVOICE_WAS_REMOVED" - Invoice was removed from the order.
• "INVOICE_WAS_SENT" - Invoice was sent to customer via email.

Payment Status (paymentStatus)

Description: Status of the order's payment.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: Yes

Can be filtered: eq, ne, hasSome

Read-only: Yes

Note: One of: 

• "PAID"
• "NOT_PAID"
• "PARTIALLY_REFUNDED"
• "FULLY_REFUNDED"

The "NOT_PAID" status is only for manual payment orders. Other non-paid orders, such as declined payments, do not appear in the orders collection.

Shipping Info (shippingInfo)

Description: The order's shipping information as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Notes: 

• Either "shipmentDetails" or "pickupDetails" will be present, but not both.

Totals (totals)

Description: The order's total information as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Weight Unit (weightUnit)

Description: The unit in which the order's weight is measured ("KG" or "LB").

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Custom Field (customField)

Description: Information about a custom field added to the checkout process as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Fulfillments (fulfillments)

Description: Lists of fulfillments for this order in an array of JSON objects.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Buyer Language (buyerLanguage)

Description: The site's displayed language.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Cart ID (cartId)

Description: The shopping cart's unique ID.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Channel Info (channelInfo)

Description: Information about the sales channel that submitted the order, as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Entered By (enteredBy)

Description: Information about the identity of the order's operator as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Note: The identityType value - the order was created by one of the following:

• "USER" - Wix user who performed a POS transaction on behalf of the buyer.
• "MEMBER" - Logged-in site member.
• "CONTACT" - A Wix contact.

Refunds (refunds)

Description: Information about order refunds in an array of JSON objects.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Note: Details about externalRefund boolean field:

• Indicates whether the refund was made externally.
• An external refund refers to refunds processed by the payment provider and reported to the Wix orders system.
• When the value is false, the refund was reported to the Wix orders system but was not processed by the payment provider.

Subscription Information (subscriptionInfo)

Description: Information about an order's subscription as a JSON object.

Type: JSON

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Note: 'frequency' field - frequency of recurring payment. One of:

• "DAY" - Daily
• "WEEK" - Weekly
• "MONTH" - Monthly
• "YEAR" - Yearly