Reference

Endpoint Get Orders

Name

get_orders

Description

Gets a list of orders by status, date and other search criteria. By default only Open orders returned. Change Status parameter to any to get all orders. [API reference]

Related Tables

Orders

Parameters

Parameter Required Options
Name: ids

Label: Order Id(s) - Comma separated

Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams)
Name: since_id

Label: Since Order Id

Restrict results created after the specified order ID.
Name: created_at_max

Label: Created Before

Restrict results to orders created before a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: created_at_min

Label: Created After

Restrict results to orders created after a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: updated_at_max

Label: Updated Before

Restrict results to orders last updated before a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: updated_at_min

Label: Updated After

Restrict results to orders last updated after a specified date. (format: 2014-04-25T16:15:47-04:00)
Name: attribution_app_id

Label: Attribution App Id

Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API.
Name: financial_status

Label: Financial Status

Filter orders by their financial status. (Default: any)
Option Value
any any
authorized authorized
pending pending
paid paid
partially_paid partially_paid
refunded refunded
voided voided
partially_refunded partially_refunded
unpaid unpaid
Name: fulfillment_status

Label: Fulfillment Status

Filter orders by their fulfillment status. (Default: any)
Option Value
any any
shipped shipped
partial partial
unshipped unshipped
unfulfilled unfulfilled
Name: processed_at_max

Label: Imported Before

Show orders imported at or before date.
Name: processed_at_min

Label: Imported After

Show orders imported at or after date.
Name: status

Label: Status

Filter orders by their status. (Default: open)
Option Value
open open
closed closed
cancelled cancelled
any any
Name: limit

Label: Page Size

The maximum number of records to show.
Name: fields

Label: Only Fields to Show

