Explanation of Order Financial Statuses
J
Is there documentation somewhere that explains the different financial
statuses for an order (e.g. authorized vs. pending vs. paid vs.
abandoned vs. refunded vs. voided)? Is there a flow chart that
explains how an order can transition from one state to the next?
If an Orders API (http://api.shopify.com/order.html) call is made, I
assume any particular order will be returned with its financial status
at that moment. If I re-run this query 2 days later, the financial
status for the same order may very well change. Is this correct? If
so, what's the recommended way of finding out changes that occur to
orders? Constantly requerying old orders seems like a bad idea.
I believe I see two ways:
1) Webhooks - Register webhooks for orders-related topics. Would I
use "orders/updated", "orders/paid", "orders/cancelled", "orders/
fulfilled" - all of the above?
2) Use the "updated_at_min" param for the Orders API (http://
api.shopify.com/order.html). This will allow me to see only orders
that have been updated since a certain time. I'll need to keep track
of this timestamp between calls.
Any help would be appreciated.
Thanks,
J
J
David Underwood
This is something that I'm working on this week, I'll post back when something goes up on the wiki.
-David Underwood
Developer Advocate, Shopify
1-888-746-7439 x771
David Underwood
J
Looking forward to the rest of the documentation, specifically in
regards to recommendations on how to listen for status changes for an
order (Webhook vs Order API).
On Jul 19, 3:42 pm, David Underwood <david.underw...@jadedpixel.com>
wrote:
Yan Sarazin
Denis Odorcic
Yan Sarazin
Jonathan Rudenberg
when the transaction is on an offsite gateway/checkout and the payment
is being processed, but is not complete.
Jonathan
--
Jonathan Rudenberg
Developer
http://shopify.com - e-commerce done right
J
On Jul 19, 2:24 pm, David Underwood <david.underw...@jadedpixel.com>
wrote:
J
Reposted:
Is there documentation somewhere that explains the different
financial
statuses for an order (e.g. authorized vs. pending vs. paid vs.
abandoned vs. refunded vs. voided)? Is there a flow chart that
explains how an order can transition from one state to the next?
If an Orders API (http://api.shopify.com/order.html) call is made, I
assume any particular order will be returned with its financial
status
at that moment. If I re-run this query 2 days later, the financial
status for the same order may very well change. Is this correct? If
so, what's the recommended way of finding out changes that occur to
orders? Constantly requerying old orders seems like a bad idea.
I believe I see two ways:
1) Webhooks - Register webhooks for orders-related topics. Would I
use "orders/updated", "orders/paid", "orders/cancelled", "orders/
fulfilled" - all of the above?
2) Use the "updated_at_min" param for the Orders API (http://
api.shopify.com/order.html). This will allow me to see only orders
that have been updated since a certain time. I'll need to keep track
of this timestamp between calls.
Yan S.
Jonathan Rudenberg
The financial status will always be updated to a non-null value after
completing checkout. There are some cases with offsite gateways where
this may not be instant, as it won't get updated until we get a
payment confirmation from the gateway.
Jonathan
--
Jonathan Rudenberg
Developer
http://shopify.com - e-commerce done right
J
John Duff
The documentation for the financial statuses is still in the works,
but this is a basic breakdown:
authorized - The shop owner has been authorized to capture the amount
for the order and the customer has the funds available. No funds have
transfered.
pending - The order is pending a response from the payment gateway.
paid - The order has been paid. Funds that were previously authorized
have been captured.
abandoned (or null) - An order that has started the checkout process
but not completed the checkout (payment information was not
submitted).
refunded - The order has been cancelled and funds refunded to the
customer (fully or partially).
voided - The order has been cancelled and the transaction voided with
the payment gateway.
For the second part of your question, how to be notified of changes to
an order, webhooks are probably your best bet. The orders/updated
webhook is fired when anything on the order changes, this includes
financial statuses. Often application developers use the webhooks as
their main method of being notified, but if something goes wrong or
they have downtime they fall back to polling with updated_at_min as
you mentioned.
I hope this helps and if you need any other information please let me know!
John Duff
Developer @ Shopify