服务API v1参考

亚马逊SPAPI

# 概述

通过服务API,你可以建立应用程序,帮助服务提供者获得和修改他们的服务订单.

# Version information

版本 : v1

# Operations

getServiceJobByServiceJobId
cancelServiceJobByServiceJobId
completeServiceJobByServiceJobId
getServiceJobs
addAppointmentForServiceJobByServiceJobId
rescheduleAppointmentForServiceJobByServiceJobId
assignAppointmentResources
setAppointmentFulfillmentData
updateSchedule
createReservation
updateReservation
cancelReservation
[createServiceDocumentUp <a name="paths">

# Paths

<a name="getservicejobbyservicejobid">

# getServiceJobByServiceJobId

GET /service/v1/serviceJobs/{serviceJobId}

# Description

获取由您指定的服务工作标识符所指示的服务工作的详细信息.

使用计划:

Rate (requests per second) Burst
20 40

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path serviceJobId
required
A service job identifier.
minLength : 1
*最大长度 : 100
string

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
400 Request有缺失或无效的参数,不能被解析.
头信息:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
422 无法处理的实体.无法处理包含的指令.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
429 请求的频率超过允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobByServiceJobIdResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobByServiceJobIdResponse

<a name="cancelservicejobbyservicejobid">

# cancelServiceJobByServiceJobId

PUT /service/v1/serviceJobs/{serviceJobId}/cancellations

# Description

取消由您指定的服务工作标识符指示的服务工作.

使用计划:

Rate (requests per second) Burst
5 20

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path serviceJobId
required
An Amazon defined service job identifier.
minLength : 1
*最大长度 : 100
string
Query cancellationReasonCode
required
A cancel reason code that specifies for canceling a service job.
minLength : 1
*最大长度 : 100
string

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
CancelServiceJobByServiceJobIdResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
429 请求的频率超过允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CancelServiceJobByServiceJobIdResponse

<a name="completeservicejobbyservicejobid">

# completeServiceJobByServiceJobId

PUT /service/v1/serviceJob/{serviceJobId}/completions /serviceJobID

# Description

完成您指定的服务工作标识符所指示的服务工作.

使用计划:

Rate (requests per second) Burst
5 20

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path serviceJobId
required
An Amazon defined service job identifier.
minLength : 1
*最大长度 : 100
string

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
CompleteServiceJobByServiceJobIdResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
429 请求的频率超过允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : 唯一的请求参考标识符.
CompleteServiceJobByServiceJobIdResponse

<a name="getervicejobs">

# getServiceJobs

GET /service/v1/serviceJobs

# Description

获取指定过滤器查询的服务工作细节.

使用计划:

Rate (requests per second) Burst
10 40

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema Default
*Query *serviceOrderIds
optional
List of service order ids for the query you want to perform.Max values supported 20.
Min count : 1
*最大计数 : 20
< string > array -
*Query *serviceJobStatus
optional
A list of one or more job status by which to filter the list of jobs. < enum (ServiceJobStatus) > array -
*Query *pageToken
optional
String在你之前请求的响应中返回. string -
Query pageSize
optional
A non-negative integer,表示列表中要返回的最大作业数,值必须是1 - 20. 默认20.
Minimum : 1
最大 : 20
integer 20
*Query *sortField
optional
Sort fields on which you want to sort the output. enum (SortField) -
Query sortOrder
optional
Sort order for the query you want to perform. enum (SortOrder) -
*Query *createdAfter
optional
用于选择在(或在)指定时间之后创建的工作的日期必须是ISO 8601格式.如果没有指定LastUpdatedAfter则需要.同时指定CreatedAfter和LastUpdatedAfter会返回一个错误. string -
*Query *createdBefore
optional
A date used for selecting jobs created before ( or at) a specified time must be in ISO 8601 format. string -
*Query *lastUpdatedAfter
optional
A date used for selecting jobs updated after ( or at) a specified time must be in ISO 8601 format. Required if createdAfter is not specified.Specifying both CreatedAfter and LastUpdatedAfter return an error. string -
*Query *lastUpdatedBefore
optional
A date used for selecting jobs updated before ( or at) a specified time must be in ISO 8601 format. string -
*Query *scheduleStartDate
optional
A日期用于过滤(或)之后的工作计划,指定的时间必须是ISO 8601格式.计划结束日期不应早于计划开始日期. string -
*Query *scheduleEndDate
optional
A用于过滤工作安排在(或在)指定时间之前的日期必须是ISO 8601格式.计划结束日期不应早于计划开始日期. string -
Query marketplaceIds
required
用于选择放置在指定市场上的工作.
Max count : 1
< string > array -

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobsResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetServiceJobsResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobsResponse
413 请求的大小超过了最大接受的大小.

x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobsResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobsResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobsResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetServiceJobsResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
GetServiceJobsResponse

<a name="addappointmentforservicejobbyservicejobid">

# addAppointmentForServiceJobByServiceJobId

POST /service/v1/serviceJobs/{serviceJobId}/appointments

# Description

向您指定的服务工作标识符所指示的服务工作添加一个预约.

使用计划:

Rate (requests per second) Burst
5 20

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path serviceJobId
required
An Amazon defined service job identifier.
minLength : 1
*最大长度 : 100
string
Body body
required
Add appointment operation input details. AddAppointmentRequest

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
SetAppointmentResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse

<a name="rescheduleappointmentforservicejobbyservicejobid">

# rescheduleAppointmentForServiceJobByServiceJobId

POST /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}

