Ctrlk
💬 Need Help? Click Me
For the complete documentation index, see llms.txt. This page is also available as Markdown.

作废

Atlas API 作废端点参考，用于检查作废条件、提交作废请求，并确定退款或后续处理路径。

💬 需要帮助？ 如果遇到问题，请在帮助中心咨询 Eva，快速获取诊断建议。

咨询 Eva

使用本部分了解专用的作废生命周期。

在需要以下内容时从此处开始：

  • 检查订单是否仍可作废

  • 使用最新的 voidOfferId 提交作废请求

  • 跟踪作废处理和结果

需要先了解工作流指南？

使用作废工作流。

常见问题

标准的 Atlas API 作废流程是什么？

标准流程是 voidQuotation.do → void.do → queryVoidOrders.do。

首先请求报价。

然后使用最新的 voidOfferId 提交作废。

提交后，查询状态直到案件完成或被拒绝。

Atlas 会在截止日期后拒绝作废请求吗？

会。

如果返回的当日作废截止日期已过，void.do 会实时失败。

典型错误信息：

  • Void deadline exceeded. This ticket can no longer be voided（超过作废截止日期。此票证无法再作废）

Atlas 支持部分乘客作废吗？

不支持。

Atlas 仅接受整单作废。

不要仅针对部分乘客提交作废。

服务费固定时，是否仍需调用 voidQuotation.do？

需要。

每次 void.do 请求前都需要调用 voidQuotation.do。

何时应使用作废而非退款？

当订单仍在航司作废窗口内时使用作废。

当作废窗口已过或案件需要走退款流程时使用退款。

当前作废覆盖范围

Atlas 作废目前支持四个地区的 23 家航司。

美洲

  • AS

  • DM

  • F9

  • G4

  • PB

  • SY

  • TS

  • Y4

欧洲

  • A3

  • D8

  • EI

  • DY

  • N0

  • OA

  • VF

  • Z0

日本

  • ZG — 仅限美国航线

韩国

  • 7C

  • BX

  • LJ

  • RS

  • TW

  • ZE

近期新增：

  • TS

  • Y4

  • EI

  • VF

覆盖范围因航司和航线而异。

如果预订超出此范围，Atlas 可能返回 843。

本部分涵盖内容

  • 请求作废报价

  • 提交作废请求

  • 查询作废状态和结果

典型流程

1

作废报价

检查订单是否可作废。

获取最新金额、方式和 voidOfferId。

2

提交作废

使用最新的报价结果提交作废请求。

保留返回的 voidCode 用于后续跟进。

3

查询作废状态

跟踪进度，直到作废完成、被拒绝或以其他方式关闭。

提交作废前应确认什么？

确认：

  • 原始 orderNo 正确

  • 订单仍在航司作废窗口内

  • 返回的当日截止日期尚未过

  • 使用的是最新的 voidOfferId

  • 该案件应走作废流程，而非退款流程

作废处理通常比退款处理更严格。

窗口过期可能使订单不可作废，即使退款仍有可能。

如果截止日期已过，Atlas 会立即拒绝作废请求。

关键行为

  • 作废使用专用端点

  • 提交前应先进行报价

  • voidOfferId 用于提交

  • voidCode 用于状态跟进

主要 API

  • voidQuotation.do

  • void.do

  • queryVoidOrders.do

请求模型

使用专用的作废流程，输入如下：

  • voidQuotation.do：orderNo

  • void.do：orderNo + voidOfferId

  • queryVoidOrders.do：voidCode

作废应在订单级别处理。

不要将作废视为部分退款流程。

Atlas 仅接受整单作废。

端点说明

voidQuotation.do

使用报价获取最新的作废资格和金额。

预期响应回答：

  • 订单是否可作废

  • 适用的 voidMethod

  • 下一步使用的 voidOfferId

首先读取的重要字段：

  • isVoidable

  • voidOfferId

  • expectedConfirmationDate

  • expectedRefundDate

  • voidWindow.sameDayDeadlineTime

  • voidWindow.sameDayTimezone

