Set Order Export Status

POST 
/v1/order/set_export_status

Set Order Export Status

Updates the ERP export status for multiple orders. This endpoint is used by integrated systems to report the success or failure of order exports to external ERP systems.

Required Scopes (io.r)

Request

A list of status update requests, each containing:

order_id: str
The unique identifier of the order whose export status is being updated.

---

status: ERPStatus
The export status to set for the order.

ERP Status Values

sent
The order was successfully sent to the ERP system.

pending
The order is pending export to the ERP system.

errors
An error occurred while attempting to export the order to the ERP system.

staged
The order has been staged for export to the ERP system.

---

error: str | None = None
An optional error message describing what went wrong during the export process. Typically only populated when the status is set to 'errors'.

Response

Returns None. The endpoint processes the status updates and returns with no response body.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...