Skip to main content

Update order status with optional metadata

PUT 
/api/v1/orders/:orderId/status

This endpoint updates the order status and optionally adds tracking information, carrier details, and notes.

Authentication: Requires Private API Key (sk_*)

Valid Status Values:

  • confirmed - Order confirmed and being prepared
    • processing - Order is being processed/packaged
    • shipped - Order has been shipped (provide tracking number)
    • partially_shipped - Part of order has been shipped
    • delivered - Order delivered to customer
    • partially_delivered - Part of order has been delivered

Important Notes:

  • Status changes trigger order.status_updated webhook
    • Shipped/Delivered statuses trigger respective webhooks (order.shipped, order.delivered)
    • Customer receives notification for major status changes
    • Status history is maintained for audit

Use Cases:

  • Updating fulfillment status from warehouse systems
    • Adding tracking information when order ships
    • Marking orders as delivered
    • Order workflow automation

Error Scenarios:

  • 404 NOT FOUND - Order not found (Error code: ORDER_NOT_FOUND)
    • 400 BAD REQUEST - Invalid status value or invalid transition (Error code: INVALID_STATUS or INVALID_STATUS_TRANSITION)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Order status updated successfully - webhooks triggered