Skip to navigation

Overview

View as Markdown

The store’s orders. Permission: orders (read, or read and update).

  • List / get - each order in full: the customer, the products with their options, delivery, coupon, promotions, VAT, the total, and every field filled in at checkout. Filter by status, paid, created_since and created_until.
  • Update - the status, paid, notes, and the shipment’s tracking number. With notifyCustomer: true, the customer gets the store’s “order status changed” email, including the tracking number.

Statuses are the store’s own (admin: הזמנות > נהל סטטוסים); 1 is “new” and 2 is “read”. Sending a status id the store does not have is answered with the list of valid ones.

To be told about new orders as they happen rather than polling, use the Order Placed webhook.