Update Order Status

patchhttps://api.flxpoint.com/orders/{id}/status

Use this when you want to update order data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Request

Query parameters

statusquerystringrequired
order status
allowedOpenClosedCanceledOn HoldFailedNo Shipping MethodNot Managed
updateNotequerystring
note about this status update

Example request

patch/orders/{id}/status

curl -X PATCH "https://api.flxpoint.com/orders/{id}/status" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

201Created

No schema documented for this status.

400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "patch": {
    "summary": "Update Order Status",
    "description": "",
    "parameters": [
      {
        "schema": {
          "type": "string",
          "enum": [
            "Open",
            "Closed",
            "Canceled",
            "On Hold",
            "Failed",
            "No Shipping Method",
            "Not Managed"
          ]
        },
        "in": "query",
        "name": "status",
        "required": true,
        "description": "order status"
      },
      {
        "schema": {
          "type": "string"
        },
        "in": "query",
        "name": "updateNote",
        "description": "note about this status update"
      }
    ],
    "responses": {
      "201": {
        "description": "Created"
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight