Shopify Connector
Documentation
Version: 2
Documentation
Home » API Integration Hub » Shopify Connector » EndPoints » Get Order Items

EndPoint Get Order Items

Name

get_order_items

Description

Gets a list of line items for all orders or the specified order(s). [API reference]

Parameters

Parameter Label Required Options Description
ids Order Id(s) - Comma separated NO Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams)
since_id Since Order Id NO Restrict results created after the specified order ID.
created_at_max Created Before NO Restrict results to orders created before a specified date. (format: 2014-04-25T16:15:47-04:00)
created_at_min Created After NO Restrict results to orders created after a specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_max Updated Before NO Restrict results to orders last updated before a specified date. (format: 2014-04-25T16:15:47-04:00)
updated_at_min Updated After NO Restrict results to orders last updated after a specified date. (format: 2014-04-25T16:15:47-04:00)
attribution_app_id Attribution App Id NO 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.
financial_status Financial Status NO
Option Value
any any
authorized authorized
pending pending
paid paid
partially_paid partially_paid
refunded refunded
voided voided
partially_refunded partially_refunded
unpaid unpaid
Filter orders by their financial status. (Default: any)
fulfillment_status Fulfillment Status NO
Option Value
any any
shipped shipped
partial partial
unshipped unshipped
unfulfilled unfulfilled
Filter orders by their fulfillment status. (Default: any)
processed_at_max Imported Before NO Show orders imported at or before date.
processed_at_min Imported After NO Show orders imported at or after date.
status Status NO
Option Value
open open
closed closed
cancelled cancelled
any any
Filter orders by their status. (Default: open)
limit Page Size NO The maximum number of records to show.
fields Only Fields to Show NO
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
Limit data retrieval to only the selected order-related fields.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_I8 bigint False
OrderId DT_I8 bigint False
OrderNumber DT_I4 int False
FulfillableQuantity DT_I4 int False
FulfillmentService DT_WSTR nvarchar(255) 255 False
FulfillmentStatus DT_WSTR nvarchar(255) 255 False
Grams DT_I4 int False
Price DT_WSTR nvarchar(255) 255 False
ProductId DT_I8 bigint False
Quantity DT_I4 int False
RequiresShipping DT_BOOL bit False
Sku DT_WSTR nvarchar(255) 255 False
Name DT_WSTR nvarchar(255) 255 False
Title DT_WSTR nvarchar(255) 255 False
VariantId DT_I8 bigint False
VariantTitle DT_WSTR nvarchar(255) 255 False
Vendor DT_WSTR nvarchar(255) 255 False
ProductExists DT_BOOL bit False
GiftCard DT_BOOL bit False
PriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
PriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
PriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
PriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
Properties DT_WSTR nvarchar(4000) 4000 True
Taxable DT_BOOL bit False
TaxLines DT_WSTR nvarchar(4000) 4000 True
TotalDiscount DT_WSTR nvarchar(255) 255 False
TotalDiscountSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalDiscountSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalDiscountSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalDiscountSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
DiscountAllocations DT_WSTR nvarchar(4000) 4000 True
OriginLocationId DT_WSTR nvarchar(255) 255 False
OriginLocationCountryCode DT_WSTR nvarchar(255) 255 False
OriginLocationProvinceCode DT_WSTR nvarchar(255) 255 False
OriginLocationName DT_WSTR nvarchar(255) 255 False
OriginLocationAddress1 DT_WSTR nvarchar(255) 255 False
OriginLocationAddress2 DT_WSTR nvarchar(255) 255 False
OriginLocationCity DT_WSTR nvarchar(255) 255 False
OriginLocationZip DT_WSTR nvarchar(255) 255 False
Duties DT_WSTR nvarchar(4000) 4000 True
BillingAddressLine1 DT_WSTR nvarchar(255) 255 False
BillingAddressLine2 DT_WSTR nvarchar(255) 255 False
BillingAddressCity DT_WSTR nvarchar(255) 255 False
BillingAddressCompany DT_WSTR nvarchar(255) 255 False
BillingAddressCountry DT_WSTR nvarchar(255) 255 False
BillingAddressFirstName DT_WSTR nvarchar(255) 255 False
BillingAddressLastName DT_WSTR nvarchar(255) 255 False
BillingAddressPhone DT_WSTR nvarchar(255) 255 False
BillingAddressProvince DT_WSTR nvarchar(255) 255 False
BillingAddressZip DT_WSTR nvarchar(255) 255 False
BillingAddressName DT_WSTR nvarchar(255) 255 False
BillingAddressProvinceCode DT_WSTR nvarchar(255) 255 False
BillingAddressCountryCode DT_WSTR nvarchar(255) 255 False
BillingAddressLatitude DT_WSTR nvarchar(255) 255 False
BillingAddressLongitude DT_WSTR nvarchar(255) 255 False
BrowserIp DT_WSTR nvarchar(255) 255 False
BuyerAcceptsMarketing DT_BOOL bit False
LineItems DT_WSTR nvarchar(4000) 4000 True
CancelReason DT_WSTR nvarchar(255) 255 False
CancelledAt DT_WSTR nvarchar(255) 255 False
CartToken DT_WSTR nvarchar(255) 255 False
CheckoutToken DT_WSTR nvarchar(255) 255 False
ClientDetailsAcceptLanguage DT_WSTR nvarchar(255) 255 False
ClientDetailsBrowserHeight DT_I4 int False
ClientDetailsBrowserIp DT_WSTR nvarchar(255) 255 False
ClientDetailsBrowserWidth DT_I4 int False
ClientDetailsSessionHash DT_WSTR nvarchar(255) 255 False
ClientDetailsUserAgent DT_WSTR nvarchar(255) 255 False
ClosedAt DT_WSTR nvarchar(255) 255 False
CompanyId DT_I8 bigint False
CompanyLocationId DT_I8 bigint False
CreatedAt DT_WSTR nvarchar(255) 255 False
Currency DT_WSTR nvarchar(255) 255 False
CurrentTotalDiscounts DT_WSTR nvarchar(255) 255 False
CurrentTotalDiscountsShopMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalDiscountsShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalDiscountsPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalDiscountsPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalDutiesShopMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalDutiesShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalDutiesPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalDutiesPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalPrice DT_WSTR nvarchar(255) 255 False
CurrentTotalPriceShopMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalPriceShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalPricePresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalPricePresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentSubtotalPrice DT_WSTR nvarchar(255) 255 False
CurrentSubtotalPriceShopMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentSubtotalPriceShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentSubtotalPricePresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentSubtotalPricePresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalTax DT_WSTR nvarchar(255) 255 False
CurrentTotalTaxShopMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalTaxShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CurrentTotalTaxPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
CurrentTotalTaxPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
CustomerId DT_I8 bigint False
CustomerLocale DT_WSTR nvarchar(255) 255 False
Email DT_WSTR nvarchar(255) 255 False
EstimatedTaxes DT_BOOL bit False
FinancialStatus DT_WSTR nvarchar(255) 255 False
OrderFulfillmentStatus DT_WSTR nvarchar(255) 255 False
LandingSite DT_WSTR nvarchar(255) 255 False
LocationId DT_I8 bigint False
MerchantOfRecordAppId DT_I8 bigint False
OrderName DT_WSTR nvarchar(255) 255 False
Note DT_NTEXT nvarchar(MAX) False
Number DT_I4 int False
OriginalTotalDutiesShopMoneyAmount DT_WSTR nvarchar(255) 255 False
OriginalTotalDutiesShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
OriginalTotalDutiesPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
OriginalTotalDutiesPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
PaymentTermsAmount DT_DECIMAL decimal(0,5) False
PaymentTermsCurrency DT_WSTR nvarchar(255) 255 False
PaymentTermsName DT_WSTR nvarchar(255) 255 False
PaymentTermsType DT_WSTR nvarchar(255) 255 False
PaymentTermsDueInDays DT_I4 int False
Phone DT_WSTR nvarchar(255) 255 False
PresentmentCurrency DT_WSTR nvarchar(255) 255 False
ProcessedAt DT_WSTR nvarchar(255) 255 False
ProcessingMethod DT_WSTR nvarchar(255) 255 False
ReferringSite DT_WSTR nvarchar(255) 255 False
ShippingAddressLine1 DT_WSTR nvarchar(255) 255 False
ShippingAddressLine2 DT_WSTR nvarchar(255) 255 False
ShippingAddressCity DT_WSTR nvarchar(255) 255 False
ShippingAddressCompany DT_WSTR nvarchar(255) 255 False
ShippingAddressCountry DT_WSTR nvarchar(255) 255 False
ShippingAddressFirstName DT_WSTR nvarchar(255) 255 False
ShippingAddressLastName DT_WSTR nvarchar(255) 255 False
ShippingAddressPhone DT_WSTR nvarchar(255) 255 False
ShippingAddressProvince DT_WSTR nvarchar(255) 255 False
ShippingAddressZip DT_WSTR nvarchar(255) 255 False
ShippingAddressName DT_WSTR nvarchar(255) 255 False
ShippingAddressProvinceCode DT_WSTR nvarchar(255) 255 False
ShippingAddressCountryCode DT_WSTR nvarchar(255) 255 False
ShippingAddressLatitude DT_WSTR nvarchar(255) 255 False
ShippingAddressLongitude DT_WSTR nvarchar(255) 255 False
SourceName DT_WSTR nvarchar(255) 255 False
SourceIdentifier DT_WSTR nvarchar(255) 255 False
SourceUrl DT_WSTR nvarchar(255) 255 False
SubtotalPrice DT_DECIMAL decimal(0,5) False
SubtotalPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
SubtotalPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
SubtotalPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
SubtotalPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
Tags DT_NTEXT nvarchar(MAX) False
TaxesIncluded DT_BOOL bit False
Test DT_BOOL bit False
Token DT_WSTR nvarchar(255) 255 False
TotalDiscounts DT_WSTR nvarchar(255) 255 False
TotalDiscountsSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalDiscountsSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalDiscountsSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalDiscountsSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalLineItemsPrice DT_WSTR nvarchar(255) 255 False
TotalLineItemsPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalLineItemsPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalLineItemsPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalLineItemsPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalOutstanding DT_WSTR nvarchar(255) 255 False
TotalPrice DT_WSTR nvarchar(255) 255 False
TotalPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalShippingPriceSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalShippingPriceSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalShippingPriceSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalShippingPriceSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalTax DT_WSTR nvarchar(255) 255 False
TotalTaxSetShopMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalTaxSetShopMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalTaxSetPresentmentMoneyAmount DT_WSTR nvarchar(255) 255 False
TotalTaxSetPresentmentMoneyCurrencyCode DT_WSTR nvarchar(255) 255 False
TotalTipReceived DT_WSTR nvarchar(255) 255 False
TotalWeight DT_DECIMAL decimal(0,5) False
UpdatedAt DT_WSTR nvarchar(255) 255 False
UserId DT_I8 bigint False
OrderStatusUrl DT_WSTR nvarchar(255) 255 False

Input Columns

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

Examples

SSIS

Use Shopify Connector in API Source component to read data or in API Destination component to read/write data:

Get Order Items using API Source

Shopify
Get Order Items
SSIS API Source - Read from table or endpoint

Get Order Items using API Destination

Shopify
Get Order Items
SSIS API Destination - Access table or endpoint