# Description

为您指定的服务工作标识符所指示的服务工作重新安排预约.

使用计划:

Rate (requests per second) Burst
5 20

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path serviceJobId
required
An Amazon defined service job identifier.
minLength : 1
*最大长度 : 100
string
路径 appointmentId
required
服务工作的现有任命标识.
minLength : 1
最大长度 : 100
string
Body body
required
Reschedule appointment operation input details. RescheduleAppointmentRequest

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
SetAppointmentResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
SetAppointmentResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
SetAppointmentResponse

<a name="assignappointmentresources">

# assignAppointmentResources

**PUT /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/resources **

# Description

分配新的资源(s)或覆盖/更新现有的一个(s)到一个服务工作任命.

使用计划:

速率(每秒的请求) 突发
1 2

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path serviceJobId
required
An Amazon-defined service job identifier.通过调用服务API的getServiceJobs操作获得此值.
minLength : 1
最大长度 : 100
string
Path appointmentId
required
An Amazon-defined identifier of active service job appointment.
minLength : 1
最大长度 : 100
string
Body body
required
Request schema for AssignAppointmentResources operation. AssignAppointmentResourcesRequest

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求.
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
500 发生了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
AssignAppointmentResourcesResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
AssignAppointmentResourcesResponse

<a name="setappointmentfulfillmentdata">

# setAppointmentFulfillmentData

PUT /service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/fulfillment

# Description

捕获预约履行的数据.

# Parameters

Type Name Description Schema
Path serviceJobId
required
An Amazon-defined service job identifier.通过调用服务API的getServiceJobs操作获得此值.
minLength : 1
最大长度 : 100
string
Path appointmentId
required
An Amazon-defined identifier of active service job appointment.
minLength : 1
最大长度 : 100
string
Body body
required
Appointment fulfillment data collection details. SetAppointmentFulfillmentDataRequest

# Responses

HTTP Code Description Schema
204 Success response
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒)_
x-amzn-RequestId (string) : 唯一的请求参考ID.
string
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
ErrorList
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
ErrorList
404 指定的资源不存在.
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
x-amzn-RequestId (string) : 唯一的请求参考 id.
ErrorList
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) : 唯一的请求参考ID.
ErrorList
415 请求的实体的格式不被被请求的资源所支持.
头信息:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : 唯一的请求参考ID.
ErrorList
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : 唯一的请求参考ID.
ErrorList
429 请求的频率超过了允许的范围.
Headers:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) : 唯一的请求参考ID.
ErrorList
500 遇到了一个意外的情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : 唯一的请求参考ID.
ErrorList
503 服务器的临时超载或维护.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) : 唯一的请求参考 id.
ErrorList

<a name="upschedule">

# updateSchedule

PUT /service/v1/serviceResources/{resourceId}/schedules

# Description

更新一个时间表

# Parameters

Type Name Description Schema
Path resourceId
required
Resource (store) Identifier
minLength : 1
最大长度 : 100
string
Body body
required
Schedule details UpdateScheduleRequest
Query marketplaceIds
required
资源所处的市场的标识符
Max count : 1
< string > array

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
UpdateScheduleResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
UpdateScheduleResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateScheduleResponse
413 请求的大小超过了最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
UpdateScheduleResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateScheduleResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateScheduleResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
UpdateScheduleResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateScheduleResponse

