Function orders/get (<http://<DOMAIN>>/api/orders/get/)

<aside> 🗒️ Block customer_details in Getting order list only for b2b projects

</aside>

<aside> 🗒️ dropshipping_details block and new ownTTNPicked parameter in the delivery_data array in the order list only for b2b projects

</aside>

Parameters:

• token — authorization key obtained through the auth function.
• from — show orders from the specified date (inclusive). Optional parameter. Date format:
  • YYYY-MM-DD
  • DD.MM.YYYY
  • Starting with version 3.30
  • YYYY-MM-DD HH:mm:ss
  • DD.MM.YYYY HH:mm:ss
• to — show orders up to the specified date (inclusive). Optional parameter. Date Format:
  • YYYY-MM-DD
  • DD.MM.YYYY
  • Starting with version 3.30
  • YYYY-MM-DD HH:mm:ss
  • DD.MM.YYYY HH:mm:ss
• ids[] — order numbers for display
• status — show orders with selected statuses (all statuses can be downloaded via the Get order statuses function). Optional parameter. The parameter can be passed as an array or variable (status=1 or status[]=1&status[]=2, {status:1}, {status:[1, 2]}). Possible values:
  • 1 - new
  • 2 - in process
  • 3 - delivered
  • 4 - not delivered
  • 6 - delivering
• additionalData — boolean value (true or false). Allows to upload additional information about the order, for example, tracking number, recipient's and sender's warehouse.
• Starting with version 3.30
• offset — offset of user selection relative to the start (works only in combination with the limit parameter)
• limit — number of orders displayed

Response:

• status
  • OK — orders found successfully
  • EMPTY — orders not found
• response.orders — array containing orders
  • response.orders[i]
    • order_id — order number
    • user — user ID in the system (unique for each user)
    • delivery_name — recipient's full name
    • delivery_email — email (unique for each user within the system, duplication is not possible)
    • delivery_phone — phone number
    • delivery_city — city (the name from carrier’s database)
    • delivery_city_stable — city (the name from Cartum’s database)
    • delivery_address — delivery address (if UkrPoshta delivery option is selected, fields are separated by @ symbol)
    • delivery_type — delivery type
      • delivery_type.id — delivery type identifier in the API. You can get information about delivery options through the functions Delivery options export and Delivery types export.
        • 3 — Nova Post
        • 8 — Local pickup
        • 9 — UkrPoshta
        • etc. (delivery option identifiers may differ on each project)
      • delivery_type.title — delivery type name
    • delivery_price — delivery cost ("delivery_price": -1 — means that the cost of delivery is calculated at the carrier's rates)
    • comment — customer comments on the order
    • payment_type — payment type. You can get information about payment options through the Payment options export and Payment methods export functions.
      • payment_type.id — payment type identifier in API
        • 11 — Cash on delivery
        • 12 — Cashless payment
        • 13 — In cash
        • 14 — Online payment (Stripe)
        • 15 — PayPal
        • etc.
      • payment_type.title — payment type name
    • payment_price — payment fee
    • payed — paid (1 — yes; 0 — no)
    • total_default — cost of goods (excluding discounts)
    • total_sum — total cost (including all discounts, but excluding shipping costs)
    • total_quantity — total number of items in the order
    • discount_percent — relative discount
    • discount_value — discount amount
    • coupon_code — discount coupon code
    • coupon_percent — relative discount of the coupon
    • coupon_discount_value — coupon discount amount
    • coupon_type — coupon type
      • 0 — without coupon
      • 1 — certificate for certain amount
      • 2 — reusable discount coupon
    • stat_status — order status. You can get information about all order statuses via the Get order statuses function (available since version 4.0).
      • 1 — new
      • 2 — in processing
      • 3 — delivered
      • 4 — not delivered
    • stat_created — date and time of order placement (example: 2021-04-09 12:09:01)
    • currency — currency in which the order was placed (in ISO format, for example: UAH — hryvnia, USD — dollar, EUR — euro, etc.). You can get information about all currencies through the Currency and exchange rate export function.
    • order_without_callback — boolean value (true or false). Whether the customer should be called back (added in version 3.32).
    • manager_id — id of the manager who processed the order
    • manager_comment — manager's comment
    • manager_discount — manager's discount
    • manager_discount_title — manager's discount name
    • delivery_country — country of delivery (if country selection is enabled on the checkout page)
    • products[i] — products in an order
    • additional_data — additional order information (only displayed if you pass the "additionalData": true key in the body of the query)