Create order

post

https://api.getkonvex.com/core/api/ecommerce/orders

This endpoint creates a new customer order in the e-commerce platform. It records all necessary order details, including customer information, products, quantities, pricing, and payment/shipping data. Key Features: Accepts order details such as customerId, items (with product IDs, quantities, and prices), shippingAddress, billingAddress, and paymentMethod. Automatically calculates totals, taxes, and discounts (if applicable). Returns a unique orderId and full order details upon successful creation. Integrates with fulfillment, invoicing, and notification workflows. Example Use Cases: Placing an order from the checkout page. Creating orders programmatically from external systems (e.g., mobile app, POS, marketplace). Testing order creation in sandbox environments for integrations. Woo Commerce Shopify Tienda Nube Mercado Libre

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

billing

object

required

Billing information of the customer, including name, address, email, and phone number.

shipping

object

required

Shipping details of the recipient, including name and address.

products

array of objects

required

List of products included in the order, specifying product IDs, variants (if applicable), and quantities.

products*

shipping_lines

array of objects

required

Details of the selected shipping method, including method ID, title, and total cost.

shipping_lines*

custom_data

array

Each e-commerce platform has its own specific data fields. These are grouped under the platform’s name in the request body.
The structure and fields may vary depending on the platform’s API requirements.
{ "TiendaNube": { "currency": "USD", "financial_status": "paid", "fulfillment_status": "fulfilled", "billing_address_zipcode": "94103", "shipping_address_zipcode": "94103", "note": "Order created via API" }, "WooCommerce": { "payment_method": "bacs", "payment_method_title": "Direct Bank Transfer" } }
Platform-Specific Fields • TiendaNube • currency: Order currency (e.g., USD, EUR). • financial_status: Payment status of the order (e.g., paid, pending). • fulfillment_status: Shipping status of the order (e.g., fulfilled, unfulfilled). • billing_address_zipcode: Zip code of the billing address. • shipping_address_zipcode: Zip code of the shipping address. • note: Additional notes related to the order. • WooCommerce • payment_method: Payment method identifier (e.g., bacs, paypal). • payment_method_title: Human-readable name of the payment method. Extensibility New platforms can be added dynamically under their respective names, with custom fields as required.

custom_data

Headers

x-software

string

enum

required

Name of the ERP or accounting software from which you want to get the information Woo Commerce Shopify Tienda Nube Mercado Libre

Allowed:

x-connection

string

required

If you send the x-connection, the connection will already be secured, and there will be no need to send the connection headers for each software. Woo Commerce Shopify Tienda Nube Mercado Libre

x-user

string

required

User of ERP API connection. Woo Commerce Shopify Tienda Nube Mercado Libre

x-apiKey

string

required

Apikey or token of ERP API connection. Woo Commerce Shopify Tienda Nube Mercado Libre

x-url

string

required

The Base URL or host domain from e-commerce. Woo Commerce Shopify Tienda Nube Mercado Libre

Responses

200200

400400