UNPKG

node-red-contrib-rollun-aws-sp-api

Version:

Node-RED nodes to access AWS Selling Partner API

1,275 lines 359 kB
{ "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 identi