segmentio / segment-docs

Segment Documentation. Powered by Jekyll.
https://segment.com/docs/
Creative Commons Attribution 4.0 International
46 stars 330 forks source link

[Content]: Clarify (and possibly correct) checkout_id vs order_id #1983

Open aaronadamsCA opened 2 years ago

aaronadamsCA commented 2 years ago

What article on segment.com/docs is affected?

https://segment.com/docs/connections/spec/ecommerce/v2/

What part(s) of the article would you like to see updated?

According to this article:

My best guess is that this is a mistake, and Checkout Started should accept only checkout_id, not order_id.

Logically, the checkout ID should exist as soon as the checkout is started, whereas an order ID won't normally exist until an order is completed. This is the way it works with most e-commerce platforms.

Additional information

No response

markzegarelli commented 2 years ago

Hi @aaronadamsCA! Thanks for submitting this. The Product team agrees that the E-commerce spec should use checkout_id for Checkout Started, in place of order_id.

However, before making the change, we want to audit our existing destinations to ensure there are no unintended consequences downstream once the change is made.

I will leave this issue open for tracking purposes, and will close once we update the docs.

joidegn commented 1 year ago

Just checking if this issue is still pending or if we should now use the checkout_id for checkout steps. Is the documentation currently correct or should we follow the logic @aaronadamsCA lined out?