Services API v1 Model
Swagger model for the Services API v1.
{
"swagger": "2.0",
"info": {
"description": "With the Services API, you can build applications that help service providers get and modify their service orders and manage their resources.",
"version": "v1",
"title": "Selling Partner API for Services",
"contact": {
"name": "Selling Partner API Developer Support",
"url": "https://sellercentral.amazon.com/gp/mws/contactus.html"
},
"license": {
"name": "Apache License 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/service/v1/serviceJobs/{serviceJobId}": {
"get": {
"tags": [
"service"
],
"description": "Gets details of service job indicated by the provided `serviceJobID`.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 20 | 40 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getServiceJobByServiceJobId",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "A service job identifier.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {}
},
"response": {
"payload": {}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
}
}
},
"response": {
"payload": {}
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/cancellations": {
"put": {
"tags": [
"service"
],
"description": "Cancels the service job indicated by the service job identifier specified.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "cancelServiceJobByServiceJobId",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "An Amazon defined service job identifier.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "cancellationReasonCode",
"in": "query",
"description": "A cancel reason code that specifies the reason for cancelling a service job.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Z0-9_]*$"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
},
"cancellationReasonCode": {
"value": "V1"
}
}
},
"response": {}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"cancellationReasonCode": {
"value": "V1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
},
"cancellationReasonCode": {
"value": "NULL"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [cancellationReasonCode]",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"cancellationReasonCode": {
"value": "NULL"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId, cancellationReasonCode]",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "unauthorizedJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
},
"cancellationReasonCode": {
"value": "V1"
}
}
},
"response": {
"errors": [
{
"code": "UnauthorizedAction",
"message": "Not authorized to access this resource.Please check your input again",
"details": ""
}
]
}
},
{
"request": {
"parameters": {}
},
"response": {}
}
]
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "completedJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
},
"cancellationReasonCode": {
"value": "V1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Job with jobId completedJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut and jobStatus COMPLETED cannot be cancelled",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
},
"cancellationReasonCode": {
"value": "INV1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Received invalid input reason code IV1 for jobId validJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "invalidJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
},
"cancellationReasonCode": {
"value": "V1"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Job not found for jobId invalidJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut",
"details": ""
}
]
}
}
]
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CancelServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/completions": {
"put": {
"tags": [
"service"
],
"description": "Completes the service job indicated by the service job identifier specified.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "completeServiceJobByServiceJobId",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "An Amazon defined service job identifier.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
}
}
},
"response": {}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "unauthorizedJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
}
}
},
"response": {
"errors": [
{
"code": "UnauthorizedAction",
"message": "Not authorized to access this resource.Please check your input again",
"details": ""
}
]
}
}
]
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "cancelledJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Operation not allowed on job with jobId : cancelledJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut and jobState : CANCELLED",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "invalidJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Job not found for jobId invalidJobId-48b6d5a3-b708-dbe9-038d-dd95e8d74iut",
"details": ""
}
]
}
}
]
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CompleteServiceJobByServiceJobIdResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs": {
"get": {
"tags": [
"service"
],
"description": "Gets service job details for the specified filter query.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 40 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getServiceJobs",
"parameters": [
{
"name": "serviceOrderIds",
"in": "query",
"description": "List of service order ids for the query you want to perform.Max values supported 20.",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"minItems": 1
},
{
"name": "serviceJobStatus",
"in": "query",
"description": "A list of one or more job status by which to filter the list of jobs.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"NOT_SERVICED",
"CANCELLED",
"COMPLETED",
"PENDING_SCHEDULE",
"NOT_FULFILLABLE",
"HOLD",
"PAYMENT_DECLINED"
],
"x-docgen-enum-table-extension": [
{
"value": "NOT_SERVICED",
"description": "Jobs which are not serviced."
},
{
"value": "CANCELLED",
"description": "Jobs which are cancelled."
},
{
"value": "COMPLETED",
"description": "Jobs successfully completed."
},
{
"value": "PENDING_SCHEDULE",
"description": "Jobs which are pending schedule."
},
{
"value": "NOT_FULFILLABLE",
"description": "Jobs which are not fulfillable."
},
{
"value": "HOLD",
"description": "Jobs which are on hold."
},
{
"value": "PAYMENT_DECLINED",
"description": "Jobs for which payment was declined."
}
]
}
},
{
"name": "pageToken",
"in": "query",
"description": "String returned in the response of your previous request.",
"required": false,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"description": "A non-negative integer that indicates the maximum number of jobs to return in the list, Value must be 1 - 20. Default 20.",
"required": false,
"type": "integer",
"default": 20,
"maximum": 20,
"minimum": 1
},
{
"name": "sortField",
"in": "query",
"description": "Sort fields on which you want to sort the output.",
"required": false,
"type": "string",
"enum": [
"JOB_DATE",
"JOB_STATUS"
],
"x-docgen-enum-table-extension": [
{
"value": "JOB_DATE",
"description": "Sort on job date."
},
{
"value": "JOB_STATUS",
"description": "Sort on job status."
}
]
},
{
"name": "sortOrder",
"in": "query",
"description": "Sort order for the query you want to perform.",
"required": false,
"type": "string",
"enum": [
"ASC",
"DESC"
],
"x-docgen-enum-table-extension": [
{
"value": "ASC",
"description": "Sort in ascending order."
},
{
"value": "DESC",
"description": "Sort in descending order."
}
]
},
{
"name": "createdAfter",
"in": "query",
"description": "A date used for selecting jobs created at or after a specified time. Must be in ISO 8601 format. Required if `LastUpdatedAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.",
"required": false,
"type": "string"
},
{
"name": "createdBefore",
"in": "query",
"description": "A date used for selecting jobs created at or before a specified time. Must be in ISO 8601 format.",
"required": false,
"type": "string"
},
{
"name": "lastUpdatedAfter",
"in": "query",
"description": "A date used for selecting jobs updated at or after a specified time. Must be in ISO 8601 format. Required if `createdAfter` is not specified. Specifying both `CreatedAfter` and `LastUpdatedAfter` returns an error.",
"required": false,
"type": "string"
},
{
"name": "lastUpdatedBefore",
"in": "query",
"description": "A date used for selecting jobs updated at or before a specified time. Must be in ISO 8601 format.",
"required": false,
"type": "string"
},
{
"name": "scheduleStartDate",
"in": "query",
"description": "A date used for filtering jobs schedules at or after a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.",
"required": false,
"type": "string"
},
{
"name": "scheduleEndDate",
"in": "query",
"description": "A date used for filtering jobs schedules at or before a specified time. Must be in ISO 8601 format. Schedule end date should not be earlier than schedule start date.",
"required": false,
"type": "string"
},
{
"name": "marketplaceIds",
"in": "query",
"description": "Used to select jobs that were placed in the specified marketplaces.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
},
{
"name": "asins",
"in": "query",
"description": "List of Amazon Standard Identification Numbers (ASIN) of the items. Max values supported is 20.",
"required": false,
"type": "array",
"items": {
"type": "string",
"minLength": 10,
"maxLength": 10
},
"maxItems": 20,
"minItems": 1
},
{
"name": "requiredSkills",
"in": "query",
"description": "A defined set of related knowledge, skills, experience, tools, materials, and work processes common to service delivery for a set of products and/or service scenarios. Max values supported is 20.",
"required": false,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"maxItems": 20,
"minItems": 1
},
{
"name": "storeIds",
"in": "query",
"description": "List of Amazon-defined identifiers for the region scope. Max values supported is 50.",
"required": false,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 50,
"minItems": 1
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {}
},
"response": {
"payload": {
"totalResultSize": 1,
"nextPageToken": "merchantSklktoreIdbcdcd2ad-5883-4e48-b114-f13328a9e9f",
"previousPageToken": "merchantSklktoreIdbcdcd2ad-5883-4e48-b114-f13328a9e9f",
"jobs": [
{
"serviceOrderId": "2345324",
"serviceJobId": "34534399990035",
"createTime": "2019-12-11T14:49:53.952Z",
"serviceJobStatus": "COMPLETED",
"buyer": {
"name": "nameExample"
},
"appointments": [
{
"appointmentId": "appointmentIdExample",
"appointmentStatus": "COMPLETED",
"appointmentTime": {
"startTime": "2020-01-31T06:38:56.961Z",
"durationInMinutes": 60
},
"assignedTechnicians": [
{
"technicianId": "technicianIdExample",
"name": "nameExample"
}
]
}
]
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"createdAfter": {
"value": "TEST_CASE_400"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid Input"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetServiceJobsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/appointments": {
"post": {
"tags": [
"service"
],
"description": "Adds an appointment to the service job indicated by the service job identifier specified.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "addAppointmentForServiceJobByServiceJobId",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "An Amazon defined service job identifier.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"description": "Add appointment operation input details.",
"required": true,
"schema": {
"$ref": "#/definitions/AddAppointmentRequest"
}
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"appointmentId": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-2-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z",
"durationInMinutes": 60
}
}
}
}
},
"response": {
"appointmentId": "validJobId-2-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z",
"durationInMinutes": 60
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "unauthorizedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "UnauthorizedAction",
"message": "Not authorized to access this resource. Please check your input again.",
"details": ""
}
]
}
}
]
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000+05:30"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "ISO8601 time 2021-01-01T10:00:00.000+05:30 is not in UTC.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10-00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to parse ISO8601 input: 2021-01-01T10-00:00.000Z",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "No job exist with jobId : invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "completedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Operation not allowed on job with jobId : completedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468 and jobState : COMPLETED",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "withActiveAppointmentJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : withActiveAppointmentJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Job already has an active appointmentId.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2019-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Start time of appointment should be in the future.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2022-01-01T10:00:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Start time for appointment is beyond the maximum allowed period of 365 days.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:15:00.000Z"
}
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Appointment slot is not available.",
"details": ""
}
]
}
}
]
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}": {
"post": {
"tags": [
"service"
],
"description": "Reschedules an appointment for the service job indicated by the service job identifier specified.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "rescheduleAppointmentForServiceJobByServiceJobId",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "An Amazon defined service job identifier.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "appointmentId",
"in": "path",
"description": "An existing appointment identifier for the Service Job.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"description": "Reschedule appointment operation input details.",
"required": true,
"schema": {
"$ref": "#/definitions/RescheduleAppointmentRequest"
}
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"appointmentId": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468_new_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-2-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-2-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z",
"durationInMinutes": 60
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"appointmentId": "validJobId-2-9cb9bc29-3d7d-5e49-5709-efb693d34468_new_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-3-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-3-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z",
"durationInMinutes": 60
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"appointmentId": "validJobId-3-9cb9bc29-3d7d-5e49-5709-efb693d34468_new_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a",
"warnings": [
{
"code": "RESOURCES_UNASSIGNED",
"message": "Unassigned resources : ATechnicianId,BTechnicianId"
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"appointmentId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z",
"durationInMinutes": 60
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "nullAppointmentId"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z",
"durationInMinutes": 60
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [appointmentId]",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "unauthorizedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "unauthorizedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "UnauthorizedAction",
"message": "Not authorized to access this resource. Please check your input again.",
"details": ""
}
]
}
}
]
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000+05:30"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "ISO8601 time 2021-01-01T10:00:00.000+05:30 is not in UTC.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10-00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to parse ISO8601 input: 2021-01-01T10-00:00.000Z",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "No job exist with jobId : invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "completedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "completedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Operation not allowed on job with jobId : completedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468 and jobState : COMPLETED",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2019-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Start time of appointment should be in the future.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2022-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Start time for appointment is beyond the maximum allowed period of 365 days.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:15:00.000Z"
},
"rescheduleReasonCode": "R1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Appointment slot is not available.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentTime": {
"startTime": "2021-01-01T10:00:00.000Z"
},
"rescheduleReasonCode": "U1"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to add appointment for jobId : validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468, reason : Appointment reschedule reason code is not valid.",
"details": ""
}
]
}
}
]
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/SetAppointmentResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/resources": {
"put": {
"tags": [
"service"
],
"description": "Assigns new resource(s) or overwrite/update the existing one(s) to a service job appointment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 2 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "assignAppointmentResources",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "appointmentId",
"in": "path",
"description": "An Amazon-defined identifier of active service job appointment.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesRequest"
}
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{}
]
}
}
}
},
"response": {}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "overBookedResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"payload": {
"warnings": [
{
"code": "RESOURCES_OVERBOOKED",
"message": "Resources overbooked for this time window."
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "nullAppointmentId"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [appointmentId]",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"appointmentId": {
"value": "nullAppointmentId"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [appointmentId, serviceJobId]",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Resources not provided in input JSON payload.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": []
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Resources must have size greater than or equal to 1.",
"details": ""
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "unauthorizedJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "UnauthorizedAction",
"message": "Not authorized to access this resource. Please check your input again.",
"details": ""
}
]
}
}
]
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "invalidJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "No job exists with jobId : invalidJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "invalidAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Failed to Update Appointment for jobId : invalidJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687, appointmentId : invalidAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d, reason : No appointment exists with appointmentId: invalidAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "badResourceId"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Invalid resourceId : badResourceId provided in the input.",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "completedJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "completedAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Operation not allowed on job with jobId : completedJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687 and jobState : COMPLETED",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "cancelledJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "cancelledAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Operation not allowed on job with jobId : cancelledJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687 and jobState : CANCELLED",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "cancelledAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "validResourceId-A8B3M999LMHF2"
},
{
"resourceId": "validResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Appointment metadata update is not allowed for appointmentId cancelledAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d",
"details": ""
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"resources": [
{
"resourceId": "invalidResourceId-A8B3M999LMHF2"
},
{
"resourceId": "invalidResourceId-AMIDIAX1H5V"
}
]
}
}
}
},
"response": {
"errors": [
{
"code": "RESOURCES_MISMATCHED_SERVICE_LOCATION_TYPE",
"message": "Resources do not have same service location type as job. Applicable resources: A8B3M999LMHF2,AMIDIAX1H5V",
"details": ""
},
{
"code": "RESOURCES_MISSING_REQUIRED_SKILLS",
"message": "Resources Missing required XYZ skills. Applicable resources: A8B3M999LMHF2,AMIDIAX1H5V",
"details": ""
},
{
"code": "RESOURCES_NOT_AVAILABLE_IN_LOCATION",
"message": "Resources are not available in the store. Applicable resources: A8B3M999LMHF2,AMIDIAX1H5V",
"details": ""
},
{
"code": "RESOURCES_NOT_REGISTERED_UNDER_MERCHANT",
"message": "Resources are not registered under this Merchant. Applicable resources: A8B3M999LMHF2,AMIDIAX1H5V",
"details": ""
},
{
"code": "RESOURCES_BACKGROUND_CHECK_INCOMPLETE",
"message": "Resources background check is incomplete. Applicable resources: A8B3M999LMHF2,AMIDIAX1H5V",
"details": ""
},
{
"code": "RESOURCES_NOT_AVAILABLE_IN_TIME_WINDOW",
"message": "Resources do not have sufficient available capacity. Applicable resources: A8B3M999LMHF2,AMIDIAX1H5V",
"details": ""
}
]
}
}
]
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/AssignAppointmentResourcesResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/appointments/{appointmentId}/fulfillment": {
"put": {
"tags": [
"service"
],
"description": "Updates the appointment fulfillment data related to a given `jobID` and `appointmentID`.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "setAppointmentFulfillmentData",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "An Amazon-defined service job identifier. Get this value by calling the `getServiceJobs` operation of the Services API.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "appointmentId",
"in": "path",
"description": "An Amazon-defined identifier of active service job appointment.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"description": "Appointment fulfillment data collection details.",
"required": true,
"schema": {
"$ref": "#/definitions/SetAppointmentFulfillmentDataRequest"
}
}
],
"responses": {
"204": {
"description": "Success response.",
"schema": {
"type": "string"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": ""
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
}
}
}
}
},
"response": ""
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
]
}
}
}
},
"response": ""
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": ""
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
]
}
}
}
},
"response": ""
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"fulfillmentDocuments": [
{
"uploadDestinationId": "348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": ""
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687"
},
"appointmentId": {
"value": "validAppointmentId-1-9cb9bc29-3d7d-5e49-5709-efb693t25687_87b9d5f2-839d-y13e-sd4d-dae1c3996s3d"
},
"body": {
"value": {
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": ""
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
},
"appointmentId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]"
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "nullAppointmentId"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [appointmentId]"
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "nullAppointmentId"
},
"body": {
"value": {}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "No fulfillment artifacts provided in JSON payload.",
"details": ""
}
]
}
]
}
},
"403": {
"description": "403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "unauthorizedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "unauthorizedJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "UnauthorizedAction",
"message": "Not authorized to access this resource. Please check your input again.",
"details": ""
}
]
}
]
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"415": {
"description": "The entity of the request is in a format not supported by the requested resource.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"serviceJobId": {
"value": "invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "invalidAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "No job exist with jobId : invalidJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "InvalidStatusJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "invalidStatusAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Job with id InvalidStatusJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468 can not be updated. Please check if the job is in valid status.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "invalidAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment with id invalidAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468 is not present in the job. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "InvalidStatusCancelledAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-02T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment with appointment id InvalidStatusCancelledAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468 is not valid to update. Please check the input again",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"endTime": "2021-01-03T13:18:10.668Z"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment start time is required. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2021-01-01T10:00:00.000+05:30"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment end time is required. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2021-01-01T10:00:00.000+05:30",
"endTime": "2021-01-03T13:18:10.668Z"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "ISO8601 time 2021-01-01T10:00:00.000+05:30 is not in UTC format. Please provide time in UTC",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2021-01-01T10-00:00.000Z",
"endTime": "2021-01-03T13:18:10.668Z"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Could not parse given time input 2021-01-01T10-00:00.000Z. Please provide time in ISO8601 format",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "9999-01-01T10:00:00.000Z",
"endTime": "2021-01-03T13:18:10.668Z"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment start time should not be in future. Please check the input again",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-01T10:00:00.000+05:30",
"endTime": "9999-01-03T13:18:10.668Z"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment end time should not be in future. Please check the input again",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2020-01-04T10:00:00.000+05:30",
"endTime": "2020-01-03T13:18:10.668Z"
}
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment end time should be after start time. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentResources": [
{
"resourceId": "InValidResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "One or more resources provided is invalid. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"appointmentResources": [
{
"resourceId": "ResourceIdNotExist-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "One or more resources provided does not exist or is deleted. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "InvalidUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Input document id does not exist. Please check the input",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "UploadDestinationIdExpired-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Input document parameters are invalid. Please check the input.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "InvalidDocumentTypeUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document failed to meet content type restrictions. Please review document uploaded",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "InvalidDocumentLengthUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Failed to retrieve document content length. Please review document uploaded",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "ExceededDcoumentLengthUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document failed to meet content length restrictions. Please review document uploaded",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "DocumentNotUploadedUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document encrypted not found or exist. Please review document uploaded",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "IncorrectEncryptedDocumentUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document failed to decrypt or decipher. Please review the uploaded document",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDestinationId-9cb9bc29-3d7d-5e49-5709-efb693d34468",
"contentSha256": "InvalidSHA256GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document failed to meet sanity check. Could not get a Sha256 Message Digest instance. Please review document uploaded",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentDocuments": [
{
"uploadDestinationId": "UploadedFileDetectedMalwareUploadeDestinationId-348293-2384982-239847982379",
"contentSha256": "validSHA256GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document failed to meet malware check. Please review document uploaded",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "InValidResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "InValidUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "ne or more resources provided is invalid. Please check the input again.",
"details": ""
},
{
"code": "InvalidInput",
"message": "Appointment start time is required. Please check the input again.",
"details": ""
},
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Input document id does not exist. Please check the input",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "InValidUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment start time is required. Please check the input again.",
"details": ""
},
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Input document id does not exist. Please check the input",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Appointment start time is required. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2022-01-03T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "ResourceIdNotExist-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "validUploadDesitnationID348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "One or more resources provided does not exist or is deleted. Please check the input again.",
"details": ""
}
]
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJobId-1-9cb9bc29-3d7d-5e49-5709-efb693d34468"
},
"appointmentId": {
"value": "validAppointmentId-9cb9bc29-3d7d-5e49-5709-efb693d34468_00b9d5f2-839d-c13e-b8cd-dae1c3995b2a"
},
"body": {
"value": {
"fulfillmentTime": {
"startTime": "2022-01-03T13:18:10.668Z",
"endTime": "2022-01-03T13:18:10.668Z"
},
"appointmentResources": [
{
"resourceId": "validResourceId-20334421900"
},
{
"resourceId": "validResourceId-82309484378"
}
],
"fulfillmentDocuments": [
{
"uploadDestinationId": "UploadedFileDetectedMalwareUploadeDestinationId-348293-2384982-239847982379",
"contentSha256": "z06EuBzgzc7GiDNVqcxMqYEr7n0BCS9EtNN7szHe0RT="
}
]
}
}
}
},
"response": [
{
"code": "InvalidInput",
"message": "Failed to process proof of appointment input. Reason: Document failed to meet malware check. Please review document uploaded",
"details": ""
}
]
}
]
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorList"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceResources/{resourceId}/capacity/range": {
"post": {
"tags": [
"service"
],
"description": "Provides capacity slots in a format similar to availability records.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getRangeSlotCapacity",
"parameters": [
{
"name": "resourceId",
"description": "Resource Identifier.",
"type": "string",
"in": "path",
"required": true,
"maxLength": 100,
"minLength": 1
},
{
"name": "body",
"description": "Request body.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/RangeSlotCapacityQuery"
}
},
{
"name": "marketplaceIds",
"description": "An identifier for the marketplace in which the resource operates.",
"in": "query",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
},
{
"name": "nextPageToken",
"description": "Next page token returned in the response of your previous request.",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacity"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static":[
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY", "AVAILABLE_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z"
}
}
}
},
"response": {
"resourceId": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48",
"capacities": [
{
"capacityType": "SCHEDULED_CAPACITY",
"slots": [
{
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z",
"capacity": 1
}
]
},
{
"capacityType": "AVAILABLE_CAPACITY",
"slots": [
{
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T01:00:00Z",
"capacity": 0
},
{
"startDateTime": "2021-04-04T01:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z",
"capacity": 1
}
]
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f29"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY", "AVAILABLE_CAPACITY"],
"startDateTime": "2022-03-01T00:00:00Z",
"endDateTime": "2022-05-30T00:00:00Z"
}
}
}
},
"response": {
"resourceId": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48",
"nextPageToken": "MjAyMi0wNC0wNVQwMDowMDowMFo%3D",
"capacities": [
{
"capacityType": "SCHEDULED_CAPACITY",
"slots": [
{
"startDateTime": "2022-03-01T00:00:00Z",
"endDateTime": "2022-04-05T00:00:00Z",
"capacity": 1
}
]
},
{
"capacityType": "AVAILABLE_CAPACITY",
"slots": [
{
"startDateTime": "2022-03-01T00:00:00Z",
"endDateTime": "2022-03-01T10:00:00Z",
"capacity": 0
},
{
"startDateTime": "2022-03-01T10:00:00Z",
"endDateTime": "2022-04-05T00:00:00Z",
"capacity": 1
}
]
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f29"
},
"nextPageToken": {
"value": "MjAyMi0wNC0wNVQwMDowMDowMFo%3D"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY", "AVAILABLE_CAPACITY"],
"startDateTime": "2022-03-01T00:00:00Z",
"endDateTime": "2022-05-30T00:00:00Z"
}
}
}
},
"response": {
"resourceId": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48",
"capacities": [
{
"capacityType": "SCHEDULED_CAPACITY",
"slots": [
{
"startDateTime": "2022-04-05T00:00:00Z",
"endDateTime": "2022-05-30T00:00:00Z",
"capacity": 1
}
]
},
{
"capacityType": "AVAILABLE_CAPACITY",
"slots": [
{
"startDateTime": "2022-04-05T00:00:00Z",
"endDateTime": "2022-05-30T10:00:00Z",
"capacity": 1
}
]
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gbadfhak32"
},
"body": {
"value": {
"capacityTypes": ["RESERVED_CAPACITY", "AVAILABLE_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z"
}
}
}
},
"response": {
"resourceId": "validResourceId-9d267d55-9426-5bfp-cc47-f167gbadfhak32",
"capacities": [
{
"capacityType": "AVAILABLE_CAPACITY",
"slots": [
{
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T01:00:00Z",
"capacity": 0
},
{
"startDateTime": "2021-04-04T01:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z",
"capacity": 1
}
]
},
{
"capacityType": "RESERVED_CAPACITY",
"slots": [
{
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T01:00:00Z",
"capacity": 1
},
{
"startDateTime": "2021-04-04T01:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z",
"capacity": 0
}
]
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static":[
{
"request": {
"parameters": {
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [Missing or invalid request parameters: [resourceId]]"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48a"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [startDateTime or endDateTime are not present]"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48b"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T02:00:00Z",
"endDateTime": "2021-04-04T00:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [endDateTime should be after Start Time]"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9426-5bfp-cc47-f167gb969f48c"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-0",
"endDateTime": "2021-04-04T00:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [startDateTime is not a valid ISO date/time object]"
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/RangeSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceResources/{resourceId}/capacity/fixed": {
"post": {
"tags": [
"service"
],
"description": "Provides capacity in fixed-size slots. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getFixedSlotCapacity",
"parameters": [
{
"name": "resourceId",
"in": "path",
"description": "Resource Identifier.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"description": "Request body.",
"required": true,
"schema": {
"$ref": "#/definitions/FixedSlotCapacityQuery"
}
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace in which the resource operates.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
},
{
"name": "nextPageToken",
"in": "query",
"description": "Next page token returned in the response of your previous request.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacity"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static":[
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9e378g66-9537-6ggq-dd48-f167gb969f48"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY", "RESERVED_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z",
"slotDuration": 30
}
}
}
},
"response": {
"resourceId": "validResourceId-9e378g66-9537-6ggq-dd48-f167gb969f48",
"slotDuration": 30,
"capacities": [
{
"startDateTime": "2021-04-04T00:00:00Z",
"scheduledCapacity": 1,
"reservedCapacity": 1
},
{
"startDateTime": "2021-04-04T00:30:00Z",
"scheduledCapacity": 1,
"reservedCapacity": 0
},
{
"startDateTime": "2021-04-04T01:00:00Z",
"scheduledCapacity": 0,
"reservedCapacity": 0
},
{
"startDateTime": "2021-04-04T01:30:00Z",
"scheduledCapacity": 0,
"reservedCapacity": 0
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static":[
{
"request": {
"parameters": {
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [Missing or invalid request parameters: [resourceId]]"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9d267d55-9dfa-5bfp-cc47-f167gb969f48a"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z",
"endDateTime": "2021-04-04T02:00:00Z",
"slotDuration": 400
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [Slot duration is not valid, it should be a multiple of 5 and within allowed range.]"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9e378g66-9537-6ggq-dd48-f1klmb969f48"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T02:00:00Z",
"endDateTime": "2021-04-04T00:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [endDateTime should be after Start Time]"
}
]
}
},
{
"request": {
"parameters": {
"body": {
"resourceId": {
"value": "validResourceId-9e378g66-9537-6ggq-dd48-f1klmb969f482"
},
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-04-04T00:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [startDateTime or endDateTime are not present]"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9e378g66-9537-6ggq-dd48-f1klmb969f483"
},
"body": {
"value": {
"capacityTypes": ["SCHEDULED_CAPACITY"],
"startDateTime": "2021-0",
"endDateTime": "2021-04-04T00:00:00Z"
}
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "This is invalid input",
"details": "Received the following errors: [startDateTime is not a valid ISO date/time object]"
}
]
}
}
]
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/FixedSlotCapacityErrors"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceResources/{resourceId}/schedules": {
"put": {
"tags": [
"service"
],
"description": "Update the schedule of the given resource.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "updateSchedule",
"parameters": [
{
"name": "resourceId",
"in": "path",
"description": "Resource (store) Identifier",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"description": "Schedule details",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateScheduleRequest"
}
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace in which the resource operates.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"body": {
"value": {
"schedules": [
{
"startTime": "2020-01-01T00:00:00.00-07",
"endTime": "2020-01-01T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-06T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
]
}
},
{
"startTime": "2020-01-11T00:00:00.00-07",
"endTime": "2020-01-11T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-16T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY"
]
}
}
]
}
}
}
},
"response": {}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"body": {
"value": {
"schedules": [
{
"startTime": "2020-01-01T12:00:00.00-07",
"endTime": "2020-01-01T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-06T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
]
}
},
{
"startTime": "2020-01-11T00:00:00.00-07",
"endTime": "2020-01-11T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-16T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY"
]
}
}
]
}
}
}
},
"response": {
"payload": [
{
"availability": {
"startTime": "2020-01-01T12:00:00.00-07",
"endTime": "2020-01-01T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-06T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
]
}
},
"warnings": [
{
"code": "ScheduleOverride",
"message": "This AvailabilityRecord will override the current schedule as the time-ranges overlap"
}
]
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "invalidResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"body": {
"value": {
"schedules": [
{
"startTime": "2020-01-01T00:00:00.00-07",
"endTime": "2020-01-01T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-06T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
]
}
},
{
"startTime": "2020-01-11T00:00:00.00-07",
"endTime": "2020-01-11T23:59:00.00-07",
"recurrence": {
"endTime": "2020-01-16T23:59:00.00-07",
"daysOfWeek": [
"MONDAY",
"TUESDAY",
"WEDNESDAY"
]
}
}
]
}
}
}
},
"response": {
"errors": [
{
"message": "Invalid request parameters: [resourceId]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"resourceId": {
"value": "null"
},
"body": {
"value": {
"schedules": []
}
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [resourceId]",
"code": "InvalidInput"
}
]
}
},
{
"request": {
"parameters": {
"resourceId": {
"value": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"body": {
"value": {
"schedules": []
}
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [schedule]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/UpdateScheduleResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/reservation": {
"post": {
"tags": [
"service"
],
"description": "Create a reservation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "createReservation",
"parameters": [
{
"in": "body",
"name": "body",
"description": "Reservation details",
"required": true,
"schema": {
"$ref": "#/definitions/CreateReservationRequest"
}
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace in which the resource operates.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"resourceId": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {
"availability": {
"startTime": "2020-04-01T10:00:00.00-07",
"endTime": "2020-04-01T11:00:00.00-07"
},
"type": "BREAK"
}
}
}
}
},
"response": {
"payload": {
"reservation": {
"reservationId": "457"
}
}
}
},
{
"request": {
"parameters": {
"body": {
"value": {
"resourceId": "invalidResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {
"availability": {
"startTime": "2020-04-01T10:00:00.00-07",
"endTime": "2020-04-01T11:00:00.00-07"
},
"type": "BREAK"
}
}
}
}
},
"response": {
"errors": [
{
"message": "Invalid request parameters: [resourceId]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"resourceId": "null",
"reservation": {}
}
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [resourceId]",
"code": "InvalidInput"
}
]
}
},
{
"request": {
"parameters": {
"body": {
"value": {
"resourceId": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {}
}
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [reservation]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CreateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/reservation/{reservationId}": {
"put": {
"tags": [
"service"
],
"description": "Update a reservation.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "updateReservation",
"parameters": [
{
"name": "reservationId",
"in": "path",
"description": "Reservation Identifier",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"in": "body",
"name": "body",
"description": "Reservation details",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateReservationRequest"
}
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace in which the resource operates.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reservationId": {
"value": "456"
},
"body": {
"value": {
"resourceId": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {
"availability": {
"startTime": "2020-04-01T10:00:00.00-07",
"endTime": "2020-04-01T11:00:00.00-07"
},
"type": "BREAK"
}
}
}
}
},
"response": {
"payload": {
"reservation": {
"reservationId": "457"
}
}
}
},
{
"request": {
"parameters": {
"reservationId": {
"value": "456"
},
"body": {
"value": {
"resourceId": "invalidResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {
"availability": {
"startTime": "2020-04-01T10:00:00.00-07",
"endTime": "2020-04-01T11:00:00.00-07"
},
"type": "BREAK"
}
}
}
}
},
"response": {
"errors": [
{
"message": "Invalid request parameters: [resourceId]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"resourceId": "null",
"reservation": {}
}
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [resourceId]",
"code": "InvalidInput"
}
]
}
},
{
"request": {
"parameters": {
"body": {
"value": {
"resourceId": "validResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {}
}
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [reservation]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The reservation specified does not exist.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reservationId": {
"value": "not-existent-456"
},
"body": {
"value": {
"resourceId": "invalidResourceId-9c156c44-8315-4aeb-bb36-e056fa827e36",
"reservation": {
"availability": {
"startTime": "2020-04-01T10:00:00.00-07",
"endTime": "2020-04-01T11:00:00.00-07"
},
"type": "BREAK"
}
}
}
}
},
"response": {
"errors": [
{
"message": "Could not find reservation with ID: [not-existent-456]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/UpdateReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"delete": {
"tags": [
"service"
],
"description": "Cancel a reservation. \n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "cancelReservation",
"parameters": [
{
"name": "reservationId",
"in": "path",
"description": "Reservation Identifier",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace in which the resource operates.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
}
],
"responses": {
"204": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reservationId": {
"value": "validReservationId-9c156c44-8315-4aeb-bb36-e056fa827e36"
}
}
},
"response": {}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reservationId": {
"value": "invalidReservationId-a654baa-8315-4aeb-bb36-e056fa827e36"
}
}
},
"response": {
"errors": [
{
"message": "Missing or invalid request parameters: [reservationId]",
"code": "InvalidInput"
}
]
}
}
]
}
},
"403": {
"description": "403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"404": {
"description": "The reservation specified does not exist.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"reservationId": {
"value": "nonExistingReservationId-a3726c44-8315-4aeb-bb36-e056fa827e36"
}
}
},
"response": {
"errors": [
{
"message": "Reservation does not exist",
"code": "InvalidInput"
}
]
}
}
]
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"415": {
"description": "The entity of the request is in a format not supported by the requested resource.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/CancelReservationResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation.\n**Note:** For this status code, the rate limit header is deprecated and no longer returned."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference id."
}
}
}
}
},
"parameters": []
},
"/service/v1/serviceJobs/{serviceJobId}/appointmentSlots": {
"get": {
"tags": [
"service"
],
"description": "Gets appointment slots for the service associated with the service job id specified.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getAppointmmentSlotsByJobId",
"parameters": [
{
"name": "serviceJobId",
"in": "path",
"description": "A service job identifier to retrive appointment slots for associated service.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace in which the resource operates.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
},
{
"name": "startTime",
"in": "query",
"description": "A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.",
"required": false,
"type": "string"
},
{
"name": "endTime",
"in": "query",
"description": "A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static":[
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJob-9c156c44-8315-4aeb-bb36-e056fa827e36"
}
}
},
"response": {
"payload": {
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T02:00:00Z",
"schedulingType": "REAL_TIME_SCHEDULING",
"appointmentSlots": [
{
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T01:0:00Z",
"capacity": 20
},
{
"startTime": "2021-04-04T01:00:00Z",
"endTime": "2021-04-04T02:0:00Z",
"capacity": 0
}
]
}
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJob-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"startTime": {
"value":"2021-04-04T00:00:00Z"
},
"endTime": {
"value":"2021-04-04T02:00:00Z"
}
}
},
"response": {
"payload": {
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T02:00:00Z",
"schedulingType": "REAL_TIME_SCHEDULING",
"appointmentSlots": [
{
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T01:0:00Z",
"capacity": 20
},
{
"startTime": "2021-04-04T01:00:00Z",
"endTime": "2021-04-04T02:0:00Z",
"capacity": 0
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static":[
{
"request": {
"parameters": {
"serviceJobId": {
"value": "nullJobId"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [serviceJobId]"
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJob-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"endTime": {
"value":"20-21-04-04T01:00:00Z"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "End Time is not a valid ISO date/time object"
}
]
}
},
{
"request": {
"parameters": {
"serviceJobId": {
"value": "validJob-9c156c44-8315-4aeb-bb36-e056fa827e36"
},
"startTime": {
"value":"2021-04-04T05:00:00Z"
},
"endTime": {
"value":"2021-04-04T02:00:00Z"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "End Time should be after Start Time"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/appointmentSlots": {
"get": {
"tags": [
"service"
],
"description": "Gets appointment slots as per the service context specified.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 20 | 40 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getAppointmentSlots",
"parameters": [
{
"name": "asin",
"in": "query",
"description": "ASIN associated with the service.",
"required": true,
"type": "string"
},
{
"name": "storeId",
"in": "query",
"description": "Store identifier defining the region scope to retrive appointment slots.",
"required": true,
"type": "string",
"maxLength": 100,
"minLength": 1
},
{
"name": "marketplaceIds",
"in": "query",
"description": "An identifier for the marketplace for which appointment slots are queried",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1
},
{
"name": "startTime",
"in": "query",
"description": "A time from which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `startTime` is provided, `endTime` should also be provided. Default value is as per business configuration.",
"required": false,
"type": "string"
},
{
"name": "endTime",
"in": "query",
"description": "A time up to which the appointment slots will be retrieved. The specified time must be in ISO 8601 format. If `endTime` is provided, `startTime` should also be provided. Default value is as per business configuration. Maximum range of appointment slots can be 90 days.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success response.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"asin": {
"value": "B07BB1RGT5"
},
"storeId": {
"value": "53694163-6dc8-4f80-b6b1-ec47b7b9747e"
}
}
},
"response": {
"payload": {
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T02:00:00Z",
"schedulingType": "REAL_TIME_SCHEDULING",
"appointmentSlots": [
{
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T01:0:00Z",
"capacity": 20
},
{
"startTime": "2021-04-04T01:00:00Z",
"endTime": "2021-04-04T02:0:00Z",
"capacity": 0
}
]
}
}
},
{
"request": {
"parameters": {
"asin": {
"value": "B07BB1RGT6"
},
"storeId": {
"value": "53694163-6dc8-4f80-b6b1-ec47b7b9747f"
},
"startTime": {
"value":"2021-04-04T00:00:00Z"
},
"endTime": {
"value":"2021-04-04T02:00:00Z"
}
}
},
"response": {
"payload": {
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T02:00:00Z",
"schedulingType": "NON_REAL_TIME_SCHEDULING",
"appointmentSlots": [
{
"startTime": "2021-04-04T00:00:00Z",
"endTime": "2021-04-04T01:0:00Z",
"capacity": 20
},
{
"startTime": "2021-04-04T01:00:00Z",
"endTime": "2021-04-04T02:0:00Z",
"capacity": 0
}
]
}
}
}
]
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"asin": {
"value": "nullValue"
},
"storeId": {
"value": "53694163-6dc8-4f80-b6b1-ec47b7b9747e"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Missing or invalid request parameters: [asin]"
}
]
}
},
{
"request": {
"parameters": {
"asin": {
"value": "B07BB1RGT5"
},
"storeId": {
"value": "53694163-6dc8-4f80-b6b1-ec47b7b9747e"
},
"endTime": {
"value":"20-21-04-04T01:00:00Z"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Range End Time is not a valid ISO date/time object"
}
]
}
},
{
"request": {
"parameters": {
"asin": {
"value": "B07BB1RGT5"
},
"storeId": {
"value": "53694163-6dc8-4f80-b6b1-ec47b7b9747e"
},
"startTime": {
"value":"2021-04-04T05:00:00Z"
},
"endTime": {
"value":"2021-04-04T02:00:00Z"
}
}
},
"response": {
"errors": [
{
"code": "InvalidInput",
"message": "Range End Time should be after Range Start Time"
}
]
}
}
]
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"404": {
"description": "The resource specified does not exist.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"422": {
"description": "Unprocessable Entity. Unable to process the contained instructions.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/GetAppointmentSlotsResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
}
}
}
},
"parameters": []
},
"/service/v1/documents": {
"post": {
"tags": [
"service"
],
"description": "Creates an upload destination.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 20 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "createServiceDocumentUploadDestination",
"parameters": [
{
"in": "body",
"name": "body",
"description": "Upload document operation input details.",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceUploadDocument"
}
}
],
"responses": {
"200": {
"description": "Successfully created an upload destination for the given resource.",
"schema": {
"$ref": "#/definitions/CreateServiceDocumentUploadDestination"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-requestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"x-amzn-api-sandbox": {
"static": [
{
"request": {
"parameters": {
"body": {
"value": {
"contentType": "PNG",
"contentLength": 1386437,
"contentMD5": "97WrSKv9ffHkDopCdB32mw=="
}
}
}
},
"response": {
"payload": {
"encryptionDetails": {
"standard": "AES",
"initializationVector": "paPlpo1iBBLmyOhU0mIo5g==",
"key": "PDuDJm2l+0ydObrRpS48tB+t2qbtOmWhSEOiFWKnH2k="
},
"uploadDestinationId": "amzn1.tortuga.3.15ba627d-8e24-42ad-89d1-5eb01f5ba0af.T15MXQRST78UTC<->amzn1.tortuga.1.token.DizquVc+EoX/lWAV/7WTlw==",
"url": "https://tortuga-devo.s3-us-west-2.amazonaws.com/%2FThirtyDays/amzn1.tortuga.3.15ba627d-8e24-42ad-89d1-5