Endpoints

Read one placed order. Requires an owner grant.

GET/orders/{order_id}v0.3.2

Request

Authentication is required by the published contract.

CURL

curl 'https://ursy.net/wp-json/ursy-net/v1/orders/{order_id}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_SERVICE_TOKEN'

Scopes: net.orders.read
Execution: At the owning service
Risk classification: not declared

Parameters

order_id path · string required

Placed order id

This operation is documented here. Use the owning service with the appropriate credentials and permissions to execute it.

Response schemas and request body

CONTRACT JSON

{
    "requestBody": null,
    "responses": {
        "200": {
            "description": "OK",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/Envelope"
                    }
                }
            }
        },
        "401": {
            "description": "No valid URSY.ID access token for this resource (typed: unauthorized, invalid_token or identity_not_configured)",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "403": {
            "description": "Refused: ordering_closed, or a token without the required scope",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "404": {
            "description": "Not found (typed error)",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "405": {
            "description": "Method not allowed; the Allow header lists what this path accepts",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "500": {
            "description": "Internal error (typed error)",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        },
        "503": {
            "description": "The authorization server could not be reached",
            "content": {
                "application/json": {
                    "schema": {
                        "$ref": "#/components/schemas/ErrorEnvelope"
                    }
                }
            }
        }
    }
}