Limit data retrieval to only the selected order-related fields.
Option Value
app_id app_id
browser_ip browser_ip
buyer_accepts_marketing buyer_accepts_marketing
cancel_reason cancel_reason
cancelled_at cancelled_at
cart_token cart_token
checkout_token checkout_token
closed_at closed_at
created_at created_at
currency currency
current_total_discounts current_total_discounts
current_total_price current_total_price
current_subtotal_price current_subtotal_price
current_total_tax current_total_tax
customer_locale customer_locale
email email
estimated_taxes estimated_taxes
financial_status financial_status
fulfillment_status fulfillment_status
gateway gateway
id id
landing_site landing_site
location_id location_id
merchant_of_record_app_id merchant_of_record_app_id
name name
note note
number number
order_number order_number
phone phone
presentment_currency presentment_currency
processed_at processed_at
processing_method processing_method
referring_site referring_site
source_name source_name
source_identifier source_identifier
source_url source_url
subtotal_price subtotal_price
tags tags
taxes_included taxes_included
test test
token token
total_discounts total_discounts
total_line_items_price total_line_items_price
total_outstanding total_outstanding
total_price total_price
total_tax total_tax
total_tip_received total_tip_received
total_weight total_weight
updated_at updated_at
user_id user_id

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_I8 bigint
BillingAddressLine1 DT_WSTR nvarchar(255) 255
BillingAddressLine2 DT_WSTR nvarchar(255) 255
BillingAddressCity DT_WSTR nvarchar(255) 255
BillingAddressCompany DT_WSTR nvarchar(255) 255
BillingAddressCountry DT_WSTR nvarchar(255) 255
BillingAddressFirstName DT_WSTR nvarchar(255) 255
BillingAddressLastName DT_WSTR nvarchar(255) 255
BillingAddressPhone DT_WSTR nvarchar(255) 255
BillingAddressProvince DT_WSTR nvarchar(255) 255
BillingAddressZip DT_WSTR nvarchar(255) 255
BillingAddressName DT_WSTR nvarchar(255) 255
BillingAddressProvinceCode DT_WSTR nvarchar(255) 255
BillingAddressCountryCode DT_WSTR nvarchar(255) 255
BillingAddressLatitude DT_WSTR nvarchar(255) 255
BillingAddressLongitude DT_WSTR nvarchar(255) 255
BrowserIp DT_WSTR nvarchar(255) 255
BuyerAcceptsMarketing DT_BOOL bit
LineItems DT_NTEXT nvarchar(MAX)
CancelReason DT_WSTR nvarchar(255) 255
CancelledAt DT_WSTR nvarchar(255) 255
CartToken DT_WSTR nvarchar(255) 255
CheckoutToken DT_WSTR nvarchar(255) 255
ClientDetailsAcceptLanguage DT_WSTR nvarchar(255) 255
ClientDetailsBrowserHeight DT_I4 int
ClientDetailsBrowserIp DT_WSTR nvarchar(255) 255
ClientDetailsBrowserWidth DT_I4 int
ClientDetailsSessionHash DT_WSTR nvarchar(255) 255
ClientDetailsUserAgent DT_WSTR nvarchar(255) 255
ClosedAt DT_WSTR nvarchar(255) 255
CompanyId DT_I8 bigint
CompanyLocationId DT_I8 bigint
CreatedAt DT_WSTR nvarchar(255) 255
Currency DT_WSTR nvarchar(255) 255
CurrentTotalDiscounts DT_WSTR nvarchar(255) 255
CurrentTotalDiscountsShopMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalDiscountsShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalDiscountsPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalDiscountsPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalDutiesShopMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalDutiesShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalDutiesPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalDutiesPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalPrice DT_WSTR nvarchar(255) 255
CurrentTotalPriceShopMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalPriceShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalPricePresentmentMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalPricePresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentSubtotalPrice DT_WSTR nvarchar(255) 255
CurrentSubtotalPriceShopMoneyAmount DT_WSTR nvarchar(255) 255
CurrentSubtotalPriceShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentSubtotalPricePresentmentMoneyAmount DT_WSTR nvarchar(255) 255
CurrentSubtotalPricePresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalTax DT_WSTR nvarchar(255) 255
CurrentTotalTaxShopMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalTaxShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CurrentTotalTaxPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
CurrentTotalTaxPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
CustomerId DT_I8 bigint
CustomerLocale DT_WSTR nvarchar(255) 255
Email DT_WSTR nvarchar(255) 255
EstimatedTaxes DT_BOOL bit
FinancialStatus DT_WSTR nvarchar(255) 255
FulfillmentStatus DT_WSTR nvarchar(255) 255
LandingSite DT_WSTR nvarchar(255) 255
LocationId DT_I8 bigint
MerchantOfRecordAppId DT_I8 bigint
Name DT_WSTR nvarchar(255) 255
Note DT_NTEXT nvarchar(MAX)
Number DT_I4 int
OrderNumber DT_I4 int
OriginalTotalDutiesShopMoneyAmount DT_WSTR nvarchar(255) 255
OriginalTotalDutiesShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
OriginalTotalDutiesPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
OriginalTotalDutiesPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
PaymentTermsAmount DT_DECIMAL decimal(0,5)
PaymentTermsCurrency DT_WSTR nvarchar(255) 255
PaymentTermsName DT_WSTR nvarchar(255) 255
PaymentTermsType DT_WSTR nvarchar(255) 255
PaymentTermsDueInDays DT_I4 int
Phone DT_WSTR nvarchar(255) 255
PresentmentCurrency DT_WSTR nvarchar(255) 255
ProcessedAt DT_WSTR nvarchar(255) 255
ProcessingMethod DT_WSTR nvarchar(255) 255
ReferringSite DT_WSTR nvarchar(255) 255
ShippingAddressLine1 DT_WSTR nvarchar(255) 255
ShippingAddressLine2 DT_WSTR nvarchar(255) 255
ShippingAddressCity DT_WSTR nvarchar(255) 255
ShippingAddressCompany DT_WSTR nvarchar(255) 255
ShippingAddressCountry DT_WSTR nvarchar(255) 255
ShippingAddressFirstName DT_WSTR nvarchar(255) 255
ShippingAddressLastName DT_WSTR nvarchar(255) 255
ShippingAddressPhone DT_WSTR nvarchar(255) 255
ShippingAddressProvince DT_WSTR nvarchar(255) 255
ShippingAddressZip DT_WSTR nvarchar(255) 255
ShippingAddressName DT_WSTR nvarchar(255) 255
ShippingAddressProvinceCode DT_WSTR nvarchar(255) 255
ShippingAddressCountryCode DT_WSTR nvarchar(255) 255
ShippingAddressLatitude DT_WSTR nvarchar(255) 255
ShippingAddressLongitude DT_WSTR nvarchar(255) 255
SourceName DT_WSTR nvarchar(255) 255
SourceIdentifier DT_WSTR nvarchar(255) 255
SourceUrl DT_WSTR nvarchar(255) 255
SubtotalPrice DT_DECIMAL decimal(0,5)
SubtotalPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255
SubtotalPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
SubtotalPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
SubtotalPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
Tags DT_NTEXT nvarchar(MAX)
TaxesIncluded DT_BOOL bit
Test DT_BOOL bit
Token DT_WSTR nvarchar(255) 255
TotalDiscounts DT_WSTR nvarchar(255) 255
TotalDiscountsSetShopMoneyAmount DT_WSTR nvarchar(255) 255
TotalDiscountsSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalDiscountsSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
TotalDiscountsSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalLineItemsPrice DT_WSTR nvarchar(255) 255
TotalLineItemsPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255
TotalLineItemsPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalLineItemsPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
TotalLineItemsPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalOutstanding DT_WSTR nvarchar(255) 255
TotalPrice DT_WSTR nvarchar(255) 255
TotalPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255
TotalPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
TotalPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalShippingPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255
TotalShippingPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalShippingPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
TotalShippingPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalTax DT_WSTR nvarchar(255) 255
TotalTaxSetShopMoneyAmount DT_WSTR nvarchar(255) 255
TotalTaxSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalTaxSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255
TotalTaxSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255
TotalTipReceived DT_WSTR nvarchar(255) 255
TotalWeight DT_DECIMAL decimal(0,5)
UpdatedAt DT_WSTR nvarchar(255) 255
UserId DT_I8 bigint
OrderStatusUrl DT_WSTR nvarchar(255) 255
If the column you are looking for is missing, consider customizing Shopify Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
OrderId DT_I8 bigint
Required columns that you need to supply are bolded.

Examples

SSIS

Use Shopify Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Orders table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Shopify
Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
Shopify
Orders
Optional Parameters
Order Id(s) - Comma separated
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Orders table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get orders:

API Destination - Shopify
Read and write Shopify data effortlessly. Integrate, manage, and automate customers, orders, products, and inventory — almost no coding required.
Shopify
Orders
Select, Lookup
Optional Parameters
Order Id(s) - Comma separated
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read orders

<p>Gets a list of all orders from the <code>Orders</code> table.</p> 

SELECT * FROM Orders

Read open orders

<p>Gets a list of orders filtered by status. Use the <code>Status</code> parameter in the <code>WITH</code> clause (e.g. 'open', 'closed', 'cancelled', 'any').</p> 

SELECT * FROM Orders WITH (Status='open') --also try 'any', 'open', 'closed', 'cancelled'

Read multiple orders by IDs

<p>Gets multiple orders by supplying a comma-separated list of IDs in the <code>ids</code> parameter within the <code>WITH</code> clause.</p> 

SELECT * FROM Orders WITH(ids='1111111111111,2222222222222,3333333333333')

Read an order by ID

<p>Gets a specific order by its unique <code>Id</code>. Supply the order ID in the <code>WHERE</code> clause.</p> 

SELECT * FROM Orders Where Id=1111111111111

get_orders endpoint belongs to Orders table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read orders

<p>Gets a list of all orders from the <code>Orders</code> table.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Orders';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Read open orders

<p>Gets a list of orders filtered by status. Use the <code>Status</code> parameter in the <code>WITH</code> clause (e.g. 'open', 'closed', 'cancelled', 'any').</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Orders WITH (Status=''open'') --also try ''any'', ''open'', ''closed'', ''cancelled''';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Read multiple orders by IDs

<p>Gets multiple orders by supplying a comma-separated list of IDs in the <code>ids</code> parameter within the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Orders WITH(ids=''1111111111111,2222222222222,3333333333333'')';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Read an order by ID

<p>Gets a specific order by its unique <code>Id</code>. Supply the order ID in the <code>WHERE</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Orders Where Id=1111111111111';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

get_orders endpoint belongs to Orders table(s), and can therefore be used via those table(s).