<a name="createreservation">

# createReservation

POST /service/v1/reservation

# Description

创建一个预订

# Parameters

Type Name Description Schema
Body body
required
Reservation details CreateReservationRequest
Query marketplaceIds
required
资源所处的市场的标识符
Max count : 1
< string > array

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
CreateReservationResponse
400 Request有缺失或无效的参数,无法解析.
头信息
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
CreateReservationResponse
404 指定的资源不存在.

x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
CreateReservationResponse
413 请求大小超过了最大接受大小.

x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
CreateReservationResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
CreateReservationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
CreateReservationResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
CreateReservationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReservationResponse

<a name="updateeservation">

# updateReservation

PUT /service/v1/reservation/{reservationId}

# Description

更新一个预订

# Parameters

Type Name Description Schema
Path reservationId
required
Reservation Identifier
minLength : 1
最大长度 : 100
string
Body body
required
Reservation details UpdateReservationRequest
Query marketplaceIds
required
资源所处的市场的标识符
Max count : 1
< string > array

# Responses

HTTP Code Description Schema
200 Success response
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求数) .
x-amzn-RequestId (string) Unique request reference identifier.
UpdateReservationResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
UpdateReservationResponse
404 指定的预订不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateReservationResponse
413 请求大小超过最大接受大小.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateReservationResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateReservationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
UpdateReservationResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference identifier.
UpdateReservationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
UpdateReservationResponse

<a name="cancelreservation">

# cancelReservation

DELETE /service/v1/reservation/{reservationId}

# Description

取消一个预订

# Parameters

Type Name Description Schema
Path reservationId
required
Reservation Identifier
minLength : 1
最大长度 : 100
string
*Query *marketplaceIds
required
资源所处的市场的标识符
*Max count : 1
< string > array

# Responses

HTTP Code Description Schema
204 Success response
Headers :
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒请求)
x-amzn-RequestId (string) Unique request reference id.
CancelReservationResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
**头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
CancelReservationResponse
404 指定的预订不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
CancelReservationResponse
413 请求大小超过了最大接受大小.

x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference id.
CancelReservationResponse
415 请求的实体格式不被请求的资源所支持.
头信息
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
CancelReservationResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)Unique request reference id.
CancelReservationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference id.
CancelReservationResponse

<a name="creaserviced documententuploaddestination">

# createServiceDocumentUploadDestination

POST /service/v1/documents

# Description

创建一个上传目的地.

# Parameters

Type Name Description Schema
Body body
required
upload document operation input details. ServiceUploadDocument

# Responses

HTTP Code Description Schema
200 成功地为给定的资源创建了一个上传目的地.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_
x-amzn-requestId (string) : 唯一的请求参考标识符.
CreateServiceDocumentUploadDestination
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CreateServiceDocumentUploadDestination
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
CreateServiceDocumentUploadDestination
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
CreateServiceDocumentUploadDestination
413 请求的大小超过了最大接受的大小.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) Unique request reference id.
CreateServiceDocumentUploadDestination
415 请求的Content-Type标头无效.
Headers :
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-requestid (string) 唯一的请求参考标识符.
CreateServiceDocumentUploadDestination
422 无法处理的实体.无法处理包含的指令
:
x-amzn-RateLimit-Limit (string) : 您对这个操作的速率限制(每秒的请求)
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateServiceDocumentUploadDestination
429 请求的频率超过允许的范围.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-requestid (string) Unique request reference ID.
CreateServiceDocumentUploadDestination
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) 唯一的请求参考标识符.
CreateServiceDocumentUploadDestination
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CreateServiceDocumentUploadDestination

<a name="definitions">

# Definitions

<a name="getervicejobbyservicejobidresponse">## Definitions

# GetServiceJobByServiceJobIdResponse

GetServiceJobByServiceJobId操作的响应模式.

Name Description Schema
payload
optional
GetServiceJobByServiceJobId操作的有效载荷. ServiceJob
errors
optional
在GetServiceJobByServiceJobId操作中发生了一个意外情况. ErrorList

<a name="cancelservicejobbyservicejobidresponse">

# CancelServiceJobByServiceJobIdResponse

CancelServiceJobByServiceJobId操作的响应模式.

Name Description Schema
errors
optional
Encountered errors for the CancelServiceJobByServiceJobId operation. ErrorList