void.do

使用最新的 voidOfferId 提交作废。

保留返回的 voidCode。

使用该代码进行所有后续状态跟进。

即使服务费固定，也不要跳过报价。

如果返回的当日截止日期已过，Atlas 会实时拒绝请求。

queryVoidOrders.do

使用查询在提交后跟踪作废状态。

在大多数情况下，Atlas 会在约 5 分钟内返回作废请求是否已被接受处理。

最终完成或拒绝仍可能需要更长时间。

首先读取的重要字段：

  • voidCode

  • voidStatus

  • cancelReason

  • actualRefundAmount（可用时）

状态处理

需要关注的主要结果状态：

  • 处理中

  • 已退款或履约完成

  • 已拒绝

如果作废被拒绝，首先检查 cancelReason。

如果作废窗口已过期，在适用时将案件移至退款流程。

集成说明

提交前使用最新的报价结果。

不要重复使用旧的 voidOfferId。

将作废窗口视为严格限制。

如果订单不再可作废，不要继续重试作废路径。

Webhook 选项

Atlas 也可以将 order.void 发送到你注册的 webhook URL。

在 void.do 之后使用它获取近乎实时的状态更新。

Webhook 是提交后跟进进度的推荐方式。

首先读取这些字段：

  • data.orderNo

  • data.voidCode

  • data.voidStatus

  • data.message

无需额外注册 webhook。

使用通过 updateWebhookURL.do 注册的同一 URL。

当需要最终对账时，使用 queryVoidOrders.do。

阅读作废通知。

相关页面

Void Quotation

post
Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredDefault: gzipExample: gzip
x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>
Body
orderNostringRequired

Atlas original order number. You can choose to request either orderNo or both airlinePNR and carrier.

Example: TESTA20260610091023287
Responses
200Success
application/json
statusintegerRequired

Status code 0 : Success 801：Order not found for void. Check the original main ticket order number. 803：Void already submitted for this passenger or segment. Query void status instead. 805：voidOfferId expired. Call refundQuotation.do again for a fresh ID, then resubmit. 808：This ticket is non-voidable per airline policy. 810：Invalid request parameters 814：Void submission already in progress. Wait before retrying. 815：Ticket not found. Verify ticket number and order number. 816：Void already submitted for this order. Query void status instead of resubmitting. 817：Void already submitted for this order. Query void status instead of resubmitting. 818：Void already submitted for this order. Query void status instead of resubmitting. 820：Ticket already used — cannot void a flown segment. 822：Void deadline exceeded. This ticket can no longer be voided. 824：Wrong orderNumber: use the main ticket order, not the ancillary order number. 841：Void not support the payment method. Please contact the airline directly for resolution. 843：Atlas does not currently support VOID service for the airline or route of this booking.

msgstring · nullableRequired

Error message The ‘msg’ element is for description of the results. Please do not use this field to check the success or failure of the request. Only use the ‘status’ code to check the result.

fastConfirmationinteger · enumRequired

Fast confirmation depends on whether the airline supports auto fulfillment. 0 for False, 1 for True.

Possible values:
expectedConfirmationDatestringRequired

Expected date of getting airline void confirmation. The format is yyyyMMdd.

expectedRefundDatestringRequired

Expected date of getting refund. The format is yyyyMMdd.

voidOfferIdstringRequired

Void offer id for this quotation which can be used for the coming Void call.

voidMethodstring · enumRequired

Void method: CashBackToOriginalPayment or Voucher. CashBackToOriginalPayment: Refund cash back to the original form of payment. Voucher: Refund in the form of a voucher.

Possible values:
orderNostringRequired

Original order number

isVoidablebooleanRequired

True : Voidable False: Non-Voidable true or false

post/voidQuotation.do
200Success

Make a Void

post

Void quotation function should be called in prior of this call

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredDefault: gzipExample: gzip
x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>
Body
orderNostringRequired

Atlas original order number. You can choose to request either orderNo or both airlinePNR and carrier.

voidOfferIdstringRequired

Get this from the void quotation response.

