EcommerceOrders

A list of an account's ecommerce orders.

Table Specific Information

Select

The cmdlet will use the Mailchimp API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the cmdlet.

The StoreId can be retrieved by selecting the ECommerceStores view.

StoreId supports the '=' operator.
Id supports the '=' operator.
CampaignId supports the '=' operator.
Outreach_Id supports the '=' operator.
CustomerId supports the '=' operator.
HasOutreach supports the '=' operator.

For example:

SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123'
SELECT * FROM EcommerceOrders WHERE StoreId = 'Test_Store123' and Id = '44'
SELECT * FROM EcommerceOrders WHERE CampaignId = '12144'
SELECT * FROM EcommerceOrders WHERE Outreach_Id = '12144'
SELECT * FROM EcommerceOrders WHERE CustomerId = '12144'
SELECT * FROM EcommerceOrders WHERE HasOutreach = true

Columns


Name	Type	ReadOnly	Description
StoreId [KEY]	String	False	The StoreId for the table.
Id [KEY]	String	False	A unique identifier for the order.
Customer	String	False	Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
CampaignId	String	False	A string that uniquely identifies the campaign associated with an order.
FinancialStatus	String	False	The order status. For example: `refunded`, `processing`, `cancelled`, etc.
FulfillmentStatus	String	False	The fulfillment status for the order. For example: `partial`, `fulfilled`, etc.
CurrencyCode	String	False	The three-letter ISO 4217 code for the currency that the store accepts.
OrderTotal	Decimal	False	The order total for the order.
TaxTotal	Decimal	False	The tax total for the order.
ShippingTotal	Decimal	False	The shipping total for the order.
TrackingCode	String	False	The MailChimp tracking code for the order. Uses the 'mc_tc' parameter in eCommerce360-enabled tracking urls.
ProcessedAtForeign	Datetime	False	The date and time the order was processed.
CancelledAtForeign	Datetime	False	The date and time the order was cancelled.
UpdatedAtForeign	Datetime	False	The date and time the order was updated.
ShippingAddress_Name	String	False	The name associated with an order's shipping address.
ShippingAddress_Address1	String	False	The shipping address for the order.
ShippingAddress_Address2	String	False	An additional field for the shipping address.
ShippingAddress_City	String	False	The city in the order's shipping address.
ShippingAddress_Province	String	False	The state or normalized province in the order's shipping address.
ShippingAddress_ProvinceCode	String	False	The two-letter code for the province or state the order's shipping address is located in.
ShippingAddress_PostalCode	String	False	The postal or zip code in the order's shipping address.
ShippingAddress_Country	String	False	The country in the order's shipping address.
ShippingAddress_CountryCode	String	False	The two-letter code for the country in the shipping address.
ShippingAddress_Longitude	Double	False	The longitude for the shipping address location.
ShippingAddress_Latitude	Double	False	The latitude for the shipping address location.
ShippingAddress_Phone	String	False	The phone number for the order's shipping address
ShippingAddress_Company	String	False	The company associated with an order's shipping address.
BillingAddress_Name	String	False	The name associated with an order's billing address.
BillingAddress_Address1	String	False	The billing address for the order.
BillingAddress_Address2	String	False	An additional field for the billing address.
BillingAddress_City	String	False	The city in the billing address.
BillingAddress_Province	String	False	The state or normalized province in the billing address.
BillingAddress_ProvinceCode	String	False	The two-letter code for the province or state in the billing address.
BillingAddress_PostalCode	String	False	The postal or zip code in the billing address.
BillingAddress_Country	String	False	The country in the billing address.
BillingAddress_CountryCode	String	False	The two-letter code for the country in the billing address.
BillingAddress_Longitude	Double	False	The longitude for the billing address location.
BillingAddress_Latitude	Double	False	The latitude for the billing address location.
BillingAddress_Phone	String	False	The phone number for the billing address.
BillingAddress_Company	String	False	The company associated with the billing address.
Lines	String	False	An array of the order's line items. The column will not work for Update. Lines can be updated using EcommerceOrderLines table.
Outreach_Id	String	False	A unique identifier for the outreach. Can be an email campaign ID.
Outreach_Name	String	False	The name for the outreach.
Outreach_Type	String	False	The type of the outreach.
Outreach_PublishedTime	String	False	The date and time the Outreach was published in ISO 8601 format.
TrackingNumber	String	False	The tracking number associated with the order.
TrackingCarrier	String	False	The tracking carrier associated with the order.
TrackingUrl	String	False	The tracking url associated with the order.
LandingSite	String	False	The URL for the page where the buyer landed when entering the shop.
Promos	String	False	The promo codes applied on the order.The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided.
OrderUrl	String	False	The URL for the order.
DiscountTotal	Decimal	False	The total amount of the discounts to be applied to the price of the order.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Filter on customer_id, only valid for SELECT.
HasOutreach	Boolean	Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad, only valid for SELECT.

Cmdlets for Mailchimp

EcommerceOrders

Table Specific Information

Select

Columns

Pseudo-Columns