<a name="completeservicejobbyservicejobidresponse">

# CompleteServiceJobByServiceJobIdResponse

CompleteServiceJobByServiceJobId操作的响应模式.

Name Description Schema
errors
optional
Encountered errors for the CompleteServiceJobByServiceJobId operation. ErrorList

<a name="getervicejobsresponse">

# GetServiceJobsResponse

GetJobs操作的响应模式.

Name Description Schema
payload
optional
GetJobs操作的有效载荷. JobListing
errors
optional
在GetServiceJobs操作过程中发生了一个意外情况. ErrorList

<a name="setappointmentresponse">

# SetAppointmentResponse

添加或重新安排预约操作的响应模式.

Name Description Schema
预约ID
可选
在添加或重新安排预约操作中产生的新预约ID. 预约ID
警告
可选
在添加或重新安排预约操作中产生的警告. WarningList
errors
optional
在添加或重新安排预约操作过程中发生的错误. ErrorList

<a name="assignappointmentresourcesresponse">

# AssignAppointmentResourcesResponse

AssignAppointmentResources操作的响应模式.

Name Description Schema
payload
optional
分配预约资源操作的payload. payload
errors
optional
Errors occurred during assignappointment resources operation. ErrorList

<a name="assignappointmentresourcesresponse-payload">**payload 支付

Name Description Schema
警告
可选
分配预约资源操作时产生的警告. 警告列表

<a name="assignappointmentresourcesrequest">

# AssignAppointmentResourcesRequest

AssignAppointmentResources操作的请求模式.

Name Description Schema
资源
要求
待分配的资源对象列表. 任命资源

<a name="joblisting">

# JobListing

GetJobs操作的有效载荷.

Name Description Schema
totalResultSize
optional
查询结果的总结果大小. integer
nextPageToken
optional
一个生成的字符串,用来传递信息给你的下一个请求.如果返回nextPageToken,将nextPageToken的值传递给pageToken,得到下一个结果. string
previousPageToken
optional
A生成的字符串,用于将信息传递给你的下一个请求. 如果返回previousPageToken,将previousPageToken的值传递给pageToken,以获得前一个页面的结果. string
jobs
optional
给定输入的工作细节列表. < ServiceJob> 数组

<a name="servicejob">

# ServiceJob

一个服务的工作细节.

