create_order

Updated May 21, 20261 min read

Create an order via POST /orders.

Parameters

NameTypeRequiredDescription
merchantstringYesMerchant that owns the order.
partner_order_referencestringYesMerchant order reference. Must be unique within the tenant.
tenantIdstringYes
billing_addressobjectNo
carriyo_metadataarrayNo
customerobjectNo
customer_collection_addressobjectNo
customer_collection_scheduleobjectNo
delivery_addressobjectNo
delivery_methodstringNoValues: DELIVERY, COLLECTION, DIGITAL.
delivery_scheduleobjectNo
delivery_typestringNo
discount_applicationsarrayNo
duties_includedbooleanNo
fulfillment_ordersarrayNo
languagestringNoISO 639-1 language code.
line_itemsarrayNo
order_datestringNoOrder date or date-time.
paymentobjectNo
sales_channelstringNo
shipping_linesarrayNo
taxes_includedbooleanNo

Example agent prompt

"Create a new order."

create_order(
  tenantId="…",
  merchant="acme",
  partner_order_reference=…
)