From 0c369106f0378144c49078c2613628f1b1219f8f Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 28 Sep 2023 14:40:14 +0200 Subject: [PATCH 1/6] TDL-24185 documented changes for api update --- .../2023/2023-xx-xx-shopify-v1-api-upgrade.md | 13 +++ _integration-schemas/shopify/orders.md | 79 ++++++++----------- _integration-schemas/shopify/transactions.md | 43 +++++++++- _saas-integrations/shopify/v1/shopify-v1.md | 2 +- 4 files changed, 88 insertions(+), 49 deletions(-) create mode 100644 _changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md diff --git a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md new file mode 100644 index 000000000..47d1eb829 --- /dev/null +++ b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md @@ -0,0 +1,13 @@ +--- +title: "Shopify (v1) update: API upgraded to Shopify v2023-04" +content-type: "changelog-entry" +date: +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 fom `2022-07` to `2023-04`. \ No newline at end of file diff --git a/_integration-schemas/shopify/orders.md b/_integration-schemas/shopify/orders.md index 58cc1d9cf..64b4496fa 100644 --- a/_integration-schemas/shopify/orders.md +++ b/_integration-schemas/shopify/orders.md @@ -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: "decimal" + + - 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." @@ -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." @@ -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." @@ -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" @@ -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: "" @@ -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." diff --git a/_integration-schemas/shopify/transactions.md b/_integration-schemas/shopify/transactions.md index e5cd8bb4c..0bc84d7f7 100644 --- a/_integration-schemas/shopify/transactions.md +++ b/_integration-schemas/shopify/transactions.md @@ -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" @@ -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: "decimal" + + - 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." diff --git a/_saas-integrations/shopify/v1/shopify-v1.md b/_saas-integrations/shopify/v1/shopify-v1.md index 739b1080f..4249e32b8 100644 --- a/_saas-integrations/shopify/v1/shopify-v1.md +++ b/_saas-integrations/shopify/v1/shopify-v1.md @@ -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 # From 9ce42fbcd66f29425222ddc8416a3cbc4c813cc5 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 28 Sep 2023 14:45:25 +0200 Subject: [PATCH 2/6] Update 2023-xx-xx-shopify-v1-api-upgrade.md --- _changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md index 47d1eb829..945ae11e6 100644 --- a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md +++ b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md @@ -1,7 +1,7 @@ --- title: "Shopify (v1) update: API upgraded to Shopify v2023-04" content-type: "changelog-entry" -date: +date: "" entry-type: updated-feature entry-category: integration connection-id: shopify @@ -10,4 +10,4 @@ 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 fom `2022-07` to `2023-04`. \ No newline at end of file +We've updated the {{ this-connection.display_name }} integration's API version fom `2022-07` to `2023-04`. We've also updated to the `orders` and `transactions` streams. \ No newline at end of file From 9c6018c5b6a86bf6684eb77a07913f160eae5fc4 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 28 Sep 2023 14:52:00 +0200 Subject: [PATCH 3/6] Update 2023-xx-xx-shopify-v1-api-upgrade.md --- _changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md index 945ae11e6..5dec75993 100644 --- a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md +++ b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md @@ -1,7 +1,7 @@ --- title: "Shopify (v1) update: API upgraded to Shopify v2023-04" content-type: "changelog-entry" -date: "" +date: 2023-09-28 entry-type: updated-feature entry-category: integration connection-id: shopify From 037345f6aa0ab4639bcb24162130ad59101f2552 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 28 Sep 2023 14:59:12 +0200 Subject: [PATCH 4/6] fixed issues --- _integration-schemas/shopify/orders.md | 2 +- _integration-schemas/shopify/transactions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_integration-schemas/shopify/orders.md b/_integration-schemas/shopify/orders.md index 64b4496fa..cb714b81a 100644 --- a/_integration-schemas/shopify/orders.md +++ b/_integration-schemas/shopify/orders.md @@ -1033,7 +1033,7 @@ attributes: - name: "original_total_additional_fees_set" type: "objects" description: "" - subattributes: &additional-fees-set + subattributes: *additional-fees-set - name: "payment_gateway_names" type: "array" diff --git a/_integration-schemas/shopify/transactions.md b/_integration-schemas/shopify/transactions.md index 0bc84d7f7..eb8f681f9 100644 --- a/_integration-schemas/shopify/transactions.md +++ b/_integration-schemas/shopify/transactions.md @@ -151,7 +151,7 @@ attributes: 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 definitions. - - name: "payment_id_" + - name: "payment_id" type: "string" description: "" From b364069426efbb7318cf835c81e74fe8233195d9 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Thu, 28 Sep 2023 15:46:20 +0200 Subject: [PATCH 5/6] changed data type --- _integration-schemas/shopify/orders.md | 2 +- _integration-schemas/shopify/transactions.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_integration-schemas/shopify/orders.md b/_integration-schemas/shopify/orders.md index cb714b81a..fed3eb81b 100644 --- a/_integration-schemas/shopify/orders.md +++ b/_integration-schemas/shopify/orders.md @@ -204,7 +204,7 @@ attributes: subattributes: &money-attributes - name: "amount" description: "" - type: "decimal" + type: "number" - name: "currency" description: "" diff --git a/_integration-schemas/shopify/transactions.md b/_integration-schemas/shopify/transactions.md index eb8f681f9..3ead8c4f1 100644 --- a/_integration-schemas/shopify/transactions.md +++ b/_integration-schemas/shopify/transactions.md @@ -212,7 +212,7 @@ attributes: subattributes: &money-attributes - name: "amount" description: "" - type: "decimal" + type: "number" - name: "currency" description: "" From afb9a7421a405402023703c854bafc23ca51c7e1 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Mon, 2 Oct 2023 09:49:16 +0200 Subject: [PATCH 6/6] Update 2023-xx-xx-shopify-v1-api-upgrade.md --- _changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md index 5dec75993..a7d48fe4d 100644 --- a/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md +++ b/_changelog-files/2023/2023-xx-xx-shopify-v1-api-upgrade.md @@ -10,4 +10,4 @@ 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 fom `2022-07` to `2023-04`. We've also updated to the `orders` and `transactions` streams. \ No newline at end of file +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. \ No newline at end of file