Name Description Schema
createTime
optional
创建工作的日期和时间,ISO 8601格式. string (date-time)
serviceJobId
optional
The service job identifier. ServiceJobId
服务工作状态
可选
服务工作的状态. enum (服务工作状态
scopeOfWork
optional
订单的工作范围. ScopeOfWork
seller
optional
关于服务工作的卖方的信息. Seller
serviceJobProvider
optional
关于服务工作提供者的信息. ServiceJobProvider
preferredAppointmentTimes
optional
买方喜欢的预约窗口列表.仅当买方在创建订单时选择了预约窗口时包括在内. < AppointmentTime> array
appointments
optional
A list of appointments. < Appointment > array
serviceOrderId
optional
亚马逊-定义的买家下订单的标识符,格式为3-7. OrderId
marketplaceId
optional
The marketplace identifier.
Pattern : "^[A-Z0-9]<li>$"
string
买家
可选
关于买家的信息. Buyer
associatedItems
optional
与服务工作相关的项目列表. < AssociatedItem> array
serviceLocation
optional
关于服务工作的位置信息. ServiceLocation

<a name="servicejobid">

# ServiceJobId

服务工作的亚马逊标识符.

类型 :字符串

minLength 1
最大长度 : 100

<a name="orderid">

# OrderId

亚马逊-定义的买家所下订单的标识符,格式为3-7-7.

类型:字符串

minLength : 5
最大长度 : 20

<a name="scopeofwork">

# ScopeOfWork

该订单的工作范围.

Name Description Schema
asin
optional
亚马逊标准识别码(ASIN)的服务工作. string
title
optional
服务工作的名称. string
数量
可选
服务工作的数量. integer
requiredSkills
optional
执行工作所需的技能列表. < string > array

<a name="seller">

# Seller

关于服务工作的卖方的信息.

Name Description Schema
sellerId
optional
服务工作的卖方的标识符.
Pattern : "^[A-Z0-9]<li>$"
string

<a name="servicejobprovider">

# ServiceJobProvider

关于服务工作提供者的信息.

Name Description Schema
serviceJobProviderId
optional
服务工作提供者的标识.
Pattern : "^[A-Z0-9]<li>$"
string

<a name="buyer">

# Buyer

关于买方的信息.

Name Description Schema
buyerId
optional
买方的识别码.
Pattern : "^[A-Z0-9]<li>$"
string
name
optional
买方的名字. string
phone
optional
买方的电话号码. string
isPrimeMember
optional
为真时,该服务是针对亚马逊Prime买家的. boolean

<a name="appointmenttime">

# AppointmentTime

预约窗口的时间.

Name Description Schema
startTime
required
预约窗口开始的日期和时间,ISO 8601格式. string (date-time)
durationInMinutes
required
预约窗口的持续时间,以分钟为单位.
最小值: 1
integer

<a name="appointmentid">

# AppointmentId

约会标识符.

类型 :字符串

最小长度 5
最大长度 : 100

<a name="appointment">

# Appointment

任命的细节.

Name Description Schema
appointmentId
optional
The appointment identifier. AppointmentId
任命状态
可选
任命的状态. enum (任命状态
预约时间
可选
预约窗口的时间. 预约时间
assignedTechnicians
optional
A list of technicians assigned to the service job. < Technician> array
rescheduledAppointmentId
optional
重新安排的预约的标识符. AppointmentId
poa
optional
Proof of Appointment (POA) details. Poa

<a name="technician">

# Technician

被指派部分或全部执行服务工作的技术员.

Name Description Schema
技术员ID
可选
技术员标识符.
minLength : 1
*最大长度 : 50
字符串
name
optional
技术员的名字. string

<a name="poa">

# Poa

委任证明(POA)详情.

Name Description Schema
预约时间
可选
预约窗口的时间. 预约时间
技术人员
可选
A技术人员列表. < 技术人员 >数组
uploadingTechnician
optional
上传POA的技术员的标识符.
Pattern : "^[A-Z0-9]<li>$"
string
uploadTime
optional
上传POA的日期和时间,ISO 8601格式. string (date-time)
poaType
optional
上传POA的类型. enum (PoaType

<a name="relateditem">

# AssociatedItem

与服务工作相关的项目的信息.

Name Description Schema
asin
optional
亚马逊标准识别码(ASIN)的物品. string
title
optional
物品的名称. string
数量
可选择
订单中包含的物品总数. integer
*orderId
optional
亚马逊-定义的买家订单的标识符,格式为3-7-7. OrderId
itemStatus
optional
物品的状态. enum (ItemStatus)
brandName
optional
物品的品牌名称. string
itemDelivery
optional
物品的交付信息. ItemDelivery

<a name="itemdelivery">

# ItemDelivery

该物品的交付信息.

Name Description Schema
estimatedDeliveryDate
optional
所有有EDD的项目的最新估计交货日期(EDD)的日期和时间.ISO 8601格式. string (date-time)
itemDeliveryPromise
optional
物品的承诺交货信息. ItemDeliveryPromise

<a name="itemdeliverypromise">

# ItemDeliveryPromise

该物品的承诺交付信息.

Name Description Schema
startTime
optional
承诺交付窗口开始的日期和时间,ISO 8601格式. string (date-time)
endTime
optional
承诺交付窗口结束的日期和时间,ISO 8601格式. string (date-time)

<a name="servicelocation">

# ServiceLocation

关于服务工作的位置信息.

Name Description Schema
serviceLocationType
optional
服务工作的位置. enum (ServiceLocationType)
address
optional
服务工作的运输地址. Address

<a name="地址">

# Address

服务工作的运输地址.

Name Description Schema
name
required
个人、企业或机构的名称. string
addressLine1
required
地址的第一行. string
addressLine2
optional
附加的地址信息,如果需要的话. string
addressLine3
optional
Additional address information, if required. string
city
optional
The city. string
county
optional
The county. string
district
optional
The district. string
州或地区
可选择
州或地区. string
postalCode
optional
邮政编码.这可以包含字母、数字、空格和/或标点符号. string
countryCode
optional
两位数的国家代码,采用ISO 3166-1 alpha-2格式. string
phone
optional
电话号码. string

<a name="addappointmentrequest">

# AddAppointmentRequest

添加预约操作的输入.

Name Description Schema
appointmentTime
required
Input appointment time details. AppointmentTimeInput

<a name="rescheduleappointmentrequest">

# RescheduleAppointmentRequest

重新安排的预约操作的输入.

Name Description Schema
appointmentTime
required
Input appointment time details. AppointmentTimeInput
rescheduleReasonCode
required
Input appointment reschedule reason. RescheduleReasonCode

<a name="appointmenttimeinput">

# AppointmentTimeInput

输入预约时间的详细信息.

Name Description Schema
startTime
required
约会开始时间的日期、时间(UTC),ISO 8601格式. string (date-time)
durationInMinutes
optional
约会的持续时间,以分钟为单位. integer

<a name="reschedulereasoncode">

# RescheduleReasonCode

预约重新安排的原因代码.

类型:字符串

<a name="errorlist">

# ErrorList

当请求不成功时返回的错误响应列表.

类型 < Error > 数组

<a name="error">

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个以人类可读的形式描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string
errorLevel
optional
错误的类型. enum (ErrorLevel)

<a name="警告列表">

# WarningList

在一个API请求的成功执行响应中返回的警告列表.

类型 : < Warning > 数组

<a name="warning">

# Warning

当请求成功后返回的警告,但执行时有一些重要的调用,API客户应在此基础上采取规定的行动.

Name Description Schema
code
required
一个警告代码,用于识别发生的警告类型. string
message
required
一个以人类可读的形式描述警告情况的信息. string
details
optional
可以帮助呼叫者理解或处理警告的额外细节. string

<a name="upscheduleresponse">

# UpdateScheduleResponse

UpdateSchedule操作的响应模式.

Name Description Schema
payload
optional
包含发生错误/警告的UpdateScheduleRecords. < UpdateScheduleRecord> array
errors
optional
Errors encountered, if any. ErrorList

<a name="setappointmentfulfillmentdatarequest">

# SetAppointmentFulfillmentDataRequest

设置约会履行数据操作的输入.

Name Description Schema
fulfillmentTime
optional
Input appointment time details. FulfillmentTime
appointmentResources
optional
Resources involved in appointment fulfillment. AppointmentResources
fulfillmentDocuments
optional
Documents specific to appointment fulfillment. FulfillmentDocuments

<a name="履行时间">

# FulfillmentTime

输入履行时间的详细信息

Name Description Schema
startTime
optional
ISO 8601格式的履行开始时间的日期、UTC时间. string (date-time)
endTime
optional
ISO 8601格式的履行结束时间的日期,UTC时间. string (date-time)

<a name="fulfillmentdocuments">

# FulfillmentDocuments

服务预约履行期间捕获的文件列表.

类型 < FulfillmentDocument >数组

<a name="fulfillmentdocument">

# FulfillmentDocument

在服务预约履行过程中捕获的文件,描述了完成的证明

Name Description Schema
uploadDestinationId
optional
上传目的地的标识符.通过调用服务API的createServiceDocumentUploadDestination操作获得此值. string
contentSha256
optional
Sha256文件内容的哈希值.这个值用来确定文件在运输过程中是否被破坏或篡改. string

<a name="appointmentresources">

# AppointmentResources

履行或执行工作预约的资源列表.

类型< AppointmentResource >数组

<a name="appointmentresource">

# AppointmentResource

进行或执行预约履行的资源.

Name Description Schema
resourceId
optional
The resource identifier. string

<a name="createreservationresponse">

# CreateReservationResponse

CreateReservation操作的响应模式.

Name Description Schema
******
optional
CreateReservationRecord只包含新的reservationId,如果操作成功的话.否则它将包含带有警告/错误的Reservation实体. CreateReservationRecord
errors
optional
Errors encountered, if any. ErrorList

<a name="updateeservationresponse">

# UpdateReservationResponse

UpdateReservation操作的响应模式.

Name Description Schema
******
可选
UpdateReservationRecord只包含新的reservationId,如果操作成功的话.否则它将包含带有警告/错误的Reservation实体. UpdateReservationRecord
errors
optional
Errors encountered, if any. ErrorList

<a name="cancelreservationresponse">

# CancelReservationResponse

取消预订操作的响应模式.

Name Description Schema
errors
optional
Errors encountered, if any ErrorList

<a name="dayofweek">

# DayOfWeek

一周中的哪一天.

类型 : 枚举

Value Description
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

<a name="recurrence">

# Recurrence

在一个时间范围内重复发生的事件.

Name Description Schema
endTime
required
End time of the recurrence. string (date-time)
daysOfWeek
optional
recurrence有效的星期几. 如果日程表在每个星期一有效,输入将包含列表中的一个项目- "MONDAY". < DayOfWeek > array
daysOfMonth
optional
recurrence有效的月份的天数. < integer > array

<a name="availabilityrecord">

# AvailabilityRecord

可用性记录表示一个资源在某个时间范围内的容量.

Name Description Schema
startTime
required
表示一天中资源可用的时间,遵循ISO-8601格式. string (date-time)
endTime
required
表示该资源在一天内可用的时间,遵循ISO-8601的格式. string (date-time)
recurrence
optional
Recurrence对象,包含时间表的循环模式. Recurrence
capacity
optional
表示一个资源的可用容量.
最小值1
integer

<a name="availabilityrecords">

# AvailabilityRecords

可用性记录(AvailabilityRecords)的列表,表示资源在某一时间范围内的容量.

类型< AvailabilityRecord > 数组

<a name="reservation">

# Reservation

预约对象减少了资源的容量.

Name Description Schema
reservationId
optional
预订的独特标识符.如果存在,我们将其视为更新预订请求并更新相应的预订.否则,它是一个新的创建预订请求. string
type
required
Type of reservation. enum (Type)
可用性
所需
AvailabilityRecord,表示资源在某个时间范围内的容量. AvailabilityRecord

<a name="reservation">

# Reservations

保留列表.

类型 < Reservation > 数组

<a name=" updates schedulerecord">

# UpdateScheduleRecord

UpdateScheduleRecord实体包含AvailabilityRecord,如果在对其执行所要求的操作时出现错误/警告.

Name Description Schema
可用性
可选
可用性记录,如果操作失败. AvailabilityRecord
warnings
optional
Warnings encountered, if any. WarningList
errors
optional
Errors encountered, if any. ErrorList

<a name="createreservationrecord">

# CreateReservationRecord

CreateReservationRecord实体包含预订,如果在对其执行所要求的操作时出现错误/警告,否则它将包含新的预订ID.

Name Description Schema
reservation
optional
Reservation record if the operation failed. It will only contain the new reservationId if the operation is successful. Reservation
warnings
optional
Warnings encountered, if any. WarningList
errors
optional
Errors encountered, if any. ErrorList

<a name="updateeservationrecord">

# UpdateReservationRecord

UpdateReservationRecord实体包含保留,如果在执行所要求的操作时出现错误/警告,否则它将包含新的保留ID.

Name Description Schema
reservation
optional
Reservation record if the operation failed. It will only contain the new reservationId if the operation is successful. Reservation
warnings
optional
Warnings encountered, if any. WarningList
errors
optional
Errors encountered, if any. ErrorList

<a name=" updateschedulerequest">

# UpdateScheduleRequest

updateSchedule操作的请求模式.

Name Description Schema
schedules
required
日程表对象列表,用于定义资源的正常工作时间. AvailabilityRecords

<a name="createreservationrequest">

# CreateReservationRequest

CreateReservation操作的请求模式.

Name Description Schema
resourceId
required
Resource (store) Identifier. string
reservation
required
Reservation对象,以减少资源的容量. Reservation

<a name="updatereservationrequest">

# UpdateReservationRequest

UpdateReservation操作的请求模式.

Name Description Schema
resourceId
required
Resource (store) Identifier. string
reservation
required
Reservation对象来减少资源的容量. Reservation

<a name="serviceuploaddocument">

# ServiceUploadDocument

将要上传的文件的输入.

Name Description Schema
内容类型
必须的
上传文件的内容类型 enum (ContentType)
内容长度
要求的
将要-上传的文件的内容长度
最小值 : 1
最大值 : 5242880
number (int64)
contentMD5
可选
将提交给上传目的地的内容的MD5哈希值.此值用于确定数据在传输过程中是否被损坏或篡改.
Pattern : "^[A-Za-z0-9\\\\+/]{22}={2}$"
string

<a name="creaserviced documententuploaddestination">

# CreateServiceDocumentUploadDestination

createServiceDocumentUploadDestination操作的响应模式.

Name Description Schema
payload
optional
Information about an upload destination. ServiceDocumentUploadDestination
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="servicedocumentuploaddestination">

# ServiceDocumentUploadDestination

关于上传目的地的信息.

Name Description Schema
uploadDestinationId
required
唯一的标识符,将被引用上传目的地的API使用. string
url
required
上传文件的URL. string
encryptionDetails
required
所需的客户端的加密细节-文件内容的加密和解密. EncryptionDetails
headers
optional
上传请求中包含的头信息. object

<a name="encryptiondetails">

# EncryptionDetails

所需的客户端-侧加密和解密文件内容的加密细节.

Name Description Schema
标准
required
加密或解密文件内容所需的加密标准. enum (Standard)
initializationVector
required
使用Cipher Block Chaining (CBC). string
key
required
用于加密或解密文件内容的加密密钥. string

<a name="servicelocationtype">

# ServiceLocationType

服务工作的位置.

类型 : 枚举

Value Description
IN_HOME 表示该服务工作的服务是在客户的家庭地址进行的.
IN_STORE 表示该服务工作的服务是在服务供应商的商店进行的.
ONLINE 表示该服务工作的服务是在远程进行的.

<a name="itemstatus">

# ItemStatus

项目的状态.

类型 : 枚举

Value Description
ACTIVE 表示该物品尚未发货.
CANCELLED 表示该商品已被取消.
SHIPPED 表示该商品已经发货,但未交付.
DELIVERED 表示该物品已经交付.

<a name="type">

# Type

预订的类型.

类型 : 枚举

Value Description
APPOINTMENT 减少资源(商店)容量,因为有预约.
旅行 因为技术人员(s)旅行而减少资源(store)容量.
VACATION 减少资源(store)的容量,因为技术员(s)在度假.
BREAK 减少资源(store)的容量,因为技术员(s)正在休息.
培训 减少资源(商店)的容量,因为技术员(s)正在培训.

<a name="contenttype">

# ContentType

to-be-uploaded 文件的内容类型

类型 : 枚举

Value Description
TIFF 要上传的POA是图像/tiff.
JPG 待上传的POA为image/jpg.
*PNG 待上传的POA为image/png.
*JPEG 待上传的POA为image/jpeg.
GIF 待上传的POA类型为image/gif.
PDF 待上传的POA是application/pdf.

<a name="poatype">

# PoaType

上传的POA的类型.

类型 : 枚举

Value Description
NO_SIGNATURE_DUMMY_POS 表示上传的预约证明类型为假签名.
CUSTOMER_SIGNATURE 表示上传的预约证明类型是客户签名.
DUMMY_RECEIPT 表示上传的预约证明的类型是假的收据.
POA_RECEIPT 表示上传的预约证明类型是收据.

<a name="sortorder">

# SortOrder

你要执行的查询的排序顺序.

类型 : 枚举

Value Description
ASC 按升序排序.
DESC 按降序排序.

<a name="errorlevel">

# ErrorLevel

错误的类型.

类型 : 枚举

Value Description
ERROR Error
WARNING Warning

<a name="sortfield">

# SortField

你想对输出进行排序的排序字段.

类型 : 枚举

Value Description
JOB_DATE 按工作日期排序.
JOB_STATUS 按工作状态排序.

<a name="standard">

# Standard

加密或解密文件内容所需的加密标准.

类型 : 枚举

Value Description
AES 高级加密标准(AES).

<a name="appointmentstatus">

# AppointmentStatus

约定的状态.

类型 : 枚举

Value Description
ACTIVE 表示预约已安排.
CANCELLED 表示预约已被取消.
COMPLETED 表示该预约已完成.

<a name="servicejobstatus">

# ServiceJobStatus

类型 : 枚举

<a id="servicejobstatus-subgroup-1">用于与定义(s): ServiceJob 服务工作的状态.

Value Description
NOT_SERVICED 表示该服务工作的服务没有完成.
CANCELLED 表示服务工作被取消.
COMPLETED 表示服务已执行,服务工作已成功关闭.
PENDING_SCHEDULE 表示该服务工作的预约还没有被安排.
NOT_FULFILLABLE 表示由于一个意外的异常,该服务工作无法操作.
*HOLD 表示服务提供者不能为客户提供预约时间优先权.
PAYMENT_DECLINED 表示客户的付款已被拒绝.

<a id="servicejobstatus-subgroup-2">用于操作(s)getServiceJobs

Value Description
NOT_SERVICED 未被服务的工作.
CANCELLED 被取消的工作.
COMPLETED Jobs successfully completed.
*待定计划 待定计划的工作.
NOT_FULFILLABLE 不能履行的工作.
HOLD 被搁置的工作.
PAYMENT_DECLINED 被拒绝付款的工作.
Last Updated: 2022/10/17 下午9:17:02