Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TDL-24185 Shopify API upgrade #961

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions _changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Shopify (v1) update: API upgraded to Shopify v2023-04"
content-type: "changelog-entry"
date: 2023-09-28
entry-type: updated-feature
entry-category: integration
connection-id: shopify
connection-version: 1
pull-request: "https://github.com/singer-io/tap-shopify/pull/178"
---
{{ site.data.changelog.metadata.single-integration | flatify }}

We've updated the {{ this-connection.display_name }} integration's API version from `2022-07` to `2023-04`. We've also updated to the `orders` and `transactions` streams.
79 changes: 32 additions & 47 deletions _integration-schemas/shopify/orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,28 @@ attributes:
description: |
The three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217){:target="new"} code for the currency used for the payment.

- name: "current_total_additional_fees_set"
type: "objects"
description: ""
subattributes: &additional-fees-set
- name: "presentment_money"
description: ""
type: "object"
subattributes: &money-attributes
- name: "amount"
description: ""
type: "number"

- name: "currency"
description: ""
type: "string"

- name: "shop_money"
description: ""
type: "object"
subattributes: *money-attributes


- name: "customer"
type: "object"
description: "Details about the customer associated with the abandoned checkout."
Expand Down Expand Up @@ -775,10 +797,6 @@ attributes:
description: |
{{ table.date-time | replace: "[ITEM]","fulfillment" | replace: "[ACTION]","last updated" }}

- name: "gateway"
type: "string"
description: "The payment gateway used by the checkout."

- name: "landing_site"
type: "string"
description: "The URL for the page where the customer entered the shop."
Expand Down Expand Up @@ -938,6 +956,10 @@ attributes:
type: "integer"
description: "The ID of the physical location where the order was processed."

- name: "merchant_of_record_app_id"
type: "integer"
description: ""

- name: "name"
type: "string"
description: "The order name as represented by a number."
Expand Down Expand Up @@ -1006,34 +1028,12 @@ attributes:

- name: "order_status_url"
type: "string"
description: "The URL of the order's status page."

- name: "payment_details"
type: "object"
description: "Details about the payment used for the order."
subattributes:
- name: "avs_result_code"
type: "string"
description: |
The response code from the [address verification system](https://en.wikipedia.org/wiki/Address_Verification_System){:target="new"}. Refer to [Electronic Merchant System's documentation](http://www.emsecommerce.net/avs_cvv2_response_codes.htm){:target="new"} for a list of possible codes and definitions.

- name: "credit_card_bin"
type: "string"
description: |
The [issuer identification number](https://en.wikipedia.org/wiki/ISO/IEC_7812){:target="new"} (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.

- name: "credit_card_company"
type: "string"
description: "The name of the company that issued the customer's credit card."

- name: "credit_card_number"
type: "string"
description: "The customer's credit card number, **with most of the leading digits redacted**."

- name: "cvv_result_code"
type: "string"
description: |
The response code from the credit card company indicating whether the customer entered the card security code or card verification value (CVV) correctly. Refer to [Electronic Merchant System's documentation](http://www.emsecommerce.net/avs_cvv2_response_codes.htm){:target="new"} for a list of possible codes and defintions.
description: "The URL of the order's status page."

- name: "original_total_additional_fees_set"
type: "objects"
description: ""
subattributes: *additional-fees-set

- name: "payment_gateway_names"
type: "array"
Expand All @@ -1052,17 +1052,6 @@ attributes:
description: |
{{ table.date-time | replace: "[ITEM]","order" | replace: "[ACTION]","processed" }}

- name: "processing_method"
type: "string"
description: |
Indicates how the payment was processed. Possible values are:

- `checkout`
- `direct`
- `manual`
- `offsite`
- `express`

- name: "reference"
type: "string"
description: ""
Expand Down Expand Up @@ -1409,10 +1398,6 @@ attributes:
type: "number"
description: "The sum of all line item prices, discounts, shipping, taxes, and tips."

- name: "total_price_usd"
type: "number"
description: "The sum of all line item prices, discounts, shipping, taxes, and tips in USD."

- name: "total_tax"
type: "number"
description: "The sum of all the taxes applied to the order."
Expand Down
43 changes: 42 additions & 1 deletion _integration-schemas/shopify/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,34 @@ attributes:
type: "string"
description: "The name of the company that issued the customer's credit card."

- name: "credit_card_expiration_month"
type: "string"
description: ""

- name: "credit_card_expiration_year"
type: "string"
description: ""

- name: "credit_card_name"
type: "string"
description: ""

- name: "credit_card_number"
type: "string"
description: "The customer's credit card number, **with most of the leading digits redacted**."

- name: "credit_card_wallet"
type: "string"
description: ""

- name: "cvv_result_code"
type: "string"
description: |
The response code from the credit card company indicating whether the customer entered the card security code or card verification value (CVV) correctly. Refer to [Electronic Merchant System's documentation](http://www.emsecommerce.net/avs_cvv2_response_codes.htm){:target="new"} for a list of possible codes and defintions.
The response code from the credit card company indicating whether the customer entered the card security code or card verification value (CVV) correctly. Refer to [Electronic Merchant System's documentation](http://www.emsecommerce.net/avs_cvv2_response_codes.htm){:target="new"} for a list of possible codes and definitions.

- name: "payment_id"
type: "string"
description: ""

- name: "payments_refund_attributes"
type: "object"
Expand Down Expand Up @@ -182,6 +202,27 @@ attributes:
- `success`
- `error`

- name: "total_unsettled_set"
type: "objects"
description: ""
subattributes:
- name: "presentment_money"
description: ""
type: "object"
subattributes: &money-attributes
- name: "amount"
description: ""
type: "number"

- name: "currency"
description: ""
type: "string"

- name: "shop_money"
description: ""
type: "object"
subattributes: *money-attributes

- name: "test"
type: "boolean"
description: "Indicates if the transaction was a test transaction."
Expand Down
2 changes: 1 addition & 1 deletion _saas-integrations/shopify/v1/shopify-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ repo-url: https://github.com/singer-io/tap-shopify
this-version: "1"

api: |
[{{ integration.display_name }} REST Admin API (v2022-07)](https://shopify.dev/docs/admin-api/rest/reference){:target="new"}
[{{ integration.display_name }} REST Admin API (v2023-04)](https://shopify.dev/docs/admin-api/rest/reference){:target="new"}

# -------------------------- #
# Stitch Details #
Expand Down