Basic principles

This section covers working with orders between your system and Base.com via API. The vast majority of integrations work in the direction out of Base — you download orders that originated from an e-shop, a marketplace, or were entered manually in the panel, into your own ERP/warehouse/accounting system.

​

Where an order comes from

Every order has an order_source field — typically "shop" (a connected e-shop), "personal" (added manually in the panel), "order_return", or a specific marketplace code ("allegro", "amazon", "ebay", "ceneo", "emag", etc.). The full list of sources and their IDs is returned by getOrderSources.

​

Confirmed and unconfirmed orders

This is the single most important concept in the entire order API. Base distinguishes between:

• Unconfirmed orders (confirmed: false) — on some marketplace channels (typically Alza, Allegro), an order first appears as an incomplete “draft” (Alza calls this stage Order Insert). You can see the line items, but not necessarily the full address, price, or shipping method — data may still change.
• Confirmed orders (confirmed: true, date_confirmed populated) — the marketplace sent confirmation (Order Confirm on Alza), and Base filled in the remaining details. From this point the order shouldn’t change materially and is safe to persist into an external system.

This concept is central to correctly downloading orders — see Downloading orders.

​

Order statuses

Independently of confirmation, every order also has a user-defined status (order_status_id) — e.g. New Order, To Be Shipped, Shipped, Delivered, Cancelled. Every account configures its own statuses, and their behavior is driven by Automatic Actions. Details in Statuses.

​

Structure of this section

• Downloading orders — how to periodically pull orders with getOrders.
• Statuses — reading and writing statuses, typical setup, cancellations.
• Shipping labels — tracking numbers and carrier labels.
• Invoices — issuing an invoice in Base or attaching one from your ERP.
• Extra fields — custom fields attached to an order.
• Automation and webhooks — catching events (cancellations, status changes) in real time.