Overview
Orders
Section titled “Orders”An order is a customer’s request to purchase one or more listings from a supplier. You can retrieve, update, add metafields and delete orders using the Orders endpoint.
Order Status
Orders are automatically created when a product is added to cart (when cart is enabled) or when the customer starts a Direct checkout. The status of the order is then draft.
You can retrieve all you abandoned carts by getting all orders created more than two hours ago and still with draft status.
After checkout, the status should be pending or new, depending on how the payment is handled. Pending status is used with non-automatic payment methods, such as bank wires, cash on delivery or checks. If the payment is made online (with cards), the status should be new if the payment succeeded, or failed if the payment fails. You can also keep the status draft if you want to let the user to retry the payment.
Contrary to e-commerce stores, on a multi-vendor marketplace you cannot be sure the Catalog is always up to date. That’s why all orders should be moderated and validated on the vendor’s side. Payment providers do not refund their fees if a transaction is cancelled. By capturing the funds only on vendor’s acceptation, you can avoid losing money on order that are declined by vendors. When the order is reviewed and validated by the vendor, the status becomes accepted. If the order is not accepted, the status becomes declined.
Status service_provided, shipped and customer_confirmed depends on your order workflow, but you can use them in any order you like.
If the vendor cannot fulfill the order, or if the customer want to cancel the order, the status becomes canceled. If money has been captured (probably the case if the status is at least accepted), you need to handle the refund of the funds. The endpoint is not publicly available, but you can ask our support team to send you all relevant documentation to handle it.
Finally, when the order’s workflow has come to an end, you can use the status completed. You can now consider the order like closed.
Notifications
No notifications sent when you update the order status through the API. You need to manually manage the sending of notifications. Please check the Notifications endpoint to learn how to send a notification.