ONYX
Docs

Orders And Provisioning

Create connectivity orders and guide activation safely.

Orders and provisioning move a partner connectivity purchase from selection to service preparation.

The partner experience should show the current order state clearly. Users should know whether the service is preparing, ready to install, active, or needs attention.

Order Creation

An order should reference an approved package from the current catalogue.

Order creation can depend on:

  • partner approval
  • package availability
  • market eligibility
  • payment status where applicable
  • account state
  • compliance requirements

Do not create orders for unavailable packages.

Provisioning

Provisioning prepares the connectivity service.

Provisioning can return:

  • preparing
  • ready to install
  • active
  • delayed
  • failed
  • unavailable

Partners should show the state returned by Onyx instead of inventing a status.

Activation Materials

Activation materials help the user install service on a supported device.

Partners should handle activation materials carefully.

Do not expose activation materials in public logs, screenshots, support transcripts, or unsecured messages.

Install Guidance

Installation guidance should tell the user what to do next.

Depending on the device and service, the user may need to:

  • install the service profile
  • select the active line
  • enable roaming where required
  • wait for network registration
  • restart the device if instructed

Use the approved Onyx activation guidance for the service.

Recovery

If installation is interrupted, show the recovery path.

Recovery can depend on:

  • order state
  • activation state
  • device state
  • whether activation materials were already used
  • current service eligibility

Partners should not tell users to delete a service profile unless the approved recovery flow says to do so.

Failed Orders

If an order fails, show the known reason and next step.

Do not retry provisioning repeatedly without a state change or Onyx guidance.