Services

Get a single account order

Get one order available to the current customer account by its id.

A main (LBA) account can additionally fetch the orders of its aggregated sub-accounts. A regular or sub account can fetch only its own orders. An order that does not exist or does not belong to the account returns 404 Not found (the existence of a foreign order is never revealed).

The response object has the same shape as one item of the GET /portal/services/order list. Per service item, provider_status is returned when the order is paid or approved by the main account; the order-level payment_date is returned only when the order is paid. Otherwise they are omitted.

get/portal/services/order/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/portal/services/order/{id}
  • Auth: HTTP basic

Path parameters

idinteger required
Example:502

Order id.

Response

idinteger
created_atstring
process_with_main_approveboolean
statusstring

Order status.

commentstring

Free-text order comment. Holds the main account's rejection note when status is rejected_by_main; empty otherwise.

notestring

Note left by the ordering account at checkout; empty when none.

servicesobject

Service items grouped by tariff type (internet, voice, recurring, bundle, one_time).

total_pricenumber
payment_datestring

Returned only when the order is paid.

Changes

No recorded changes to this operation across all 1 revision of this API.