A complete checkout flow requires four steps.
Step 1: Add Item to Cart
Specify the child item ID (variant-resolved) and quantity. The API returns a Cart ID for each item added.
| Note: Use child item IDs only. Submitting a parent item ID returns a null response. |
Step 2: Generate Invoice and Orders
Submit an array of Cart IDs. The response returns:
- One Invoice object
- Orders grouped by merchant
- Item pricing, merchant details, delivery details, and commission fees
Items from the same merchant are grouped under the same Order object.
| Note: At this stage, Orders and the Invoice exist. Payment may or may not yet be executed, depending on the CTA model configured for the marketplace. |
Step 3: Update Order Details
Two APIs are available: Edit Order Details API and Edit Many Orders' Details API (bulk). Editable fields include:
- FulfilmentStatus, PaymentStatus, Delivery Address, Surcharge, Discount Amount, Freight, Order Custom Fields
When financial values are modified, the Total field is automatically recalculated.
Order Custom Fields can be used to store workflow-specific data, commonly used for B2B requirements and operational routing. Examples include:
- PO numbers and billing references
- Delivery constraints (time window, access instructions)
- Promo codes and rewards points
- Approval or verification flags for staged fulfilment
- Unique identifiers
Step 4: Update Transaction Details
Reflects payment execution outcomes. Editable fields include:
- Total, Admin commission fee, payment gateway details, transaction status
Transaction status determines how the record appears in the Admin Portal (successful, failed, refunded, etc.).