-
Notifications
You must be signed in to change notification settings - Fork 22
/
src_shopify.yml
1442 lines (1409 loc) · 88.6 KB
/
src_shopify.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
version: 2
sources:
- name: shopify # This source will only be used if you are using a single Shopify source connector. If multiple sources are being unioned, their tables will be directly referenced via adatper.get_relation
schema: "{{ var('shopify_schema', 'shopify') }}"
database: "{% if target.type not in ('spark') %}{{ var('shopify_database', target.database) }}{% endif %}"
tables:
- name: order
description: Each record represents an order in Shopify.
identifier: >
{% if target.type == 'snowflake' %}{{ var('shopify_order_identifier', '"ORDER"') }}
{%- else %}{{ var('shopify_order_identifier', 'order') }}{% endif %}
quoting:
identifier: "{{ false if target.type == 'snowflake' else true }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: app_id
description: The ID of the app that created the order.
- name: billing_address_address_1
description: The street address of the billing address.
- name: billing_address_address_2
description: An optional additional field for the street address of the billing address.
- name: billing_address_city
description: The city, town, or village of the billing address.
- name: billing_address_company
description: The company of the person associated with the billing address.
- name: billing_address_country
description: The name of the country of the billing address.
- name: billing_address_country_code
description: The two-letter code (ISO 3166-1 format) for the country of the billing address.
- name: billing_address_first_name
description: The first name of the person associated with the payment method.
- name: billing_address_last_name
description: The last name of the person associated with the payment method.
- name: billing_address_latitude
description: The latitude of the billing address.
- name: billing_address_longitude
description: The longitude of the billing address.
- name: billing_address_name
description: The full name of the person associated with the payment method.
- name: billing_address_phone
description: The phone number at the billing address.
- name: billing_address_province
description: The name of the region (province, state, prefecture, …) of the billing address.
- name: billing_address_province_code
description: The two-letter abbreviation of the region of the billing address.
- name: billing_address_zip
description: The postal code (zip, postcode, Eircode, …) of the billing address.
- name: browser_ip
description: The IP address of the browser used by the customer when they placed the order.
- name: buyer_accepts_marketing
description: Whether the customer consented to receive email updates from the shop.
- name: cancel_reason
description: The reason why the order was canceled.
- name: cancelled_at
description: The date and time when the order was canceled.
- name: cart_token
description: The ID of the cart that's associated with the order.
- name: closed_at
description: The date and time when the order was closed (archived).
- name: created_at
description: The autogenerated date and time when the order was created in Shopify.
- name: currency
description: The three-letter code for the shop currency.
- name: customer_id
description: The ID of the order's customer.
- name: email
description: The customer's email address.
- name: financial_status
description: The status of payments associated with the order. Can only be set when the order is created
- name: fulfillment_status
description: The order's status in terms of fulfilled line items.
- name: id
description: The ID of the order, used for API purposes. This is different from the order_number property, which is the ID used by the shop owner and customer.
- name: landing_site_base_url
description: The URL for the page where the buyer landed when they entered the shop.
- name: location_id
description: The ID of the physical location where the order was processed.
- name: name
description: The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings.
- name: note
description: An optional note that a shop owner can attach to the order.
- name: number
description: The order's position in the shop's count of orders. Numbers are sequential and start at 1.
- name: order_number
description: The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001.
- name: processed_at
description: The date and time when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports.
- name: referring_site
description: The website where the customer clicked a link to the shop.
- name: shipping_address_address_1
description: The street address of the shipping address.
- name: shipping_address_address_2
description: An optional additional field for the street address of the shipping address.
- name: shipping_address_city
description: The city, town, or village of the shipping address.
- name: shipping_address_company
description: The company of the person associated with the shipping address.
- name: shipping_address_country
description: The name of the country of the shipping address.
- name: shipping_address_country_code
description: The two-letter code (ISO 3166-1 format) for the country of the shipping address.
- name: shipping_address_first_name
description: The first name of the person associated with the shipping address.
- name: shipping_address_last_name
description: The last name of the person associated with the shipping address.
- name: shipping_address_latitude
description: The latitude of the shipping address.
- name: shipping_address_longitude
description: The longitude of the shipping address.
- name: shipping_address_name
description: The full name of the person associated with the payment method.
- name: shipping_address_phone
description: The phone number at the shipping address.
- name: shipping_address_province
description: The name of the region (province, state, prefecture, …) of the shipping address.
- name: shipping_address_province_code
description: The two-letter abbreviation of the region of the shipping address.
- name: shipping_address_zip
description: The postal code (zip, postcode, Eircode, …) of the shipping address.
- name: source_name
description: Where the order originated. Can be set only during order creation, and is not writeable afterwards.
- name: subtotal_price
description: The price of the order in the shop currency after discounts but before shipping, taxes, and tips in the shop currency.
- name: taxes_included
description: Whether taxes are included in the order subtotal.
- name: test
description: Whether this is a test order.
- name: token
description: A unique token for the order.
- name: total_discounts
description: The total discounts applied to the price of the order in the shop currency.
- name: total_line_items_price
description: The sum of all line item prices in the shop currency.
- name: total_price
description: The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
- name: total_tax
description: The sum of all the taxes applied to the order in th shop currency. Must be positive.
- name: total_weight
description: The sum of all line item weights in grams.
- name: updated_at
description: The date and time (ISO 8601 format) when the order was last modified.
- name: user_id
description: The ID of the user logged into Shopify POS who processed the order, if applicable.
- name: checkout_token
description: A unique value when referencing the checkout that's associated with the order.
- name: confirmed
description: Whether inventory has been reserved for the order.
- name: customer_locale
description: A two-letter or three-letter language code, optionally followed by a region modifier.
- name: checkout_id
description: ID of the order's checkout.
- name: order_status_url
description: The URL pointing to the order status web page, if applicable.
- name: _fivetran_deleted
description: "{{ doc('_fivetran_deleted') }}"
- name: total_tip_received
description: The sum of all the tips in the order in the shop currency.
- name: device_id
description: The ID for the device.
- name: presentment_currency
description: The presentment currency that was used to display prices to the customer.
- name: total_shipping_price_set
description: The total shipping price set for the order in presentment and shop currencies.
- name: client_details_user_agent
description: Details of the browsing client, including software and operating versions.
- name: total_tax_set
description: The total tax applied to the order in shop and presentment currencies.
- name: total_shipping_price_set
description: The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true, then total_shipping_price_set includes taxes.
- name: total_discounts_set
description: The total discounts applied to the price of the order in shop and presentment currencies.
- name: total_line_items_price_set
description: The total of all line item prices in shop and presentment currencies.
- name: total_price_set
description: The total price of the order in shop and presentment currencies.
- name: is_confirmed
description: Whether the order is confirmed.
- name: source_identifier
description: The ID of the order placed on the originating platform. This value doesn't correspond to the Shopify ID that's generated from a completed draft.
- name: customer
identifier: "{{ var('shopify_customer_identifier', 'customer') }}"
description: Each record represents a customer in Shopify.
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: accepts_marketing
description: Whether the customer has consented to receive marketing material via email. Deprecated and will be coalesced with `email_marketing_consent_state`.
- name: created_at
description: The date and time when the customer was created.
- name: default_address_id
description: The default address for the customer.
- name: email
description: The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.
- name: first_name
description: The customer's first name.
- name: id
description: A unique identifier for the customer.
- name: last_name
description: The customer's last name.
- name: orders_count
description: The number of orders associated with this customer.
- name: phone
description: The unique phone number (E.164 format) for this customer. Attempting to assign the same phone number to multiple customers returns an error.
- name: state
description: The state of the customer's account with a shop.
- name: tax_exempt
description: Whether the customer is exempt from paying taxes on their order. If true, then taxes won't be applied to an order at checkout. If false, then taxes will be applied at checkout.
- name: total_spent
description: The total amount of money that the customer has spent across their order history.
- name: updated_at
description: The date and time when the customer information was last updated.
- name: verified_email
description: Whether the customer has verified their email address.
- name: email_marketing_consent_state
description: The current email marketing state for the customer. New version of `accepts_marketing` field.
- name: email_marketing_consent_opt_in_level
description: The marketing subscription opt-in level, as described in the M3AAWG Sender Best Common Practices, that the customer gave when they consented to receive marketing material by email. New version of `marketing_opt_in_level` field.
- name: email_marketing_consent_consent_updated_at
description: The date and time when the customer consented to receive marketing material by email. If no date is provided, then the date and time when the consent information was sent is used. New version of `accepts_marketing_updated_at` field.
- name: accepts_marketing_updated_at
description: Deprecated. The package will coalesce with `email_marketing_consent_consent_updated_at`.
- name: marketing_opt_in_level
description: Deprecated. The package will coalesce with `email_marketing_consent_opt_in_level`.
- name: _fivetran_deleted
description: "{{ doc('_fivetran_deleted') }}"
- name: note
description: A note about the customer.
- name: currency
description: The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders.
- name: order_line
identifier: "{{ var('shopify_order_line_identifier', 'order_line') }}"
description: Each record represents a line item for an order in Shopify.
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: fulfillable_quantity
description: "The amount available to fulfill, calculated as follows: quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity"
- name: fulfillment_status
description: How far along an order is in terms line items fulfilled.
- name: gift_card
description: Whether the item is a gift card. If true, then the item is not taxed or considered for shipping charges.
- name: grams
description: The weight of the item in grams.
- name: id
description: The ID of the line item.
- name: name
description: The name of the product variant.
- name: order_id
description: The ID of the related order.
- name: price
description: The price of the item before discounts have been applied in the shop currency.
- name: product_id
description: The ID of the product that the line item belongs to. Can be null if the original product associated with the order is deleted at a later date.
- name: quantity
description: The number of items that were purchased.
- name: requires_shipping
description: Whether the item requires shipping.
- name: sku
description: The item's SKU (stock keeping unit).
- name: taxable
description: Whether the item was taxable.
- name: title
description: The title of the product.
- name: total_discount
description: The total amount of the discount allocated to the line item in the shop currency.
- name: variant_id
description: The ID of the product variant.
- name: vendor
description: The name of the item's supplier.
- name: index
description: Index of the order line.
- name: pre_tax_price
description: The pre tax price of the line item in shop currency.
- name: pre_tax_price_set
description: The pre tax price of the line item in shop currency and presentment currency.
- name: price_set
description: The price of the line item in shop and presentment currencies.
- name: tax_code
description: Tax code applied to the line item. As multiple taxes can apply to a line item, we recommend referring to `stg_shopify__tax_line`.
- name: total_discount_set
description: The total amount allocated to the line item in the presentment currency.
- name: variant_title
description: The title of the product variant.
- name: variant_inventory_management
description: The fulfillment service that tracks the number of items in stock for the product variant.
- name: properties
description: Line item properties.
- name: tax_code
description: Tax code applied to the line item. As multiple taxes can apply to a line item, we recommend referring to `stg_shopify__tax_line`.
- name: order_line_refund
identifier: "{{ var('shopify_order_line_refund_identifier', 'order_line_refund') }}"
description: Each record represents a line item refund in Shopify.
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: id
description: The unique identifier of the line item in the refund.
- name: location_id
description: TThe unique identifier of the location where the items will be restockedBD
- name: order_line_id
description: The ID of the related line item in the order.
- name: quantity
description: The quantity of the associated line item that was returned.
- name: refund_id
description: The ID of the related refund.
- name: restock_type
description: How this refund line item affects inventory levels.
- name: subtotal
description: Subtotal amount of the order line refund in shop currency.
- name: total_tax
description: The total tax applied to the refund in shop currency.
- name: subtotal_set
description: The subtotal of the refund line item in shop and presentment currencies.
- name: total_tax_set
description: The total tax of the line item in shop and presentment currencies.
- name: subtotal_set
description: The subtotal of the refund line item in shop and presentment currencies.
- name: product
identifier: "{{ var('shopify_product_identifier', 'product') }}"
description: Each record represents a product in Shopify.
columns:
- name: _fivetran_deleted
description: Whether the record has been deleted in the source system.
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: created_at
description: The date and time when the product was created.
- name: handle
description: A unique human-friendly string for the product. Automatically generated from the product's title.
- name: id
description: An unsigned 64-bit integer that's used as a unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id, even if they're from different shops.
- name: product_type
description: A categorization for the product used for filtering and searching products.
- name: published_at
description: The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel.
- name: published_scope
description: Whether the product is published to the Point of Sale channel.
- name: title
description: The name of the product.
- name: updated_at
description: The date and time when the product was last modified.
- name: vendor
description: The name of the product's vendor.
- name: status
description: >
The status of the product. Valid values:
- active: The product is ready to sell and is available to customers on the online store, sales channels, and apps. By default, existing products are set to active.
- archived: The product is no longer being sold and isn't available to customers on sales channels and apps.
- draft: The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft.
- name: product_variant
identifier: "{{ var('shopify_product_variant_identifier', 'product_variant') }}"
description: Each record represents a product variant in Shopify
columns:
- name: barcode
description: The barcode, UPC, or ISBN number for the product.
- name: compare_at_price
description: The original price of the item before an adjustment or a sale in shop currency.
- name: created_at
description: The date and time (ISO 8601 format) when the product variant was created.
- name: fulfillment_service
description: The fulfillment service associated with the product variant.
- name: grams
description: The weight of the product variant in grams.
- name: id
description: The unique numeric identifier for the product variant.
- name: image_id
description: The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.
- name: inventory_item_id
description: The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information.
- name: inventory_management
description: The fulfillment service that tracks the number of items in stock for the product variant.
- name: inventory_policy
description: Whether customers are allowed to place an order for the product variant when it's out of stock.
- name: inventory_quantity
description: An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource.
- name: old_inventory_quantity
description: This property is deprecated. Use the InventoryLevel resource instead.
- name: option_1
description: "The custom properties that a shop owner uses to define product variants. You can define three options for a product variant: option1, option2, option3."
- name: option_2
description: "The custom properties that a shop owner uses to define product variants. You can define three options for a product variant: option1, option2, option3."
- name: option_3
description: "The custom properties that a shop owner uses to define product variants. You can define three options for a product variant: option1, option2, option3."
- name: position
description: The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed.
- name: price
description: The price of the product variant in shop currency.
- name: product_id
description: The unique numeric identifier for the product.
- name: requires_shipping
description: This property is deprecated. Use the `requires_shipping` property on the InventoryItem resource instead.
- name: sku
description: A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.
- name: taxable
description: Whether a tax is charged when the product variant is sold.
- name: tax_code
description: This parameter applies only to the stores that have the Avalara AvaTax app installed. Specifies the Avalara tax code for the product variant.
- name: title
description: The title of the product variant. The title field is a concatenation of the option1, option2, and option3 fields. You can only update title indirectly using the option fields.
- name: updated_at
description: The date and time when the product variant was last modified. Gets returned in ISO 8601 format.
- name: weight
description: The weight of the product variant in the unit system specified with weight_unit.
- name: weight_unit
description: "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: g, kg, oz, and lb."
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: transaction
identifier: "{{ var('shopify_transaction_identifier', 'transaction') }}"
description: Each record represents a transaction in Shopify.
columns:
- name: id
description: The ID for the transaction.
- name: order_id
description: The ID for the order that the transaction is associated with.
- name: refund_id
description: The ID associated with a refund in the refund table.
- name: amount
description: The amount of money included in the transaction.
- name: authorization
description: The authorization code associated with the transaction.
- name: created_at
description: The date and time when the transaction was created.
- name: processed_at
description: The date and time when a transaction was processed.
- name: device_id
description: The ID for the device.
- name: gateway
description: The name of the gateway the transaction was issued through.
- name: source_name
description: The origin of the transaction.
- name: message
description: A string generated by the payment provider with additional information about why the transaction succeeded or failed.
- name: currency
description: The three-letter code (ISO 4217 format) for the currency used for the payment.
- name: location_id
description: The ID of the physical location where the transaction was processed.
- name: parent_id
description: The ID of an associated transaction.
- name: payment_avs_result_code
description: The response code from the address verification system.
- name: payment_credit_card_bin
description: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card.
- name: payment_cvv_result_code
description: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly.
- name: payment_credit_card_number
description: The customer's credit card number, with most of the leading digits redacted.
- name: payment_credit_card_company
description: The name of the company that issued the customer's credit card.
- name: kind
description: The transaction's type.
- name: receipt
description: A transaction receipt attached to the transaction by the gateway.
- name: currency_exchange_id
description: The ID of the adjustment.
- name: currency_exchange_adjustment
description: The difference between the amounts on the associated transaction and the parent transaction.
- name: currency_exchange_original_amount
description: The amount of the parent transaction in the shop currency.
- name: currency_exchange_final_amount
description: The amount of the associated transaction in the shop currency.
- name: currency_exchange_currency
description: The shop currency.
- name: error_code
description: A standardized error code, independent of the payment provider.
- name: status
description: The status of the transaction.
- name: test
description: Whether the transaction is a test transaction.
- name: user_id
description: The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable.
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: authorization_expires_at
description: The date and time (ISO 8601 format) when the Shopify Payments authorization expires.
- name: refund
identifier: "{{ var('shopify_refund_identifier', 'refund') }}"
description: Each record represents a refund within Shopify.
columns:
- name: id
description: The unique numeric identifier for the refund.
- name: created_at
description: Timestamp of the date when the refund was created.
- name: processed_at
description: Timestamp of the date when the refund was processed.
- name: note
description: User generated note attached to the refund.
- name: restock
description: Boolean indicating if the refund is a result of a restock.
- name: user_id
description: Reference to the user id which generated the refund.
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: total_duties_set
description: Record representing total duties set for the refund.
- name: order_id
description: Reference to the order which the refund is associated.
- name: order_adjustment
identifier: "{{ var('shopify_order_adjustment_identifier', 'order_adjustment') }}"
description: Each record represents and adjustment to and order within Shopify.
columns:
- name: id
description: The unique numeric identifier for the order adjustment.
- name: order_id
description: Reference to the order which the adjustment is associated.
- name: refund_id
description: Reference to the refund which the adjustment is associated.
- name: amount
description: Amount of the adjustment.
- name: tax_amount
description: Tax amount applied to the order adjustment in shop currency.
- name: kind
description: The kind of order adjustment (eg. refund, restock, etc.).
- name: reason
description: The reason for the order adjustment.
- name: amount_set
description: Amount set towards the order adjustment in shop and presentment currencies.
- name: tax_amount_set
description: Tax amount set towards the order adjustment in shop and presentment currencies.
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: abandoned_checkout
description: A checkout is considered abandoned after the customer has added contact information, but before the customer has completed their purchase.
identifier: "{{ var('shopify_abandoned_checkout_identifier', 'abandoned_checkout') }}"
columns:
- name: _fivetran_deleted
description: "{{ doc('_fivetran_deleted') }}"
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: abandoned_checkout_url
description: The recovery URL that's sent to a customer so they can recover their checkout.
- name: billing_address_address_1
description: The street address of the billing address.
- name: billing_address_address_2
description: An optional additional field for the street address of the billing address.
- name: billing_address_city
description: The city of the billing address.
- name: billing_address_company
description: The company of the person associated with the billing address.
- name: billing_address_country
description: The name of the country of the billing address.
- name: billing_address_country_code
description: The two-letter code (ISO 3166-1 alpha-2 format) for the country of the billing address.
- name: billing_address_first_name
description: The first name of the person associated with the payment method.
- name: billing_address_last_name
description: The last name of the person associated with the payment method.
- name: billing_address_latitude
description: The latitude of the billing address.
- name: billing_address_longitude
description: The longitude of the billing address.
- name: billing_address_name
description: The full name of the person associated with the payment method.
- name: billing_address_phone
description: The phone number at the billing address.
- name: billing_address_province
description: The name of the state or province of the billing address.
- name: billing_address_province_code
description: The two-letter abbreviation of the state or province of the billing address.
- name: billing_address_zip
description: The zip or postal code of the billing address.
- name: buyer_accepts_marketing
description: Whether the customer would like to receive email updates from the shop. This is set by the 'I want to receive occasional emails about new products, promotions and other news' checkbox during checkout.
- name: cart_token
description: The ID for the cart that's attached to the checkout.
- name: closed_at
description: The date and time (ISO 8601 format) when the checkout was closed. If the checkout was not closed, then this value is null.
- name: created_at
description: The date and time (ISO 8601 format) when the checkout was created.
- name: currency
description: The three-letter code (ISO 4217 format) of the shop's default currency at the time of checkout. For the currency that the customer used at checkout, see `presentment_currency`.
- name: customer_id
description: ID of the customer with the abandoned checkout.
- name: customer_locale
description: The two or three-letter language code, optionally followed by a region modifier. Example values - en, en-CA.
- name: device_id
description: The ID of the Shopify POS device that created the checkout.
- name: email
description: The customer's email address.
- name: gateway
description: The payment gateway used by the checkout.
- name: id
description: The ID for the checkout.
- name: landing_site_base_url
description: The URL for the page where the customer entered the shop.
- name: location_id
description: The ID of the physical location where the checkout was processed.
- name: name
description: Checkout order number.
- name: note
description: The text of an optional note that a shop owner can attach to the order.
- name: phone
description: The customer's phone number for receiving SMS notifications.
- name: presentment_currency
description: The three-letter code (ISO 4217 format) of the currency that the customer used at checkout. For the shop's default currency, see `currency`.
- name: referring_site
description: The website that referred the customer to the shop.
- name: shipping_address_address_1
description: The street address of the shipping address.
- name: shipping_address_address_2
description: An optional additional field for the street address of the shipping address.
- name: shipping_address_city
description: The city of the shipping address.
- name: shipping_address_company
description: The company of the person associated with the shipping address.
- name: shipping_address_country
description: The name of the country of the shipping address.
- name: shipping_address_country_code
description: The two-letter code (ISO 3166-1 alpha-2 format) for the country of the shipping address.
- name: shipping_address_first_name
description: The first name of the person associated with the shipping address.
- name: shipping_address_last_name
description: The last name of the person associated with the shipping address.
- name: shipping_address_latitude
description: The latitude of the shipping address.
- name: shipping_address_longitude
description: The longitude of the shipping address.
- name: shipping_address_name
description: The full name of the person associated with the shipping address.
- name: shipping_address_phone
description: The phone number at the shipping address.
- name: shipping_address_province
description: The name of the state or province of the shipping address.
- name: shipping_address_province_code
description: The two-letter abbreviation of the state or province of the shipping address.
- name: shipping_address_zip
description: The zip or postal code of the shipping address.
- name: source_name
description: Where the checkout originated. Valid values include `web`, `pos`, `iphone`, `android`.
- name: subtotal_price
description: The price of the checkout in _presentment_ (customer) currency before shipping and taxes.
- name: taxes_included
description: Boolean representing whether taxes are included in the price.
- name: token
description: A unique ID for a checkout.
- name: total_discounts
description: The total amount of discounts to be applied in presentment currency.
- name: total_duties
description: The total duties of the checkout in presentment currency.
- name: total_line_items_price
description: The sum of the prices of all line items in the checkout in _presentment_ (customer) currency.
- name: total_price
description: The sum of line item prices, all discounts, shipping costs, and taxes for the checkout in _presentment_ (customer) currency.
- name: total_tax
description: The sum of all the taxes applied to the checkout in _presentment_ (customer) currency.
- name: total_weight
description: The sum of all the weights in grams of the line items in the checkout.
- name: updated_at
description: The date and time (ISO 8601 format) when the checkout was last modified.
- name: user_id
description: The ID of the user who created the checkout.
- name: collection_product
description: Table relating products to the collections they belong to. Use this instead of the deprecated `COLLECT` table.
identifier: "{{ var('shopify_collection_product_identifier', 'collection_product') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: collection_id
description: ID referencing the `collection` the product belongs to.
- name: product_id
description: ID referencing the `product`.
- name: collection
description: >
A collection is a grouping of products that merchants can create to make their stores easier to browse.
Merchants can create collections by selecting products individually or by defining rules that automatically determine whether products are included (aka a "smart collection").
identifier: "{{ var('shopify_collection_identifier', 'collection') }}"
columns:
- name: _fivetran_deleted
description: "{{ doc('_fivetran_deleted') }}"
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: disjunctive
description: Boolean representing whether the `rules` or disjuctive (logical `OR`) or not. True = disjuctive, false = conjunctive (logical `AND`).
- name: handle
description: A unique, human-readable string for the collection automatically generated from its title. This is used in themes by the Liquid templating language to refer to the collection.
- name: id
description: The ID for the collection.
- name: published_at
description: The time and date (ISO 8601 format) when the collection was made visible. Returns null for a hidden collection.
- name: published_scope
description: >
Whether the collection is published to the Point of Sale channel. Valid values `web` (the collection is published to the Online Store channel but not published to the Point of Sale channel)
and `global` (the collection is published to both the Online Store channel and the Point of Sale channel).
- name: rules
description: >
An array of rules that define what products go into the smart collection. Each rule (`column` -- `relation` --> `condition`) has these properties:
- `column`: the property of a product being used to populate the smart collection. Ex: 'tag', 'type', 'vendor', 'variant_price', etc.
- `relation`: The comparitive relationship between the column choice, and the condition ('equals', 'contains', 'greater_than', etc.)
- condition: Select products for a smart collection using a condition. Values are either strings or numbers, depending on the relation value.
See the [Shopify docs](https://shopify.dev/api/admin-rest/2022-10/resources/smartcollection#resource-object) for more.
- name: sort_order
description: >
The order of the products in the collection. Valid values inclide
- `alpha-asc`: The products are sorted alphabetically from A to Z.
- `alpha-des`: The products are sorted alphabetically from Z to A.
- `best-selling`: The products are sorted by number of sales.
- `created`: The products are sorted by the date they were created, from oldest to newest.
- `created-desc`: The products are sorted by the date they were created, from newest to oldest.
- `manual`: The products are manually sorted by the shop owner.
- `price-asc`: The products are sorted by price from lowest to highest.
- `price-desc`: The products are sorted by price from highest to lowest.
- name: title
description: The name of the collection
- name: updated_at
description: The date and time (ISO 8601 format) when the collection was last modified.
- name: customer_tag
description: Tags that the shop owner has attached to the customer. A customer can have up to 250 tags.
identifier: "{{ var('shopify_customer_tag_identifier', 'customer_tag') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: index
description: Index (starting from 1) represnting when the tag was placed on the customer.
- name: customer_id
description: ID of the customer being tagged.
- name: value
description: Value of the tag.
- name: discount_code
description: >
Table storing discount codes that enable specific discounts to be redeemed. Merchants can distribute discount codes to their customers using a variety of means, such as an email or URL,
and customers can apply these codes at checkout. Each discount code belongs to a price rule, which holds the logic for the discount.
identifier: "{{ var('shopify_discount_code_identifier', 'discount_code') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: code
description: The case-insensitive discount code that customers use at checkout. Shopify recommends this map onto the associated `price_rule.title`.
- name: created_at
description: The date and time (ISO 8601 format) when the discount code was created.
- name: id
description: The ID for the discount code.
- name: price_rule_id
description: The ID for the price rule that this discount code belongs to.
- name: updated_at
description: The date and time (ISO 8601 format) when the discount code was updated.
- name: usage_count
description: The number of times that the discount code has been redeemed.
- name: fulfillment
description: >
A fulfillment order represents a group of one or more items in an order that will be fulfilled from the same location.
A fulfillment represents work that is completed as part of a fulfillment order and can include one or more items.
identifier: "{{ var('shopify_fulfillment_identifier', 'fulfillment') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: created_at
description: The date and time when the fulfillment was created. The API returns this value in ISO 8601 format.
- name: id
description: The ID for the fulfillment.
- name: location_id
description: The unique identifier of the location that the fulfillment was processed at.
- name: name
description: >
The uniquely identifying fulfillment name, consisting of two parts separated by a .. The first part represents the order name and the second part represents the fulfillment number.
The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).
- name: order_id
description: The unique numeric identifier for the order.
- name: receipt_authorization
description: The authorization code from the receipt.
- name: service
description: The fulfillment service associated with the fulfillment.
- name: shipment_status
description: >
The current shipment status of the fulfillment. Valid values include:
- label_printed: A label for the shipment was purchased and printed.
- label_purchased: A label for the shipment was purchased, but not printed.
- attempted_delivery: Delivery of the shipment was attempted, but unable to be completed.
- ready_for_pickup: The shipment is ready for pickup at a shipping depot.
- confirmed: The carrier is aware of the shipment, but hasn't received it yet.
- in_transit: The shipment is being transported between shipping facilities on the way to its destination.
- out_for_delivery: The shipment is being delivered to its final destination.
- delivered: The shipment was succesfully delivered.
- failure: Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.
- name: status
description: >
The status of the fulfillment. Valid values include:
- pending: Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to 'open' or 'success'.
- open: The fulfillment has been acknowledged by the service and is in processing.
- success: The fulfillment was successful.
- cancelled: The fulfillment was cancelled.
- error: There was an error with the fulfillment request.
- failure: The fulfillment request failed.
- name: tracking_company
description: The name of the tracking company.
- name: tracking_number
description: Primary tracking number for the order.
- name: tracking_numbers
description: A list of tracking numbers, provided by the shipping company.
- name: tracking_urls
description: The URLs of tracking pages for the fulfillment.
- name: updated_at
description: The date and time (ISO 8601 format) when the fulfillment was last modified.
- name: inventory_item
description: >
An inventory item represents a physical good. It holds essential information about the physical good, including its SKU and whether its inventory is tracked.
There is a 1:1 relationship between a product variant and an inventory item.
identifier: "{{ var('shopify_inventory_item_identifier', 'inventory_item') }}"
columns:
- name: _fivetran_deleted
description: "{{ doc('_fivetran_deleted') }}"
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: cost
description: The unit cost of the inventory item. The shop's default currency is used.
- name: country_code_of_origin
description: The country code (ISO 3166-1 alpha-2) of where the item came from.
- name: created_at
description: The date and time (ISO 8601 format) when the inventory item was created.
- name: id
description: The ID of the inventory item.
- name: province_code_of_origin
description: The province code (ISO 3166-2 alpha-2) of where the item came from. The province code is only used if the shipping provider for the inventory item is Canada Post.
- name: requires_shipping
description: Boolean representing whether a customer needs to provide a shipping address when placing an order containing the inventory item.
- name: sku
description: The unique SKU (stock keeping unit) of the inventory item.
- name: tracked
description: Boolean representing whether inventory levels are tracked for the item. If true, then the inventory quantity changes are tracked by Shopify.
- name: updated_at
description: The date and time (ISO 8601 format) when the inventory item was last modified.
- name: inventory_level
description: >
An inventory level represents the quantities of an inventory item for a location.
Each inventory level belongs to one inventory item and has one location. For every location where an inventory item can be stocked, there's an inventory level that represents
the inventory item's quantities relating to that location.
identifier: "{{ var('shopify_inventory_level_identifier', 'inventory_level') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: available
description: The available quantity of an inventory item at the inventory level's associated location. Returns null if the inventory item is not tracked.
- name: inventory_item_id
description: The ID of the inventory item associated with the inventory level.
- name: location_id
description: The ID of the location that the inventory level belongs to.
- name: updated_at
description: The date and time (ISO 8601 format) when the inventory level was last modified.
- name: location
description: A location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist.
identifier: "{{ var('shopify_location_identifier', 'location') }}"
columns:
- name: _fivetran_deleted
description: "{{ doc('_fivetran_deleted') }}"
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: active
description: >
Boolean representing whether the location is active. If true, then the location can be used to sell products, stock inventory, and fulfill orders.
- name: address_1
description: The location's street address.
- name: address_2
description: The optional second line of the location's street address.
- name: city
description: The city the location is in.
- name: country
description: The country the location is in (two-letter code).
- name: country_code
description: The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in.
- name: country_name
description: Full name of the location's country.
- name: created_at
description: The date and time (ISO 8601 format) when the location was created.
- name: id
description: The ID of the location.
- name: legacy
description: >
Boolean representing whether this is a fulfillment service location. If true, then the location is a fulfillment service location.
If false, then the location was created by the merchant and isn't tied to a fulfillment service.
- name: localized_country_name
description: The localized name of the location's country.
- name: localized_province_name
description: The localized name of the location's region. Typically a province, state, or district.
- name: name
description: The name of the location.
- name: phone
description: The phone number of the location. This value can contain special characters, such as - or +.
- name: province
description: The province, state, or district of the location.
- name: province_code
description: The province, state, or district code (ISO 3166-2 alpha-2 format) of the location.
- name: updated_at
description: The date and time (ISO 8601 format) when the location was last updated.
- name: zip
description: The zip or postal code.
- name: metafield
description: >
Metafields are a flexible way to attach additional information to a Shopify resource (e.g. Product, Collection, etc.). Some examples of data stored using metafields include specifications, size charts,
downloadable documents, release dates, images, or part numbers. Metafields are identified by an owner resource, a namespace, and a key and they store a value along with type information for that context.
identifier: "{{ var('shopify_metafield_identifier', 'metafield') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: created_at
description: The date and time (ISO 8601 format) when the metafield was created.
- name: description
description: A description of the information that the metafield contains.
- name: id
description: The unique ID of the metafield.
- name: key
description: The key of the metafield. Keys can be up to 64 characters long and can contain alphanumeric characters, hyphens, underscores, and periods.
- name: namespace
description: A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. Must have between 3-255 characters.
- name: owner_id
description: The unique ID of the resource that the metafield is attached to.
- name: owner_resource
description: The type of resource (table) that the metafield is attached to.
- name: type
description: The type of data that the metafield stores in the `value` field. Refer to the [list](https://shopify.dev/apps/metafields/types) of supported types. Use this instead of `value_type`.
- name: updated_at
description: The date and time (ISO 8601 format) when the metafield was last updated.
- name: value
description: The data to store in the metafield. The value is always stored as a string, regardless of the metafield's type.
- name: value_type
description: DEPRECATED as of [June 2022](https://fivetran.com/docs/applications/shopify/changelog#june2022). Use `type` instead.
- name: order_note_attribute
description: Table storing custom attributes placed on orders.
identifier: "{{ var('shopify_order_note_attribute_identifier', 'order_note_attribute') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: name
description: Name of the attribute.
- name: order_id
description: ID referencing the order the note attribute belongs to.
- name: value
description: Value of the attribute.
- name: order_shipping_line
description: Represents the shipping details that the customer chose for their order.
identifier: "{{ var('shopify_order_shipping_line_identifier', 'order_shipping_line') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: carrier_identifier
description: A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
- name: code
description: A reference to the shipping method.
- name: delivery_category
description: The general classification of the delivery method.
- name: discounted_price
description: The pre-tax shipping price with discounts applied in the shop currency.
- name: discounted_price_set
description: The pre-tax shipping price with discounts applied (JSON) in presentment and shop currencies.
- name: id
description: A globally-unique identifier.
- name: order_id
description: ID of the associated order.
- name: phone
description: The phone number at the shipping address.
- name: price
description: Returns the price of the shipping line in shop currency.
- name: price_set
description: Returns the price of the shipping line (JSON) in presentment and shop currencies.
- name: requested_fulfillment_service_id
description: The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.
- name: source
description: Returns the rate source for the shipping line.
- name: title
description: Returns the title of the shipping line.
- name: order_shipping_tax_line
description: Represents taxes associated with order shipping lines.
identifier: "{{ var('shopify_order_shipping_tax_line_identifier', 'order_shipping_tax_line') }}"
columns:
- name: _fivetran_synced
description: "{{ doc('_fivetran_synced') }}"
- name: index
description: Index (from 1) representing the order of shipping lines per order.
- name: order_shipping_line_id
description: ID of the order shipping line this recod is associated with.
- name: price
description: The amount of tax, in shop currency, after discounts and before returns.
- name: price_set
description: The amount of tax, in shop and presentment currencies, after discounts and before returns (JSON).
- name: rate
description: The proportion of the line item price that the tax represents as a decimal.
- name: title
description: The name of the tax.
- name: order_tag
description: Tags that the shop owner has attached to the order.