Order Items - Return

服务:

Edge Hardware Center

API 版本:

2024-02-01

返回订单项。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return?api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
orderItemName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9][-A-Za-z0-9]*[A-Za-z0-9]$|^[A-Za-z0-9]$	订单项的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
returnReason	True	string	返回原因。
returnAddress		AddressProperties	客户寄信人地址。
serviceTag		string	服务标记（位于设备的右下角）。
shippingBoxRequired		boolean	需要寄送箱。

响应

名称	类型	说明
200 OK		Azure作已成功完成。
202 Accepted		已接受资源作。 标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ReturnOrderItem

示例请求

HTTP

POST https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderName4/return?api-version=2024-02-01

{
  "returnReason": "Order returned"
}

示例响应

状态代码:

200

状态代码:

202

location: https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/locations/westus/operationResults/operationid?api-version=2024-02-01

定义

名称	说明
AddressClassification	基于地址的使用上下文的类型。
AddressProperties	地址属性。
AddressType	地址类型。
AddressValidationStatus	地址验证的状态。
ContactDetails	联系人详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	预配状态
ReturnOrderItemDetails	返回订单项请求正文。
ShippingAddress	客户希望接收设备的寄送地址。

AddressClassification

枚举

基于地址的使用上下文的类型。

值	说明
Shipping	订单的寄送地址。
Site	站点地址。

AddressProperties

Object

地址属性。

名称	类型	说明
addressClassification	AddressClassification	基于地址的使用上下文的类型。
addressValidationStatus	AddressValidationStatus	地址验证的状态。
contactDetails	ContactDetails	地址的联系人详细信息。
provisioningState	ProvisioningState	预配状态
shippingAddress	ShippingAddress	地址的寄送详细信息。

AddressType

枚举

地址类型。

值	说明
None	地址类型未知。
Residential	居住地址。
Commercial	商业地址。

AddressValidationStatus

枚举

地址验证的状态。

值	说明
Valid	提供的地址有效。
Invalid	提供的地址无效或不受支持。
Ambiguous	提供的地址不明确，请选择返回的备用地址之一。

ContactDetails

Object

联系人详细信息。

名称	类型	说明
contactName	string	联系人的联系人姓名。
emailList	string[]	要通知有关作业进度的电子邮件 ID 的列表。
mobile	string	联系人的手机号码。
phone	string	联系人的电话号码。
phoneExtension	string	联系人的电话号码。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ProvisioningState

枚举

预配状态

值	说明
Creating	创建状态。
Succeeded	成功状态。
Failed	失败状态。
Canceled	已取消状态。

ReturnOrderItemDetails

Object

返回订单项请求正文。

名称	类型	默认值	说明
returnAddress	AddressProperties		客户寄信人地址。
returnReason	string		返回原因。
serviceTag	string		服务标记（位于设备的右下角）。
shippingBoxRequired	boolean	False	需要寄送箱。

ShippingAddress

Object

客户希望接收设备的寄送地址。

名称	类型	说明
addressType	AddressType	地址类型。
city	string	City 的名称。
companyName	string	公司的名称。
country	string	国家/地区的名称。
postalCode	string	邮政编码。
stateOrProvince	string	州或省的名称。
streetAddress1	string	街道地址行 1。
streetAddress2	string	街道地址行 2。
streetAddress3	string	街道地址行 3。
zipExtendedCode	string	扩展的邮政编码。