Order API FAQ

This section provides answers to some commonly asked questions about Order API

What are the rules for orders and tracking numbers?

Currently, orders cannot be split or merged. Multiple orders can share the same tracking number. And A single order can have multiple packages, each with its own tracking number.

What is the logic behind the total_price field?

Taxes: total_price represents the final amount paid by the customer, including taxes if applicable.

Additional Fees: total_price includes extra charges like additional_total, total_shipping, total_tax, shipping_tax_total, and tips (total_tip_received).

Formula:

📘

Field Explanation

sub_total: Total price of products.

total_shipping: Total shipping fees.

additional_total: Additional charges.

total_tax: Total product tax.

shipping_tax_total: Total shipping tax.

total_tip_received: Total tips received.

total_discount: Total discounts (e.g., product and code discounts).

If sub_total is tax-exclusive (order.config.product_tax_included == false):

total_price = (sub_total + total_shipping + additional_total + total_tax + shipping_tax_total + total_tip_received) - total_discount

If sub_total is tax-inclusive (order.config.product_tax_included == true):

total_price = (sub_total + total_shipping + additional_total + shipping_tax_total + total_tip_received) - total_discount

PayPal Payments: total_price reflects the amount the customer pays, excluding any PayPal transaction fees, which are handled separately by the platform.

What is the purpose of the buyer_accepts_marketing field?

The buyer_accepts_marketing field indicates whether a customer consents to receive marketing promotions:

  • Accepted: Merchants can send promotional emails or discount offers.
  • Not Accepted: Customers are excluded from marketing campaigns.
    This field does not directly affect the order list or its information.

Does the customer.orders_count field include canceled or unpaid orders?

orders_count includes all orders created by the customer in the current store, regardless of their status (e.g., canceled or unpaid).

Can a customer use different currencies for payments in the same store?

Yes, stores can support multi-currency payments. All payments are converted into the store's primary market currency for consistency.

I created an order via API, but why can't I see it in the shop admin dashboard?​

This is typically because the order lacks a shipping address. The admin dashboard filters out and does not display orders considered "invalid" due to missing address information. However, these orders may still be retrievable via the API.

Why does the id of a line item in an order response change between API calls?​

The line item id for an ​​unpaid (incomplete) order​​ might not be persistent. Once the order is successfully paid for, the line item IDs will become stable and remain unchanged in subsequent API queries.