Skip to content

Knowledgebase

Track domain orders and cancel only work that remains cancellable

domain-nexus, development

Use the order resources to track a commercial request and its linked items, settlements and domain operations. Read the existing order before deciding to retry or cancel. The order header and the registrar's completed work are separate facts.

01 Inspect the order

Method Resource Scope Idempotency-Key
GET /v2/orders orders:read Not required by this route
GET /v2/orders/{orderId} orders:read Not required by this route
POST /v2/orders/{orderId}/cancel orders:write Required
POST /v2/orders orders:write Required
  1. List your account's orders and locate the returned order ID using the external reference or request evidence.
  2. GET the order detail. Compare its state with linked domain operations and settlements.
  3. If work is still eligible for cancellation, submit the cancel route with an idempotency key.
  4. Read the order again and inspect any related operation that may already have reached the provider.
  5. Record the outcome against the original customer order instead of creating a second local order to represent the same attempt.

Does POST /v2/orders buy several domains at once?

No. It creates an explicit order header with fields such as order_type, external_order_id, currency_id and recorded totals. It does not accept and execute a multi-line shopping cart. Use the specific registration, transfer, renewal or supported service endpoints to perform those operations.

Can cancelling an order undo a completed registration?

No. Cancellation cannot reverse provider work that has already completed. A registered domain, a possible registry deletion request and a billing refund each have their own eligibility and workflow. Do not promise an automatic refund or a released name from an order-cancel response.

The current cancellation handler performs the allowed state change before returning. Follow the actual response and subsequent detail instead of assuming it is always an asynchronous cancellation job.

What should I do after a timeout?

Preserve the original request, order and idempotency references. Re-read the operation and payment evidence before retrying. If cancellation is rejected because the order has advanced, reconcile that current state and explain it to the customer. Repeatedly submitting a new purchase is not a recovery procedure for an uncertain earlier one.

Was this answer helpful?

Need a little more help?

Our support team can help you find the next step.

Contact support