Fixing and improving Orders API #1345

Isabella-Veloso · 2024-10-15T17:23:50Z

Types of changes

New content (endpoints, descriptions or fields from scratch)
Improvement (make an endpoint's title or description even better)
Spelling and grammar accuracy (self-explanatory)

Changelog

Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?

Yes, I already created a release note about this change.
No, but I am going to.

This reverts commit a71fc5b.

This reverts commit 2deeb0f.

github-actions · 2024-10-15T17:24:48Z

Thanks for your contribution. The .json file will be checked now with Spectral.

…/vtex/openapi-schemas into fixing-and-improving-Orders-API-

julia-rabello · 2024-10-16T16:11:57Z

VTEX - Orders API.json

                                        },
                                        "orderGroup": {
                                            "type": "string",
-                                            "description": "Order's group ID."
+                                            "description": "Order group ID, a code part of the order ID that groups all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."


Suggested change

"description": "Order group ID, a code part of the order ID that groups all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."

"description": "Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`), the order group ID is `v71021570str`."

julia-rabello · 2024-10-16T16:14:00Z

VTEX - Orders API.json

                                        },
                                        "hostname": {
                                            "type": "string",
-                                            "description": "Account host name, which is the [domain](https://help.vtex.com/en/tutorial/configuring-the-store-domain--tutorials_2450#store-address-structure) registered in **Account Settings**."
+                                            "description": "Main [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC)."


Is this really only the account name (e.g. apiexamples) or the full hostname (e.g. www.apiexamples.com)?

Asking because of the name of the parameter and the previous description including this doc https://help.vtex.com/en/tutorial/configuring-the-store-domain--tutorials_2450#store-address-structure

julia-rabello · 2024-10-16T16:16:48Z

VTEX - Orders API.json

                                        },
                                        "roundingError": {
                                            "type": "integer",
-                                            "description": "Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field."
+                                            "description": "Rounding error total value in cents, when applicable. For example, in orders with a discount over non-integer multiplier items, the rounding price is applied per item, not after the sum of all items, what can cause a difference in the total discount value."


Suggested change

"description": "Rounding error total value in cents, when applicable. For example, in orders with a discount over non-integer multiplier items, the rounding price is applied per item, not after the sum of all items, what can cause a difference in the total discount value."

"description": "Rounding error total value in cents, when applicable. For example, in orders with discounts on non-integer multiplier items, rounding is applied per item, not after the sum of all items, which can result in a difference in the total discount value."

julia-rabello · 2024-10-16T16:18:50Z

VTEX - Orders API.json

                                                                            },
                                                                            "end": {
                                                                                "type": "string",
-                                                                                "description": "Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`.",
+                                                                                "description": "Subscription ending date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",


Suggested change

"description": "Subscription ending date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",

"description": "Subscription end date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",

julia-rabello · 2024-10-16T16:20:26Z

VTEX - Orders API.json

                                            "type": "object",
-                                            "description": "Store's configuration data, stored in [Account settings](https://help.vtex.com/en/tutorial/account-details-page--2vhUVOKfCaswqLguT2F9xq).",
+                                            "description": "Customizable fields created by the store for the shopping cart. This field is useful for storing data not included in other fields. For example, a message for a gift or a name to be printed in a shirt.",


Is this related to Catalog attachments / custom product attributes? (asking beacuse of the examples)

If so, I suggest linking to related docs.

julia-rabello · 2024-10-16T16:21:37Z

VTEX - Orders API.json

+                                                    "description": "Customizable apps created by the store.",
+                                                    "nullable": true,
+                                                    "items": {
+                                                        "type": "string",
+                                                        "description": "Customizable apps details.",


What does this mean? Is there an example for this somewhere?

julia-rabello · 2024-10-16T16:22:35Z

VTEX - Orders API.json

@@ -3270,7 +2935,7 @@
                                            },
                                            "orderGroup": {
                                                "type": "string",
-                                                "description": "Order's group ID, a code part of the order ID that groupes all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."
+                                                "description": "Order group ID, a code part of the order ID that groups all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."


Suggested change

"description": "Order group ID, a code part of the order ID that groups all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."

"description": "Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."

julia-rabello · 2024-10-16T16:23:08Z

VTEX - Orders API.json

@@ -13292,7 +12941,7 @@
                    },
                    "changesData": {
                        "type": "array",
-                        "description": "Order changes details.",
+                        "description": "Order changes information.",


Suggested change

"description": "Order changes information.",

"description": "Information about changes in the order.",

julia-rabello · 2024-10-16T16:24:19Z

VTEX - Orders API.json

@@ -20503,7 +20143,7 @@
                                "description": "Quantity of items been replaced."


Suggested change

"description": "Quantity of items been replaced."

"description": "Quantity of items replaced."

julia-rabello · 2024-10-16T16:24:37Z

VTEX - Orders API.json

@@ -20503,7 +20143,7 @@
                                "description": "Quantity of items been replaced."
                              },
                              "price": {
-                                "type": "string",
+                                "type": "integer",
                                "nullable": true,
                                "description": "Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents."


Suggested change

"description": "Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents."

"description": "Shipping price for the replaced item, in cents. It does not account for the whole order's shipping price."

Isabella-Veloso added 30 commits October 14, 2024 14:28

Update VTEX - Orders API.json

7fdd07a

Update VTEX - Orders API.json

5482758

Update VTEX - Orders API.json

4f357c8

Update VTEX - Orders API.json

834cc72

Update VTEX - Orders API.json

13e41c5

Update VTEX - Orders API.json

3165a8f

Update VTEX - Orders API.json

0a5a051

Update VTEX - Orders API.json

8904f48

Update VTEX - Orders API.json

254538d

Update VTEX - Orders API.json

c331829

Update VTEX - Orders API.json

a8a660a

Update VTEX - Orders API.json

98fc177

Update VTEX - Orders API.json

8d78279

Update VTEX - Orders API.json

9e4904e

Update VTEX - Orders API.json

f6c0500

Update VTEX - Orders API.json

e8b4e4a

Update VTEX - Orders API.json

fe97abc

Update VTEX - Orders API.json

441dffc

Update VTEX - Orders API.json

f55f131

Update VTEX - Orders API.json

537af97

Update VTEX - Orders API.json

5c1c761

Update VTEX - Orders API.json

7b73bc4

Update VTEX - Orders API.json

eff9a55

Update VTEX - Orders API.json

4e2dd22

Update VTEX - Orders API.json

57fc0fe

Update VTEX - Orders API.json

f6afa91

Update VTEX - Orders API.json

9f9ff81

Update VTEX - Orders API.json

a71fc5b

Revert "Update VTEX - Orders API.json"

d278d21

This reverts commit a71fc5b.

Update VTEX - Orders API.json

e37142e

Isabella-Veloso added 17 commits October 14, 2024 16:33

Update VTEX - Orders API.json

f387f98

Update VTEX - Orders API.json

ccb42fa

Update VTEX - Orders API.json

81f6ce4

Update VTEX - Orders API.json

003969f

Update VTEX - Orders API.json

93249b6

Update VTEX - Orders API.json

a6c2ddc

Update VTEX - Orders API.json

ae31366

Update VTEX - Orders API.json

9b1c52b

Update VTEX - Orders API.json

7e70284

Update VTEX - Orders API.json

9fd35f8

Update VTEX - Orders API.json

545507e

Update VTEX - Orders API.json

2bf7f77

Update VTEX - Orders API.json

82dbbe2

Update VTEX - Orders API.json

2deeb0f

Update VTEX - Orders API.json

893c0ac

Revert "Update VTEX - Orders API.json"

1228ecf

This reverts commit 2deeb0f.

Update VTEX - Orders API.json

4e3ca99

Isabella-Veloso requested review from karenkrieger, PedroAntunesCosta, julia-rabello and ricardoaerobr October 15, 2024 17:23

Update generated files by portman

5859e26

Isabella-Veloso added 6 commits October 15, 2024 14:28

Update VTEX - Orders API.json

3cd4c0c

Update VTEX - Orders API.json

9dc0488

Merge branch 'fixing-and-improving-Orders-API-' of https://github.com…

b348775

…/vtex/openapi-schemas into fixing-and-improving-Orders-API-

Update VTEX - Orders API.json

6809d06

Update VTEX - Orders API.json

a24373f

Update VTEX - Orders API.json

3030124

julia-rabello requested changes Oct 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing and improving Orders API #1345

Fixing and improving Orders API #1345

Isabella-Veloso commented Oct 15, 2024

github-actions bot commented Oct 15, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

julia-rabello Oct 16, 2024

	"description": "Order group ID, a code part of the order ID that groups all orders related to the same purchase. For example, in order ID `v71021570str-02`), the order group ID is `v71021570str`."
	"description": "Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`), the order group ID is `v71021570str`."

	"description": "Rounding error total value in cents, when applicable. For example, in orders with a discount over non-integer multiplier items, the rounding price is applied per item, not after the sum of all items, what can cause a difference in the total discount value."
	"description": "Rounding error total value in cents, when applicable. For example, in orders with discounts on non-integer multiplier items, rounding is applied per item, not after the sum of all items, which can result in a difference in the total discount value."

	"description": "Subscription ending date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
	"description": "Subscription end date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",

	"description": "Order changes information.",
	"description": "Information about changes in the order.",

		@@ -20503,7 +20143,7 @@
		"description": "Quantity of items been replaced."

	"description": "Quantity of items been replaced."
	"description": "Quantity of items replaced."

	"description": "Shipping price for the item been replaced. It does not account for the whole order's shipping price and is presented in cents."
	"description": "Shipping price for the replaced item, in cents. It does not account for the whole order's shipping price."

Fixing and improving Orders API #1345

Are you sure you want to change the base?

Fixing and improving Orders API #1345

Conversation

Isabella-Veloso commented Oct 15, 2024

Types of changes

Changelog

github-actions bot commented Oct 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment