Store

Orders

Create and manage orders for your customers. Creating an order automatically generates an invoice and a payment link. Prices are taken directly from the product catalog.

List orders

GET /v1/orders

Optional parameters: status, payment_status, customer (UUID), search, limit, page

Status: pending, confirmed, processing, shipped, delivered, completed, canceled, refunded

Payment status: pending, paid, partially_paid, refunded

Create order

POST /v1/orders

Body

{
  "customer_id": "uuid-del-cliente",
  "items": [
    { "product_id": "uuid-producto-1", "quantity": 2 },
    { "product_id": "uuid-producto-2", "quantity": 1 }
  ],
  "notes": "Entregar antes de las 5pm",
  "shipping_name": "Juan Pérez",
  "shipping_phone": "+5215512345678",
  "shipping_address": "Av. Reforma 123, CDMX"
}

Field	Type	Required	Description
`customer_id`	uuid	Yes	Customer UUID
`items`	array	Yes	List of products with product_id and quantity
`notes`	string	No	Notes visible to the customer
`internal_notes`	string	No	Internal notes
`currency`	string	No	ISO 4217 currency
`shipping_name`	string	No	Recipient name
`shipping_phone`	string	No	Recipient phone
`shipping_address`	string	No	Shipping address
`metadata`	object	No	Custom metadata

Get order

GET /v1/orders/{'{id}'}

Includes the customer, items with products and the associated invoice.

Order lifecycle

POST /v1/orders/{'{id}'}/cancel — Cancel order (restores stock)

POST /v1/orders/{'{id}'}/ship — Mark as shipped

POST /v1/orders/{'{id}'}/deliver — Mark as delivered

POST /v1/orders/{'{id}'}/complete — Mark as completed

Typical flow: pending → confirmed → shipped → delivered → completed

Order items

GET /v1/orders/{'{id}'}/items

Returns the order items with details of each product.

Was this page helpful? Thanks for letting us know.