Responses
200Success
application/json
statusintegerRequired

Status code 0 : Success, 801：Order not found for void. Check the original main ticket order number. 803：Void already submitted for this passenger or segment. Query void status instead. 805：voidOfferId expired. Call refundQuotation.do again for a fresh ID, then resubmit. 808：This ticket is non-voidable per airline policy. 810：Invalid request parameters 814：Void submission already in progress. Wait before retrying. 815：Ticket not found. Verify ticket number and order number. 816：Void already submitted for this order. Query void status instead of resubmitting. 817：Void already submitted for this order. Query void status instead of resubmitting. 818：Void already submitted for this order. Query void status instead of resubmitting. 820：Ticket already used — cannot void a flown segment. 822：Void deadline exceeded. This ticket can no longer be voided. 824：Wrong orderNumber: use the main ticket order, not the ancillary order number. 841：Void not support the payment method. Please contact the airline directly for resolution. 843：Atlas does not currently support VOID service for the airline or route of this booking.

msgstring · nullableRequired

Error message The ‘msg’ element is for description of the results. Please do not use this field to check the success or failure of the request. Only use the ‘status’ code to check the result.

fastConfirmationintegerRequired

Fast confirmation depends on whether the airline supports auto fulfillment. 0 for False, 1 for True.

expectedConfirmationDatestringRequired

Expected date of getting airline void confirmation. The format is yyyyMMdd.

expectedRefundDatestringRequired

Expected date of getting refund. The format is yyyyMMdd.

voidOfferIdstringRequired

Void offer id for this quotation which can be used for the coming void call.

voidMethodstringRequired

Voidmethod: CashBackToOriginalPayment or Voucher. CashBackToOriginalPayment: Refund cash back to the original form of payment. Voucher: Refund in the form of a voucher.

orderNostringRequired

Original order number

isVoidablebooleanRequired

True : Voidable False: Non-Voidable true or false

voidStatusintegerRequired

The present status of the void. The options are: 0: Atlas Processing 1: Airline Processing (Submitted to airline by Atlas) 2: Refunded 3: Airline Refunding 4: Rejected 5: Fullfillment Done 6: Withdrew If the ticket is paid by deposit: the status can be 0,1,2,3,4 If the ticket is paid by VCC pass through: the status can be 0,1,4,5,6 Withdrew is only in the refund claim

voidCodestringRequired

Void order number generated for this void request

cancelReasonstringRequired

The reason why the void was cancelled.

post/void.do
200Success

Query Void Status

post

No preceding function needs to be carried out.

Header parameters
AcceptstringRequiredExample: application/json
Content-TypestringRequiredExample: application/json
Accept-EncodingstringRequiredDefault: gzipExample: gzip
x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>
x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>
Body
orderNostringRequired

Atlas original order number.

voidCodestringOptional

The code of the void transaction received in the void.do response.

Responses
200Success
application/json

Void order query response

statusintegerRequired

API status code. 0 : Success 801: No voidable orders found. Please check the original main ticket order number. 803: Passenger or segment has already submitted a void request. Please check the void status. 805: voidOfferId has expired. Please call refundQuotation.do again to get a new ID and resubmit. 808: This ticket cannot be voided according to airline policy. 810: Invalid request parameters. 814: Void submission is already in process, please try again later. 815: Ticket not found. Please verify the ticket number and order number. 816: This order has already submitted a void request. Please check the void status, do not resubmit. 817: This order has already submitted a void request. Please check the void status, do not resubmit. 818: This order has already submitted a void request. Please check the void status, do not resubmit. 820: Ticket already used - cannot void flown segments. 822: Void deadline has passed. This ticket can no longer be voided. 824: Wrong order number: Please use the main ticket order number, not the ancillary service order number. 841: Void is not supported for this payment method. Please contact the airline directly for processing. 843: Atlas currently does not support void service for this airline or route.

msgstring · nullableRequired

Error message

post/queryVoidOrders.do
200Success
Previous退款Next重新生成订单

Last updated

Was this helpful?