Schemas
UpdateOrderSuspensionRequest
suspendedWhen true, suspends the order; when false, unsuspends.
reasonSuspension reason (required when suspended is true).
UpdateBulkOrderSuspensionRequest
suspendedWhen true, suspends the orders; when false, unsuspends.
orderIdsOrder identifiers to update.
reasonSuspension reason (required when suspended is true).
removeChildLocksWhether to remove child locks when unsuspending.
OrderSummaryDto
orderIdOrder identifier
customerIdCustomer identifier
domainNameDomain or primary product name
descriptionOrder description
currentStatusCurrent order status
productKeyProduct key
productCategoryProduct category
productNameProduct display name
creationTimeOrder creation timestamp
endTimeOrder expiry timestamp
deletionTimeScheduled deletion timestamp when applicable
entityTypeIdEntity type identifier
resellerIdReseller identifier
parentKeyParent reseller chain key
domainNameUnicodeUnicode domain name when applicable
recurringWhether the order is recurring
daysToExpiryDays until expiry
daysToDeletionDays until deletion
tenureOfLastActionPerformedTenure of the last action performed on the order
entityTypeKeyentityTypeNameOrderDetailsDto
orderIdOrder identifier
customerIdCustomer identifier
parentKeyParent key hierarchy
domainNameDomain or product description
descriptionOrder description
currentStatusCurrent order status
productKeyProduct key
productCategoryProduct category
creationTimeOrder creation timestamp
endTimeOrder expiry timestamp
recurringWhether the order is recurring
entityTypeIdEntity type identifier
serviceProviderIdDNS/service provider identifier
orderSuspendedByParentWhether the order is suspended by a parent reseller
allowDeletionWhether deletion is allowed for this order
moneybackPeriodMoney-back guarantee period in days
isImmediateResellerWhether the caller is the immediate reseller for this order
isOrderSuspendedUponExpiryWhether the order is suspended upon expiry
autoRenewTermTypeAuto-renew term classification when applicable
autoRenewAttemptDurationAuto-renew attempt duration when applicable
currentOrderTenureCurrent order tenure when applicable
pausedorderStatuscreationDtproductCategoryLabelcustomerCostresellerCostactionCompletedjumpConditionsExecution metadata returned with order detail responses.
Additional product-specific overview fields for this order.
OrderExecutionInfoParamsDto
rpInfoRpDomainIdRegistry provider domain identifier for the in-flight action.
invoiceIdInvoice identifier associated with the order action.
isBulkWhether the action was submitted as a bulk operation.
currentExpDateCurrent domain expiry timestamp at action time.
addActionUserDetailsUser and role details recorded when the action was created.
actionInvoiceMapInvoice mapping for the action.
roleRole of the user who initiated the action.
paymentTypePayment type used for the action.
rpInfoRpActionStatusRegistry provider action status.
autoRenewalWhether auto-renewal was enabled for the action.
rpInfoRpActionIdRegistry provider action identifier.
addActionIpAddressIP address recorded when the action was created.
discountDiscount amount applied to the action.
customerCostCustomer cost for the action from execution metadata.
userIdUser identifier that initiated the action.
noOfYearsNumber of years requested for renewal or registration.
OrderDnsServiceStatusResponse
activeWhether the service is active
parentKeycustomerIdresellerIdstatusOperation status
messageStatus message
OrderDomainForwardStatusResponse
activeWhether domain forwarding is active
parentKeyParent reseller chain key
customerIdCustomer identifier
resellerIdReseller identifier
statusOperation status when present
messageError or status message when the order cannot be evaluated
SearchOrdersResponse
totalItemsTotal matching orders in the result set
itemsOnPageOrders returned on this page
totalPagesTotal number of pages for the search
totalCountOrder summaries
productNamestatusOperation status when present
messageStatus message when present
UpdateBulkOrderSuspensionResponse
successWhether the bulk operation succeeded.
UpdateOrderSuspensionResponse
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
descriptionAdditional description when provided.
statusStatus text
messageResult message

