Express POST API Documentation

Purpose

This endpoint is used to create an Express Order for a specific account, including order-level properties, multiple order lines, pricing details, tax configurations, and optional purchase order and purchase invoice information. It provides a single consolidated request to generate an order with all required data such as pricing snapshot, fulfillment configuration, purchase orders, and applied payments.

Use Case

• Creating a new order for an account in a single action.
• Adding multiple order line items with individual pricing snapshots.
• Generating purchase orders automatically while creating the order.
• Including purchase invoice payment details for each purchase order.
• Applying manual fulfillment configuration for the order.
• Creating an order that immediately generates its invoice and charge items.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

This endpoint does not use any query parameters.

Request Body

                JSON
              

                      {
    "account": {
        "id": "{{ACCOUNT_ID}}",
        "order": {
            "properties": {
                "fulfillment_mode": "{{FULFILLMENT_MODE}}",
                "fulfillment_term": "{{FULFILLMENT_TERM}}"
            },
            "price_tax_inclusive": "{{PRICE_TAX_INCLUSIVE}}",
            "lines": [
                {
                    "item_id": "{{ITEM_ID}}",
                    "item_order_quantity": "{{ITEM_ORDER_QUANTITY}}",
                    "item_price_snapshot": {
                        "pricing_rule": {
                            "price": "{{ITEM_PRICE}}"
                        }
                    },
                    "tax_exempt_when_sold": "{{TAX_EXEMPT_FLAG}}",
                    "purchase_order": {
                        "create_po": true,
                        "po_information": {
                            "id": "{{PO_ID}}",
                            "tax_exempt_when_sold": "{{PO_TAX_EXEMPT_FLAG}}",
                            "item_quantity": "{{PO_ITEM_QUANTITY}}",
                            "item_price_snapshot": {
                                "pricing_rule": {
                                    "price": "{{PO_ITEM_PRICE}}"
                                }
                            },
                            "purchase_invoice": {
                                "purchase_payment": {
                                    "purchase_payment_applied": [
                                        {
                                            "processor": "{{PAYMENT_PROCESSOR}}",
                                            "reference": "{{PAYMENT_REFERENCE}}"
                                        }
                                    ]
                                }
                            }
                        }
                    }
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
account	object	Contains account-level information.
account.id	string	Unique identifier of the account.
account.order	object	Contains order-level details.
order.properties	object	Holds fulfillment configuration for the order.
properties.fulfillment_mode	string	Fulfillment mode.
properties.fulfillment_term	string	Fulfillment processing term.
order.price_tax_inclusive	string	Indicates whether prices are tax-inclusive.
order.lines	array	List of order line items.
lines.item_id	string	Identifier of the item being ordered.
lines.item_order_quantity	string	Quantity of the item ordered.
lines.item_price_snapshot	object	Snapshot pricing information at the time of order.
pricing_rule.price	string	Unit price of the item.
lines.tax_exempt_when_sold	string	Indicates tax-exempt status at sale.
lines.purchase_order	object	Contains purchase order creation details.
purchase_order.create_po	boolean	Indicates if a purchase order must be generated.
po_information.id	string	Unique identifier for the purchase order.
po_information.tax_exempt_when_sold	string	Tax-exempt flag for the purchase order.
po_information.item_quantity	string	Quantity for the purchase order.
po_information.item_price_snapshot	object	Purchase order pricing snapshot.
pricing_rule.price	string	Price used in purchase order.
purchase_invoice	object	Contains purchase invoice details.
purchase_payment	object	Contains details of applied payments.
purchase_payment_applied	array	List of payments applied to the purchase invoice.
processor	string	Payment processor used.
reference	string	Reference note for the payment.

Response

The API returns a fully constructed order object containing all order details, including generated order ID, currency information, time zone, invoice ID, line items with pricing snapshots, tax configurations, KPIs, and additional metadata. The response confirms that the Express Order has been successfully created along with all its associated line items, pricing details, and purchase order data. It also includes metadata such as creation timestamps, versions, custom forms, user information, totals, and all supporting financial records.

Response Body

                JSON
              

                      {
    "order": {
        "status": "{{ORDER_STATUS}}",
        "id": "{{ORDER_ID}}",
        "pre_order": "{{PRE_ORDER_FLAG}}",
        "quote_order": "{{QUOTE_ORDER_FLAG}}",
        "name": "{{ORDER_NAME}}",
        "display_name": "{{ORDER_DISPLAY_NAME}}",
        "description": "{{ORDER_DESCRIPTION}}",
        "referral_account": "{{REFERRAL_ACCOUNT}}",
        "customer_purchase_order_id": "{{CUSTOMER_PO_ID}}",
        "shipping_profile": {},
        "shipping_cost": "{{SHIPPING_COST}}",
        "discount_profile": null,
        "origin": "{{ORDER_ORIGIN}}",
        "custom_forms": {
            "uuid": "{{FORM_UUID}}",
            "name": "{{FORM_NAME}}"
        },
        "currency": {
            "uuid": "{{CURRENCY_UUID}}",
            "name": "{{CURRENCY_NAME}}",
            "link": "{{CURRENCY_LINK}}"
        },
        "time_zone": {
            "uuid": "{{TIMEZONE_UUID}}",
            "name": "{{TIMEZONE_NAME}}",
            "link": "{{TIMEZONE_LINK}}"
        },
        "invoice_note": "",
        "billing_start_date": "{{BILLING_START_DATE}}",
        "order_start_date": "{{ORDER_START_DATE}}",
        "next_billing_from_date": "",
        "price_tax_inclusive": "{{PRICE_TAX_INCLUSIVE}}",
        "billing_address": {},
        "shipping_address": {},
        "created_by": "{{CREATED_BY}}",
        "created_on": "{{CREATED_ON}}",
        "last_updated_by": "",
        "last_updated_on": "",
        "uuid": "{{ORDER_UUID}}",
        "version": "{{ORDER_VERSION}}",
        "account_id": "{{ACCOUNT_ID}}",
        "account_name": "{{ACCOUNT_NAME}}",
        "allow_contract": "{{ALLOW_CONTRACT_FLAG}}",
        "custom_attributes": [],
        "custom_objects": [],
        "currency_id": "{{CURRENCY_ID}}",
        "properties": {
            "communication_profile": "",
            "invoice_mode": "{{INVOICE_MODE}}",
            "invoice_term": "{{INVOICE_TERM}}",
            "billing_period": "{{BILLING_PERIOD}}",
            "consolidate_invoice": "{{CONSOLIDATE_INVOICE_FLAG}}",
            "payment_processor": "{{PAYMENT_PROCESSOR}}",
            "payment_mode": "{{PAYMENT_MODE}}",
            "payment_term": "{{PAYMENT_TERM}}",
            "payment_term_alignment": "{{PAYMENT_TERM_ALIGNMENT}}",
            "fulfillment_mode": "{{FULFILLMENT_MODE}}",
            "fulfillment_term": "{{FULFILLMENT_TERM}}"
        },
        "invoice_id": "{{INVOICE_ID}}",
        "lines": [
            {
                "charge_item_uuid": "{{CHARGE_ITEM_UUID}}",
                "item_uuid": "{{ITEM_UUID}}",
                "item_id": "{{ITEM_ID}}",
                "item_name": "{{ITEM_NAME}}",
                "item_order_quantity": "{{ITEM_ORDER_QUANTITY}}",
                "shipping_cost": "{{LINE_SHIPPING_COST}}",
                "item_invoice_note": "",
                "item_description": "",
                "item_type": "{{ITEM_TYPE}}",
                "item_charge_type": "{{ITEM_CHARGE_TYPE}}",
                "item_custom_attributes": [],
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "{{PRICING_RULE_UUID}}",
                        "version": "{{PRICING_RULE_VERSION}}",
                        "price_type": "{{PRICE_TYPE}}",
                        "price": "{{PRICE}}",
                        "uom": "",
                        "price_period": "",
                        "pricing_schedule": "",
                        "pricing_level": "",
                        "pricing_method": "{{PRICING_METHOD}}",
                        "warehouse": "{{WAREHOUSE}}"
                    }
                },
                "item_sale_tax_configuration": {
                    "sale_price_is_based_on": "{{SALE_PRICE_BASE}}",
                    "tax_code": {
                        "uuid": "",
                        "code": "",
                        "rate": "",
                        "link": ""
                    }
                },
                "isTaxExemptWhenSold": "{{TAX_EXEMPT_FLAG}}",
                "item_price_tax": {
                    "uuid": "{{ITEM_TAX_UUID}}",
                    "code": "{{ITEM_TAX_CODE}}",
                    "rate": 0,
                    "link": "{{ITEM_TAX_LINK}}"
                },
                "item_accounting_code": {
                    "sales_revenue": ""
                },
                "version": "{{LINE_VERSION}}",
                "expected_delivery_date": "",
                "purchase_order_id": "",
                "purchase_invoice_id": "",
                "discount": 0,
                "total": "{{LINE_TOTAL}}",
                "subtotal": "{{LINE_SUBTOTAL}}",
                "tax": "{{LINE_TAX}}"
            }
        ],
        "total": "{{ORDER_TOTAL}}",
        "subtotal": "{{ORDER_SUBTOTAL}}",
        "tax": "{{ORDER_TAX}}",
        "kpis": {
            "start_date": "",
            "estimated_total": 0,
            "total_revenue": 0,
            "monthly_recurring_revenue": 0,
            "total_collected": 0,
            "total_outstanding": 0,
            "total_due": 0,
            "last_invoice_issue_date": "",
            "last_invoice_total": 0,
            "total_invoice": 0,
            "next_invoice_issueDate": "",
            "last_reactivated_on": "",
            "last_cancelled_on": "",
            "last_changed_on": "",
            "last_deleted_on": ""
        },
        "line_items": []
    }
}

                    

Attribute	Type	Description
order	object	Contains full order details.
order.status	string	Current status of the order.
order.id	string	Unique order identifier.
order.pre_order	string	Indicates pre-order status.
order.quote_order	string	Indicates quote order status.
order.name	string	Name of the order.
order.display_name	string	Display name of the order.
order.description	string	Order description.
order.referral_account	string	Referral account value.
order.customer_purchase_order_id	string	Customer PO reference.
shipping_profile	object	Shipping profile details.
shipping_cost	string	Shipping cost for the order.
custom_forms	object	Form applied to the order.
currency	object	Currency information.
time_zone	object	Time zone details.
billing_start_date	string	Start date for billing.
order_start_date	string	Order start date.
properties	object	Payment, billing, and fulfillment configuration.
invoice_id	string	Generated invoice ID.
lines	array	List of all processed line items.
lines.item_id	string	Item identifier.
lines.total	string	Total amount for the line item.
lines.subtotal	string	Subtotal for the line item.
lines.tax	string	Tax applied for the line item.
kpis	object	Order KPI metrics.
total	string	Total amount for the order.
subtotal	string	Subtotal amount for the order.
tax	string	Total tax applied.